cancelPayment method

Description

Cancels a deferred payment.

Address for calling the cancelPayment operation

https://server:port/webservice/mws/api/cancelPayment

Input parameters

Parameter

Type

Description

requestDT

dateTime

Time in the merchant's system when the request to perform the operation was made.

orderId

long

Transaction number of the deferred payment, issued by Yandex.Checkout 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 Yandex.Checkout 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.

Output parameters

The response contains parameters that are shared for all types of financial transaction request.

Examples

Request example
requestDT=2011-07-02T20:38:00.000Z&orderId=12345
Response example
<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