/v1/orders/{order_id}/rollback

Прерывание оплаты продавцом путем аннулирования платежной ссылки. Запрещает дальнейшую оплату заказа.

Когда использовать:

покупатель хочет оплатить другим способом;
нужна новая ссылка на оплату.

Если заказ успел оплатиться, то метод произведет полный возврат средств. В реестрах такая операция отразится как возврат, но в нем не будет идентификатора операции externalOperationId — вы не сможете получить детали через метод /operations/{external_operation_id}.

Поэтому используйте /rollback только для прерывания оплаты, а /refund — для возврата денег.

Статусы

Метод доступен для платежей в любом статусе. Целевое использование — до завершения оплаты, в статусе PENDING.

В случае успеха статус платежа изменится на FAILED.

Ошибки при прерывании платежа

Пример

{
  "status": "fail",
  "reasonCode": "ORDER_NOT_FOUND_ERROR",
  "reason": "",
  "details": {}
}

Name	Description
`status`	Type: string Статус операции прерывания платежа.
`reasonCode`	Type: string Код ошибки. Указывает на конкретную причину ошибки.
`reason`	Type: string \| null Текстовое описание ошибки. Может быть пустой строкой `""` или отсутствовать в ответе.
`details`	Type: object \| null Объект с дополнительными данными об ошибке. Может быть пустым объектом `{}` или отсутствовать в ответе.

Коды ошибок

Возможные значения reasonCode:

ORDER_NOT_FOUND_ERROR — Заказ с указанным идентификатором не найден.

Сравнение /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}/rollback

Production

POST

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

Sandbox

Path parameters

Name

Description

order_id

Type: string

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

Max length: 2048

Example: ``

Responses

200 OK

Body

application/json

{
  "code": 200,
  "data": {},
  "status": "success"
}

Name	Description
code	Type: unknown Default: `200`
data	Type: object Example `{}`
status	Type: string Default: `success` Const: `success`

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

/v1/orders/{order_id}/capture

/v1/orders/{order_id}/submit