GET Banks

Overview

Returns the Bank and Branch Codes used per country, per product.

HTTP Request

GET /v1/realpay/{merchant_number}/general/banks/{product}

Path Parameters

• merchant_number (string, required)
• product (string, required)

Query Parameters

• Version (string, required, default: v1)

Success Response (200)

Schema: BanksGetResponse

Example

{
  "BanksGetResponse": [
    {
      "Country": "South Africa",
      "Products": [
        {
          "Product": "ABSADC",
          "Banks": [
            {
              "BankCode": 4,
              "BankName": "ABSA South Africa",
              "Branches": [
                {
                  "BranchCode": 250655,
                  "BranchName": "ABSA South Africa"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• BanksGetResponse[].Country (string, maxLength 40)
• Products[].Product (string, maxLength 10)
• Banks[].BankCode (integer, maxLength 2)
• Banks[].BankName (string, maxLength 40)
• Branches[].BranchCode (integer, maxLength 6)
• Branches[].BranchName (string, maxLength 40)

Error Responses

• 400 BadRequest
• 401 Unauthorized
• 404 NotFound
• 500 InternalError
• 503 ServiceUnavailable