OpusPAY
User guide
×
Menu
Index

Plan Summary - Standard - Edit

This page allows the user to Edit a Standard Plan for merchants.
 
Plan Summary - Standard - Edit
1

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 any changes. Refer to the specification for that page here.
-
-
-
-
-
-
2

Plan Name

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Text
-
1. Allows the user to change the name
of the current 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.
 
 
3

Standard / Custom Radio Buttons

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Radio Buttons
-
1. Allows the user to switch Plan Type and specify if this is a Standard or Custom Plan.
 
2. If user switches the Plan from Standard to Custom or Custom to Standard, and a merchant is assigned to this plan any changes to the Tier-Level rows will be applied to the next invoice and will be effective for all transactions not yet invoiced.
 
3. Tier-Level rows will be deleted. Display a popup modal informing user that Tier-Level rows will be deleted. Refer to the specifications for that modal screen here.
 
4. If user clicks on Continue from popup modal screen, delete all Tier-Level rows and switch the transaction table to match the Plan Type selected.
 
5. If user clicks Cancel from popup modal screen, do not change Plan Type and make no other changes.
-
-
Y
-
-
-
4

Merchant Country

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Combo-Box
-
1. If merchants are linked to current Plan, Merchant Country cannot be changed until all merchants have been switched to another Plan. Display inline error message.
 
2. Allows the user to switch the country that this Plan applies to.
 
3. 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.
 
4. If user clicks on Save without selecting a Merchant Country, display inline error message.
Y
-
Y
-
-
1. Cannot switch Merchant Country until all merchants currently attached to this Plan are switched to another Plan.
 
4. Please select a Country.
5

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
6

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.
 
2. If Plan is changed to Inactive, merchants will no longer be able to be assigned to this plan going forward. Existing merchants assigned to this Plan will not be changed and invoicing will continue to apply for the inactive Plan until the merchant is assigned a different Plan.
-
-
Y
-
-
-
7

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

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 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 minmum number of transactions for this Tier-Level.
9

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

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

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

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

Edit

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
If a merchant is assigned to this plan any changes to the Tier-Level row will be applied to the next invoice and will be effective for all transactions not yet invoiced.
1. Allows the user to update Tier-level row of volume and rates.
 
2. When clicked change Edit button to Save button.
-
-
Y
-
-
-
14

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.
 
2. If a merchant is assigned to this plan any changes to the Tier-Level row will be applied to the next invoice and will be effective for all transactions not yet invoiced.
-
-
Y
-
-
-
15

Save

 
Type
Notes
Rules
Compulsory
Format
Edit
Size
Default
Error Message
Button
If there are any merchants who have a greater number of transactions than the maximum number entered in Quantity To field, all transactions will be charged as per Tier-Level row with the highest Quantity To number.
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 Plan. 
 
2. If there are no Tier-Level rows, display an inline error message.
 
3. If all validation checks are successful, save the 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.