Опис помилок

В цьому розділі наведені структура та загальні помилки системи Escrow Box.

Загальна структура помилок

Всі оброблені помилки сервісу Escrow Box повертаються із статус кодом 400 в форматі JSON єдиної структури.

Приклад повної структури:

Опис полів помилок:

ПолеОбов'язковістьОпис
errorТакОб'єкт помилки, містить подробиці помилки
error.codeТакТекстовий код помилки
error.messageНіКороткий опис помилки
error.fieldsНі

Об'єкт, який вказує до якого (-их) із полів запиту відноситься помилка, об'єкт дублює структуру таких полів і в значення записує текстовий код помилки

Помилки

codemessageОписПриклад
NOT_ALLOWEDAuthorization credentials are requiredНе передано HTTP header Authorization, або передано, але не правильної структури чи не правильно зашифровано

NOT_ALLOWEDWrong authorization credentials have been passed to headersПередані авторизаційні дані (логін та пароль) невірні
NOT_ALLOWEDClient is not ACTIVEАккаунт відключено адміністраторами
FORMAT_ERROR-

Помилка валідації полів запиту, в об'єкті error.fields повторюється структура проблемних полів, з якими виникла помилка при валідації, а в значенні цих полів вказується більш детальна помилка валідації, якщо така має місце. Варіанти таких помилок: FORMAT_ERRORWRONG_FORMATWRONG_PHONEWRONG_DATEREQUIREDWRONG_DATE,  NOT_NUMBER,   NOT_STRING,  WRONG_EMAIL и др.

DUPLICATE_IDCart is already createdКошик з таким externalId вже існує
DUPLICATE_IDDeal is already createdУгода з таким externalId вже існує
WRONG_IDCan not find adОголошення з таким ID не знайдено
WRONG_IDCan not find cartКошик з таким ID не знайдено
WRONG_IDCan not find dealУгода з таким ID не знайдена
WRONG_IDWrong clientIdКлієнт з таким ID не знайдено
WRONG_IDThere is no payment with such paymentIdПлатіж з таким D не знайдено
NOT_ALLOWED
  • It is not allowed to use payment module {{payerType}}
  • It is not allowed to use payer {{payerType}}

Платіжна система {{payerType}} не дозволена цьому користувачу

NOT_ALLOWEDPayment system {{payerType}} is not consistent with selected ad's payment module

Платіжна система {{payerType}} не дозволена для цього оголошення

NOT_ALLOWEDIt is not allowed to use handler {{handlerType}}

Обробник {{handlerType}} не дозволений цьому користувачу

NOT_ALLOWEDHandler {{handlerType}} is not consistent with ad's handler

Обробник {{handlerType}} не дозволено для цього оголошення

NOT_ALLOWEDIt is not allowed to pay {{dealStatus}} deal

Не дозволено оплачувати угоду в статусі {{dealStatus}}

NOT_ALLOWEDIt is not allowed to reject {{dealStatus}} deal

Не дозволено скасовувати угоду в статусі {{dealStatus}}

NOT_ALLOWEDAd is not confirmedОголошення не підтверджено
NOT_ALLOWEDPayment is do not waiting for confirmationПлатіж не очікує підтвердження
NOT_ALLOWEDAd is already deactivatedОголошення вже видалено 
CONFIRM_IS_NOT_ALLOWEDIt is not allowed to confirm deal with status {{dealStatus}}

Не дозволено підтверджувати угоду в статусі {{dealStatus}}

FORBIDDEN_PARAMYou can not update {{key}} in {{adStatus}} ad

Не дозволено оновлювати поле {{key}} , якщо оголошення в статусі {{adStatus}}

FORBIDDEN_PARAMYou can not update {{key}} in {{adStatus}} deal

Не дозволено оновлювати поле {{key}}, якщо угода в статусі {{adStatus}}

NOT_ENOUGH_DATAThere is no data about handlerНедостатньо даних по обробнику для підтвердження оголошення
NOT_ENOUGH_DATAThere is no data about paymentНедостатньо даних по платіжним системам для підтвердження оголошення
INCOMPLETE_ADNo required data: {{fields}}

Недостатньо полів для підтвердження оголошення, {{fields}} - поля, котрі мають бути заповнені

INCOMPLETE_DEALNo required data: {{fields}}

Недостатньо полів для оплати чи підтвердження угоди, {{fields}} - поля, котрі мають бути заповнені

DEAL_LOCKEDDeal is locked for {{lockedForStatus}} status

Угода заблокована для переходу в статус {{lockedForStatus}}

UNKNOWN_ERROR
  • Internal server error
  • Либо любая другая формулировка описания ошибки

Необроблена/невідома помилка