Endpoints

List receiving accounts

Lists the merchant's receiving (settlement) accounts. Account numbers are masked to the last 4 digits. inuse = true marks an account referenced by an active payment route, so such an account cannot be deleted.

GET
/v1/merchants/{merchantId}/receiving-accounts

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

{
  "merchantid": 0,
  "accounts": [
    {
      "id": 0,
      "bankname": "string",
      "accountname": "string",
      "accountnumber": "string",
      "branchcode": "string",
      "accounttype": "string",
      "inuse": true,
      "bankcode": "string"
    }
  ]
}
{
  "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