GET Payout cancel codes

Overview

Returns the Cancel Codes for Payout Products. Cancel Codes to be used to Cancel Payout Transactions.

HTTP Request

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

Path Parameters

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

Query Parameters

• Version (string, required, default: v1)

Success Response (200)

Schema: CancelCodesGetResponse

Example

{
  "CancelCodesGetResponse": [
    {
      "Product": "ABSAPAY",
      "CancelCode": "A001",
      "CancelDescription": "Cancel Description"
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• CancelCodesGetResponse[].Product (string, maxLength 10)
• CancelCodesGetResponse[].CancelCode (string, maxLength 4)
• CancelCodesGetResponse[].CancelDescription (string, maxLength 50)

Error Responses

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