/v1/orders/{order_id}/rollback
Прерывание оплаты продавцом путем аннулирования платежной ссылки. Запрещает дальнейшую оплату заказа.
Когда использовать:
- покупатель хочет оплатить другим способом;
- нужна новая ссылка на оплату.
Если заказ успел оплатиться, то метод произведет полный возврат средств. В реестрах такая операция отразится как возврат, но в нем не будет идентификатора операции externalOperationId — вы не сможете получить детали через метод /operations/{external_operation_id}.
Поэтому используйте /rollback только для прерывания оплаты, а /refund — для возврата денег.
Статусы
Метод доступен для платежей в любом статусе. Целевое использование — до завершения оплаты, в статусе PENDING.
В случае успеха статус платежа изменится на FAILED.
Сравнение /rollback, /refund и /cancel
Подробнее см. в разделе Возврат платежей.
|
Метод |
|||
|
Описание |
Прерывание оплаты продавцом путем аннулирования платежной ссылки. |
Полный или частичный возврат средств. |
Отмена блокировки средств на счете плательщика. Используется только в двухстадийных платежах. |
|
Доступен в статусах |
Доступен в любом статусе. Целевое использование — до завершения оплаты, в статусе |
|
|
|
Переводит в статус |
|
|
|
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 ID заказа на стороне продавца, который был передан в ответе на /orders. Max length: |
Responses
200 OK
Body
application/json
{
"code": 200,
"data": {},
"status": "success"
}
|
Name |
Description |
|
code |
Type: number Default: |
|
data |
Type: object |
|
status |
Type: string Default: Enum: |
No longer supported, please use an alternative and newer version.