В этом разделе описаны структура и общие ошибки системы 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" } } |
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" } } |
NOT_ALLOWED | It is not allowed to use payment module {{payerType}} | Платежная система {{payerType}} не разрешена этому пользователю {{payerType}} - тип платежной системы | { "error": { "code": "NOT_ALLOWED", "message": "It is not allowed to use payment module {{payerType}}" } } |
NOT_ALLOWED | Payment system {{payerType}} is not consistent with selected ad's payment module | Платежная система {{payerType}} не разрешена для этого объявления {{payerType}} - тип платежной системы | { "error": { "code": "NOT_ALLOWED", "message": "Payment system {{payerType}} is not consistent with selected ad's payment module" } } |
NOT_ALLOWED | It is not allowed to pay {{dealStatus}} deal | Нельзя оплачивать сделку в статусе {{dealStatus}} {{dealStatus}} - статус сделки | { "error": { "code": "NOT_ALLOWED", "message": "It is not allowed to pay {{dealStatus}} deal" } } |
NOT_ALLOWED | It is not allowed to reject {{dealStatus}} deal | Нельзя отменять сделку в статусе {{dealStatus}} {{dealStatus}} - статус сделки | { "error": { "code": "NOT_ALLOWED", "message": "It is not allowed to reject {{dealStatus}} 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" } } |
CONFIRM_IS_NOT_ALLOWED | It is not allowed to confirm deal with status {{dealStatus}} | Нельзя подтвердить сделку в статусе {{dealStatus}} | |
WRONG_ID | There is no payment with such paymentId | Платеж с таким ID не найден | { "error": { "code": "WRONG_ID", "message": "There is no payment with such paymentId" } } |
UNKNOWN_ERROR |
| Необработанная/неизвестная ошибка Если вам в ответ на какой то из запросов к EscrowBox вернулась подобная ошибка, просим обратиться в нашу техподдержку с подробными логами(примерное время выполнения запроса, от какого ID клиента, URL на который был отправлен запрос, HTTP методо, тело запроса, если имееться, и сам ответ). | { "error": { "code": "UNKNOWN_ERROR", "message": "Internal server error" } } |