OpusPAY

^{User guide}

×

Menu

Index

Search

(c) Company name, 2020

Edit Account - Gateway Details - Devices

This screen allows the user to edit the devices related to the selected gateway

Edit Account - Gateway Details - Devices

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

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	-

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.

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.

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.

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

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

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

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 4 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 4.	-	-	Y	-	-	-

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

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

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

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

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.

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

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

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 Edit Account - Gateway Details screen. Refer to the specifications for that screen here.	-	-	-	-	-	-

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	-

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

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