Платежи

POST /payments/{payment_id}/cancel

Changed on

Отмена платежа

Request

  • Base URL
    https://api.yookassa.ru/v3
  • Auth
    HTTP basic

Path parameters

payment_idstring required

Headers

Idempotence-Keystring required

Response

The request has succeeded.

idstring required
status'pending' | 'waiting_for_capture' | 'succeeded' | 'canceled' required
descriptionstring
captured_atstring date-time

Время подтверждения платежа.

created_atstring date-time required

Время создания заказа.

expires_atstring date-time

Время, до которого вы можете бесплатно отменить или подтвердить платеж.

testboolean required

Признак тестовой операции.

paidboolean required

Признак оплаты заказа.

refundableboolean required

Возможность провести возврат по API.

receipt_registration'pending' | 'succeeded' | 'canceled'
metadataMetadata

Любые дополнительные данные, которые нужны вам для работы (например, номер заказа). Передаются в виде набора пар «ключ-значение» и возвращаются в ответе от ЮKassa. Ограничения: максимум 16 ключей, имя ключа не больше 32 символов, значение ключа не больше 512 символов, тип данных — строка в формате UTF-8.

merchant_customer_idstring
invoice_detailsstring

Данные о счете, который оплачивается.

Changes

    • breaking

      the ///// response property's maxLength was unset from 50 for the response status

    • breaking

      the //// response property's maxLength was unset from 128 for the response status

    • breaking

      the response property's maxLength was unset from 36 for the response status

    • breaking

      the //// response property's maxLength was unset from 200 for the response status

    • breaking

      the // response property's maxLength was unset from 128 for the response status

    • breaking

      the ///// response property's minLength was decreased from 36 to 0 for the response status

    • breaking

      the response property's minLength was decreased from 36 to 0 for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the /////// response's property type changed from string to no type for status

    • breaking

      the /////// response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id Payments_cancel was added

    • info

      for the path request parameter payment_id, the minLength was decreased from 36 to 0

    • info

      removed the pattern [0-9a-zA-Z+-_.]{1,64} from the header request parameter Idempotence-Key

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

    • info

      added to the /////// response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      removed subschema #2 subschema #3 from the // response property allOf list for the response status

    • info

      removed subschema #2 subschema #3 from the // response property allOf list for the response status

    • info

      added to the response property anyOf list for the response status

    • info

      added to the response property anyOf list for the response status

    • info

      removed discriminator from response property for the response status

    • info

      removed discriminator from ////// response property for the response status

    • info

      removed discriminator from response property for the response status

    • info

      removed the AMD enum value from the ///// response property for the response status

    • info

      removed the AMD enum value from the ///// response property for the response status

    • info

      removed the AMD enum value from the ///// response property for the response status

    • info

      removed the AMD enum value from the /////// response property for the response status

    • info

      removed the AMD enum value from the /////// response property for the response status

    • info

      removed the AZN enum value from the ///// response property for the response status

    • info

      removed the AZN enum value from the ///// response property for the response status

    • info

      removed the AZN enum value from the ///// response property for the response status

    • info

      removed the AZN enum value from the /////// response property for the response status

    • info

      removed the AZN enum value from the /////// response property for the response status

    • info

      removed the BYN enum value from the ///// response property for the response status

    • info

      removed the BYN enum value from the ///// response property for the response status

    • info

      removed the BYN enum value from the ///// response property for the response status

    • info

      removed the BYN enum value from the /////// response property for the response status

    • info

      removed the BYN enum value from the /////// response property for the response status

    • info

      removed the EUR enum value from the ///// response property for the response status

    • info

      removed the EUR enum value from the ///// response property for the response status

    • info

      removed the EUR enum value from the ///// response property for the response status

    • info

      removed the EUR enum value from the /////// response property for the response status

    • info

      removed the EUR enum value from the /////// response property for the response status

    • info

      removed the INR enum value from the ///// response property for the response status

    • info

      removed the INR enum value from the ///// response property for the response status

    • info

      removed the INR enum value from the ///// response property for the response status

    • info

      removed the INR enum value from the /////// response property for the response status

    • info

      removed the INR enum value from the /////// response property for the response status

    • info

      removed the KZT enum value from the ///// response property for the response status

    • info

      removed the KZT enum value from the ///// response property for the response status

    • info

      removed the KZT enum value from the ///// response property for the response status

    • info

      removed the KZT enum value from the /////// response property for the response status

    • info

      removed the KZT enum value from the /////// response property for the response status

    • info

      removed the MDL enum value from the ///// response property for the response status

    • info

      removed the MDL enum value from the ///// response property for the response status

    • info

      removed the MDL enum value from the ///// response property for the response status

    • info

      removed the MDL enum value from the /////// response property for the response status

    • info

      removed the MDL enum value from the /////// response property for the response status

    • info

      removed the RUB enum value from the ///// response property for the response status

    • info

      removed the RUB enum value from the ///// response property for the response status

    • info

      removed the RUB enum value from the ///// response property for the response status

    • info

      removed the RUB enum value from the /////// response property for the response status

    • info

      removed the RUB enum value from the /////// response property for the response status

    • info

      removed the TRY enum value from the ///// response property for the response status

    • info

      removed the TRY enum value from the ///// response property for the response status

    • info

      removed the TRY enum value from the ///// response property for the response status

    • info

      removed the TRY enum value from the /////// response property for the response status

    • info

      removed the TRY enum value from the /////// response property for the response status

    • info

      removed the UAH enum value from the ///// response property for the response status

    • info

      removed the UAH enum value from the ///// response property for the response status

    • info

      removed the UAH enum value from the ///// response property for the response status

    • info

      removed the UAH enum value from the /////// response property for the response status

    • info

      removed the UAH enum value from the /////// response property for the response status

    • info

      removed the USD enum value from the ///// response property for the response status

    • info

      removed the USD enum value from the ///// response property for the response status

    • info

      removed the USD enum value from the ///// response property for the response status

    • info

      removed the USD enum value from the /////// response property for the response status

    • info

      removed the USD enum value from the /////// response property for the response status

    • info

      removed the UZS enum value from the ///// response property for the response status

    • info

      removed the UZS enum value from the ///// response property for the response status

    • info

      removed the UZS enum value from the ///// response property for the response status

    • info

      removed the UZS enum value from the /////// response property for the response status

    • info

      removed the UZS enum value from the /////// response property for the response status

    • info

      removed the canceled enum value from the response property for the response status

    • info

      removed the canceled enum value from the // response property for the response status

    • info

      removed the error enum value from the //// response property for the response status

    • info

      removed the error enum value from the //// response property for the response status

    • info

      removed the error enum value from the //// response property for the response status

    • info

      removed the error enum value from the //// response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the pending enum value from the // response property for the response status

    • info

      removed the succeeded enum value from the response property for the response status

    • info

      removed the succeeded enum value from the // response property for the response status

    • info

      removed the waiting_for_capture enum value from the response property for the response status

    • info

      removed the waiting_for_capture enum value from the // response property for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the ////// response property oneOf list for the response status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status