API додавання чека до чорного списку

Додавання чеків до чорного списку

Якщо потрібно додати чеки до чорного списку і не надсилати їх банку, використовуйте наступний запит.

Додавання чеків до чорного списку

Метод: PUT

URL: /receiptNI/blacklist

Опис основного об’єкта

ПараметрТипОбов’язковийОпис
retailer_iduuidТакID ритейлера
order_idstringТакID чека

Body:

{
  "retailer_id": "c4a12b27-21db-4c55-9b1e-00b914f3ffd9",
  "order_id": "123321"
}

Успішна відповідь

HTTP-код: 200

Тіло відповіді:

{
  "message": "Success added to blacklist until 2023-07-25 12:52:25",
  "traceID": "94998cda-821a-4ba8-bcf3-6b6a0f917773",
  "retailer_id": "c4a12b27-21db-4c55-9b1e-00b914f3ffd9",
  "order_id": "123321"
}

Опис основного об’єкта

ПараметрТипОпис
messagestringСтатус відповіді з датою та часом
order_idstringID замовлення у ритейлера
traceIDuuidID запиту
retailer_iduuidID ритейлера

Помилка

HTTP-код: 400/500

Тіло відповіді:

{
  "status": 400,
  "code": 1000,
  "message": "\"delay\" must be less than or equal to 604800. TraceID - 0e9cf0e8-9e01-440e-9450-78bcf9179700"
}

Коди

КодОпис
1000Validation Error
1005Internal Server Error

Відповідь DeepLoyalty, якщо чек додано до чорного списку

Метод: PUT

URL: /receiptNI

HTTP-код: 200

Тіло відповіді:

{
  "message": "Blocked by retailer. TraceID - e4f0c041-347c-4fc7-818a-e08096ee790f",
  "retailer_id": "c4a12b27-21db-4c55-9b1e-00b914f3ffd9",
  "order_id": "123321"
}