Merchant management
Revio allows platform providers to set up their merchants on the API. This is useful for payment service providers or marketplaces that need full control of new merchant sign-up.
Getting going
The following is required to operate as a platform provider using the Revio API:
- Standard Bank Profile Code and credit limits
- Standard Bank processing account (for real-time settlement)
- PASA Registration as TPPP
- Revio verification and approval
Getting going
To set up a new client (Merchant), the following steps are required:
- Get your client profile (provided by the Revio support team)
- Add merchant profile (requires that the merchant abbreviated name is registered with PASA)
Get Master Merchant profile
Merchant profiles are used to store your specific banking configuration as a platform provider.
Reference | Link |
---|---|
Integration Recipe | /v2/merchantprofile/ |
Documentation | Swagger |
API Reference | Reference |
Content-type : application/json
Authorization : Bearer XXXXXXXXXXXXXXXXXXXXXXXXX
// As generated in Post https://dev-payce.auth.eu-west-1.amazoncognito.com/oauth2/token
From this profile you can create new merchant profiles. The following fields need to be unique:
- Profile Code
- Account Number
- Instruments
- Bank Abbreviated Name
Create merchant profile
Reference | Link |
---|---|
Integration Recipe | /v2/merchantprofile/ |
Documentation | Swagger |
API Reference | Reference |
POST /v2/merchantprofile
// content-type : json
// Example
{
"profileCode" : "TEST1",
"bank" : "STANDARDBANK",
"instruments" : ["EFTONEDAY", "EFTTWODAY", "EFTSAMEDAY", "DEBICHECK"],
"name" : "TEST MERCHANT 1",
"accountNumber" : "12345678",
"branchCode" : "051001",
"abbreviatedName" : "TESTMERCH1",
"contactNumber" : "+27-615333440",
"emailAddress" : "[email protected]",
"currency" : "ZAR",
"entryClass" : "21",
"clientId" : "247"
}
Content-type : application/json
Authorization : Bearer XXXXXXXXXXXXXXXXXXXXXXXXX
Field notes
Field | Type | Description |
---|---|---|
Profile Code | string | From applicable Master merchant profile |
Bank | string | Bank name (STANDARDBANK) |
Name | string | Merchant name registered at bank |
Account Number | string | Account number registered at bank (TPPP clients to be provided with account number) |
Instruments | string[] | An array of collection/payment instruments used by this merchant profile. Accepted values are EFTONEDAY, EFTTWODAY, EFTSAMEDAY and DEBICHECK |
Branch Code | string | Branch code associated with account number |
Abbreviated Name | string | Abbreviated name registered at bank |
Contact Number | string | Phone number of merchant |
Email Address | string | Email Address of merchant |
Currency | string | Only "ZAR" accepted |
Entry Class | string | Only "21" accepted |
Client Id | string | Master merchant Id provided to you by the Revio support team |
After successfully setting up your merchant profile, you are good to go! 🎉
Updated over 1 year ago