OpusPAY
User guide
×
Menu
Index

Edit Account - Gateway Details - Devices

This screen allows the user to add sub-accounts to their merchant portal.
 
Edit Account - Gateway Details - Devices
1

Back

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. When clicked this should navigate the user to the Accounts screen without saving any changes. Refer to the specification for that page here.
-
-
Y
-
-
-
2

Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Hyperlink
-
1. This will display the Device Names as a hyperlink.
 
2. Clicking on the hyperlink will navigate the user to the Add/Edit Device details screen. Refer to the specifications for that screen here.
 
3. The column should be sortable
-
-
N
-
-
-
3

Gateway Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow for the entry of the Gateway details.
 
2. This tab should be highlighted to identify the tab the user is on.
-
-
Y
-
-
-
4

Location

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Column
-
1. This will display details as to the location of the device and if the row is in Edit mode, will allow the user to change the Location.
 
2. This should be sortable.
N
-
Y
-
-
-
5

Gateway Merchant ID

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display Merchant ID and set field to disabled. If the Account will have it's own Gateway account, enable this field and allow the user to enter the Merchant ID.
 
2. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
Disabled.
2. Please enter the Merchant ID.
6

Add Devices

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. This will add a new row to the table allowing the user to enter details for a new Device.
-
-
Y
-
-
-
7

Primary Contact Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This displays the Primary Contact of the Account. Refer to the specifications for that screen here.
-
-
Y
-
-
-
8

Gateway API Public Key

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display Gateway API Public Key and set field to disabled. If the Account will have it's own Gateway account, enable this field and allow the user to enter the Gateway API Public Key.
 
2. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
Disabled.
2. Please enter the API Public Key.
9

Gateway

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Dropdown
-
1. This will display the current Gateway for the Account.
 
2. If the Account is not linked to the PrimaryEntity's Gateway, this should allow the user to change the Gateway for the Account.
 
3. This list should be flltered to only show Gateways where the accepted Country matches the country the merchant is located in.
 
4. When a Gateway is selected, clear all fields on the Gateway tab (including the Payment Methods and Devices tabs) and repopulate the list of "Payment Methods" based on the options the Gateway allows.
 
5. If the user clicks on the Save button without entering a value in this field, display an inline error message and do not create the record.
Y
-
Y
-
-
5. Please enter the Gateway.
10

Save

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. Check the rules mentioned in each input element on both the Payment Methods and Devices tabs, and show inline error messages for invalid / unpopulated inputs.
 
2. If the validation results are successful save all Gateway options selected and entered.
 
3. Navigate the user to the View Account - Gateway Details - Devices screen. Refer to the specifications for that screen here.
-
-
-
-
-
-
11

Status

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Column
-
1. This will display the Status of the Device (active or inactive) and if the row is in Edit mode, will allow the user to change the Status.
 
2. This should be sortable.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
-
-
Y
-
-
3. Please select a Status.
12

Delete

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. This will allow the user to "delete" a Device from this table.
 
2. Devices should never be deleted from the database, only from this list. Deleted Devices will still need to be used for any reports, etc. where the Device is linked to a transaction.
-
-
-
-
-
-
13

Number of Records

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. This should allow the user to select an option to control the number of device records visible in the grid.
 
2. Displays following options to select from:
 
  • 10
  • 25
  • 50
  • 100
 
-
-
Y
-
10
-
14

Pagination Control

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. This should allow the users to paginate through the Plans Grid records.
 
2. To determine the number of pagination buttons to display please follow the current logic that is being used in byondcloud.
-
-
Y
-
-
-
15

Merchant Account Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow for the entry of the Merchant Account name.
 
2. If the user clicks on the Save button without entering a value in this field, display an inline error message and do not create the record.
Y
-
Y
255
-
2. Please enter the Merchant Account's name
16

Website URL

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter the website of the organisation.
-
-
Y
255
-
-
17

Country

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. This should allow the user to select a Country. List of available countries comes from the Countries & Currencies list set in the Admin Portal. Refer to the specifications for that screen here.
 
2. Use the same Address Component and logic as per byondcloud registration page.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
-
3. Please enter the organisation's Country.
18

State

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. This should allow the user to select a State.
 
2. Use the same Address Component and logic as per byondcloud registration page.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
-
3. Please enter the organisation's State.
19

Suburb/Town

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. This should allow the user to select a Suburb/Town.
 
2. Use the same Address Component and logic as per byondcloud registration page.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
-
3. Please enter the organisation's Suburb/Town.
20

Address Line 1

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow for the entry of Address Line 1 for the organisation.
 
2. If the user clicks on the Save button without entering a value in this field, display an inline error message and do not create the record.
Y
-
Y
255
-
2. Please enter organisation's Address Line 1
21

Payment Methods Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This displays the Gateway's Payment Methods and allows the user to select which Payment Methods the Account will offer. Refer to the specifications for that screen here.
-
-
Y
-
-
-
22

Devices Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This displays the Devices the Account uses. The user can add and remove Devices here.
 
2. This tab should be highlighted to identify the tab the user is on
-
-
Y
-
-
-
23

OpusPAY API Credentials Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This displays the Accounts API Credentials. Refer to the specifications for that screen here.
-
-
Y
-
-
-
24

Plan Tab

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This displays the Plan assigned to the Parent Entity. Refer to the specifications for that screen here.
-
-
Y
-
-
-
25

Address Line 2

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter the Address Line 2
-
-
Y
255
-
-
26

Post Code

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. This should allow the user to select a Post Code.
 
2. Use the same Address Component and logic as per byondcloud registration page.
 
3. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
-
3. Please enter the organisation's Post Code.
27

Gateway API Private Key

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display Gateway API Private Key and set field to disabled. If the Account will have it's own Gateway account, enable this field and allow the user to enter the Gateway API Private Key.
 
2. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
-
Y
255
Disabled.
2. Please enter the API Private Key.
28

Invoice Account Directly

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Checkbox
-
1. If checked, indicate in the database that this account is to be invoiced directly for it's transactions.
N
-
Y
-
Not Checked
-
29

Status

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Column
-
1. This should display the status of the Account (Active or Inactive). If the Account is Active, it is able to pass transactions through opuspay. If Inactive, the Account cannot pass transactions through opuspay.
 
2. If the user changes the Status from Active to Inactive for a Parent Account, all Sub Accounts that are set to "Invoice Account Directly" = "False" and/or where the Gateway is set to "Link to the Parent Entity's gateway account", set the Sub Account to Inactive as well.
byondpro should also be updated to show that the merchant account is inactive (which would display as On-Hold in byondpro).
 
3. If the Parent Merchant Account has been set to Inactive from the Admin Portal, all Sub Accounts must be set to Inactive as well and neither the Parent or Sub Accounts can be set to Active. They can only be activated from the Admin portal again.
Y
-
Y
-
Active
-