Base URL
All API requests for the staging environment should be sent to:Authentication
The API uses OAuth2 for security.- Generate Token: Call the
POST /oauth/tokenendpoint using Basic Authentication (Client ID and Secret) along with your username and password. - Make Requests: Use the returned
access_tokenas a Bearer token in theAuthorizationheader for all protected endpoints.
Transaction Reference (PCN)
Every transaction is identified by a unique Reference Code (often referred to as PCN). This code is generated by you (the partner) and must be unique for every request. It is used to:- Track the status of a transaction.
- Reconcile payments.
Reference Data
Transaction Types
Use these values for thetransaction_type field.
Transaction Purposes
Use these values for thetransaction_purpose field.
Beneficiary Relationships
Common values forbeneficiaryRelationship: FRIENDS, PARENTS, RELATIVES, SPOUSE, SIBLING, SELF, BUSINESS_PARTNER, etc.
Document Types
Documents required for KYC/Compliance.Response Statuses
The lifecycle status of a transaction.Response Codes
Specific error or success codes returned inmsg_code.
HTTP Status Codes
Client Errors
Server Errors
