GET /v2/open-api/receipt/fiscalisation-operations/{operationId}operationId — ідентифікатор із data.operationId відповіді запуску. Збережіть його разом із вихідним запитом і клієнтським ідентифікатором. Використовуйте авторизацію відповідного API. GET перевіряє наявну операцію; повторний GET не запускає її заново.data.status | Значення | Рекомендована дія клієнта |
|---|---|---|
PENDING | Операцію створено; виконання ще не почалося. | Продовжити перевірку того самого operationId. |
PROCESSING | Операція обробляється. | Продовжити перевірку, не створюючи дубль. |
COMPLETED | Операцію завершено. | Зберегти результат і завершити звичайний polling. |
FAILED | Спроба завершилася помилкою. | Розібрати причину та перевірити фактичний стан перед повторним запуском. |
FAILED — стан операції, але за наявності збереженої помилки API повертає HTTP 400 замість HTTP 200 із data.status = FAILED. Клієнт повинен обробляти обидва варіанти. Саме значення success: true означає успішне отримання статусу, а успішне завершення операції визначається data.status = COMPLETED.{
"success": true,
"data": { "status": "PROCESSING" },
"errors": null
}data.result може бути відсутнім. Не очікуйте, що причину невдачі буде повернуто всередині result. Цей GET також не гарантує повернення operationId, createdAt, updatedAt або окремого поля error.| Відповідь | Можливе значення | Рекомендована дія |
|---|---|---|
| 400 | Збережена помилка виконання операції; також можливі помилки обробки запиту. | Прочитати errors.id та errors.message. Не вважати будь-який 400 автоматично статусом FAILED без аналізу причини. Для підтвердженої невдачі припинити звичайний polling і перейти до перевірки/відновлення. |
404, NOT_FOUND, Operation not found | Запис операції не знайдено. | Звірити ID із відповіддю запуску, endpoint і середовище. Не створювати нову фіскальну дію лише через 404. Якщо ID правильний — передати його підтримці. |
| 401 / 403 | Проблема авторизації або доступу, зокрема на рівні шлюзу чи захисту API. | Перевірити API-ключ і контекст доступу; після виправлення повторити GET із тим самим ID. Ці відповіді не визначають стан фіскалізації. |
| 429, якщо повертається інфраструктурою | Обмеження частоти запитів. | Збільшити інтервал, врахувати Retry-After, якщо він є. Не повторювати запуск операції. |
| 5xx | Помилка сховища, внутрішнього сервісу або формування відповіді. | Повторити GET із затримкою; якщо помилка зберігається — звернутися до підтримки. Не робити висновок, що фіскальна дія не виконана. |
| Таймаут / обрив з’єднання | Відповідь не отримана; стан невідомий. | Зберегти ID і повторити GET. Таймаут клієнта не скасовує операцію. |
{
"success": false,
"data": null,
"errors": {
"id": "<код конкретної причини>",
"message": "<опис причини>"
}
}SHIFT_NOT_FOUND у errors.id під час невдалого виконання не означає HTTP 404 цього GET. Відрізняйте це від NOT_FOUND із повідомленням Operation not found.SOMETHING_WENT_WRONG, INTERNAL_ERROR, неповне повідомлення або серверна помилка. Клієнт має мати загальну гілку для невідомого коду та не визначати поведінку лише за точним текстом повідомлення.data.result містить реквізити результуючого чека: id, fiscalId, fiscalisationTime та urlTax, якщо посилання вдалося сформувати. Для відміни/повернення це результат відповідної операції, а не новий продаж. fiscalisationTime повертається рядком.result, якщо не вдалося прочитати дані чека. Відсутність urlTax також можлива через брак даних для посилання та сама по собі не означає невдалу фіскалізацію.{
"success": true,
"data": {
"status": "COMPLETED",
"result": {
"id": "f3c8a4db-dd7b-4da1-987e-851abf859d9a",
"fiscalId": "mQBTBijv2z8",
"fiscalisationTime": "1722013783064",
"urlTax": "https://cabinet.tax.gov.ua/cashregs/check?id=mQBTBijv2z8&fn=4000520275&date=20240726&time=2009&sm=100&t="
}
},
"errors": null
}| Причина / можливий код | Що перевірити | Рекомендована дія |
|---|---|---|
SHIFT_NOT_FOUND, SHIFT_NOT_OPEN | Наявність і стан зміни, правильність shiftId. | Звірити зміну й уже створені чеки; повторювати запуск лише після усунення причини. |
CHECK_NOT_FOUND або повідомлення про відсутній чек | Ідентифікатор та доступність вихідного чека/його даних. | Знайти правильний чек; для відміни/повернення не підміняти його довільним іншим ID. |
Check already cancelled | Чи вже існує успішна відміна. | Отримати наявний результат. Це повідомлення в коді виникає і без окремого коду CHECK_ALREADY_CANCELLED. |
NOT_ENOUGH_CASH | Залишок готівки для відповідного повернення/відміни. | Звірити рух коштів і суму операції; після корекції перевірити, чи повернення ще не виконане. |
INVALID_PAYMENT_TYPE_ID, INVALID_PAYMENT_GROUP_ID | Типи й групи оплат вихідного запиту. | Виправити дані перед новою спробою. Той самий запит без виправлень не усуває причину. |
KEY_NOT_FOUND | Доступність і налаштування ключа підпису. | Відновити доступ/налаштування підпису, потім перевірити чек перед повторенням. |
CHECKS_IS_EXIST або повідомлення про дублікат | Наявність уже збереженого чека. | Знайти та зіставити попередній результат; не генерувати новий clientCheckId автоматично. |
| Помилка ДПС, підпису, з’єднання або невідомий код | Чи встигла фіскальна дія виконатися. | Спочатку звірити фактичний чек; за невизначеності звернутися до підтримки. |
clientCheckId та checkId; ключ залежить від обох і від типу операції. Для відміни/повернення використовується additionalInfo.clientCheckId. Зміна ключа через втрату відповіді може створити іншу операцію.operationId, клієнтський ідентифікатор, вихідні параметри й тип операції.operationId, тип операції, час запиту, ідентифікатори каси/зміни/чека, HTTP-код та отримані errors. API-ключі й дані підпису не включати.operationId; далі слід перевіряти саме новий ID.curl --location 'https://dev.e-check.com.ua/v2/open-api/receipt/fiscalisation-operations/f44c9d98-7e46-43b1-a19c-b8636a89eed0' \
--header 'apikey: {{apikey}}'{
"success": true,
"data": {
"status": "COMPLETED",
"result": {
"id": "f3c8a4db-dd7b-4da1-987e-851abf859d9a",
"fiscalId": "mQBTBijv2z8",
"fiscalisationTime": "1722013783064",
"urlTax": "https://cabinet.tax.gov.ua/cashregs/check?id=mQBTBijv2z8&fn=4000520275&date=20240726&time=2009&sm=100&t="
}
},
"errors": null
}