Purpose of the document
The purpose of this document is to provide a comprehensive user guide for the Merchant Portal. It outlines the key features and functionalities available within the portal and provides guidance on the activities and tasks that users can perform.
This guide serves as a central reference for understanding and using the Merchant Portal effectively. It is intended for all types of merchants, including Group, Division, and Merchant-level users, with relevant functionalities and access depending on their assigned user roles and permissions.
Navigation of the document
Use the “In this Article” section on the right-hand side to quickly navigate to the relevant section of the user guide. Select a section heading to go directly to the information you need.
1. System portal - Hierarchy structure
This Set Up can be done only by Wpay Admin in System Portal.
Group Merchant
Division Merchant
Company
Example Structure:
2. User roles
a. Group Merchant:
| Term | Description |
Group Merchant Admin |
|
Group Merchant Sub Admin |
Inherits all access rights from Merchant Admin, except Merchant User features (Manage/Add/Edit Merchant User). |
Group Merchant Viewer |
Performs read-only access to the portal. User with this role can have read-only access to all system functionalities except Merchant User feature (Manage/Add/Edit Merchant User). |
b. Division merchant:
Term |
Description |
|---|---|
Division Merchant Admin |
|
Division Merchant Sub Admin |
Inherits all access rights from Merchant Admin, except Merchant User features (Manage/Add/Edit Merchant User). |
Division Merchant Viewer |
Performs read-only access to the portal. User with this role can have read-only access to all system functionalities except Merchant User feature (Manage/Add/Edit Merchant User). |
c. Merchant:
Term |
Description |
|---|---|
Merchant Admin |
|
Merchant Sub Admin |
Inherits all access rights from Merchant Admin, except Merchant User features (Manage/Add/Edit Merchant User). |
Merchant Viewer |
Performs read-only access to the portal. User with this role can have read-only access to all system functionalities except Merchant User feature (Manage/Add/Edit Merchant User). |
3. User access matrix
a. Group Merchant:
Role |
Group Merchant |
Group Merchant |
Group Merchant |
|---|---|---|---|
Home - Quick Links, Daily Transaction snapshot Available | |||
View Home |
✓ |
✓ |
✓ |
All Companies | |||
View Child Companies |
✓ |
✓ |
✓ |
Edit Child Company Details (Except Business Details, Business Configurations & MID Details) |
✓ |
✓ |
✗ |
Update Child Company |
✓ |
✓ |
✗ |
Manage Mobile Users | |||
View Mobile Users |
✓ |
✓ |
✓ |
Edit Mobile User |
✓ |
✓ |
✗ |
Update Mobile User status |
✓ |
✓ |
✗ |
Manage Transactions | |||
View Transactions |
✓ |
✓ |
✓ |
Settings | |||
Change Password |
✓ |
✓ |
✗ |
Administrator | |||
View Merchant Users |
✓ |
✓ |
✓ |
Edit Merchant Users |
✓ |
✓ |
✗ |
Add a Merchant User |
✓ |
✓ |
✗ |
Update Merchant User |
✓ |
✓ |
✗ |
Trigger Password for |
✓ |
✓ |
✗ |
View Audit Trail |
✓ |
✓ |
✓ |
b. Division Merchant:
Role |
Division Merchant |
Division Merchant |
Division Merchant |
|---|---|---|---|
Home - Quick Links, Daily Transaction snapshot Available |
|||
View Home |
✓ |
✓ |
✓ |
All Companies |
|||
View Child Companies |
✓ |
✓ |
✓ |
Edit Child Company Details (Except Business Details, Business Configurations & MID Details) |
✓ |
✓ |
✗ |
Update Child Company Authoriser Status |
✓ |
✓ |
✗ |
Update Child Company |
✓ |
✓ |
✗ |
Manage Mobile Users |
|||
View Mobile Users |
✓ |
✓ |
✓ |
Edit Mobile User |
✓ |
✓ |
✗ |
Update Mobile User status |
✓ |
✓ |
✗ |
Manage Transactions |
|||
View Transactions |
✓ |
✓ |
✓ |
Settings |
|||
Change Password |
✓ |
✓ |
✗ |
Administrator |
|||
View Merchant Users |
✓ |
✓ |
✓ |
Edit Merchant Users |
✓ |
✓ |
✗ |
Add a Merchant User |
✓ |
✓ |
✗ |
Update Merchant User |
✓ |
✓ |
✗ |
Trigger Password for |
✓ |
✓ |
✗ |
View Audit Trail |
✓ |
✓ |
✓ |
c. Merchant:
Role |
Merchant |
Merchant |
Merchant |
|---|---|---|---|
Home - Quick Links, Daily Transaction snapshot Available | |||
View Home |
✓ |
✓ |
✓ |
Manage Mobile Users | |||
View Mobile Users |
✓ |
✓ |
✓ |
Edit Mobile User |
✓ |
✓ |
✗ |
Update Mobile User status |
✓ |
✓ |
✗ |
Manage Transactions | |||
View Transactions |
✓ |
✓ |
✓ |
Settings | |||
Change Password |
✓ |
✓ |
✗ |
Administrator | |||
View Merchant Users |
✓ |
✓ |
✓ |
Edit Merchant Users |
✓ |
✓ |
✗ |
Add a Merchant User |
✓ |
✓ |
✗ |
View Audit Trail |
✓ |
✓ |
✓ |
Update Tipping Settings |
✓ |
✓ |
✗ |
Update Surcharge Settings |
✓ |
✓ |
✗ |
4. Activation page
After submitting the details for Group Merchant/ Division merchant/ Merchant details in system portal, Users will receive an email with below details:
User id
Activation code(Validity default to 30 mins)
Link to set the password and login to Merchant portal
Click on the link and reset the password to login to Merchant portal
Rules - Reset Password
S:No |
Rule |
|---|---|
1 |
Only 1 Group Merchant admin/Division Merchant admin/Merchant admin user role per system for each access levels. |
2 |
Error will be displayed, if it doesn't match any of the below:
|
5. Login page
Merchant Portal Login page served as the entry point to Merchant Portal via web browser. It is used to manage user authentication and authorization. User’s use the Merchant user’s registered email address and Merchant user’s registered password.
Rules - Login Page
S:No |
Rule |
|---|---|
1 |
If entered User ID and/or Password is wrong, “Invalid User ID and/or Password” will be displayed. |
2 |
If User has entered wrong User ID and/or Password, User is allowed to retry. |
3 |
Account gets suspended after 4 failed attempts |
4 |
User password validity is N days. MPOS system will force reset password if there is no reset password request within N days where N is configurable. Default is 90 days. |
5 |
If user has an active reset password request, user is not allowed to login with existing password. “Please reset your account password” will be displayed. |
6 |
If user’s account is suspended, user is not allowed to login into merchant portal. “Your account is suspended” will be displayed. |
6. Forgot password
Upon clicking Forgot password on Login page, it redirects user to Forgot Password pop out.
User |
Description |
|---|---|
Group Merchant |
|
Division Merchant |
|
Merchant |
|
7. Homepage
“Home” will display an overview for daily transaction snapshot and quick links for all modules by per Role Type – E.g. Group Merchant Admin, Division Admin and Merchant Admin.
Merchant |
Homepage Details |
|---|---|
Group Merchant/ Division Merchant/ Merchant |
|
8. All companies
“All Companies” is used to view all child companies, and navigate to the merchant details page to view and edit the details.
View Merchant Summary:
• Group Merchant level access can view Division Merchants and Merchants
• Division Merchant level access can view Merchants
Merchants |
|
|---|---|
Group Merchant |
Division Merchant Summary:
a. View Details → Go: It will take to the Division Merchant details page b. Suspend Division Access → Go: It will take to Suspend Division Access page. “Suspend Division Access” will only be displayed in quick link if Division’s status is “Active”. c. If selected quick link is “Reinstate Division Access”, clicking “Go” will navigate to Reinstate Division Access page. “Reinstate Division Access” will only be displayed in quick link if Division status is “Suspended”.
Merchants Summary:
a. View Details → Go: It will take to the Merchant details page b. View Mobile Users → Go: It will take to the list of mobile users associated with the merchant c. View Transactions → Go: It will navigate to transaction page. d. Suspend Merchant Access → Go: It will take to Suspend Merchant page. “Suspend Merchant Access” will only be displayed in quick link if merchant's status is “Active”. e. If selected quick link is “Reinstate Merchant Access”, clicking “Go” will navigate to Reinstate Merchant Access page. “Reinstate Merchant Access” will only be displayed in quick link if merchant status is “Suspended”.
|
Division Merchant |
Merchants Summary:
a. View Details → Go: It will take to the Merchant details page b. View Mobile Users → Go: It will take to the list of mobile users associated with the merchant c. View Transactions → Go: It will navigate to transaction page. d. Suspend Merchant Access → Go: It will take to Suspend Merchant page. “Suspend Merchant Access” will only be displayed in quick link if merchant's status is “Active”. e. If selected quick link is “Reinstate Merchant Access”, clicking “Go” will navigate to Reinstate Merchant Access page. “Reinstate Merchant Access” will only be displayed in quick link if merchant status is “Suspended”.
|
Merchant |
Merchant users will not have the “All Company“ section |
Merchant Details Page
This page is going to display details of that Merchant, all the companies linked to that Merchant and with few other options like Reset password, Suspend Division access, Suspend Authoriser, View mobile user, View Transactions.
Merchants |
|
|---|---|
Group Merchant |
Division Merchant Details:
Merchant Details:
Status History: Division Merchant details page → Status History → Will provide the Status history of that Division Merchant Switch Company:
|
Division Merchant |
Merchant Details:
Switch Company:
|
Merchant |
Merchant users will not have the “All Company“ section |
Edit Merchant Details
Merchants |
Based on the User Roles & User Access Matrix, Merchants will be able to Edit the Child Company details |
|---|---|
Group Merchant |
Edit Division Merchant Details:
Edit Merchant Details:
|
Division Merchant |
Edit Merchant Details:
|
Merchant |
Merchant users will not have the “All Company“ section |
9. Manage mobile user
“Manage Mobile Users” is used to manage all registered mobile users.
Mobile User Summary Page:
| Merchants | |
Group Merchants, Division Merchant & Merchant |
a. View Details → Go: It will take to the Division Merchant details page b. View Transactions → Go: It will take to the Transaction summary page c. Suspend Mobile User Access → Go: It will take to Suspend Mobile User Access page. “Suspend Mobile User Access” will only be displayed in quick link if Mobile User status is “Active”. d. If selected quick link is “Reinstate Mobile User Access”, clicking “Go” will navigate to Reinstate Mobile User Access page. “Reinstate Mobile User Access” will only be displayed in quick link if Mobile User status is “Suspended”
|
Mobile User details page:
This page is going to display details of that Mobile User, and other options like View Company details, Suspend Mobile User access, View Transactions.
Merchant |
|
|---|---|
Group Merchants, Division Merchants & Merchants |
|
Group Merchants, Division Merchants |
When Merchant clicks “View Company Details“ on Mobile User details page, it will take to Linked company details page |
Edit Mobile User Details
Merchant |
Based on the User Roles & User Access Matrix, Merchants will be able to Edit the Mobile user details |
|---|---|
Group Merchant, Division Merchant, Merchants |
Edit Mobile User Details:
|
10. Manage transactions
This section will cover how users can view and manage transactions
Transaction Summary Page:
Merchants |
|
|---|---|
Group Merchant/ Division Merchant/ Merchant |
|
View Transaction Details Page:
Merchants |
|
|---|---|
Group Merchant/ Division Merchant/ Merchant |
|
11. Settings
Change Password
Merchant |
|
|---|---|
Group Merchant/ Division Merchant/ Merchant |
|
12. Administrator
Manage Merchant Users
Merchants |
|
|---|---|
Group Merchant/ Division Merchant/Merchant |
|
Merchant User Details Page
Merchants |
|
|---|---|
Group Merchant, Division Merchant, Merchant |
|
Edit Merchant User Details
Merchant |
Based on the User Roles & User Access Matrix, Merchants will be able to edit the details |
|---|---|
Group Merchant, Division Merchant, Merchant |
|
Add a Merchant User
Merchant |
|
|---|---|
Group Merchant, Division Merchant, Merchant |
|
Audit Trial
Merchants |
|
|---|---|
Group Merchant, Division Merchant, Merchant |
|