YooMoney API
Old versions of the API
Help
Sign up for YooMoney
cancelPayment method
 
Description
Cancels a deferred payment.
Request
Address for calling the operation
https://shop.yookassa.ru/webservice/mws/api/cancelPayment
Request parameters
ParameterTypeDescription
requestDTdateTimeTime in the merchant’s system when the request to perform the operation was made.
orderIdlongTransaction number of the deferred payment, issued by YooMoney in the invoiceId parameter.
ym_merchant_receipt
string
Data for creating the receipt in the JSON format (as in payment form).
The parameter is transmitted and deemed mandatory in the following cases:
  • you set up interaction with your online sales register via YooMoney and transmit details for creating the receipt in the payment form;
  • the receipt was not transmitted on the authorization stage for the operation being cancelled.
Request example
requestDT=2011-07-02T20:38:00.000Z&orderId=12345
Response
The response contains parameters that are shared for all types of financial transaction request.
Example of the response
XML
<cancelPaymentResponse
         orderId="12345"
         status="0" error="0"
         processedDT="2011-07-02T20:38:01.000Z"
         />
See also
Scenario for deferred payments Rules for processing requests Error codes Data types