GET Mandate reason codes

Overview

Returns the mandate reason codes used for DebiCheck. Mandate Reason Codes describe reasons of certain mandate changes.

HTTP Request

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

Path Parameters

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

Query Parameters

• Version (string, required, default: v1)

Request Body

None

Success Response (200)

Schema: MandateReasonGetResponse

Example

{
  "MandateReasonGetResponse": [
    {
      "MandateProduct": "ADCTT1",
      "MandateReasonCodes": [
        {
          "MandateReason": "CEXP",
          "MandateReasonDescription": "Contract Expired",
          "MandateReasonType": "CAN",
          "MandateReasonISOCode": "P"
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• MandateReasonGetResponse[].MandateProduct (string, maxLength 10)
• MandateReasonCodes[].MandateReason (string, maxLength 4)
• MandateReasonCodes[].MandateReasonDescription (string, maxLength 100)
• MandateReasonCodes[].MandateReasonType (string, maxLength 3)
• MandateReasonCodes[].MandateReasonISOCode (string, maxLength 1)

Error Responses

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