Skip to content

Maintain Mandate freeze

Overview

Freeze or unfreeze a mandate.

Path

/v1/realpay/{merchant_number}/maintain/mandate_freeze/{product}

Path Parameters

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

Common Query Parameters

  • Version (string, required, default: v1)

PUT Freeze / Unfreeze Mandate

Toggle mandate freeze state. One of (ClientNumber & ContractNumber) OR ContractSequence must be provided plus FreezeUnfreeze flag.

Additional Required Query Parameters (PUT)

  • ClientNumber (string) AND ContractNumber (string) OR ContractSequence (integer)
  • FreezeUnfreeze (string, required): (F)reeze or (U)nfreeze

Success Response (200) Schema (PUT)

FreezeUnfreezePutResponse

Response Example (PUT)

{
  "FreezeUnfreezePutResponse": [
    {
      "Successful": [
        {
          "ContractSequence": 9011154048,
          "ClientNumber": "L00012",
          "ContractNumber": "C1603",
          "FreezeUnfreeze": "F"
        }
      ],
      "Failed": []
    }
  ],
  "APIResponse": {
    "CallSequence": 7271,
    "Status": "SUCCESS",
    "Version": "1.0.0",
    "Name": "INTERNAL NAME OF CALL"
  }
}

Error Responses

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