Skip to content

GET Bank responses

Overview

Returns Bank Response Codes.

HTTP Request

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

Path Parameters

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

Query Parameters

  • Version (string, required, default: v1)

Success Response (200)

Schema: BankResponseGetResponse

Example

{
  "BankResponseGetResponse": [
    {
      "Country": "South Africa",
      "Products": [
        {
          "Product": "ABSADC",
          "BankResponses": [
            {
              "ResponseCode": "09001",
              "ResponseDescription": "MANDATE INITIATION ACB. RECORD-ID INVALID OR NOT NUMERIC"
            }
          ]
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

  • BankResponseGetResponse[].Country (string, maxLength 40)
  • Products[].Product (string, maxLength 10)
  • BankResponses[].ResponseCode (string, maxLength 6)
  • BankResponses[].ResponseDescription (string, maxLength 100)

Error Responses

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