Call-back уведомления
Общая информация
Beepul Business отправляет callback-уведомления на сервер партнёра и/или мерчанта при наступлении определённых событий, таких как:
- Оплата обычная, с холдированием и при оплате через iFrame: Payments
- Переводы на карту с помощью Account2Card API
- При токенизации карты через iFrame: Cards
Система поддерживает два независимых канала доставки уведомлений:
| Канал | URL | Аутентификация | Настраивается на уровне |
|---|---|---|---|
| Partner API | partnerUrl | Заголовок X-Api-Key | Бизнес |
| Merchant API | endpointUrl | — | Мерчант |
❗️ Каналы работают независимо. Если настроены оба URL, уведомления будут отправлены на оба адреса одновременно. Приоритизации между каналами нет.
Важно: callback pay — это лишь уведомление о том, что операция была зафиксирована на стороне Beepul. Её фактический результат можно проверять через метод GetTransaction по ULID.
Предварительная настройка
Перед тем как использовать callback-уведомления, необходимо:
- Указать callback-URL в панели управления Beepul Business;
- Убедиться, что сервер доступен по HTTPS и корректно принимает запросы
POST; - Проверить, что принимающая система возвращает HTTP 200 OK — это подтверждает успешную обработку уведомления.
❗️ Без настроенного URL callback-уведомления не отправляются.
Уровень бизнеса (Partner API):
| Параметр | Описание |
|---|---|
partnerUrl | URL для отправки коллбэков партнёру |
partnerApiKey | Секретный ключ для аутентификации запросов |
callBackApis | Массив типов событий, на которые нужно получать уведомления |
Уровень мерчанта (Merchant API):
| Параметр | Описание |
|---|---|
endpointUrl | URL для отправки коллбэков мерчанту |
Аутентификация
Для коллбэков на Partner API в запросе передаётся HTTP-заголовок:
X-Api-Key: <Base64 от partnerApiKey>
Для коллбэков на Merchant API заголовок аутентификации не передаётся.
Обработка на стороне партнёра
- Сервер должен вернуть
HTTP 200 OKв течение 3 секунд; - В случае таймаута или ошибки (4xx / 5xx), Beepul может повторить отправку до 5 раз с интервалами.
Для получения подробной информации о транзакции (её статус, результат и т.д.) необходимо вызвать метод GetTransaction, передав полученный ULID.