Reporting API

Краткий обзор

API предназначен для получения отчётов по операциям платежей и переводов (A2C), совершаемых через платформу Beepul. Методы поддерживают пагинацию, обеспечивая удобную обработку больших объёмов данных.

API

Взаимодействие происходит в формате JSON в кодировке UTF-8, HTTP Status Code: 200 - для успешных вызовов.

Авторизация

Все запросы должны содержать содержать заголовок X-Api-Key, с ключем авторизации который предоставляется партнеру.

В случае если ключ не указан, сервис будет возвращать следующий ответ:

{
  "message": "No API key found in request"
}

В случае если ключ указан некорректно:

{
  "message": "Invalid authentication credentials"
}

Локализация

Все запросы должны содержать содержать заголовок X-Api-Lang, с ключами поддерживаемых Beepul-ом языков. Ключ uzb/rus

В случае если ключ языка не указан, по умолчанию используется русский язык rus.

Если транзакция должна быть подтверждена OTP кодом, то во всех методах по flow должны передаваться одинаковый ключ языка, в обратном случае будут ошибки с подтверждением OTP.

Оплата

Концептуальная схема

ВНИМАНИЕ! Перед оплатой, аккаунт партнера должен быть настроена на стороне Beepul Business.