OpusPAY
User guide
×
Menu
Index

Gateway Summary - APIs

 
This page allows users to view a list of current Gateway APIs and add new Gateway APIs for merchant transaction processing.
 
Gateway Summary - APIs
1

Back

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. If the Edit button has been clicked (Save button is displayed in the bottom right corner), display a popup modal warning user that continuing will cause them to lose any changes they have made. Refer to the specification for that screen here.
 
2. If the Edit button has not been clicked (Edit button is displayed in the bottom right corner), this should navigate the user to the Gateways screen when clicked. Refer to the specification for that screen here.
-
-
Y
-
-
-
2

Gateway

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display a Gateway's name.
 
2. If in edit mode, the user is able to update a Gateway's name.
 
3. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
255
Disabled
3. Please enter the Gateway's name.
3

Status

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
1. Active Gateways should be allowed to be selected and used by Merchants in their portal for transactions.
 
2. Gateways cannot be set to Inactive if they are linked to at least one Merchant.
1. This should display the status of a Gateway, either Active or Inactive.
 
2. If in edit mode, the user will be able to change the Gateway's status.
 
3. If in edit mode and the user changes the status to Inactive. Check the database to see if there are any Merchants attached to this Gateway. If there is, do not change the status to Inactive and display an inline error message.
-
-
Y
-
Disabled
3. Gateway cannot be set to Inactive because it is linked to a Merchant. Please change all Merchants to another Gateway before setting this Gateway to Inactive.
4

Accepted Countries

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow the user to view existing Accepted Countries & Currencies. If in edit mode users can also update existing, or add new, countries & currencies as required.  Refer specification for that tab here.
-
-
-
-
-
-
5

Payment Methods

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow the user to view existing Gateway Payment Methods. If in edit mode, users can also update existing and add new Payment Methods as required. Refer specification for that tab here.
-
-
-
-
-
-
6

Devices

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow the user to view existing Gateway Devices. If in edit mode, users can also update existing and add new Devices as required. Refer specification for that tab here.
-
-
-
-
-
-
7

API Configurations

 
Tab for managing API Configuration rules
 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow the user to view existing Gateway APIs. If in edit mode, users can also update existing and add new APIs as required.
-
-
-
-
-
-
8

Address 1

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display Address 1 for the Gateway. If in edit mode, users can also update this field.
 
2. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
-
Disabled
2. Please enter an Address 1.
9

Address 2

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display Address 2 for the Gateway.  If in edit mode, users can also update this field.
-
-
Y
-
Disabled
-
10

Suburb / Town

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display the Suburb/Town for the Gateway. If in edit mode, users can also update this field.
 
2. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
-
Disabled
2. Please enter a Suburb / Town.
11

State

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display State for the Gateway. If in edit mode, users can also update this field.
 
2. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
-
Disabled
Please enter a State.
12

Post Code

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display the Post Code for the Gateway. If in edit mode, users can also update this field.
 
2. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
-
Disabled
Please enter a Post Code.
13

Country

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should display Country for the Gateway. If in edit mode, users can also update this field.
 
2. If the user clicks on Save without entering a value in this field, display an inline error message.
Y
-
Y
-
Disabled
2. Please enter a Country.
14

Add Row

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. When enabled, clicking this button will allow the user to add an API to the grid.
 
2. The user is navigated to the Add/Edit API screen after clicking this button. Refer to the specification of that page here.
-
-
Y
-
Disabled
-
15

Save Button

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. This should check the rule mentioned in each input element on all tabs and show inline error messages for invalid / unpopulated inputs.
 
2. If all inputs are confirmed to be valid and populated then:
 
2a. This should save the Gateway record. Either create a new Gateway or save the changes made to the existing Gateway.
 
2b. This should set the Gateway as 'Active' when the record is created.
 
2c. If creating a new Gateway, close this screen and navigate the user to the Gateway screen. Refer to the specifications for that screen here.
 
2d. If changing an already existing Gateway, disable all fields on all tabs and change the Edit button to a Save button.
Y
-
Y
-
-
-
16

Delete API Rule

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
1. When enabled, clicking this button will delete the API Rule for this row.
-
-
N
-
Disabled
-
17

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 countries and currencies records visible in the grid.
 
2. Displays following options to select from:
 
  • 10
  • 25
  • 50
  • 100
 
-
-
Y
-
10
-
18

Pagination

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

Business Phone

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter the Phone Number for the Gateway.
 
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 Business Phone Number.
20

Business Email

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter an email address. Could be the email address of the primary contact or a general email address such as info@gateway.com
 
2. This should display an inline error message if the user clicks the Submit button without populating this field.
Y
Email
Y
255
Disabled
2. Please enter the Primary Contact's Email Address.
 
21

Given Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter the Given Name of the primary contact of the Gateway.
N
-
Y
255
Disabled
-
22

Last Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. This should allow the user to enter the Last Name of the primary contact of the Gateway.
N
-
Y
255
-
-
23

API Description

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Grid
-
1. Grid should be sortable by all data columns.
-
-
-
-
-
-
API Description
Column
  • Show a list of all rules created
  • Sort in Alphabetical order
  • Hyperlink each rule which when selected opens that rule in edit mode. Refer to the specifications for that screen here.
-
-
-
-
-
-
24

Copy

 
Allows to copy a rule with all its definitions
 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
  • If selected, then insert a new row into the grid
  • Copy the selected rule to the new row with the same rule name but with the word "[COPY]" at the front of the description
  • Insert all the rule definition detail from the copied ruled into the new rule
  • Mark the rule as In-Active
 
-
-
Y
-
-
-
25

Active

 
Function to activate or de-activate a row
 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
-
  • If selected then open Activate Pop-up
  • If de-selected then open De-Activate Pop-up
 
-
-
Y
-
-
-
 
Activate Pop-Up
 
        
 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Pop-Up
-
  • If Yes is selected then check the Active checkbox for that row and return to the rules list
  • If No, then close pop-up and return to the rules definition list
-
-
Y
-
-
-
 
 
De-Activate Pop-Up
 
        
 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Pop-Up
-
  • If Yes is selected then un-check the Active checkbox for that row and return to the rules list
  • If No, then close pop-up and return to the rules definition list
-
-
Y
-
-
-
26

API Keys

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Tab
-
1. This should allow the user to view existing Gateway API Keys. If in edit mode, users can also update existing and add new API Keys as required. Refer specification for that tab here.
-
-
-
-
-
-