OpusPAY
User guide
×
Menu
Index

Edit Account - Gateway Details - PM

 
This screen allows the user to edit the payment methods of the selected gateway
 
Edit Account - Gateway Details - PM
1

Title

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This displays the title of the screen.
1a. By default, the text 'Payment Gateway' should be shown followed by a hyphen and the name of the selected gateway.
Eg.
Payment Gateway - Payrix
Y
-
N
-
-
-
2

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.
2a. Display Merchant ID, API Private Key, API Public Key and all other keys as hidden.
2b. Display a key icon within each field. If this key icon is clicked when the keys are hidden, unhide the values within each key and do not display the key icon.

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

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
-
2. Please enter the Merchant ID.
4

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
-
2. Please enter the API Public Key.
5

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
-
2. Please enter the API Private Key.
6

API Key 1

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1.  If linking to the Parent Entity's gateway account, display API Key 1 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 API Key 1.
-
-
Y
-
-
-
7

API Key 2

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display API Key 2 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 API Key 2.
-
-
Y
-
-
-
8

API Key 3

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display API Key 2 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 API Key 2.
-
-
Y
-
-
-
9

API Key 4

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. If linking to the Parent Entity's gateway account, display API Key 2 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 API Key 2.
-
-
Y
-
-
-
10

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

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

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

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 details entered.
 
3. Navigate the user to the Edit Account - Gateway Details screen. Refer to the specifications for that screen here.
-
-
-
-
-
-
14

Close

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. When clicked this should navigate the user to Edit Account - Gateway Details screen. Refer to the specification for that page here.
-
-
Y
-
-
-