Link Поиск Меню Развернуть Документ

Отмена заказа

Для отмены заказа до момента его полной оплаты, необходимо вызвать следующий метод API:

  • метод: DELETE
  • ресурс: /v3/billing/api/order/order/:uuid - где :uuid это идентификатор заказа
  • тело запроса - отсутствует
  • тело ответа - объект OrderResponse со статусом status = canceled

Пример запроса:

🌐 HTTP

DELETE /v3/billing/api/order/order/c5041a79-24a6-42d1-b0ce-4abb94982cd9
Accept: application/json
User-Agent: MyApp 1.0
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e

🧊 CURL

curl -L -X DELETE '{baseUrl}/v3/billing/api/order/order/c5041a79-24a6-42d1-b0ce-4abb94982cd9' \
  -H 'Accept: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -H 'Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e'

{baseUrl} - базовый URL

В зависимости от сценария использования и настроек магазина, может быть применена разная логика при вызове метода. По умолчанию, отменить заказ возможно только до момента получения системой Инвойсбокс информации об отгрузке по заказу (информация о факте оказания услуги или поставки товара). После получения информации об отгрузке системой Инвойсбокс, для отмены заказа и возврата средств, пожалуйста, воспользуйтесь методом оформления возврата.

В случае, если оплата заказа подтверждена с использованием гарантийных платёжных инструментов (Обещанный платёж, Гарантийный фонд, Овердрафт и т.д.) и у заказа нет информации об успешной отгрузке, отмена заказа инициирует полный возврат гарантийного платежа плательщику. Гарантийный платёж и его отмена не будут отражены в реестрах и финансовых отчётах магазина.

Сценарий отмены заказа без невозможности оказания услуги

Пример использования метода отмены заказа для осуществления отмены гарантийного платежа в случае невозможности оказать услугу или поставить товар покупателю. Например, при получении информации об оплате заказа произошла ошибка оформления купленного билета или на складке не оказалось выбранного товара.

sequenceDiagram autonumber participant Покупатель participant Магазин participant Инвойсбокс rect rgb(204, 245, 204) Покупатель->>Магазин: Создает заказ Магазин->>Инвойсбокс: Вызов метода создания заказа Инвойсбокс->>Магазин: Идентификатор заказа и ссылка на оплату Магазин->>Покупатель: Перенаправление на платёжную страницу Покупатель-->>Инвойсбокс: Взаимодействие с платёжной страницей, получение счёта Покупатель->>Инвойсбокс: Оплата счёта через предавторизацию средств на карте или гарантийный фонд Инвойсбокс->>Покупатель: Перенаправление покупателя на сайт магазина Инвойсбокс->>Магазин: Уведомление об успешной оплате Магазин->>Инвойсбокс: Ошибка оказания услуги/поставки товара, status = shipping_unavailable Магазин->>Инвойсбокс: Вызов метода отмены заказа Инвойсбокс->>Покупатель: Возврат оплаченных средств end
  1. Покупатель оформляет заказ на сайте Магазина и выбирает способ оплаты через систему «Инвойсбокс».
  2. Магазин создает в системе «Инвойсбокс» заказ через метод API.
  3. Система возвращает ссылку на платёжную страницу для оплаты заказа.
  4. Магазин перенаправляет покупателя по полученной ссылке.
  5. Покупатель заполняет необходимые для оплаты сведения и получет счёт для оплаты.
  6. Покупатель оплачивает счёт, система Инвойсбокс предавторизует сумму оплаты на карте плательщика или гарантийном фонде.
  7. Система «Инвойсбокс» перенаправляет покупателя обратно на сайт Магазина.
  8. Система «Инвойсбокс» оповещает Магазин об успешной оплате заказа.
  9. Магазин отвечает системе «Инвойсбокс» на уведомление ошибкой оказания услуги/поставки товара, возвращая статус shipping_unavailable
  10. Магазин вызывает в системе «Инвойсбокс» метод отмены заказа.
  11. Если в заказе имеется статус shipping_unavailable и предавторизованный платёж, система «Инвойсбокс» отменяет оплату и заказ, возвращает средства плательщику. Если в заказе иной статус - возвращается ошибка.

Читать далее »