/v1/orders/{order_id}/cancel
Запрос на отмену платежа.
Доступно только для платежей в статусе AUTHORIZED.
В случае успеха статус платежа изменится на VOIDED.
Request
POST
https://pay.yandex.ru/api/merchant/v1/orders/{order_id}/cancel
https://sandbox.pay.yandex.ru/api/merchant/v1/orders/{order_id}/cancel
Production
Sandbox
Path parameters
|
Name |
Type |
Description |
|
order_id* |
string |
ID заказа на стороне продавца, который был передан в ответе на /order/create. |
Body
{
"externalOperationId": "string",
"reason": "string"
}
|
Name |
Type |
Description |
|
externalOperationId |
string |
Идентификатор операции |
|
reason* |
string |
Причина отмены |
Responses
200 OK
Body
{
"code": 200,
"data": {
"operation": {
"amount": "123.45",
"created": "2022-12-29T18:02:01Z",
"externalOperationId": "string",
"operationId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"operationType": "AUTHORIZE",
"orderId": "string",
"params": {},
"reason": "string",
"status": "PENDING",
"updated": "2022-12-29T18:02:01Z"
}
},
"status": "success"
}
|
Name |
Type |
Description |
|
code |
number |
Default: |
|
data |
||
|
status |
string |
Enum: |
OperationResponseData
|
Name |
Type |
Description |
|
operation |
Operation
|
Name |
Type |
Description |
|
amount* |
string<double> |
Сумма операции |
|
created |
string<date-time> |
Дата и время создания операции (ISO 8601) |
|
externalOperationId |
string |
Идентификатор операции на стороне продавца |
|
operationId* |
string<uuid> |
|
|
operationType* |
string |
Enum: |
|
orderId* |
string |
|
|
params |
object |
|
|
reason |
string |
Причина ошибки |
|
status |
string |
Enum: |
|
updated |
string<date-time> |
Дата и время обновления операции (ISO 8601) |