Обзор
Платёжная платформа Menu — назначение мерчантского API
Документация описывает HTTP API платёжной платформы Menu, предназначенное для интеграции мерчантов.
Назначение
API обеспечивает:
- приём платежей от клиентов мерчанта (Pay In) по картам, СБП, переводам на счёт, через банковскую форму оплаты, моно‑банковские каналы и локальные платёжные рельсы;
- выплаты клиентам мерчанта (Pay Out) на карту, по номеру телефона через СБП или на расчётный счёт;
- размещение платёжной формы платформы для сценариев, в которых мерчант не реализует собственный UI оплаты;
- получение текущего баланса мерчанта и истории операций;
- доставку событий смены статуса операции через webhook.
Базовый URL
Все эндпойнты, описанные в настоящей документации, доступны относительно указанного базового URL.
Формат обмена
- Транспорт: HTTPS.
- Кодировка тела запроса и ответа:
application/json, UTF‑8. - Аутентификация: HTTP‑заголовок
Authorization: Bearer <JWT>. - Числовые суммы: десятичные числа, разделитель — точка, до четырёх знаков после разделителя.
- Даты: ISO‑8601 в UTC.
Структура документации
| Раздел | Содержание |
|---|---|
| Быстрый старт | Последовательность действий для первой успешной операции |
| Аутентификация | Формат, выдача и применение JWT‑токена |
| Host‑to‑host | Эндпойнты Pay In и Pay Out для прямой интеграции |
| Платёжная форма | Эндпойнты создания операций с UI на стороне платформы |
| Операции | Получение операции по идентификатору и список операций |
| Webhooks | Доставка событий смены статуса |
| Баланс | Текущий баланс мерчанта |
| Статусы | Перечень статусов и переходов между ними |
| Методы платежа | Допустимые значения paymentMethod |
| Валюты | Поддерживаемые валюты и мультивалютная схема |
| Справочник банков | Получение перечня банков для Pay Out |
| Ошибки | Структура ответа, коды ошибок и реакция на них |
| Идемпотентность | Поведение при повторных запросах и сетевых сбоях |
| Тестирование | Тестовая среда и контрольный список перед боевым включением |
| История изменений | Изменения, затрагивающие интеграцию |
Область применения документации
Документация распространяется исключительно на мерчантское API (bb-merchantapi). Сервисы, доступные администраторам платформы, провайдерам платежей и внутренней инфраструктуре, в настоящем документе не рассматриваются.