Payment cancellation notification (cancelOrder)

Description

The notification about the canceled order is sent to the merchant. Used for payment with funds the user is requesting a loan for (paymentType=KV).

An order may be canceled only before the money has been transferred to the merchant's address.

Note. 

If the user couldn't get a loan to pay for the item, the store gets a Payment cancellation notification (cancelOrder). The order won't be paid, and the hold on the item can be removed.

Method name

cancelOrder

Address for receiving request

checkURL — The URL in the merchant's system. Stored on Yandex.Checkout. You can set it during activation. The order verification (checkOrder) request is also sent to this URL.

Input parameters

The parameters for this request mostly overlap with the parameters for the order verification request. The table lists the parameters that are specific to the cancelOrder request.

Parameter

Type

Description

action

xs:normalizedString, maximum 16 characters

Request type, value: cancelOrder.

Note. 

Requests may contain parameters not covered in this document. The merchant should ignore them.

Response parameters

The parameters for the merchant's response to this request are the same as the parameters for the response to the Order verification request.

Request processing result codes

Code

Value

Description

0

Successful

The merchant successfully received the notification. This value should be passed even if the Yandex.Checkout request was received a second time.

1

Authorization error

The md5 parameter does not match the result of calculating the hash function. Fatal error.

200

Request parsing error

The merchant is not able to parse the request. Fatal error.

Examples

Request example
POST /path_to_checkOrder HTTP/1.1 
Host: someshop.ru 
Content-Type: application/x-www-form-urlencoded
Request parameters

requestDatetime

2011-05-04T20:38:00.000+04:00

action

cancelOrder

md5

45125C95A20A7F25B63D58EA304AFED2

invoiceId

1234567

customerNumber

8123294469

orderCreatedDatetime

2011-05-04T20:38:00.000+04:00

Response example for successful processing
<cancelOrderResponse performedDatetime="2011-05-04T20:38:11.000+04:00" code="0" invoiceId="1234567" shopId="13"/>