OpusPAY
User guide
×
Menu
Index

Edit Account - Gateway Details - PM

 
This screen allows the user to add sub-accounts to their merchant portal. Will need mulitple Gateways. In future if not now.
 
Edit Account - Gateway Details - PM
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

Payment Method

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Column
-
1. This will display the available Payment Methods for the Gateway.
 
2. At least one Payment Method must be selected. If no Payment Methods are selected, display an inline error message if the user clicks the Save button.
Y
-
Y
-
-
3. Please select at least one Payment Method.
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

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.
5

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
-
-
-
6

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 by selecting an Active Gateway from the list.
 
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.
7

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 - PM screen. Refer to the specifications for that screen here.
-
-
-
-
-
-
8

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
9

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
-
-
10

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.
11

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.
12

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.
13

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
14

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.
 
2. This tab should be highlighted to identify the tab the user is on
-
-
Y
-
-
-
15

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. Refer to the specifications for this screen here.
-
-
Y
-
-
-
16

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
-
-
-
17

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
-
-
-
18

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
-
-
19

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.
20

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.
21

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.
22

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
-
23

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
-
24

Gateway Account Options

Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. These radio buttons determine if the Account is linked to the Parent Entity's Gateway account or if the Account will have it's own Gateway account.
 
2. If the "Link to the Parent Entity's Gateway account" option is selected, disable and autopopulate the Gateway, Merchant ID, API Private Key, and API Public Key.

3. If the "Link to an existing gateway account" option is selected, clear and enable the Gateway, Merchant ID, API Private Key, and API Public Key fields.
-
-
Y
-
Link to Parent Entity's Gateway Account
-