Method cancel

URL: POST - /partner/hold/cancel

Method allows to cancel the hold.

Header parameters

Parameter	Type	Description
client-id *	authorization	Unique Partner ID
client-secret *	authorization	Unique authentication key for VIA API

Request parameters

Parameter	Type	Description
holdId *	string	Holding request ID

Пример запроса

curl POST '/partner/hold/cancel?holdId=phl_2RW4uL2eTpbCqyUjw9mZEOUgVYY' \
    --header 'client-id: system' \
    --header 'client-secret: system123'

Response parameters

Parameter	Type	Description
holdId	string	Holding request ID
status	string	Holding request execution status The following values are available: «NEW» - New holding request accepted «CREATE_SUCCESS» - Holding successful «CREATE_PENDING» - Holding request is pending «CREATE_ERROR» - Error occurred during holding request «CONFIRM_SUCCESS» - Withdrawal completed successfully «CONFIRM_PENDING» - Withdrawal process pending «CONFIRM_ERROR» - Error during withdrawal «CANCEL_SUCCESS» - Holding cancellation completed successfully «CANCEL_PENDING» - Cancellation process pending «CANCEL_ERROR» - Error while canceling holding «EXPIRED» - Holding period has expired

Example response if successful

{
  "data": {
    "holdId": "phl_2RW4uL2eTpbCqyUjw9mZEOUgVYY",
    "status": "CANCEL_SUCCESS"
  }
}

Example response in case of error

{
    "status": {
        "code": "1234",
        "message": "Error while executing the request"
    },
    "error": {
        "path": "URL Path",
        "message": {
            "uz": "Error message in Uzbek",
            "ru": "Error message in Russian",
            "en": "Error message in English"
        }
    }
}