Endpoints
Add a receiving account
Adds a receiving account to the merchant. The bank must match the merchant's currency. The response echoes the account with its number masked to the last 4 digits.
Supported banks for receiving accounts (distinct from the payment-routing banks in GET /v1/banks):
| Bank | BankCode |
|---|---|
| Absa | absa |
| African Bank | africanbank |
| Bidvest Bank | bidvestbank |
| Capitec | capitec |
| FNB | fnb |
| Nedbank | nedbank |
| Standard Bank | standardbank |
| TymeBank | tymebank |
| Investec Bank | investec |
| Discovery Bank | discovery |
| Old Mutual | oldmutual |
| Rand Merchant Bank | rmb |
| Access Bank | accessbank |
Authorization
bearerAuth AuthorizationBearer <token>
A partner API token issued to a Master Account. Send Authorization: Bearer <token> on every request. Tokens are issued and revoked by a SuperAdmin in the backoffice, not through this API.
In: header
Path Parameters
merchantId*integer
The merchant id. Must belong to the calling master, or the request is 404.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
{
"id": 0,
"bankname": "string",
"accountname": "string",
"accountnumber": "string",
"branchcode": "string",
"accounttype": "string",
"inuse": true,
"bankcode": "string"
}{
"error": {
"code": "validation_failed",
"message": "MINIMUM_EFT_AMOUNT must be numeric.",
"requestid": "8f3c1a9b2d7e4f60"
}
}{
"error": {
"code": "unauthorized",
"message": "A valid bearer token is required.",
"requestid": "8f3c1a9b2d7e4f60"
}
}{
"error": {
"code": "not_found",
"message": "Merchant not found.",
"requestid": "8f3c1a9b2d7e4f60"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the period indicated.",
"requestid": "8f3c1a9b2d7e4f60"
}
}