Еквайринг

Create And Fiscalize Invoice

Створення рахунку (інвойсу), на основі інформації про чек та при успішній оплаті фіскалізація чека. При використані цього методу зміна може бути закритою. Відкриття та закриття зміни відбувається автоматично. Чек стане доступний при успішній оплаті інвойсу.

post/api/v1/invoices/fiscalize

Request

  • Base URL: https://api.checkbox.ua (the document declares no server; this is the origin it was published from)
  • URL: https://api.checkbox.ua/api/v1/invoices/fiscalize
  • Auth: HTTP bearer

Headers

X-Client-Namestring

Назва клієнту або сервісу що інтегрується з API, наприклад 'My Custom SDK'

X-Client-Versionstring

Номер версії клієнту що інтегрується з API, наприклад 'v1.2.5'

string uuid required
OR
string required

Request body

idstring uuid

Обов'язково вкажіть унікальний UUID чеку!

cashier_namestring
departamentstring
roundingboolean

Застаріле поле, використовуйте rounding_mode

rounding_mode'ROUND_10' | 'ROUND_50'

An enumeration.

headerstring
footerstring
barcodestring
order_idstring uuid
related_receipt_idstring uuid
related_receipt_created_atstring date-time
stock_codestring
technical_returnboolean
is_pawnshopboolean
contextobject
terminal_idstring uuid

ID терміналу, який буде використовуватися.

validityinteger

Строк дії в секундах, за замовчуванням рахунок перестає бути дійсним через 24 години. Мінімум тривалості - 60 секунд.

redirect_urlstring uri

Адреса для повернення (GET) - на цю адресу буде переадресовано користувача після завершення оплати (у разі успіху або помилки)

tips_employee_idstring

ID співробітника (для чайових)

Example request

{
  "payments": [
    {
      "type": "CASH",
      "value": 4242
    }
  ]
}

Response

Successful Response

idstring uuid required
external_idstring required
status'CREATED' | 'PROCESSING' | 'HOLD' | 'SUCCESS' | 'FAILURE' | 'REVERSED' | 'REQUEST_TO_CANCEL' | 'EXPIRED' required

Statuses of invoice

page_urlstring
receipt_idstring uuid required

Чек стане доступним для перегляду при успішній сплаті рахунку

Changes

No recorded changes to this operation across all 1 revision of this API.