/v1/orders/{order_id}/cancel

Отмена блокировки средств на счете плательщика. Используется только в двухстадийных платежах.

Доступно только для платежей в статусе AUTHORIZED — средства заблокированы на счете плательщика, но не списаны методом /capture.

В случае успеха статус платежа изменится на VOIDED — оплата отменена продавцом до списания средств.

Сравнение /rollback, /refund и /cancel

Подробнее см. в разделе Возврат платежей.

Метод	/rollback	/refund	/cancel
Описание	Прерывание оплаты продавцом путем аннулирования платежной ссылки.	Полный или частичный возврат средств.	Отмена блокировки средств на счете плательщика. Используется только в двухстадийных платежах.
Доступен в статусах	Доступен в любом статусе. Целевое использование — до завершения оплаты, в статусе `PENDING`.	`CAPTURED` — заказ успешно оплачен, средства списаны со счета плательщика. `PARTIALLY_REFUNDED` — совершен частичный возврат средств.	`AUTHORIZED` — средства заблокированы на счете плательщика, но не списаны методом /capture.
Переводит в статус	`FAILED` — оплата не прошла.	`REFUNDED` — совершен полный возврат средств. `PARTIALLY_REFUNDED` — совершен частичный возврат средств. В заказе остались товары.	`VOIDED` — оплата отменена продавцом до списания средств.

Request

POST

https://pay.yandex.ru/api/merchant/v1/orders/{order_id}/cancel

Production

POST

https://sandbox.pay.yandex.ru/api/merchant/v1/orders/{order_id}/cancel

Sandbox

Path parameters

Name

Description

order_id*

Type: string

ID заказа на стороне продавца, который был передан в ответе на /orders.

Max length: 2048

Body

application/json

{
    "externalOperationId": "string",
    "reason": "string"
}

Name

Description

reason*

Type: string

Причина отмены

Max length: 2048

externalOperationId

Type: string

Идентификатор операции

Max length: 2048

Responses

200 OK

Body

application/json

{
    "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": {},
            "pointsAmount": "123.45",
            "reason": "string",
            "status": "PENDING",
            "updated": "2022-12-29T18:02:01Z"
        }
    },
    "status": "success"
}

Name	Description
code	Type: number Default: `200`
data	Type: OperationResponseData
status	Type: string Default: `success` Enum: `success`

OperationResponseData

Name	Description
operation	Type: Operation

Operation

Name	Description
amount*	Type: string<double> Сумма операции в фиатной валюте Example: `123.45`
operationId*	Type: string<uuid> Max length: `2048`
operationType*	Type: string Enum: `AUTHORIZE`, `BIND_CARD`, `REFUND`, `CAPTURE`, `VOID`, `RECURRING`, `PREPAYMENT`, `SUBMIT`
orderId*	Type: string Уникальный идентификатор заказа на стороне продавца. Используется: как ключ идемпотентности; для дальнейшего взаимодействия по заказу и платежу; в сверках. Max length: `2048`
created	Type: string<date-time> Дата и время создания операции (ISO 8601)
externalOperationId	Type: string Идентификатор операции на стороне продавца Max length: `2048`
params	Type: object Дополнительные параметры операции. Список полей отличается в зависимости от типа операции. При возврате сохраняются `motive`, `branchId` и `managerId`, которые вы указали в запросе /refund: `{ "params": { "motive": "Товар не устроил", // причина возврата "branch_id": "42", // идентификатор точки продаж "manager_id": "12345" // идентификатор менеджера } }` При отмене сохраняется `reason`, который вы указали в запросе /cancel: `{ "params": { "cancel_reason": "Покупатель отказался" // причина отмены } }`
pointsAmount	Type: string<double> Сумма операции в баллах Плюса Example: `123.45`
reason	Type: string Причина ошибки Max length: `2048`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Дата и время обновления операции (ISO 8601)

Была ли статья полезна?

/v1/orders/{order_id}

/v1/orders/{order_id}/refund