Создание счёта в ЕРИП
Требования к API запросам
Запросы на выставление платёжных требований в ЕРИП к API bePaid должны:
- иметь авторизацию типа Basic c ID магазина и секретным ключем магазина как имя пользователя и пароль соответственно;
- иметь заголовки
Content-Type: application/jsonиAccept: application/json.
Запрос на оплату через ЕРИП отправляется в виде JSON-сообщения. В случае принятия запроса системой, возвращается ответ со статусом оплаты pending или permanent.
В случае возникновения ошибки, возвращается статус error и описание ошибки.
Как работает оплата через ЕРИП
После получения от bePaid на ваш запрос ответа со статусом pending или permanent об успешном создании счёта в ЕРИП, bePaid и мы находимся в стадии ожидания подтверждения оплаты от ЕРИП.
Когда оплата проходит и bePaid получает от АИС <<Расчёт>> уведомление об этом, то статус платежа меняется на successful или failed и высылается уведомление об оплате на скрипты вашей IT-системы, а платеж с обновлённым статусом отображается в личном кабинете.
Если оплата началась, но по каким-то причинам не завершилась, платёжное требование находится в статусе start 30 минут и не доступно для повторной оплаты.
По истечении 30 минут, оно автоматически вернется в статус pending и будет снова доступно для оплаты.
Статусы платёжных требований
| Статус | Описание |
pending |
Платежное требование создано успешно. Находимся в ожидании оплаты |
auto_created |
Платёжное требование, созданное при авансовой оплате или при оплате постоянного платежного требования. Находимся в ожидании оплаты |
expired |
Платёжное требование не оплачено и срок оплаты истёк или было созданно новое платёжное требование с тем же номером заказа/счёта или договора. |
permanent |
Постоянно действующее платёжное требование на оплату. По данному счёту можно платить сколько угодно раз. |
successful |
Оплата произведена успешно. |
failed |
Оплата произведена не успешно. |
deleted |
Платёжное поручение удалено торговцем. |
Создать платёжное требование
Отправьте POST запрос на https://api.bepaid.by/beyag/payments со следующими параметрами:
Параметры запроса
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Пример запроса
{
"request": {
"amount": 1000,
"currency": "BYN",
"description": "Оплата заказа #123",
"email": "ivanpetrov@example.com",
"ip": "127.0.0.1",
"order_id": 123456789012,
"tracking_id": "AB8923",
"notification_url": "http://merchant.example.com",
"customer": {
"first_name": "Иван",
"middle_name": "Иванович",
"last_name": "Петров",
"country": "BY",
"city": "Минск",
"zip": "220000",
"address": "ул. Независимости, 1",
"phone": "+375172000000"
},
"payment_method": {
"type": "erip",
"account_number": "123",
"service_no": "99999999",
"service_info": [
"Оплата заказа 123"
],
"receipt": [
"Спасибо за оплату заказа 123"
]
},
"additional_data":{
"receipt_text": ["Первая строка", "Вторая строка"],
"notifications": [
"sms"
]
}
}
}
Пример запроса со счётчиком
{
"request": {
"amount": 1000,
"currency": "BYN",
"description": "Оплата водоснабжения счётчика #123",
"email": "ivanpetrov@example.com",
"ip": "127.0.0.1",
"order_id": 123456789012,
"tracking_id": "AB8923",
"notification_url": "http://merchant.example.com",
"customer": {
"first_name": "Иван",
"middle_name": "Иванович",
"last_name": "Петров",
"country": "BY",
"city": "Минск",
"zip": "220000",
"address": "ул. Независимости, 1",
"phone": "+375172000000"
},
"payment_method": {
"type": "erip",
"account_number": "123",
"service_no": "99999999",
"service_info": [
"Оплата водоснабжения счётчика #123"
],
"receipt": [
"Спасибо за оплату"
],
"erip_devices": [
{
"name":"Холодная вода",
"item_unit":"м3",
"rank":"4",
"value":"1234",
"rate":"0.4392"
}
]
},
"additional_data":{
"receipt_text": ["Первая строка", "Вторая строка"],
"notifications": [
"sms"
]
}
}
}
Параметры ответа
Если платежный запрос принят успешно, ответ будет выдан в виде JSON-сообщения, содержащего status. Такое же сообщение будет отправлено в уведомлении на notification_url после проведения оплаты.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Пример ответа
{
"transaction": {
"type": "payment",
"billing_address": null,
"customer": {
"email": null,
"ip": "127.0.0.1",
"external_id": null
},
"payment": {
"ref_id": null,
"message": "Требование на оплату счета создано.",
"status": "pending",
"gateway_id": 3483
},
"additional_data": {},
"smart_routing_verification": null,
"id": "f8ac0ca3-7dc6-4a1a-8e04-9e643ae80cc4",
"uid": "f8ac0ca3-7dc6-4a1a-8e04-9e643ae80cc4",
"order_id": "633602201673",
"status": "pending",
"message": "Требование на оплату счета создано.",
"amount": 1000,
"currency": "BYN",
"description": "Оплата заказа #123",
"tracking_id": "633602201673",
"created_at": "2026-04-28T09:02:48Z",
"updated_at": "2026-04-28T09:02:48Z",
"settled_at": null,
"psp_settled_at": null,
"registry_id": null,
"paid_at": null,
"manually_corrected_at": null,
"test": true,
"language": "ru",
"version": 0,
"payment_method_type": "erip",
"erip": {
"request_id": null,
"service_no": null,
"account_number": "123",
"transaction_id": null,
"instruction": [
"Платежи -> Магазин -> Оплата"
],
"service_info": [
"Введите номер заказа"
],
"receipt": [
"Спасибо за оплату"
],
"agent_code": null,
"agent_name": null,
"service_no_erip": "12345678",
"qr_code_raw": "MDAwMjAxMDEwMjEyMzIzOTAwMTBieS5yYXNjaGV0MDEwODEyMzQ1Njc4MTAwMzEyMzEyMDIxMjMzMjIwMDE4YnkuZXBvcy5iZUdhdGVUZXN0NTIwNDQ1Njc1MzAzOTMzNTQwNTEwLjAwNTUwMjAyNTgwMkxUNTkwOURlbW9UZXN0czYwMDdWaWxuaXVzNjIxMzAzMDlEZW1vVGVzdHM2NDE5MDAwMnJ1MDEwOURlbW9UZXN0czU2MDUxMC4wMDYzMDQ5QTA4",
"qr_code": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAK0AAACtAQAAAADq1MLuAAADKklEQVR4nO2WMUwTURzG72p67SKJMHhtAn0OwuxUGITExToIMzj0FWJ7HWiiDu0dkXuvhjscxIQO9GrsHYMwKwNlAKKLOIgzOrSvRHoMQGCh95pwkrga/86G//jlly/f9+7e/S/g/2naAeGPcyVfyf+PTAM0o/jI0knFExFEx9ppLi8TXHHvU59AtIfejIh7epe7XhWK/xCwl4i5exMpOoX+pY64k4w628MMYZgONe4vbjN7MqESYRakWXgN8RqXPziyLRKI1i9w8OucETzwp1t+A6KpttAZmkpprS9WuOhAdMaYkFwco+VNLW+Aua1orXl5iMnog/rkOJhEPjKSjWJitWHnhFUE0SeljyNRyfqsdEq2Cnr7c8NufqZci51PowLYUv10SBb87FSIVFqUQPT86h5RfcOfMS0Gn0n+rO+J0iJq1R3lLga9g9fMCK0bTTtO1sEkfH9OSWmyi3lCgN+TWPURkrY65T5xqMrB3G7Trusp4rC6UkkiiC5sSVzGC8zYejq6DCZpqdTM2lqBu4J1gMGW6fFoZT4tIh5sm6B3rbjin5ctNCvx+W6w5WisVF6ejOXcnq4YcSB6TfPN3QL3iNDRjkFvV5ISFVeK3DqYlWSwZTCVvVMNpnTNI0wBvSdCpyxDImZ7QUg/BenQmRtc3DBa+o/wBuy9nut78U0n+Hhd12pwEu/WQW1fcXq+LSazBKKP+zx9J6+eHcVZ1nAgem0qW1pC8nL0UL+714BovKkTcWds2iKhrIkgWmqK/XRgsPCwzCc8MDe9EBL4hnI4OD79Fr7zkWvndwaoriWcTqAH9H74sz91SoSbKBNnOdC70kOvd6W7TyxtrOpgiMav6lRrsaXvr+JRDHqv8PkkKxkvEX+wK4D0I39RrDrNQpBGou/Blr2quZRRbJTIG78X919p0cwQIWmr5PUPG36WNFDYnxnQRM0zOMcQHWsL725/l6QNQ5YkB6I9dMi0FaY9Jk0G753L74+QUdvHzrO5Ftzycuw4peqXy3+fXZAONfx24rkhO0d0GL6XLNws1lwhU5bTTQzS+oXuM4sIWCzr8Aa8kq/k/1T+BXYGg02zYF3wAAAAAElFTkSuQmCC",
"banks": [
{
"name": "Альфа-Банк",
"icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNlZjMxMjQiIHZpZXdCb3g9IjAgMCAxNDAuNTggMjE0LjU2Ij48ZyBkYXRhLW5hbWU9ItCh0LvQvtC5IDIiPjxnIGRhdGEtbmFtZT0i0KHQu9C+0LkgMSI+PHBhdGggZD0iTTEzNy42IDE0NS41N2gtOS4zNWMtNi4wNyAwLTEyLjE1LS4xMi0xOC4yMS4wNi0yLjM4LjA3LTMuMjctLjc1LTMuOTMtMy0yLjM3LTgtNS0xNi03LjQ4LTI0LS42Mi0yLTEuNDgtMi44OC0zLjc4LTIuODZxLTI1LjA4LjE3LTUwLjE2IDBjLTIgMC0zIC41LTMuNzIgMi41OS0yLjcgOC4zNy01LjY0IDE2LjY2LTguNDcgMjUtLjQyIDEuMjMtLjggMi4yMi0yLjQ4IDIuMi04LjU3LS4wOC0xNy4xNCAwLTI1LjcxIDBhNyA3IDAgMCAxLTEuMjQtLjI2YzEuMzQtMy44NyAyLjYxLTcuNjEgMy45My0xMS4zUTI2Ljg2IDc3LjQ5IDQ2Ljc4IDIxYTc4LjY2IDc4LjY2IDAgMCAxIDMuNzktOC45M0M1My45MyA1LjQxIDU5LjI4IDEuMjEgNjYuODEuMzVjNy4zNC0uODQgMTQuNTMtLjQ4IDIwLjQzIDQuODMgMy42MiAzLjI1IDUuNzggNy41IDcuMzEgMTJxMTAuMTcgMjkuOTQgMjAuMTkgNTkuOTIgMTEgMzIuOCAyMiA2NS42MWMuMjYuNzkuNDggMS41OC44NiAyLjg2Wk04OS42OSA5MS4yMSA3MC45NCAzMi4yN2wtLjkyLjA4Yy02LjU3IDE5LjUyLTEzLjE0IDM5LjA1LTE5LjggNTguODZaTTAgMTg1LjkyaDE0MC41OHYyOC42NEgwWiIvPjwvZz48L2c+PC9zdmc+",
"platform_urls": {
"ios": "https://insync.by/pay?sourse=null&type=E_POS&target={serviceId}#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08",
"android": "https://insync.by/pay?sourse=null&type=E_POS&target={serviceId}#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08",
"huaweiapp": "https://insnc.by/?external=qr#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08"
}
},
{
"name": "Приорбанк",
"icon": "data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgNDM5IDIzMCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTI2OC4zMzMgMEgxNDMuMjEzTDAgMjMwSDEyNS4wMThMMjY4LjMzMyAwWiIgZmlsbD0iI0ZGRTAwMCIvPgo8cGF0aCBkPSJNNDM4LjI3OSAwSDMxMy4wNTZMMTY5Ljk0NSAyMzBIMjk0Ljk2M0w0MzguMjc5IDBaIiBmaWxsPSIjRkZFMDAwIi8+Cjwvc3ZnPgo=",
"platform_urls": {
"ios": "https://www.prior.by/web/qrpay#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08",
"android": "https://www.prior.by/web/qrpay#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08",
"huaweiapp": "https://www.prior.by/web/qrpay#00020101021232390010by.raschet010812345678100312312021233220018by.epos.beGateTest520445675303933540510.005502025802LT5909DemoTests6007Vilnius62130309DemoTests64190002ru0109DemoTests560510.0063049A08"
}
}
]
}
}
}
Пример ответа об ошибке
Если случается ошибка, то ответ будет следующего вида:
{
"message": "Unknown 'erip' payment method",
"errors": {
"system": [
"System error."
]
}
}
|
Получение данных о платеже
По uid платежа
Чтобы получить детали платежа по :uid платежа, отправьте GET запрос с авторизационными данными на https://api.bepaid.by/beyag/payments/:uid.
По order_id платежа
Чтобы получить детали платежа по :order_id платежа, отправьте GET запрос с авторизационными данными на https://api.bepaid.by/beyag/payments/?order_id=:order_id.
Удаление по uid платежа
Если по какой-то причине, вам необходимо отменить созданное платёжное требование, то требования в статусах pending или permanent доступны для удаления.
Для сохранения истории и поддержания целостности данных, реального удаления платежа не происходит.
Платеж переходит в статус deleted и не будет больше доступен для оплаты.
Для удаления платёжного требования отправьте DELETE запрос с авторизационными данными на https://api.bepaid.by/beyag/payments/:uid.