Видача готівкових коштів тримачам електронних платіжних засобів
Запит
URI: /api/v2/check/cash-withdrawal
Метод реалізує видачу готівкових коштів тримачам електронних платіжних засобів.
Запит виконується методом POST з тілом запиту у JSON форматі.
⚠️ Запит повинен містити заголовки Accept: application/json та Content-Type: application/json
Параметри запиту
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
api_token | string | Так | Токен авторизації, згенерований в особистому кабінеті |
num_fiscal | integer | Так | Фіска льний номер каси |
action_type | string | Так | Тип дії |
local_number | integer | Так | Локальний номер операції, який клієнт передає з кожним чеком |
sum | integer | Так | Сума видачі |
name | string | Так | Назва електронного платіжного засобу |
terminal | list[object] | Так | Містить параметри платіжного терміналу |
terminal.name | string | Так | Назва платіжного терміналу |
terminal.terminal_id | string | Так | Ідентифікатор платіжного терміналу |
terminal.epz | string | Так | Маска картки |
terminal.card_type | string | Так | Тип картки |
terminal.auth_code | string | Так | Код авторизації |
terminal.rrn | string | Так | Унікальни й ідентифікатор банківської транзакції |
terminal.additional_text | string | Так | Додатковий текст |
footer | string | Так | Текст в нижній частині чека |
open_shift | boolean | Так | Прапор відкриття зміни Якщо зміна закрита і передано значення True , тоді зміна буде відкрита |
Приклад запиту
Запит: /api/v2/check/cash-withdrawal
{
"api_token": "42b5eaccba739f08***e7fe157eba8bf",
"num_fiscal": "4000022469",
"action_type": "CASH_WITHDRAWAL",
"local_number": 18,
"sum": 500,
"name": "KARTKA",
"terminal": {
"name": "Ощадбанк",
"terminal_id": "40904582",
"epz": "4149XXXXXXXX5807",
"card_type": "VISA GOLD",
"auth_code": "538296",
"rrn": "000018706638",
"additional_text": "Тримач ЕПЗ — підпис"
},
"footer": "This is my\n custom footer! Welcome to CashDesk! \n Test \n Next line text!",
"open_shift": true
}
Параметри відповіді
Ім'я | Тип | Опис |
---|---|---|
ORDERNUM | string | Номер чека |
ORDERDATE | string | Дата формування чека |
ORDERTIME | string | Час формування чека |
MAC | string | Так |
is_offline | boolean | Ознака офлайн чека |
qr | string | QR код чека |
qr_data | string | Дані для генерації QR кода |
link | string | Посилання для перегляду чека на сайті |
string | PDF представлення чека | |
text_print | string | Текстове представлення чека |
uuid | string | Локальний uuid номер чека |
local_number | string | Локальний номер операції, який клієнт передає з кожним чеком |
cash_in_box | integer | Поточна кількість грошей в касі |