В цьому розділі наведені структура та загальні помилки системи Escrow Box.
Загальна структура помилок
Всі оброблені помилки сервису Escrow Box повертаються із статус кодом 400 в форматі JSON єдиної структури.
Приклад повної структури:
{
"error": {
"code": "SOME_CODE",
"message": "Some description of the error",
"fields": {
"someField": "SOME_CODE"
}
}
}
Опис полів помилок:
| Поле | Обов'язковість | Опис |
|---|---|---|
| error | Так | Об'єкт помилки, містить подробиці помилки |
| error.code | Так | Текстовий код помилки |
| error.message | Ні | Короткий опис помилки |
| error.fields | Ні | Об'єкт, який вказує до якого (-их) із полів запиту відноситься помилка, об'єкт дублює структуру таких полів і в значення записує текстовий код помилки |
Помилки
| code | message | Опис | Приклад |
|---|---|---|---|
| NOT_ALLOWED | Authorization credentials are required | Не передано HTTP header Authorization, або передано, але не правильної структури чи не правильно зашифровано | {
"error": {
"code": "NOT_ALLOWED",
"message": "Authorization credentials are required"
}
}
|
| NOT_ALLOWED | Wrong authorization credentials have been passed to headers | Передані авторизаційні дані (логін та пароль) невірні | {
"error": {
"code": "NOT_ALLOWED",
"message": "Wrong authorization credentials have been passed to headers"
}
}
|
| NOT_ALLOWED | Client is not ACTIVE | Аккаунт відключено адміністраторами | {
"error": {
"code": "NOT_ALLOWED",
"message": "Client is not ACTIVE"
}
}
|
| FORMAT_ERROR | - | Помилка валідації полів запиту, в об'єкті error.fields повторюється структура проблемних полів, з якими виникла помилка при валідації, а в значенні цих полів вказується більш детальна помилка валідації, якщо така має місце. Варіанти таких помилок: FORMAT_ERROR, WRONG_FORMAT, WRONG_PHONE, WRONG_DATE, REQUIRED, WRONG_DATE, NOT_NUMBER, NOT_STRING, WRONG_EMAIL и др. | {
"error": {
"fields": {
"sellerFirstName": "WRONG_FORMAT"
},
"code": "FORMAT_ERROR"
}
}
|
| DUPLICATE_ID | Cart is already created | Кошик з таким externalId вже існує | {
"error": {
"code": "DUPLICATE_ID",
"message": "Cart is already created"
}
}
|
| DUPLICATE_ID | Deal is already created | Угода з таким externalId вже існує | {
"error": {
"code": "DUPLICATE_ID",
"message": "Deal is already created"
}
}
|
| WRONG_ID | Can not find ad | Оголошення з таким ID не знайдено | {
"error": {
"fields": {
"params": {
"adId": "WRONG_ID"
}
},
"code": "WRONG_ID",
"message": "Can not find ad"
}
}
|
| WRONG_ID | Can not find cart | Кошик з таким ID не знайдено | {
"error": {
"fields": {
"params": {
"cartId": "WRONG_ID"
}
},
"code": "WRONG_ID",
"message": "Can not find cart"
}
}
|
| WRONG_ID | Can not find deal | Угода з таким ID не знайдена | {
"error": {
"fields": {
"params": {
"dealId": "WRONG_ID"
}
},
"code": "WRONG_ID",
"message": "Can not find deal"
}
}
|
| WRONG_ID | Wrong clientId | Клієнт з таким ID не знайдено | {
"error": {
"fields": {
"params": {
"clientId": "WRONG_ID"
}
},
"code": "WRONG_ID",
"message": "Wrong clientId"
}
}
|
| WRONG_ID | There is no payment with such paymentId | Платіж з таким D не знайдено | {
"error": {
"code": "WRONG_ID",
"message": "There is no payment with such paymentId"
}
}
|
| NOT_ALLOWED |
| Платіжна система {{payerType}} не дозволена цьому користувачу {{payerType}} - тип платіжної системи | {
"error": {
"code": "NOT_ALLOWED",
"message": "It is not allowed to use payment module P2P"
}
}
|
| NOT_ALLOWED | Payment system {{payerType}} is not consistent with selected ad's payment module | Платіжна система {{payerType}} не дозволена для цього оголошення {{payerType}} - тип платіжної системи | {
"error": {
"code": "NOT_ALLOWED",
"message": "Payment system P2P is not consistent with selected ad's payment module"
}
}
|
| NOT_ALLOWED | It is not allowed to use handler {{handlerType}} | Обробник {{handlerType}} не дозволений цьому користувачу {{handlerType}} - тип обробника | {
"error": {
"code": "NOT_ALLOWED",
"message": "It is not allowed to use handler NovaPoshta"
}
}
|
| NOT_ALLOWED | Handler {{handlerType}} is not consistent with ad's handler | Обробник {{handlerType}} не дозволено для цього оголошення {{handlerType}} - тип обробника | {
"error": {
"code": "NOT_ALLOWED",
"message": "Handler NovaPoshta is not consistent with ad's handler"
}
}
|
| NOT_ALLOWED | It is not allowed to pay {{dealStatus}} deal | Не дозволено оплачувати угоду в статусі {{dealStatus}} {{dealStatus}} - статус угоди | {
"error": {
"code": "NOT_ALLOWED",
"message": "It is not allowed to pay DELIVERED deal"
}
}
|
| NOT_ALLOWED | It is not allowed to reject {{dealStatus}} deal | Не дозволено скасовувати угоду в статусі {{dealStatus}} {{dealStatus}} - статус угоди | {
"error": {
"code": "NOT_ALLOWED",
"message": "It is not allowed to reject DELIVERED deal"
}
}
|
| NOT_ALLOWED | Ad is not confirmed | Оголошення не підтверджено | {
"error": {
"code": "NOT_ALLOWED",
"message": "Ad is not confirmed"
}
}
|
| NOT_ALLOWED | Payment is do not waiting for confirmation | Платіж не очікує підтвердження | {
"error": {
"code": "NOT_ALLOWED",
"message": "Payment is do not waiting for confirmation"
}
}
|
| NOT_ALLOWED | Ad is already deactivated | Оголошення вже видалено | {
"error": {
"code": "NOT_ALLOWED",
"message": "Ad is already deactivated"
}
}
|
| CONFIRM_IS_NOT_ALLOWED | It is not allowed to confirm deal with status {{dealStatus}} | Не дозволено підтверджувати угоду в статусі {{dealStatus}} {{dealStatus}} - статус угоди | {
"error": {
"code": "CONFIRM_IS_NOT_ALLOWED",
"message": "It is not allowed to confirm deal with status DELIVERED"
}
}
|
| FORBIDDEN_PARAM | You can not update {{key}} in {{adStatus}} ad | Не дозволено оновлювати поле {{key}} , якщо оголошення в статусі {{adStatus}} {{key}} - поле {{adStatus}} - статус оголошення | {
"error": {
"fields": {
"params": {
"sellerPhone": "FORBIDDEN_PARAM"
}
},
"code": "FORBIDDEN_PARAM",
"message": "You can not update sellerPhone in CONFIRMED ad"
}
}
|
| FORBIDDEN_PARAM | You can not update {{key}} in {{adStatus}} deal | Не дозволено оновлювати поле {{key}}, якщо угода в статусі {{adStatus}} {{key}} - поле {{adStatus}} - статус оголошення | {
"error": {
"fields": {
"params": {
"productPrice": "FORBIDDEN_PARAM"
}
},
"code": "FORBIDDEN_PARAM",
"message": "You can not update productPrice in DELIVERED deal"
}
}
|
| NOT_ENOUGH_DATA | There is no data about handler | Недостатньо даних по обробнику для підтвердження оголошення | {
"error": {
"code": "NOT_ENOUGH_DATA",
"message": "There is no data about handler"
}
}
|
| NOT_ENOUGH_DATA | There is no data about payment | Недостатньо даних по платіжним системам для підтвердження оголошення | {
"error": {
"code": "NOT_ENOUGH_DATA",
"message": "There is no data about payment"
}
}
|
| INCOMPLETE_AD | No required data: {{fields}} | Недостатньо полів для підтвердження оголошення, {{fields}} - поля, котрі мають бути заповнені {{fields}} - перелік полів через кому | {
"error": {
"code": "INCOMPLETE_AD",
"message": "No required data: sellerPhone, sellerEmail"
}
}
|
| INCOMPLETE_DEAL | No required data: {{fields}} | Недостатньо полів для оплати чи підтвердження угоди, {{fields}} - поля, котрі мають бути заповнені {{fields}} - перелік полів через кому | {
"error": {
"code": "INCOMPLETE_DEAL",
"message": "No required data: productPrice, productWeight"
}
}
|
| DEAL_LOCKED | Deal is locked for {{lockedForStatus}} status | Угода заблокована для переходу в статус {{lockedForStatus}} {{lockedForStatus}} - статус угоди, для якої вона заблокована | {
"error": {
"code": "DEAL_LOCKED",
"message": "Deal is locked for PAID status"
}
}
|
| UNKNOWN_ERROR |
| Необроблена/невідома помилка Якщо вам у відповідь будь-який із запитів повернув подібну помилку, просимо повідомити в нашу техпідтримку з детальними логами (приблизний час виконання запиту; від якого ID клієнта; URL, на який було відправлено запит; HTTP метод; тіло запиту; якщо є, то і саму відповідь). | {
"error": {
"code": "UNKNOWN_ERROR",
"message": "Internal server error"
}
}
|