API оцінки роботи мерчанта

Оцінка роботи мерчанта

Метод: POST

URL: /retailers-rating

Query parameters

ПараметрТипОбов’язковийОписExample
bankIdstringТакУнікальний ідентифікатор банку01bf7ce4-ac55-430e-a811-5ceab00a3711
bankCustomerIdstringТакID клієнта (якщо транзакцію знайдено); якщо транзакцію не знайдено — поле необов’язкове7187946870578925269
retailerIdstringТакУнікальний ідентифікатор ритейлера7725110e-b68d-4112-97e3-a8a0c9517892
ratingnumberТакОцінка роботи мерчанта1-5
commentstringНіКоментар клієнтаmax length 1024

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

HTTP-код: 200

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

{
  "bankId": "5aec26a8-d2da-49a3-96be-b9da2448f426",
  "bankCustomerId": "1234",
  "rating": 5,
  "retailerId": "b7720467-363d-4c5a-aabd-b51cd595856d",
  "retailerCustomerId": null,
  "ratingId": "08819b06-1944-4a62-ad45-98a3fcbcbad4",
  "createdAt": "2025-02-21T14:52:35.490Z",
  "updateAt": "2025-02-21T14:52:35.490Z"
}

Інший приклад:

{
  "bankId": "5aec26a8-d2da-49a3-96be-b9da2448f426",
  "bankCustomerId": "3493790926675156825",
  "rating": 5,
  "retailerId": "b7720467-363d-4c5a-aabd-b51cd595856d",
  "retailerCustomerId": "380674806076",
  "ratingId": "63721742-7c69-49f7-ad69-3832d9ddd7bd",
  "createdAt": "2025-02-21T14:53:11.176Z",
  "updateAt": "2025-02-21T14:53:11.176Z"
}

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

ПараметрТипОпис
bankIdUUIDУнікальний ідентифікатор банку. Формат: UUID v4
bankCustomerIdStringВнутрішній ID клієнта банку. Формат: числовий рядок
ratingIntegerОцінка задоволеності клієнта. Діапазон: 1-5
retailerIdUUIDУнікальний ідентифікатор ритейлера. Формат: UUID v4
retailerCustomerIdStringВнутрішній ID клієнта ритейлера. Формат: string
ratingIdUUIDУнікальний ідентифікатор цієї оцінки. Формат: UUID v4
createdAtDateTimeЧас створення оцінки. Формат: ISO 8601
updateAtDateTimeЧас останнього оновлення оцінки. Формат: ISO 8601

Помилка

HTTP-код: 400

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

{
  "result": "error",
  "statusCode": 400,
  "traceID": "12470c5b-74c0-44bf-81d3-e538e7a2a755",
  "error": {
    "code": "WrongRequestException",
    "message": "Validation Error!",
    "data": {
      "isString": "bankCustomerId must be a string"
    }
  }
}

HTTP-код: 500

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

{
  "statusCode": 500,
  "message": "Internal server error"
}