Запрос на отмену платежа

Доступно только для платежей в статусе AUTHORIZED.
В случае успеха статус платежа изменится на VOIDED.

Запрос

POST /api/merchant/v1/orders/{orderId}/cancel

Тело запроса:

{
    "reason": string,                   # Причина отмены
    "externalOperationId": string       # Опционально. Идентификатор операции.
}

Ответ

Ответ в случае успеха содержит детали операции отмены:

  • 200 OK c телом:
{
    "status": "success",
    "data": {
        "operation": {
            "operationId": uuid,
            "orderId": string,
            "operationType": "VOID",
            "status": "SUCCESS",
            "externalOperationId": string or null,
            "created": string,
            "updated": string
        }
    }
}

Ответ в случае ошибки:

  • 404 Not Found - Заказ с указанным orderId не найден
  • 400 Bad Request - Некорректный запрос. Тело ответа:
{
    "status": "fail",
    "reasonCode": enum<INVALID_PAYMENT_STATUS|BAD_REQUEST|...>,  # код ошибки
    "reason": string or null  # текстовое описание, например: "Captured payment cannot be cancelled"
}
В этой статье: