Sign in
Платежи

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

post/payments/{payment_id}/cancel

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

Changed in 1 of the 5 revisions of this API.263111

  • fe24d3dfadad263111See the full diff
    • ▲

      the deal/allOf[PaymentDealInfo]/id response property's maxLength was unset from 50 for the response status 200

      response-property-max-length-unset

    • ▲

      the description/allOf[Description]/ response property's maxLength was unset from 128 for the response status 200

      response-property-max-length-unset

    • ▲

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

      response-property-max-length-unset

    • ▲

      the merchant_customer_id/allOf[MerchantCustomerId]/ response property's maxLength was unset from 200 for the response status 200

      response-property-max-length-unset

    • ▲

      the transfers/items/description response property's maxLength was unset from 128 for the response status 200

      response-property-max-length-unset

    • ▲

      the deal/allOf[PaymentDealInfo]/id response property's minLength was decreased from 36 to 0 for the response status 200

      response-property-min-length-decreased

    • ▲

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

      response-property-min-length-decreased

    • ▲

      the amount/allOf[MonetaryAmount]/currency response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the authorization_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the cancellation_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the deal/allOf[PaymentDealInfo]/id response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the deal/allOf[PaymentDealInfo]/settlements/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the id response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the income_amount/allOf[MonetaryAmount]/currency response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the invoice_details response's property type/format changed from object/ to string/ for status 200

      response-property-type-changed

    • ▲

      the recipient response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the refunded_amount/allOf[MonetaryAmount]/currency response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

      the transfers/items/amount/allOf[MonetaryAmount]/currency response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the transfers/items/status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property authorization_details/three_d_secure from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property cancellation_details/party from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property cancellation_details/reason from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property recipient/account_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property recipient/gateway_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property authorization_details/auth_code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property authorization_details/rrn from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoice_details/id from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id Payments_cancel was added

      api-operation-id-added

    • ○

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

      request-parameter-min-length-decreased

    • ○

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

      request-parameter-pattern-removed

    • ○

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

      response-body-all-of-removed

    • ○

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

      response-body-all-of-removed

    • ○

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

      response-body-all-of-removed

    • ○

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

      response-body-all-of-removed

    • ○

      added AuthorizationDetails to the authorization_details response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added CurrencyCode to the amount/allOf[MonetaryAmount]/currency response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added CurrencyCode to the income_amount/allOf[MonetaryAmount]/currency response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added CurrencyCode to the refunded_amount/allOf[MonetaryAmount]/currency response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added CurrencyCode to the transfers/items/amount/allOf[MonetaryAmount]/currency response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added CurrencyCode to the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added DealId to the deal/allOf[PaymentDealInfo]/id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added PaymentCancellationDetails to the cancellation_details response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added PaymentId to the id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added PaymentStatus to the status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added Recipient to the recipient response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added TransferStatus to the transfers/items/status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

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

      response-property-all-of-removed

    • ○

      removed subschema #2 from the transfers/items/account_id response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed subschema #2 subschema #3 from the transfers/items/amount response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      removed subschema #2 subschema #3 from the transfers/items/platform_fee_amount response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      added ConfirmationRedirect ConfirmationExternal ConfirmationQr ConfirmationEmbedded ConfirmationMobileApplication to the confirmation response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added PaymentMethodBankCard PaymentMethodCash PaymentMethodQiwi PaymentMethodAlfabank PaymentMethodWebmoney PaymentMethodSberbank PaymentMethodTinkoffBank PaymentMethodYooMoney PaymentMethodApplePay PaymentMethodGooglePay PaymentMethodMobileBalance PaymentMethodInstallments PaymentMethodB2bSberbank PaymentMethodWeChat PaymentMethodSbp PaymentMethodSberLoan PaymentMethodElectronicCertificate PaymentMethodSberBnpl to the payment_method response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed discriminator from confirmation response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed discriminator from deal/allOf[PaymentDealInfo]/settlements/items/ response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed discriminator from payment_method response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed the AMD enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AMD enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AMD enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AMD enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AMD enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the AZN enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the BYN enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the EUR enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the INR enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the KZT enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the MDL enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the RUB enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the TRY enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UAH enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the USD enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the income_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the refunded_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the transfers/items/amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the UZS enum value from the transfers/items/platform_fee_amount/allOf[MonetaryAmount]/currency response property for the response status 200

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

      removed the canceled enum value from the transfers/items/status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the error enum value from the allOf[Error]/type response property for the response status 400

      response-property-enum-value-removed

    • ○

      removed the error enum value from the allOf[Error]/type response property for the response status 401

      response-property-enum-value-removed

    • ○

      removed the error enum value from the allOf[Error]/type response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the error enum value from the allOf[Error]/type response property for the response status 500

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

      removed the pending enum value from the transfers/items/status response property for the response status 200

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

      removed the succeeded enum value from the transfers/items/status response property for the response status 200

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

      removed the waiting_for_capture enum value from the transfers/items/status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed ConfirmationRedirect ConfirmationExternal ConfirmationQr ConfirmationEmbedded ConfirmationMobileApplication from the confirmation response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PaymentMethodBankCard PaymentMethodCash PaymentMethodQiwi PaymentMethodAlfabank PaymentMethodWebmoney PaymentMethodSberbank PaymentMethodTinkoffBank PaymentMethodYooMoney PaymentMethodApplePay PaymentMethodGooglePay PaymentMethodMobileBalance PaymentMethodInstallments PaymentMethodB2bSberbank PaymentMethodWeChat PaymentMethodSbp PaymentMethodSberLoan PaymentMethodElectronicCertificate PaymentMethodSberBnpl from the payment_method response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed SettlementPayoutPayment from the deal/allOf[PaymentDealInfo]/settlements/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      added the required property deal/allOf[PaymentDealInfo]/settlements/items/amount to the response with the 200 status

      response-required-property-added

    • ○

      added the required property deal/allOf[PaymentDealInfo]/settlements/items/type to the response with the 200 status

      response-required-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog