Дана інструкція створена для розробників ПЗ, які бажають підключити банківський POS-термінал із застосунком AirCheck від Checkbox для прийому оплат та видачі фіскальних чеків.
¶ Основні можливості ПЗ AirCheck від Checkbox
- універсальне API для прийому оплат або проведення повернень через POS-термінал від будь-якого банку
- відображення фіскального чека для покупця на екрані POS-терміналу
- друк фіскального чека для покупця з POS-терміналу
ПЗ AirCheck від Checkbox - не створює фіскальні чеки автоматично!
Програма лише приймає оплату від покупця і повертає дані про банківську транзакцію до фронт-системи, яка в свою чергу має створити фіскальний чек методами API.
¶ Вимоги до розробників front-систем
ПЗ AirCheck від Checkbox - не створює фіскальні чеки автоматично!
Програма лише приймає оплату від покупця і повертає дані про банківську транзакцію до фронт-системи, яка в свою чергу має створити фіскальний чек методами API.
Відповідно у front-системі має бути реалізовані інтерфейси:
- підключення ПРРО (авторизаційні методи для взаємодії з ПРРО)
- підключення POS-терміналу із ПЗ AirCheck (введення
hostтаportданих терміналу)
Користувач front-системи під час створення фіскальних чеків та прийому оплат від покупця має чітко розуміти, який термінал він використовує, та у разі наявних помилок - бачити відповідні описи.
¶ Локальне підключення до POS-терміналу
Для того, щоб мати можливість викликати термінальне ПЗ для проведення транзакції спочатку необхідно відкрити WebSocket та встановити з’єднання. URL за яким необхідно підключатися можна побачити у застосунку в режимі AirCheck на POS-терміналі.
Якщо потрібно підключатися до POS-терміналу з інших пристроїв, але обидва пристрої знаходяться в одній мережі - потрібно використовувати для підключення URL формату:
wss://192.168.**.**:9021/{path\_url}
¶ Отримання списку доступних девайсів
Для виклику запиту на список доступних девайсів від серверу треба використовувати запит:
ws://192.168.\**.\**:9021/api/devices
¶ Request URL
ws://192.168.0.141:9021/api/devices
¶ Request body
Тіло запиту у даному випадку має бути порожнім
¶ Response body
[
{
"id": "test4e08db460c66", //<str - id пристрою>
"name": "Android Checkbox Paylink", //<str - “AirCheck Checkbox”>
"type": "PAX", //<str - вендор пристрою>,
"model": "A910S" //<str - модель пристрою>
}
]
¶
¶ Створення чеків
¶ Запит на прийом оплати
Для виклику запиту на проведення оплати по терміналу треба відкрити сокет по URL:
ws://192.168.\**.\**:9021/api/pos/{device\_id}/purchase
¶ Request URL
ws://192.168.0.141:9021/api/pos/test4e08db460c66/purchase
¶ Request body
{
"amount": "100" //<int - сума для проведення транзакції>
}
¶ Response body
{
"terminal_id": "test33b1-3c50-4061-8a02-30a406b21852",
"request_id": "",
"operation_type": "purchase",
"success": true,
"code": 0,
"result": {
"terminal_id": "CHECKBO2",
"terminal": "CHECKBO2",
"merchant_id": "40907785",
"pan": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"card_mask": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"rrn": "000019643368",
"auth_code": "181690",
"invoice_num": 23,
"receipt_no": "23",
"owner_name": "40907785",
"issuer_name": "VISA",
"payment_system": "VISA",
"amount": 100
}
}
¶
¶ Запит на скасування (повернення) оплати
Для виклику запиту на проведення оплати по терміналу треба відкрити сокет по URL:
ws://192.168.\**.\**:9021/api/pos/{device\_id}/cancel
¶ Request URL
ws://192.168.0.141:9021/api/pos/test4e08db460c66/cancel
¶ Request body
{
"amount": "100", //<int - сума для проведення транзакції>
"rrn": "000019643368" //<str - RRN транзакції за якою роблять повернення>
}
¶ Response body
У відповідь після проведення транзакції ви отримаєте:
{
"terminal_id": "test33b1-3c50-4061-8a02-30a406b21852",
"request_id": "",
"operation_type": "сancel",
"success": true,
"code": 0,
"result": {
"terminal_id": "CHECKBO2",
"terminal": "CHECKBO2",
"merchant_id": "40907785",
"pan": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"card_mask": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"rrn": "289562463760",
"auth_code": "181690",
"invoice_num": 24,
"receipt_no": "24",
"owner_name": "40907785",
"issuer_name": "VISA",
"payment\\_system": "VISA",
"amount": 100,
}
}
¶
¶ Закриття банківської зміни
Також, в кінці зміни, ви можете відправити запит на закриття банківської зміни:
ws://192.168.\**.\**:9021/api/pos/{device\_id}/settlement
¶ Request body
Тіло запиту у даному випадку має бути порожнім
¶ Response body
У відповідь ви отримаєте 200 OK та побачите як на терміналі
закривається банківська зміна
¶
¶ Процес взаємодії фронт-системи з AirCheck через API Checkbox:
¶ Авторизація касиром стандартними методами
Щоб розпочати взаємодію з фрон-системою, авторизуйтесь касиром у терміналі та перейдіть у режим AirCheck.
Детальна інформація про "Касира".
¶ Запит для авторизації
Запит /api/v1/cashier/signin призначений для знаходження необхідного терміналу.
POST /api/v1/cashier/signin
¶ Request body
{
"login": "test_testqt9d1",
"password": "test_testqt9d1"
}
curl -X 'POST' \
'https://api.checkbox.ua/api/v1/cashier/signin' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"login": "test_testqt9d1",
"password": "test_testqt9d1"
}'
¶ Response body
{
"type": "bearer",
"token_type": "bearer",
"access_token": "teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA"
}
¶ Запит для пошуку необхідного терміналу
Запит /api/v1/paylink/terminals призначений для знаходження необхідного терміналу.
GET /api/v1/paylink/terminals
¶ Request headers
{
"Authorization": "Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA"
}
curl -X 'GET' \
'https://api.checkbox.ua/api/v1/paylink/terminals?limit=25&offset=0' \
-H 'accept: application/json' \
-H 'Authorization: Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA'
¶ Request body
Тіло запиту у даному випадку має бути порожнім.
¶ Response body
{
"meta": {
"limit": 25,
"offset": 0
},
"results": [
{
"id": "test2384-3648-4053-8a5f-9f6d62664746",
"device_id": "test4e08db460c66",
"label": "Android Checkbox Paylink PAX A910S",
"last_client_online_at": null,
"last_server_online_at": null,
"created_at": "2025-09-03T08:05:13.450Z",
"updated_at": "2025-09-03T08:05:13.450Z",
"online": {
"server": false,
"client": false
}
}
]
}
¶
¶ Запит для отримання переліку доступних пРРО
Запит /api/v1/paylink/terminals призначений для знаходження необхідного терміналу.
GET /api/v1/cash-registers
¶ Request headers
{
"Authorization": "Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA"
}
curl -X 'GET' \
'https://api.checkbox.ua/api/v1/cash-registers?limit=25&offset=0' \
-H 'accept: application/json' \
-H 'Authorization: Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA'
¶ Request body
Тіло запиту у даному випадку має бути порожнім.
¶ Response body
{
"meta": {
"limit": 25,
"offset": 0
},
"results": [
{
"id": "test963f-6da9-4a1f-a26d-f5c5a935b31a",
"fiscal_number": "TEST830077",
"active": true,
"created_at": "2025-08-25T12:42:19+00:00",
"updated_at": "2026-01-29T22:47:03+00:00",
"number": "1",
"is_test": true,
"shift": null,
"offline_mode": false,
"stay_offline": false,
"branch": null,
"address": "УКРАЇНА, М.КИЇВ ГОЛОСІЇВСЬКИЙ Р-Н, Тестова, 41а",
"type": 0
}
}
]
}
¶
¶ Запит для авторизації клієнта
Метод /api/v1/paylink/auth/client дозволяє виконати авторизицію клієнта.
POST /api/v1/paylink/auth/client
¶ Request headers
{
"Authorization": "Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA"
}
¶ Request body
{
"id": "test2384-3648-4053-8a5f-9f6d62664746",
"cash_register_id": "test963f-6da9-4a1f-a26d-f5c5a935b31a"
}
curl -X 'POST' \
'https://api.checkbox.ua/api/v1/paylink/auth/client' \
-H 'accept: application/json' \
-H 'Authorization: Bearer teSTbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQVBJIiwianRpIjoiZjYyMjQwZmYtMjE1Ni00NjM5LTg1OWMtYzc3YmVkZmMyN2UxIiwic3ViIjoiNTBlNzdmOGEtNjQzOC00ZjhmLWFiMTktOTViOTFlNjdkZjE3IiwibmJmIjoxNzY5MTcxNDExLCJpYXQiOjE3NjkxNzE0MTF9.10HigTbyLYuGTa7eJ_n_P2tFfoiTXNEyKGqrIZW4HGA' \
-H 'Content-Type: application/json' \
-d '{
"id": "test2384-3648-4053-8a5f-9f6d62664746",
"cash_register_id": "test963f-6da9-4a1f-a26d-f5c5a935b31a"
}'
¶ Response body
{
"token": "testbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjkxNzI1NzgsIm1vZGUiOiJjbGllbnQiLCJuYmYiOjE3NjkxNzI1NzgsInN1YiI6IjIwOWYyMzg0LTM2NDgtNDA1My04YTVmLTlmNmQ2MjY2NDc0NiJ9.em4c_aTiYltkKNeEoniHPw2tveM61Z3EzV8VHR9SvNY",
"terminal": {
"id": "test2384-3648-4053-8a5f-9f6d62664746",
"device_id": "test4e08db460c66",
"label": "Android Checkbox Paylink PAX A910S",
"last_client_online_at": null,
"last_server_online_at": null,
"created_at": "2025-09-03T08:51:33.916Z",
"updated_at": "2025-09-03T08:51:33.916Z",
"online": {
"server": false,
"client": false
}
}
}
¶
¶ Запит для підключення до WebSocket
Підключення до WebSocket за URL із використанням токена термінала:
wss://api.checkbox.ua/paylink/api/v1/proxy
¶ Query Params
{
"token": "testbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjkxNzI1NzgsIm1vZGUiOiJjbGllbnQiLCJuYmYiOjE3NjkxNzI1NzgsInN1YiI6IjIwOWYyMzg0LTM2NDgtNDA1My04YTVmLTlmNmQ2MjY2NDc0NiJ9.em4c_aTiYltkKNeEoniHPw2tveM61Z3EzV8VHR9SvNY",
"cash_register_id": "test963f-6da9-4a1f-a26d-f5c5a935b31a"
}
¶ Створення чеків у відкритому WebSoket
¶ Запит на прийом оплати
Для виклику запиту на проведення оплати по терміналу треба відправити Message у раніше відкритий WebSoket:
¶ Message
{
"operation_type": "purchase",
"terminal_id": "test2384-3648-4053-8a5f-9f6d62664746",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e21ce", // <генерація та передача UUID чека на стороні інтеграції є обовʼязковою>
"payload":{
"amount": 10000
}
}
¶ Response body
У відповідь після проведення операції на терміналі ви отримаєте:
{
"terminal_id": "test2384-3648-4053-8a5f-9f6d62664746",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e21ce",
"operation_type": "purchase",
"success": true,
"code": 0,
"result": {
"terminal_id": "CHECKBO2",
"terminal": "CHECKBO2",
"merchant_id": "40907785",
"pan": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"card_mask": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"rrn": "289562463760",
"auth_code": "289562",
"invoice_num": 43,
"receipt_no": "43",
"owner_name": "40907785",
"issuer_name": "VISA",
"payment_system": "VISA",
"amount": 10000
}
}
¶
¶ Запит на скасування (повернення) оплати
Для виклику повернення оплати по терміналу треба відправити Message у раніше відкритий WebSoket:
¶ Message
{
"operation_type": "cancel",
"terminal_id": "test2384-3648-4053-8a5f-9f6d62664746",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e22ce", // <генерація та передача UUID чека на стороні інтеграції є обовʼязковою>
"payload":{
"amount": 10000,
"invoiceNum": 43,
"rrn": "289562463760",
"auth_code": "289562"
}
}
¶ Response body
У відповідь після проведення операції на терміналі ви отримаєте:
{
"terminal_id": "test2384-3648-4053-8a5f-9f6d62664746",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e22ce",
"operation_type": "сancel",
"success": true,
"code": 0,
"result": {
"terminal_id": "CHECKBO2",
"terminal": "CHECKBO2",
"merchant_id": "40907785",
"pan": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"card_mask": "4428\\*\\*\\*\\*\\*\\*\\*\\*6646",
"rrn": "533424019813",
"auth_code": "181696",
"invoice_num": 44,
"receipt_no": "44",
"owner_name": "40907785",
"issuer_name": "VISA",
"payment\\_system": "VISA",
"amount": 10000,
}
}
¶
¶ Закриття банківської зміни
Також, в кінці зміни, ви відправляєте Message у раніше відкритий WebSoket на закриття банківської зміни:
¶ Message
{
"operation_type": "settlement",
"terminal_id": "test2384-3648-4053-8a5f-9f6d62664746"
}
¶ Response body
У відповідь ви отримаєте 200 OK та побачите як на терміналі
закривається банківська зміна
¶
¶ Процес взаємодії https://my.checkbox.ua/ з AirCheck:
¶ Запит реєстрації "отримання токену та ID-терміналу"
POST /paylink/processing/auth/client
¶ Request body
{
"terminalId": "666d4dce-dff3-45c9-9c68-fa11310btest"
}
¶ Response body
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NzAxMTIzNjgsIm1vZGUiOiJjbGllbnQiLCJuYmYiOjE3NzAxMTIzNjgsInN1YiI6IjY2NmQ0ZGNlLWRmZjMtNDVjOS05YzY4LWZhMTEzMTBiYmMxZCJ9.uQ8Fr-20ocTu1dZAF1FCHPmLe4Sv_nUt47V6H1NpgAE",
"terminal": {
"id": "666d4dce-dff3-45c9-9c68-fa11310btest",
"device_id": "ead1496bc6fb74ab",
"label": "Android Checkbox Paylink Google Pixel 4 XL",
"organization_id": "caf9162f-a4ee-48d9-8065-be2db9d5test",
"created_at": "2026-01-26T12:23:08.612336Z",
"updated_at": "2026-01-27T10:06:20.446225Z",
"last_server_connect_at": "2026-01-27T12:11:10.91823Z",
"last_client_connect_at": "2026-02-03T09:51:32.869387Z",
"online": {
"server": false,
"client": false,
"connected_clients": 0
}
}
}
¶
¶ Запит для підключення до WebSocket
Підключення до WebSocket за URL із використанням токена та ID термінала:
wss://api.checkbox.ua/paylink/api/v1/proxy
¶ Request body
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NzAxMTIzNjgsIm1vZGUiOiJjbGllbnQiLCJuYmYiOjE3NzAxMTIzNjgsInN1YiI6IjY2NmQ0ZGNlLWRmZjMtNDVjOS05YzY4LWZhMTEzMTBiYmMxZCJ9.uQ8Fr-20ocTu1dZAF1FCHPmLe4Sv_nUt47V6H1NpgAE",
"cash_register_id": "7e15963f-6da9-4a1f-a26d-f5c5a935b31a"
}
Після встановлення з'єднання через WebSocket за вказаною адресою, відбувається обмін даними відповідно до протоколу, що використовується в AirCheck.
¶
¶ Протокол використання AirCheck:
¶ Запит на підключення/відключення терміналу
Підключення терміналу:
{
"sender": "proxy",
"event": "connected",
"message": "Термінал підключено"
}
Відключення терміналу:
{
"sender": "proxy",
"event": "disconnected",
"message": "Термінал відключено"
}
¶ Запити оплати
Запит на оплату:
{
"operation_type": "purchase",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e21ce",
"payload":{
"amount": 10000
}
}
Результат оплати:
{
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"request_id": "1bca4a89-fc23-4505-ae94-bea1be28ee71",
"operation_type": "purchase",
"success": true,
"code": 0,
"result":{
"terminal_id": "ACDCSSI1",
"terminal": "ACDCSSI1",
"merchant_id": "ACDCSSI10000000",
"pan": "989898******0074",
"card_mask": "989898******0074",
"rrn": "944409183203",
"currency": "",
"auth_code": "988378",
"receipt_no": "000100",
"owner_name": "TEST CARD",
"payment_system": "PROSTIR",
"amount": 10000,
"bank_name": "АТ Універсал банк"
}
}
¶ Запити чеку
Відображення чеку:
{
"operation_type": "display-receipt",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"payload":{
"receipt": "================================\n ТЕСТОВИЙ ЗВІТ \n================================\n ФОП Тестовий \n УКРАЇНА, М.КИЇВ ГОЛОСІЇВСЬКИЙ \n Р-Н, Тестова, 41а \n ІД 3727207473 \n X-звіт №10 \n Номер каси 1 \n за 16.06.2025 \n================================\nЗміна відкрита\n 16.06.2025 12:02:40\nОстанній фіскальний чек -\nВалюта звіту ГРН\n---------- Реалізація ----------\n Одержано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---------- Повернення ----------\n Видано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---- Готівкові кошти в касі ----\nПочатковий залишок 990.00\nСлужбове внесення 0.00\nСлужбове вилучення 0.00\nКінцевий залишок 990.00\n----------- Виручка ------------\nВсього 0.00\n================================\nФН ПРРО TEST005445\nТЕСТОВИЙ ДОКУМЕНТ CHECKBOX\n\n 16.06.2025 14:59:58 \n================================\n ТЕСТОВИЙ ЗВІТ \n================================"
}
}
Друк чеку:
{
"operation_type": "print-receipt",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"payload":{
"receipt": "================================\n ТЕСТОВИЙ ЧЕК\n================================\n ФОП Тестовий \n М.КИЇВ ГОЛОСІЇВСЬКИЙ Р-Н, \n Тестова, 41а\n ІД 3727207473\n================================\n1.000 x 100.00\nКод УКТЗЕД: 0000009999\nШтрих-код: 00009999\nТовар №9999 -100.00 Є\n--------------------------------\nБанк Райффайзен Банк\nТранзакція № 62\nЕквайр 7777798\nТермінал S0130027\nПовернення\nЕПЗ 989898**********\nПЛАТІЖНА СИСТЕМА TEST CARD\nКОД АВТ. 349424\nRRN 516109000063\nБезготівкова -100.00 ГРН\nСУМА -100.00 ГРН\nБез ПДВ Є\n\n================================\n Чек № TEST-ceUBei\n10.06.2025 09-52-58\n ОНЛАЙН\nФН ПРРО TEST005445\n ТЕСТОВИЙ ЧЕК\n CHECKBOX\n================================\n ТЕСТОВИЙ ЧЕК\n================================",
"qr_url":"https://cabinet.tax.gov.ua/cashregs/check?id=TEST-ceUBei&date=20250610&time=09%3A52%3A58&fn=TEST005445&sm=100.00&mac=f2171e38df672fd330d5d0be15f907224eb84ff049468cef729cf07d52882099"
}
}
¶ Запити повернення
Запит на повернення:
{
"operation_type": "cancel",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e21ce",
"payload":{
"amount": 10000,
"invoiceNum": 1,
"rrn": "944409183203",
"auth_code": "988378"
}
}
Результат оплати (повернення):
{
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"request_id": "2a47bc6c-d799-42a4-ad95-1df2d77e21ce",
"operation_type": "cancel",
"success": true,
"code": 0,
"result":{
"terminal_id": "ACDCSSI1",
"terminal": "ACDCSSI1",
"merchant_id": "ACDCSSI10000000",
"pan": "989898******0074",
"card_mask": "989898******0074",
"rrn": "944409183203",
"auth_code": "988378",
"invoice_num": 1,
"receipt_no": "000100",
"owner_name": "TEST CARD",
"issuer_name": "PROSTIR",
"payment_system": "PROSTIR",
"amount": 10000
}
}
¶ Запити звіту
Відображення звіту:
{
"operation_type": "display-receipt",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"payload":{
"receipt": "================================\n ТЕСТОВИЙ ЗВІТ \n================================\n ФОП Тестовий \n УКРАЇНА, М.КИЇВ ГОЛОСІЇВСЬКИЙ \n Р-Н, Тестова, 41а \n ІД 3727207473 \n X-звіт №10 \n Номер каси 1 \n за 16.06.2025 \n================================\nЗміна відкрита\n 16.06.2025 12:02:40\nОстанній фіскальний чек -\nВалюта звіту ГРН\n---------- Реалізація ----------\n Одержано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---------- Повернення ----------\n Видано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---- Готівкові кошти в касі ----\nПочатковий залишок 990.00\nСлужбове внесення 0.00\nСлужбове вилучення 0.00\nКінцевий залишок 990.00\n----------- Виручка ------------\nВсього 0.00\n================================\nФН ПРРО TEST005445\nТЕСТОВИЙ ДОКУМЕНТ CHECKBOX\n\n 16.06.2025 14:59:58 \n================================\n ТЕСТОВИЙ ЗВІТ \n================================"
}
}
Друк звіту:
{
"operation_type": "print-receipt",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2",
"payload":{
"receipt": "================================\n ТЕСТОВИЙ ЗВІТ \n================================\n ФОП Тестовий \n УКРАЇНА, М.КИЇВ ГОЛОСІЇВСЬКИЙ \n Р-Н, Тестова, 41а \n ІД 3727207473 \n X-звіт №10 \n Номер каси 1 \n за 16.06.2025 \n================================\nЗміна відкрита\n 16.06.2025 12:02:40\nОстанній фіскальний чек -\nВалюта звіту ГРН\n---------- Реалізація ----------\n Одержано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---------- Повернення ----------\n Видано по формах оплати \nЗагальний оборот 0.00\nКількість чеків 0\n---- Готівкові кошти в касі ----\nПочатковий залишок 990.00\nСлужбове внесення 0.00\nСлужбове вилучення 0.00\nКінцевий залишок 990.00\n----------- Виручка ------------\nВсього 0.00\n================================\nФН ПРРО TEST005445\nТЕСТОВИЙ ДОКУМЕНТ CHECKBOX\n\n 16.06.2025 14:59:58 \n================================\n ТЕСТОВИЙ ЗВІТ \n================================"
}
}
¶ Запит закриття зміни
Закриття зміни:
{
"operation_type": "settlement",
"terminal_id": "164e34d0-9a61-4967-bb0d-95f82bb31ef2"
}
Якщо у Вас виникли питання, Ви знайшли помилку або хочете запропонувати вказати додаткову інформацію в інструкціях - Ви завжди можете зв'язатись з нами зручним для вас способом.