Content Comparison

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

...

Загальна структура

...

помилок

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

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

Code Block

language	js

{
    "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, либо передан, но не правильной структуры или не правильно зашифрованпередано HTTP header Authorization, або передано, але не правильної структури чи не правильно зашифровано

Code Block

language	js

{
    "error": {
        "code": "NOT_ALLOWED",
        "message": "Authorization credentials are required"
    }
}

NOT_ALLOWED

Wrong authorization credentials have been passed to headers

Передаваемые авторизационные данные(логин и Передані авторизаційні дані (логін та пароль) неверныневірні

Code Block

language	js

{
    "error": {
        "code": "NOT_ALLOWED",
        "message": "Wrong authorization credentials have been passed to headers"
    }
}

NOT_ALLOWED

Client is not ACTIVE

Аккаунт отключен администраторамивідключено адміністраторами

Code Block

language	js

{
    "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 и др.

Code Block

language	js

{
    "error": {
        "fields": {
            "sellerFirstName": "WRONG_FORMAT"
        },
        "code": "FORMAT_ERROR"
    }
}

DUPLICATE_ID

Cart is already created

Корзина с Кошик з таким externalId уже существует вже існує

Code Block

language	js

{
    "error": {
        "code": "DUPLICATE_ID",
        "message": "Cart is already created"
    }
}

DUPLICATE_ID

Deal is already created

Сделка с Угода з таким externalId уже существует вже існує

Code Block

language	js

{
    "error": {
        "code": "DUPLICATE_ID",
        "message": "Deal is already created"
    }
}

WRONG_ID

Can not find ad

Объявление с Оголошення з таким ID не найдензнайдено

Code Block

language	js

{
  "error": {
    "fields": {
      "params": {
        "adId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find ad"
  }
}

WRONG_ID

Can not find cart

Корзина с Кошик з таким ID не найденазнайдено

Code Block

language	js

{
  "error": {
    "fields": {
      "params": {
        "cartId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find cart"
  }
}

WRONG_ID

Can not find deal

Сделка с Угода з таким ID не найденазнайдена

Code Block

language	js

{
  "error": {
    "fields": {
      "params": {
        "dealId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find deal"
  }
}

WRONG_ID

Wrong clientId

Клиент с ткаим Клієнт з таким ID не найдензнайдено

Code Block

language	js

{
  "error": {
    "fields": {
      "params": {
        "clientId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Wrong clientId"
  }
}

WRONG_ID

There is no payment with such paymentId

Платіж з таким D не знайдено

Code Block

language	js

{
    "error": {
        "code": "WRONG_ID",
        "message": "There is no payment with such paymentId"
    }
}

NOT_ALLOWED

It is not allowed to use payment module {{payerType}}

It is not allowed to use payer {{payerType}}

Платежная

Платіжна система {{payerType}} не

разрешена этому пользователю

дозволена цьому користувачу

Info
{{payerType}} - тип

платежной системы

платіжної системи

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to use payment module {{payerType}}module P2P"
  }
}

NOT_ALLOWED

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

Платежная

Платіжна система {{payerType}}

не разрешена

не дозволена для

этого объявления

цього оголошення

Info
{{payerType}} - тип

платежной системы

платіжної системи

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Payment system {{payerType}}system P2P is not consistent with selected ad's payment module"
  }
}

NOT_ALLOWED

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

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

Info
{{handlerType}} - тип обробника

Code Block

language	js

{
  "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}} не дозволено для цього оголошення

Info
{{handlerType}} - тип обробника

Code Block

language	js

{
  "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}}

Info
{{dealStatus}} - статус

сделки

угоди

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to pay {{dealStatus}}DELIVERED deal"
  }
}

NOT_ALLOWED

It is not allowed to reject {{dealStatus}} dealНельзя отменять сделку

в статусе

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

Info
{{dealStatus}} - статус

сделки

угоди

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to reject {{dealStatus}}reject DELIVERED deal"
  }
}

NOT_ALLOWED

Ad is not confirmed

Объявление Оголошення не подтвержденопідтверджено

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Ad is not confirmed"
  }
}

NOT_ALLOWED

Payment is do not waiting for confirmation

Платеж Платіж не ожидает подтвержденияочікує підтвердження

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Payment is do not waiting for confirmation"
  }
}

NOT_ALLOWED

Ad is already deactivated

Оголошення вже видалено

Code Block

language	js

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Ad is already deactivated"
  }
}

CONFIRM_IS_NOT_ALLOWED

It is not allowed to confirm deal with status {{dealStatus}}Нельзя

подтвердить сделку в статусе

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

Info
{{dealStatus}}

WRONG_ID

There is no payment with such paymentId

Платеж с таким ID не найден

- статус угоди

Code Block

language	js

{
  "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}}

Info

{{key}} - поле

{{adStatus}} - статус оголошення

Code Block

language	js

{
  "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}}

Info

{{key}} - поле

{{adStatus}} - статус оголошення

Code Block

language	js

{
  "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

Недостатньо даних по обробнику для підтвердження оголошення

Code Block

language	js

{
    "error": {
        "code": "NOT_ENOUGH_DATA",
        "message": "There is no data about handler"
    }
}

NOT_ENOUGH_DATA

There is no data about payment

Недостатньо даних по платіжним системам для підтвердження оголошення

Code Block

language	js

{
    "error": {
        "code": "WRONGNOT_ENOUGH_IDDATA",
        "message": "There is no data about payment with such paymentId"
    }
}

INCOMPLETE_AD

No required data: {{fields}}

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

Info
{{fields}} - перелік полів через кому

Code Block

language	js

{
    "error": {
        "code": "INCOMPLETE_AD",
        "message": "No required data: sellerPhone, sellerEmail"
    }
}

INCOMPLETE_DEAL

No required data: {{fields}}

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

Info
{{fields}} - перелік полів через кому

Code Block

language	js

{
    "error": {
        "code": "INCOMPLETE_DEAL",
        "message": "No required data: productPrice, productWeight"
    }
}

DEAL_LOCKED

Deal is locked for {{lockedForStatus}} status

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

Info
{{lockedForStatus}} - статус угоди, для якої вона заблокована

Code Block

language	js

{
    "error": {
        "code": "DEAL_LOCKED",
        "message": "Deal is locked for PAID status"
    }
}

UNKNOWN_ERROR

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

Необработанная

Необроблена/

неизвестная ошибка

невідома помилка

Info

Если вам в ответ на какой то из запросов к EscrowBox вернулась подобная ошибка, просим обратиться в нашу техподдержку с подробными логами(примерное время выполнения запроса, от какого ID клиента, URL на который был отправлен запрос, HTTP методо, тело запроса, если имееться, и сам ответ

Якщо вам у відповідь будь-який із запитів повернув подібну помилку, просимо повідомити в нашу техпідтримку з детальними логами (приблизний час виконання запиту; від якого ID клієнта; URL, на який було відправлено запит; HTTP метод; тіло запиту; якщо є, то і саму відповідь).

Code Block

language	js

{
    "error": {
        "code": "UNKNOWN_ERROR",
        "message": "Internal server error"
    }
}

...

Version	Old Version 25	New Version Current
Changes made by	Denys Kucheriavyi	antonina smetanina
Saved on	282 51, 2018	013 29, 2022

Versions Compared

Key

Загальна структура

помилок

Помилки