API отримання даних terminal id

Отримання даних terminal id

Метод: GET

URL: /terminal-id

Query parameters

Параметр	Тип	Обов’язковий	Опис	Example
`retailerId`	string	Так	Унікальний ідентифікатор ритейлера	7725110e-b68d-4112-97e3-a8a0c9517892
`date`	string	Так	Дата транзакції у форматі YYYY-MM-DD	2024-03-25

Приклад запиту:

/terminal-id?retailerId=09238c4a-cbe2-4a96-b15d-d678ec921691&date=2024-03-25

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

HTTP-код: 200

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

{
  "result": "ok",
  "traceID": "776e355f-d5e1-4ee6-b474-beca7f0b8934",
  "data": [
    {
      "retailerId": "09238c4a-cbe2-4a96-b15d-d678ec921691",
      "retailerName": "WOG PRIDE",
      "terminalId": "AUTH123456, AUTH98078, AUTH6754",
      "lastTransactionDate": "2024-06-02"
    }
  ]
}

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

Параметр	Тип	Опис
`retailerId`	string	Унікальний ідентифікатор ритейлера
`retailerName`	string	Назва ритейлера
`terminalId`	string	Terminal id
`lastTransactionDate`	string	Остання дата транзакції з поточним terminal_id (формат: YYYY-MM-DD)

Помилка

HTTP-код: 404

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

{
  "result": "error",
  "statusCode": 404,
  "traceID": "b8867914-33ec-48c1-b3f4-530df3821da1",
  "error": {
    "code": "NotFoundException",
    "message": "Data not found for specified retailer and date"
  }
}

HTTP-код: 400

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

{
  "result": "error",
  "statusCode": 400,
  "traceID": "19d219c5-eb1a-45f5-ad2a-dc41c2024d3a",
  "error": {
    "code": "WrongRequestException",
    "message": "Validation Error!",
    "data": {
      "isDateString": "date must be a valid ISO 8601 date string"
    }
  }
}

HTTP-код: 500

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

{
  "status": 500,
  "code": 1005,
  "message": "Internal server error"
}

Коди

Код	Опис
1000	Invalid Request Parameters
1001	Data Not Found
1005	Internal Server Error