Обработка ответов и коды ошибок

Обработка ответа

Сначала следует анализировать HTTP-код ответа.

Если код ответа 200, нужно смотреть, что пришло в поле status.

Если статус ok, значит, запрос прошел успешно, смотрите подробности в объекте data.

HTTP-коды ответа

200 — Запрос сформирован правильно, посмотрите, что пришло в поле status.

422 — Ошибка в запросе, подробности — в поле error.description:

• request_body_validation_error — ошибка в теле запроса;
• request_header_validation_error - отсутствует заголовок x-partner-project.

500 — Ошибка на стороне Банка 131, повторите запрос позже.

Статусы ответа status

Статусы ответа приходят в поле status.

ok — запрос успешно обработан, смотрите подробности в объекте data.

pending — запрос в обработке, чтобы узнать результат, повторите запрос с теми же данными чуть позже.

error — ошибка в результате обработки запроса, посмотрите, что пришло в объекте Error.

Коды ошибок

Ошибки приходят в объекте Error:

• code содержит код ошибки,
• description — описание ошибки.

code	description	Описание ошибки
invalid_sign	Signature verification failure	Некорректная подпись запроса check
passport_validation_failure	Passport is not valid	Паспорт недействителен
passport_validation_failure	No passport information available	Сведения о паспорте отсутствуют
inn_validation_failure	Passport and INN do not match	Паспортные данные и ИНН не соответствуют
already_exists	Request with the same data already exists	Вы уже отправляли эти данные на проверку. Чтобы узнать результат, отправьте запрос check{id} с идентификатором предыдущей проверки, который пришел в поле data.id
request_not_found	Request with given id not found	Запрос на проверку с этим идентификатором не найден
partner_project_not_found	partner project not found	Идентификатор проекта, отправленный в заголовке X-PARTNER-PROJECT, не существует
birthday_validation_failure	Date of birth verification failed. Identification cannot be carried out for a minor applicant	Проверка даты рождения не пройдена. Идентификация не может быть проведена несовершеннолетнему заявителю

Примеры ответов

Паспорт недействителен

{
    "status": "error",
    "error": {
        "code": "passport_validation_failure",
        "description": "passport is not valid"
    }
}

Сведения о паспорте отсутствуют

{
    "status": "error",
    "error": {
        "code": "passport_validation_failure",
        "description": "no passport information available"
    }
}

ИНН и паспорт не прошли проверку

{
    "status": "error",
    "error": {
        "code": "inn_validation_failure",
        "description": "passport and INN do not match"
    }
}