API Docs
Версия API
версия 1.0

Быстрый старт

Путь от первого запроса до заказа и колбэков о смене его состояния. Каждый запрос проходит аутентификацию: клиентский сертификат и HMAC-подпись.

Шаг 1. Счёт мерчанта

Номер счёта для заказа берётся из списка счетов.

Шаг 2. Коды из справочников

Поле заказа Справочник
country Страны
method Методы оплаты
type Типы платежей
currency Валюты
bank Банки — необязательно, участвует в подборе маршрута

Шаг 3. Создать заказ

Создание заказа создаёт заказ и подбирает для него маршрут платежа.

Ответы:

  • 200 — заказ создан;
  • 400 — тело не распарсилось как JSON или не найден маршрут платежа (detail: payment route not found);
  • 422 — массив ошибок полей: field — путь до поля (account.number), code — правило (REQUIRED, TOO_SMALL, NOT_ALLOWED и другие);
  • 429 — превышен лимит запросов, повторите позже.

Успешные ответы оборачиваются в конверт { data, metadata, request_id }, ошибки — в { error, request_id }. Поле retryable в ошибке говорит, имеет ли смысл повторить запрос без изменений.

Шаг 4. Принять колбэк

При смене состояния заказа на callback_url мерчанта отправляется POST с телом orderStateChanged. Состояния: created, attempting, awaiting, orphaned, review, succeeded, failed.

Ответьте любым 2xx в течение 5 секунд, иначе колбэк будет повторён: до 8 попыток через 30 с, 1, 2, 4, 8, 16, 30 мин.

Одно событие может прийти повторно и не по порядку. Ключ события — order_id + sequence:

  • уже обработанную пару принимайте с 200;
  • событие с sequence меньше полученного не применяйте.

Шаг 5. Проверить заказ

Коды статусов расшифровываются справочником статусов, причины — справочником причин.

Разделы