ТаргетВики
ГлавнаяЯндекс ДиректФорматы

API партнёра для кредитов и кредитных карт в Директе: loan_approval, поля ответа, коды ответов

Банк-партнёр отвечает на запрос предложений по номеру телефона методом loan_approval: возвращает решение (has_approve или rejected) и предложения с суммой, сроком, ставкой, ПСК, платежом и ссылкой на анкету. Путь для кредитных карт — POST /api/banking/loan_approval, для кредитов — POST /integrations/v1/api/loan_approval. Тип продукта: loan, credit_card или realty_bail_credit. Описаны коды ответов 200, 400, 403, 404, 500.

Цифры

Подключение

ПараметрЗначение
Письмо в поддержкуfinance-search@yandex-team.ru, заголовок «Интеграция API в кредитных картах» или «Интеграция API в кредитах» и название организации
Дальшеменеджер связывается по указанным контактам
Что реализоватьпубличный API-эндпоинт, к которому Яндекс отправляет запросы; в ответ отдаются офферы
Проверкапройти проверку работоспособности интеграции
Базовый адресhttps://host/integrations
Кредитные картыHTTP/REST-метод партнёра или готовый интеграционный API банка с реализацией на стороне Яндекса
КредитыHTTP/REST-метод партнёра

Методы

ПродуктыЗапросНазначение
Кредитные картыPOST /api/banking/loan_approvalактуальные предложения банков-партнёров по номеру телефона; предпочтительный унифицированный канал, подходит и для кредитов, и для карт
КредитыPOST /integrations/v1/api/loan_approvalактуальные предложения банков-партнёров по номеру телефона; предпочтительный унифицированный канал

Тело запроса

ПолеКредитная картаКредит
phone_numberномер телефонаномер телефона
product_typecredit_cardloan
amountв справке не нашлисумма, пример 500000.00
termв справке не нашлисрок, пример 36
search_idID запросаID запроса

Ответ 200: верхний уровень

ПолеТипОбязательноЗначение
search_idstringдаID запроса
statusstringдаpending — обрабатывается; done — завершено
namestringданаименование организации
decisionstringдаhas_approve — есть одобрение; rejected — отклонено
dataarrayнетмассив решений; при одном предложении один элемент

Ответ 200: элемент data

ПолеТипОбязательноЗначение
product_typestringдаloan — кредит наличными; credit_card — кредитная карта; realty_bail_credit — кредит под залог недвижимости (только API кредитов)
decisionstringдаpre_approved — предодобрено; full_approved — полностью одобрено
amount.min, amount.maxnumberдасумма займа; для credit_card — кредитный лимит
term.min, term.maxnumberда, если product_type = loanсрок в месяцах
rate.min, rate.maxnumberдаставка
total_cost.min, total_cost.maxnumberдаполная стоимость кредита (ПСК)
grace_periodnumberда, если product_type = credit_cardльготный период в днях
payment.min, payment.maxnumberда, если product_type = loanежемесячный платёж
payment.cc_ratenumberда, если product_type = credit_cardминимальный платёж по карте в процентах, например 10 — это 10% от суммы долга
special_conditionsarrayнетмассив строк с дополнительными условиями
required_documentsarrayнетобязательные документы, массив строк
choosable_documentsarrayнетдокументы на выбор, массив строк
propousal_linkobjectдадолжна быть хотя бы одна ссылка на анкету
propousal_link.linkstringнетссылка на сайт
propousal_link.deepstringнетссылка на приложение
bail_conditionsstringнетусловия залога; только при product_type = realty_bail_credit (API кредитов)
propsarrayнетслужебные параметры, оговорённые вне страницы

Коды ответов

КодПоля ответаОбязательно
200 OKполя из таблиц вышесм. таблицы
400 Bad Requestsearch_id, message; properties — массив полей с ошибкойsearch_id, message да; properties нет
403 Access Forbiddensearch_id, messageда, да
404 Not Foundsearch_id, messageда, да
500 Internal Server Errorsearch_id, messageда, да
Асинхронная модельsearch_id — параметр для повторных запросовда

Подробности

Что делает метод

Метод принимает номер телефона клиента, тип продукта и ID запроса (search_id) и отдаёт Яндексу решение банка и список предложений. Справка называет его предпочтительным унифицированным каналом: через него можно получать и кредиты, и кредитные карты. Предложения затем показываются пользователю в тематическом разделе, а оформление идёт по ссылке из propousal_link.

Примеры из справки

  • Для кредитной карты пример положительного решения — запрос с phone_number, product_type = credit_card и search_id.
  • Для кредита пример положительного решения о выдаче 500 000 рублей — запрос с phone_number, amount 500000.00, term 36, product_type = loan и search_id.
  • Примеры ответов в тексте страниц не приведены.

Чем различаются документы по картам и кредитам

  • Пути запросов разные (см. таблицу методов).
  • В документации кредитов добавлено значение realty_bail_credit и поле bail_conditions для кредитов под залог недвижимости.
  • Для карт отдельно сказано, что вместо HTTP/REST-метода можно предоставить готовый интеграционный API банка.

Важно знать

  • Путь метода в документации карт (/api/banking/loan_approval) и кредитов (/integrations/v1/api/loan_approval) разный, а в обеих сказано, что API реализуется по адресу вида https://host/integrations. Какой путь использовать банку, у которого есть и карты, и кредиты, справка не поясняет.
  • Описание метода для карт говорит, что он подходит для одобрения и кредитов, и карт, но значение realty_bail_credit и bail_conditions есть только в документации кредитов.
  • Имена полей приведены как в справке, включая propousal_link.
  • Примеры ответов, допустимые диапазоны и формат значений полей, кроме указанных, в справке не нашли. Не нашли и срок, за который партнёр должен ответить.
  • Страницы API займов и ОСАГО описаны в статьях про займы и страхование.

Похожие статьи