Опис помилок

В цьому розділі наведені структура та загальні помилки системи 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Ні

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

Помилки

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

NOT_ALLOWEDWrong authorization credentials have been passed to headersПередані авторизаційні дані (логін та пароль) невірні
{
    "error": {
        "code": "NOT_ALLOWED",
        "message": "Wrong authorization credentials have been passed to headers"
    }
}
NOT_ALLOWEDClient is not ACTIVEАккаунт відключено адміністраторами
{
    "error": {
        "code": "NOT_ALLOWED",
        "message": "Client is not ACTIVE"
    }
}
FORMAT_ERROR-

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

{
    "error": {
        "fields": {
            "sellerFirstName": "WRONG_FORMAT"
        },
        "code": "FORMAT_ERROR"
    }
}
DUPLICATE_IDCart is already createdКошик з таким externalId вже існує
{
    "error": {
        "code": "DUPLICATE_ID",
        "message": "Cart is already created"
    }
}
DUPLICATE_IDDeal is already createdУгода з таким externalId вже існує
{
    "error": {
        "code": "DUPLICATE_ID",
        "message": "Deal is already created"
    }
}
WRONG_IDCan not find adОголошення з таким ID не знайдено
{
  "error": {
    "fields": {
      "params": {
        "adId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find ad"
  }
}
WRONG_IDCan not find cartКошик з таким ID не знайдено
{
  "error": {
    "fields": {
      "params": {
        "cartId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find cart"
  }
}
WRONG_IDCan not find dealУгода з таким ID не знайдена
{
  "error": {
    "fields": {
      "params": {
        "dealId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Can not find deal"
  }
}
WRONG_IDWrong clientIdКлієнт з таким ID не знайдено
{
  "error": {
    "fields": {
      "params": {
        "clientId": "WRONG_ID"
      }
    },
    "code": "WRONG_ID",
    "message": "Wrong clientId"
  }
}
WRONG_IDThere is no payment with such paymentIdПлатіж з таким D не знайдено
{
    "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}} не дозволена цьому користувачу

{{payerType}} - тип платіжної системи

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to use payment module P2P"
  }
}
NOT_ALLOWEDPayment 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_ALLOWEDIt is not allowed to use handler {{handlerType}}

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

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

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to use handler NovaPoshta"
  }
}
NOT_ALLOWEDHandler {{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_ALLOWEDIt is not allowed to pay {{dealStatus}} deal

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

{{dealStatus}} - статус угоди

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

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

{{dealStatus}} - статус угоди

{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "It is not allowed to reject DELIVERED deal"
  }
}
NOT_ALLOWEDAd is not confirmedОголошення не підтверджено
{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Ad is not confirmed"
  }
}
NOT_ALLOWEDPayment is do not waiting for confirmationПлатіж не очікує підтвердження
{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Payment is do not waiting for confirmation"
  }
}
NOT_ALLOWEDAd is already deactivatedОголошення вже видалено 
{
  "error": {
    "code": "NOT_ALLOWED",
    "message": "Ad is already deactivated"
  }
}
CONFIRM_IS_NOT_ALLOWEDIt 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_PARAMYou 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_PARAMYou 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_DATAThere is no data about handlerНедостатньо даних по обробнику для підтвердження оголошення
{
    "error": {
        "code": "NOT_ENOUGH_DATA",
        "message": "There is no data about handler"
    }
}
NOT_ENOUGH_DATAThere is no data about paymentНедостатньо даних по платіжним системам для підтвердження оголошення
{
    "error": {
        "code": "NOT_ENOUGH_DATA",
        "message": "There is no data about payment"
    }
}
INCOMPLETE_ADNo required data: {{fields}}

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

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

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

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

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

{
    "error": {
        "code": "INCOMPLETE_DEAL",
        "message": "No required data: productPrice, productWeight"
    }
}
DEAL_LOCKEDDeal is locked for {{lockedForStatus}} status

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

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

{
    "error": {
        "code": "DEAL_LOCKED",
        "message": "Deal is locked for PAID status"
    }
}
UNKNOWN_ERROR
  • Internal server error
  • Либо любая другая формулировка описания ошибки

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

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

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