GET Mandate statuses

Overview

Returns the mandate statuses used for DebiCheck.

HTTP Request

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

Path Parameters

• merchant_number (string, required)
• product (string, required): The specific product that must be used.

Query Parameters

• Version (string, required, default: v1)

Request Body

None

Success Response (200)

Schema: MandateStatusGetResponse

Example

{
  "MandateStatusGetResponse": [
    {
      "MandateRegisterStatuses": [
        {
          "MandateRegisterStatusCode": "A",
          "MandateRegisterStatusDescription": "Active"
        }
      ],
      "MandateInitiateStatuses": [
        {
          "MandateInitiateStatusCode": "S",
          "MandateInitiateStatusDescription": "APPROVED"
        }
      ],
      "MandateAmendStatuses": [
        {
          "MandateAmendStatusCode": "F",
          "MandateAmendStatusDescription": "NOT APPROVED"
        }
      ],
      "MandateCancelStatuses": [
        {
          "MandateCancelStatusCode": "W",
          "MandateCancelStatusDescription": "PROCESSING"
        }
      ],
      "MandateRFIStatuses": [
        {
          "MandateRFIStatusCode": "A",
          "MandateRFIStatusDescription": "FUTURE"
        }
      ]
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Fields

• MandateRegisterStatuses[].MandateRegisterStatusCode (string, maxLength 1)
• MandateRegisterStatuses[].MandateRegisterStatusDescription (string, maxLength 40)
• MandateInitiateStatuses[].MandateInitiateStatusCode (string, maxLength 1)
• MandateInitiateStatuses[].MandateInitiateStatusDescription (string, maxLength 40)
• MandateAmendStatuses[].MandateAmendStatusCode (string, maxLength 1)
• MandateAmendStatuses[].MandateAmendStatusDescription (string, maxLength 40)
• MandateCancelStatuses[].MandateCancelStatusCode (string, maxLength 1)
• MandateCancelStatuses[].MandateCancelStatusDescription (string, maxLength 40)
• MandateRFIStatuses[].MandateRFIStatusCode (string, maxLength 1)
• MandateRFIStatuses[].MandateRFIStatusDescription (string, maxLength 40)

Error Responses

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