Нотификации заявки
На основе таких уведомлений магазин может предоставлять товар или услугу покупателю. Бывают email-нотификации и HTTP-нотификации
Email-нотификации
Отправляются на электронную почту. Это обычные письма
- Одобрено — заявка одобрена одним из банков, покупателю остается подписать документы через СМС или на встрече с представителем банка.
- Отказано — по заявке пришел отказ от одного из банков, вы можете связаться с покупателем и предложить альтернативные способы оплаты: банковской картой, наличными
- Отмена — заявка отменена, покупатель по какой-то причине отменил заказ. Покупатель может изменить состав заказа и заново отправить заявку в банк или выбрать другой способ оплаты
- Подписано — договор подписан покупателем. Если заявка не охлаждается, то вы можете подтвердить заявку методом API Commit или в личном кабинете агента, а затем выдать товар покупателю или оказать услугу. В случае охлаждения вызов метода API Commit возможен только после его окончания.
Письма с решениями «Одобрено» и «Отказано» приходят по каждому банку. Письмо «Отказано» не означает, что по всей заявке пришел отказ, дождитесь решения всех банков
HTTP-нотификации
Если вы хотите оперативно отслеживать состояние заказа, можно подписаться на HTTP-уведомления, или вебхуки. Это вид нотификации через оповещения на сайте, сформированные с помощью HTTP-запроса. Когда придет такое уведомление, вам нужно проверить состояние заявки методом Info, а затем поменять статус заказа в системе учета интернет-магазина. Вебхуки пригодятся, когда объект API меняется без вашего участия. Для получения вебхуков нужно указать адрес для уведомлений
Статичный адрес
- Впишите его в личном кабинете руководителя. Перейдите в «Кредитование в магазинах» и выберите магазин и нажмите «Редактировать»
- Нажмите на «Уведомления», «Адрес для HTTP-нотификаций» и поставьте галочку в чекбоксе
Свой адрес для каждой заявки
Нужно передавать его при создании заявки в поле webhookURL. При этом в личном кабинете руководителя все равно должен быть настроен статичный адрес. Подключение по API
Домен уведомлений должен совпадать с доменом вашего сайта. Чтобы использовать вебхуки, при создании заявки передайте параметр orderNumber — именно он передается в вебхуках в поле id. Ваш сайт должен использовать защищенный HTTPS, решения с HTTP-протоколом мы не поддерживаем. Перечень подходящих сертификатов для вашего сайта.
Вебхуки отправляются на события:
- Approved — заявка одобрена одним из банков, покупателю остается подписать документы через СМС или на встрече с представителем банка
- Rejected — по заявке пришел отказ от одного из банков, вы можете связаться с покупателем и предложить альтернативные способы оплаты: банковской картой, наличными
- Canceled — заявка отменена, покупатель по какой-то причине отменил заказ. Покупатель может изменить состав заказа и заново отправить заявку в банк или выбрать другой способ оплаты
- Signed — договор подписан покупателем. Если заявка не охлаждается, то вы можете подтвердить заявку методом API Commit или в личном кабинете агента, а затем выдать товар покупателю или оказать услугу. В случае охлаждения вызов метода API Commit возможен только после его окончания. Время действия можно посмотреть в параметре вебхука Signed (где commit_cooldown.has_happened = true).
- Signed (где commit_cooldown.has_happened = true) - период охлаждения закончен. Вебхук отправится в случае, если по заявке действовал период охлаждения. При автокоммите вебхук отправится в случае, если заявка не была отменена клиентом. При отключенном автокоммите вы можете подтвердить заявку методом API Commit или в личном кабинете агента, а затем выдать товар покупателю или оказать услугу. Если клиент отменит заявку в период охлаждения, то будет отправлен вебхук Canceled.
Вебхуки с решениями Approved и Rejected приходят по каждому банку. Вебхук Rejected не означает, что по всей заявке пришел отказ. Стоит дождаться решения всех банков
Подлинность
Обязательно проверяйте подлинность полученных HTTP-нотификаций:
- Запросите состояние заявки через метод Info API. Это нужно также, чтобы получить актуальный статус заявки.
- Проверьте IP-адрес. Уведомления банка приходят с маски сети 91.194.226.00/23. IP-адрес первого хоста — 91.194.226.1 и IP-адрес последнего хоста — 91.194.227.254, хостов в сети 510
Структура. Параметры вебхука
| Описание | Параметр |
|---|---|
| id string(64), required | Номер заказа. Соответствует orderNumber |
| status enum, required | Тип вебхука: signed — заявка подписана. canceled — заявка отменена покупателем. rejected — заявка отклонена банком. approved — заявка одобрена банком |
| created_at string dateTime, required | Дата и время создания заявки |
| demo boolean, required | Флаг, является ли заявка тестовой |
| committed boolean, required | Флаг, является ли заявка подтвержденной |
| first_payment number double | Первоначальный взнос |
| order_amount number double, required | Сумма заказа |
| credit_amount number double | Сумма выдаваемого покупателю кредита |
| transfer_amount number double | Сумма для перевода партнеру |
| product enum | Тип продукта: кредит — credit. рассрочка — installment_credit |
| term integer int32 | Срок кредита в месяцах |
| monthly_payment number double | Ежемесячный платеж |
| first_name string | Имя покупателя |
| last_name string | Фамилия покупателя |
| middle_name string | Отчетсво покупателя |
| phone string | Телефон покупателя |
| loan_number string | Номер кредитного договора |
| email string | E-mail покупателя |
| appropriate_signing_types string[], required | Доступные покупателю способы подписания: bank — подписание на встрече. sms — подписание через СМС для повторных клиентов банка. ses — подписание по Self id |
| signing_type string | Актуальный способ подписания заявки. Входит в appropriate_signing_types |
| chosen_bank string | Банк, выдавший кредит. ОТП Банк, Т-Банк или МТС Банк |
| expected_overdue_at string dateTime, required | Дата и время окончания срока действия заявки |
| items Item[] | Состав заказа покупателя. Описано в таблице "Item" |
| commit_cooldown CommitCooldown | Информация о периоде охлаждения. Описано в таблице "CommitCooldown" |
Структура «Item»
| Описание | Параметр |
|---|---|
| name string(255), required | Название товарной позиции |
| quantity integer, required | Количество единиц товара указанной позиции |
| price number, required | Цена одной единицы товара |
Структура CommitCooldown (опциональное поле)
| Описание | Параметр |
|---|---|
| until string dateTime, required | Дата и время окончания периода охлаждения в ISO 8601 формате |
| has_happened boolean, required | Флаг окончания охлаждения: true - охлаждение закончилось, false - заявка охлаждается |
Пример
Клиентская информация в вебхуках в маскированном виде
- JSON
{
"id": "1234567890",
"status": "signed",
"created_at": "2022-11-10T09:03:48.780Z",
"demo": false,
"committed": false,
"first_payment": 0,
"order_amount": 100000,
"credit_amount": 100000,
"transfer_amount": 100000,
"product": "credit",
"term": 6,
"monthly_payment": 18155,
"first_name": "Петр",
"last_name": "И*****",
"middle_name": "В*********",
"phone": "+7912*****89",
"loan_number": "543147",
"email": "i****v@gmail.com",
"appropriate_signing_types": [
"bank",
"sms"
],
"signing_type": "sms",
"chosen_bank": "Т-Банк",
"expected_overdue_at": "2022-11-24T09:04:55.526449Z"
"items": [
{
"name": "Телефон",
"quantity": 1,
"price": 80000,
"category": "mobile",
"vendorCode": null
},
{
"name": "Наушники",
"quantity": 1,
"price": 20000
}
]
}
Ответ
После получения вебхука нужно отправить ответ. Ответ формата 2ХХ расценивается как удачно полученный вебхук. Если придет другой ответ — отправим вебхук повторно