OpusPAY

^{User guide}

×

Menu

Index

Search

(c) Company name, 2020

Add Standard Plan

This page allows the user to create a Standard Plan for merchants.

Add Standard Plan

Back

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	-	1. Allows the user to navigate back to the Plans Grid screen without saving the new plan. Refer to the specification for that page here.	-	-	-	-	-	-

Plan Name

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text	-	1. Allows the user to enter the name of a Plan. 2. If user clicks on Save without entering a Plan name, display inline error message. 3. Plan name must be unique. Check Plan name against other plans in the database. If Plan name matches the name of another plan, display inline error message.	Y	-	Y	255	-	2. Please enter the name of Plan. 3. A Plan with this name already exists. Please enter a new Plan name.

Standard / Custom Radio Buttons

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Radio Buttons	Standard Plan means OpusXenta is invoicing the merchant. Custom Plan means Gateway is paying OpusXenta.	1. Allows the user to choose if this is a Standard or Custom Plan.	-	-	Y	-	Standard	-

Merchant Country

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Combo-Box	-	1. Allows the user to select a country that this Plan applies to. 2. The country selected determines which merchants the Plan is available for. If a merchant is not in the country selected, this Plan cannot be linked to the merchant. 3. If user clicks on Save without selecting a Merchant Country, display inline error message.	Y	-	Y	-	-	3. Please select a Country

Currency

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Combo-Box	-	1. Allows the user to select the billing currency for this Plan. Merchants assigned to this plan will be billed in the currency selected. 2. The country selected determines which currency is available for the Plan. Refer to the specification for this screen here. 3. If only one currency is available for the country selected, set this field to the currency by default. 4. If user clicks on Save without selecting a Currency, display inline error message.	Y	-	Y	-	-	4. Please select a Currency

Status

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Combo-Box	If the Plan Status = Active, the Plan can be assigned to merchants. If the Plan Status = Inactive, it cannot be assigned to merchants.	1. Allows the user to set the Status of the Plan to Active or Inactive.	-	-	Y	-	Active	-

Add Row

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	At least one Tier-Level row is required.	1. Allows the user to add Tier-Level volume and rates.	-	-	Y	-	-	-

Quantity From

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Number	-	1. Allows the user to enter the minimum number of transactions required for this Tier-Level. 2. Number only, no decimals. 3. If there is a previous Tier Level row, Quantity From must be greater than the value in the Quantity To from the previous Tier Level row. 4. If user clicks on Save for this Tier-Level without selecting a minimum number of transactions, display inline error message.	Y	-	Y	-	-	4. Please enter a minmum number of transactions for this Tier-Level.

Quantity To

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Number	-	1. Allows the user to enter the maxiumum number of transactions required for this Tier-Level. Number cannot be less than the number entered in the Quantity From field for this same Tier Level row (can be the same number). 2. Number only, no decimals. 3. If user clicks on Save for this Tier-Level without selecting a minimum number of transactions, display inline error message.	Y	-	Y	-	-	3. Please enter a maximum number of transactions for this Tier-Level.

Invoice By

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Combo-Box	Transaction means that invoicing = Rate X number of transactions. Month means invoicing = Rate each month.	1. Allows the user to select what invoicing will be based on. 2. Should be pre-populated with below options: Transaction Month	Y	-	Y	-	Transaction	-

Rate

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Number/Decimal	-	1. Allows the user to enter a Fixed Rate for a Tier Level. 2. Format should allow two decimal places. 3. If user clicks on Save for this Tier-Level without selecting a rate, display inline error message.	Y	-	Y	-	-	3. Please enter a rate for this Tier-Level row.

Tier Level Save

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	-	1. Allows the user to save the Tier Level row of volumes and rates for a Plan. 2. Check the rules mentioned in each input element, starting with Quantity From, Quantity To, and Rate. Show inline error message for the first invalid / unpopulated input the check comes across, stop the check, allow the user to make changes and do not save this new Tier-Level row. 3. If all validation checks are successful, save the Tier-Level row. 4. Change Save button to Edit button.	-	-	Y	-	-	-

Edit

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	-	1. Allows the user to update Tier-level row of volume and rates. 2. When clicked change Edit button to Save button.	-	-	Y	-	-	-

Delete

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	-	1. Allows the user to delete Tier-level row of volume and rates.	-	-	Y	-	-	-

Save

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button	-	1. Check the rules mentioned in each input element, starting with Plan Name, then Merchant Country. Show inline error message for the first invalid / unpopulated input the check comes across, stop the check, allow the user to make changes and do not save this new Plan. 2. If there are no Tier-Level rows, display an inline error message. 3. If all validation checks are successful, save the new Plan. 4. Navigate the user back to the Plans Grid screen. Refer to the specification for that page here.	-	-	Y	-	-	2. Please enter at least one Tier-Level row.

The contents of Add Standard Plan

Plan Summary - Standard - View

Plan Summary - Standard - Edit