Інструкція з фіскалізації транзакцій (EasyPay + Checkbox: відмінності між версіями

Матеріал з apidocs
Перейти до: навігація, пошук
Рядок 123: Рядок 123:
<!-- 6.2 Обʼєкт receipt -->
<!-- 6.2 Обʼєкт receipt -->
<table style="width:100%; border-collapse:collapse; border-spacing:0;">
<table style="width:100%; border-collapse:collapse; border-spacing:0;">
  <thead>
     <tr style="border-bottom:1px solid #e6e6e6;">
     <tr style="border-bottom:1px solid #e6e6e6;">
       <th style="text-align:left; padding:12px 16px;">Поле</th>
       <th style="text-align:left; padding:12px 16px;">Поле</th>
Рядок 130: Рядок 129:
       <th style="text-align:left; padding:12px 16px;">Опис</th>
       <th style="text-align:left; padding:12px 16px;">Опис</th>
     </tr>
     </tr>
  </thead>
  <tbody>
     <tr style="border-bottom:1px solid #efefef;">
     <tr style="border-bottom:1px solid #efefef;">
       <td style="padding:16px;">goods</td>
       <td style="padding:16px;">goods</td>
Рядок 144: Рядок 141:
       <td style="padding:16px;">Інформація про оплату</td>
       <td style="padding:16px;">Інформація про оплату</td>
     </tr>
     </tr>
  </tbody>
</table>
</table>

Версія за 09:08, 20 січня 2026

1. Попередні умови


Для фіскалізації транзакцій мерчант повинен:

  • Бути зареєстрованим у сервісі Checkbox: https://checkbox.ua
  • Мати в Checkbox:
    • зареєстровану касу
    • створеного касира


2. Дані, які потрібно надати EasyPay


Після реєстрації в Checkbox необхідно надіслати менеджеру EasyPay на email:

Ключ ліцензії каси (licenseKey)


PIN-код касира

serviceKey, з якого будуть фіскалізуватися транзакції

⚠️ Без передачі цих даних фіскалізація працювати не буде.

3. Робота зі змінами


  • Зміна відкривається автоматично разом із першою фіскалізованою транзакцією за день
  • Зміна автоматично закривається о 23:45


4. Загальна схема роботи


  1. Мерчант створює замовлення (createOrder) з параметрами фіскалізації
  2. EasyPay ініціює фіскалізацію в сервісі Checkbox
  3. Checkbox формує фіскальний чек
  4. Статус фіскалізації та URL чека:
    • надсилаються в callback, або
    • доступні через метод fiscalization/check
  5. У разі повернення коштів використовується метод CancelOrder


5. Створення платежу з фіскалізацією


Для фіскалізації транзакції в методі:

POST /api/merchant/createOrder

потрібно передати обʼєкт fiscalization.

5.1. Приклад запиту createOrder


{
"order": {
"serviceKey": "MERCHANT-TEST-XXXX",
"orderId": "Fiscalization29",
"description": "Test for fiscalization",
"amount": 3,
"isOneTimePay": false,
"additionalItems": {
"Merchant.UrlNotify": "http://notifysigncheckexample.com"
}
},
"fiscalization": {
"licenseKey": "test8d2f483fafef",
"receiptType": "Url",
"receipt": {
"goods": [
{
"good": {
"code": "9999",
"name": "Wine",
"price": 1.5
},
"quantity": 2
}
],
"payments": [
{
"type": "CASHLESS",
"value": 3
}
]
}
}
}

6. Обʼєкт fiscalization


6.1. Загальна структура


Поле Тип Обов'язкове Опис
licenseKey string Ключ ліцензії каси Checkbox
receiptType string Завжди "Url"
receipt object Дані фіскального чека

6.2 receipt

Поле Тип Обовʼязкове Опис
goods array Перелік товарів
payments array Інформація про оплату