Endpoints

List processing banks

Active processing banks for the merchant's currency, for building payment routing. AbsaPay is included only when the currency is ZAR and the merchant's ABSAPAY_ENABLE setting is on.

GET
/v1/merchants/{merchantId}/banks

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.

Response Body

application/json

application/json

application/json

application/json

{
  "banks": [
    {
      "bankcode": "absa",
      "bankname": "ABSA",
      "currency": "ZAR"
    },
    {
      "bankcode": "fnb",
      "bankname": "FNB",
      "currency": "ZAR"
    }
  ]
}
{
  "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"
  }
}

On this page