paygine.php¶
В этой статье
Модуль синхронизации заказов Paygine для администраторов: выполнение сверки платежей, обработка реферальных систем и формирование отчетов по биллингам.
Методы API¶
| Метод | Действие | Описание |
|---|---|---|
check | проверка статуса | Проверяет текущий статус заказа и завершает транзакцию, если платеж подтвержден. |
init | инициализация платежа | Инициализирует новый заказ на оплату счета или возобновляет существующий активный заказ. |
sbp_check | проверка SBP | Проверяет статус привязки счета СБП по идентификатору QR-кода. |
sbp_subscribe | подписка SBP | Инициализирует процесс привязки счета СБП для автоматических платежей. |
sync_orders | синхронизация заказов | Синхронизирует заказы по указанным биллингам за определенный период времени. Доступно только администраторам. |
paygine/check¶
Проверяет текущий статус заказа и завершает транзакцию, если платеж подтвержден.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: check |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | integer | Идентификатор счета (invoice id) |
| order_id | ✅ | integer | Идентификатор заказа (order id) |
| billing | ❌ | string | Идентификатор или конфигурация биллинга для обработки платежей и заказов. |
Пример запроса
Пример успешного ответа
paygine/init¶
Инициализирует новый заказ на оплату счета или возобновляет существующий активный заказ.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: init |
| token | ✅ | string | Токен авторизации |
| invoice_id | ✅ | integer | Идентификатор счета для оплаты |
| subscribe | ❌ | boolean | Флаг создания рекуррентного платежа (подписки) |
| billing | ❌ | string | Идентификатор биллинга для обработки платежа и получения настроек. |
Пример запроса
Пример успешного ответа
paygine/sbp_check¶
Проверяет статус привязки счета СБП по идентификатору QR-кода.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: sbp_check |
| token | ✅ | string | Токен авторизации |
| qrc_id | ✅ | string | Идентификатор QR-кода (1-50 символов, alphanumeric). |
| billing | ❌ | string | Идентификатор системы биллинга для обработки платежа. |
Пример запроса
paygine/sbp_subscribe¶
Инициализирует процесс привязки счета СБП для автоматических платежей.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: sbp_subscribe |
| token | ✅ | string | Токен авторизации |
| billing | ❌ | string | Данные для обработки платежной операции через систему биллинга. |
Пример запроса
Пример успешного ответа
paygine/sync_orders¶
Синхронизирует заказы по указанным биллингам за определенный период времени. Доступно только администраторам.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: sync_orders |
| token | ✅ | string | Токен авторизации |
| billing | ❌ | array<string> | Список биллингов для синхронизации. Принимает несколько значений: billing[]=val1&billing[]=val2 |
| days | ❌ | integer | Количество дней для синхронизации заказов. По умолчанию 3. |
Пример запроса