Уведомления о ЕРИП платежах
Для информирования вашей IT-системы об изменениях статуса платежного требования и об осуществленной оплате bePaid использует механизм уведомлений на адрес, указанный в notification_url
запроса.
Уведомления - это POST-запросы с вашими авторизационными данными и содержащие JSON-сообщения с данными платёжного требования.
Проверяйте авторизационные данные, чтобы убедиться, что запрос пришел от bePaid.
Уведомления приходят в случае изменения статуса операции на pending
, expired
, failed
или successful
.
Параметры сообщения
Параметр | Тип | Описание |
---|---|---|
transaction | object | |
status | string | Статус платежа. |
message | string | Сообщение системы |
type | string | payment |
amount | integer | Сумма платежа в копейках. |
currency | string | Валюта BYN |
description | string | Описание заказа. |
uid | string | uid транзакции. |
id | string | id транзакции. |
order_id | string | Значение order_id из платежного запроса. |
tracking_id | string | Значение tracking_id или order_id из платежного запроса. |
expired_at | string | Дата, до которой действует платёж. Данный параметр отсутствует, если у платежа нет срока действия. Смотрите описание формата в expired_at запроса на оплату. |
paid_at | string | Дата, когда был оплачен платёж. Данный параметр отсутствует, если платеж еще не оплачен. Смотрите описание формата в expired_at запроса на оплату. |
created_at | string | Время создания платёжного требования. |
language | string | Значение параметра language из запроса или en по умолчанию. |
test | boolean | true , если платежный запрос является тестовым. Иначе, false . |
payment_method_type | string | erip |
additional_data | object | Секция, содержащая дополнительную информацию о платеже. |
notifications | array | Типы уведомлений, отправляемых клиентам при создании платежных требований. |
receipt_text | array | Массив строк текста, который будет добавлен в письмо клиенту. |
billing_address | object | Секция информации о покупателе. |
first_name | string | Имя покупателя. |
middle_name | string | Отчество покупателя. |
last_name | string | Фамилия покупателя. |
country | string | Страна покупателя. |
city | string | Город покупателя. |
zip | string | Почтовый индекс или zip-код покупателя. |
address | string | Адрес покупателя. |
phone | string | Телефонный номер покупателя. |
customer | object | Секция информации о покупателе. |
ip | string | IP адрес покупателя. |
string | Электронная почта покупателя. | |
payment | object | Секция оплаты |
ref_id | string | Идентификационный номер транзакции в ЕРИП. |
message | string | Сообщение ЕРИП. |
status | string | Статус операции в ЕРИП. |
gateway_id | string | Идентификатор внутреннего платежного шлюза. |
erip | object | Данные о ЕРИП платеже. |
request_id | integer | Номер запроса в ЕРИП. |
service_no | integer | Код услуги ЕРИП, присвоенный bePaid. |
account_number | string | Номер заказа/услуги/договора, для оплаты через ЕРИП. |
transaction_id | integer | Номер операции в ЕРИП. |
instruction | array | Массив строк информации, которая описывает путь в дереве ЕРИП для нахождения платежного поручения. |
service_info | array | Массив строк информации, которая будет показана плательщику перед подтверждением оплаты через ЕРИП и описывающая за что происходит оплата. |
receipt | array | Массив строк информации, которая будет отображена на чеке-подтверждении оплаты через ЕРИП. |
agent_code | integer | Код платежного агента, принявшего платеж. |
agent_name | string | Имя платежного агента, принявшего платеж. |
service_no_erip | integer | Код услуги, присвоенный ЕРИП. |
qr_code_raw | string | Закодированные в base64 данные для генерации QR-кода. |
qr_code | string | Закодированная в base64 PNG картинка QR-кода. Для отображения QR-кода на сайте нужно вставить значение qr_code в img HTML тэг: <img src="здесь значение qr_code"> . |
Пример уведомления
{
"transaction":{
"status":"pending",
"message":"Требование на оплату счёта создано.",
"type":"payment",
"id":"8759cf84-e56d-44b7-a8ae-62640f6402c4",
"uid":"8759cf84-e56d-44b7-a8ae-62640f6402c4",
"order_id":"100000003495",
"amount":22000,
"currency":"BYR",
"description":"Оплата заказа #123",
"tracking_id":"AB8923",
"created_at":"2015-12-07T14:21:24.420Z",
"expired_at":"2016-12-07T14:21:240Z",
"paid_at":"2016-12-07T14:40:120Z",
"test":true,
"payment_method_type":"erip",
"billing_address":{
"first_name":"Иван",
"middle_name": "Иванович",
"last_name":"Петров",
"country":"BY",
"city":"Минск",
"address":"ул. Независимости, 1",
"zip":"220000",
"phone":"+375172000000"
},
"customer":{
"email":"ivanpetrov@example.com",
"ip":"127.0.0.7"
},
"payment":{
"ref_id":null,
"message":null,
"status":"pending",
"gateway_id":1
},
"erip":{
"request_id":"00000001",
"service_no":99999999,
"account_number":"123",
"transaction_id":"0000001",
"service_info":["Оплата заказа 123"],
"instruction": ["'Расчёт' ЕРИП-> Интернет-магазины/сервисы-> B -> bePaid.by"],
"receipt":["Спасибо за оплату заказа 123"]
}
}
}