Документация v2.8 от 12 июля 2018 г.


Общее описание:
Межсистемный шлюз представляет из себя WEB-сервер, принимающий запросы только с разрешенных IP-адресов.
Каждый партнер, подключаемый к системе, должен получить уникальный код партнера, хеш-пароль и список сервисов, доступных ему для вызова.

Формат взаимодействия:
Обмен данными осуществляется по протоколу SOAP/HTTPS.
SOAP-пакеты должны соответствовать предоставленному WSDL-интерфейсу.

WSDL-интерфейс доступен по адресу: https://api.b2pos.ru/loan/wsdl.php


Сохранение заявки на кредит

Исходящий запрос

Название тега Обязательность Тип данных Описание тега Справочник или комментарий
SendShortOptyRequest да   — Блок данных заявки
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
lastName да VARCHAR Фамилия клиента   —
firstName да VARCHAR Имя клиента   —
surName да VARCHAR Отчество клиента   —
mobilePhone да VARCHAR Номер мобильного телефона клиента 10 цифр без остальных символов
Пример: "9259876543"
comment TEXT Комментарий по заявке Дополнительная информация или пожелания клиента
firstPayment FLOAT Первоначальный взнос клиента
passport VARCHAR Серия и номер паспорта РФ Должно содержать 4 цифры серии и 6 цифр номера паспорта через пробел
Пример: "XXXX YYYYYY"
period INT Срок кредита в месяцах
requestID VARCHAR ID заявки в вашей системе (в системе интернет-магазина) Для удобной идентификации заявки в кабинете
tradeID INT ID торговой точки Для нескольких компаний при работе с одной системы API.
Список ТТ по запросу
creditCondition INT Условия оформления кредита 0 — кредит; 1 — рассрочка
goodParams да   — Блок данных о приобретаемых товарах   —
[goodParams] article да   — Блок данных одного товара Обязательно должен быть заполнен один "article"
[goodParams] [article] goodName да VARCHAR Наименование товара Наименование товара в произвольной форме
[goodParams] [article] goodPrice да FLOAT Стоимость   —
[goodParams] [article] goodModel да VARCHAR Модель   —
[goodParams] [article] goodBrand да VARCHAR Бренд   —

.

Пример запроса


.

Получение ответа

Имя поля Тип данных Комментарий
SendShortOptyResponse   — Блок данных заявки
profileID INT Идентификатор анкеты
error Блок данных об ошибке. Этот тег не обязателен и может отсутствовать, если ошибок не возникло.
code INT Код ошибки.
description VARCHAR Текстовое описание ошибки.

.

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

.

Загрузка файлов и документов по заявке

Исходящий запрос

Название тега Обязательность Тип данных Описание тега Справочник или комментарий
LoadFilesShortOptyRequest да   — Блок данных заявки
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты
documents да   — Блок данных о передаваемых файлах   —
[documents] document да   — Блок данных одного файла   —
[documents] [document] ext да VARCHAR Расширение файла Разрешены только значения jpg/jpeg/png/pdf
[documents] [document] type да VARCHAR Тип файла photo - фотография клиента;
passport_main - 2-3 страница паспорта;
passport_reg - страница паспорта с регистрацией;
document - остальные документы
[documents] [document] file да TEXT Файл в формате Base64 в виде строки   —

.

Пример запроса


.

Получение ответа

Имя поля Тип данных Комментарий
LoadFilesShortOptyResponse   — Блок данных заявки
profileID INT Идентификатор анкеты
result VARCHAR Решение по документам:
success - файлы успешно загружены;
failed - произошла ошибка при сохранение файлов на сервер
error Блок данных об ошибке. Этот тег не обязателен и может отсутствовать, если ошибок не возникло.
code INT Код ошибки.
description VARCHAR Текстовое описание ошибки.

.

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

.

Получение решения по заявке

Исходящий запрос

Название тега Обязательность Тип данных Описание тега Справочник или комментарий
StatusShortOptyRequest да   — Блок данных заявки
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты
isAdditionalFiles нет INT Запрос на получение блока дополнительных документов additionalFiles Если значение не передано, то дополнительные документы не возвращаются в ответ на запрос.
Если передано значение "1", то возвращаем в ответ список дополнительных документов

.

Пример запроса


.

Получение ответа

Имя поля Тип данных Комментарий
StatusShortOptyResponse   — Блок данных заявки
profileID INT Идентификатор анкеты
statusID INT Решение по заявке:
0 - новая заявка;
1 - в обработке;
2 - в кредите отказано;
3 - кредит предоставлен;
4 - ошибочный ввод;
5 - отказ клиента;
6 - договор авторизован;
7 - договор подписан клиентом;
answer TEXT Комментарий сотрудника Контакт-центра при обработке заявки
bankID INT Значение банка, в котором предоставлен кредит:
1 - ОТП Банк;
2 - Банк Ренессанс Кредит;
3 - Русфинанс Банк;
4 - Русский Стандарт Банк;
5 - Восточный Экспресс Банк;
6 - Альфа Банк;
7 - Лето Банк;
8 - Тинькофф Банк;
9 - Кредит Европа Банк;
10 - Сетелем Банк
document TEXT Если status=3, то передается кредитный договор (PDF-файл) в формате Base64 в виде строки
documentLink VARCHAR Если status=3, то дополнительно передается URL на кредитный договор
saleProcent FLOAT Процент скидки для клиента при рассрочке
firstPayment FLOAT Первоначальный взнос
contract VARCHAR Номер банковского договора
amount FLOAT Сумма кредита в рублях
paymentAmount FLOAT Сумма ежемесячного платежа
creditTerms INT Срок кредита в месяцах
accountNum VARCHAR Номер кредитного счета в банке
authCode VARCHAR Код авторизации по заявке. Является подтверждением успешной выдачи кредита.
productName VARCHAR Название кредитного продукта
productCode VARCHAR Банковский код продукта (идентификатор продукта в банке)
lastName VARCHAR Фамилия клиента
firstName VARCHAR Имя клиента
surName VARCHAR Отчество клиента
delay INT Признак "Заявка перенесена"
0 — заявка НЕ перенесена, 1 — заявка перенесена
delayComments Блок данных комментариев по заявке, если признак "Заявка перенесена" = 1
[delayComments] delayComment TEXT Комментарий сотрудника Контакт-центра при признаке "Заявка перенесена" = 1
transferPayment Блок данных по отправлению платежа за кредит от POS-CREDIT к Партнеру
[transferPayment] statusPayment VARCHAR Статуса перевода денег. Значения: approved (исполнен) / waiting (в ожидание) / bank (получите деньги от банка напрямую)
[transferPayment] datePayment VARCHAR Дата перевода платежа в формате dd.mm.yyyy
[transferPayment] numberPayment INT Номер платежного поручения
[transferPayment] codePayment VARCHAR Код проведения платежа
[transferPayment] amountPayment FLOAT Сумма кредита, которая была переведена Партнеру
insurances Блок данных по страховым компаниям и по дополнительным услугам
[insurances] insurance Блок данных по одной услуге
[insurances] [insurance] name VARCHAR Системное наименование сервиса/услуги:
renlife — Страхование Ренессанс Жизнь
rgs — Страхование КапиталЛайф
d2 — D2 страхование
[insurances] [insurance] amount FLOAT Страховая премия / Стоимость услуги
[insurances] [insurance] contract VARCHAR Номер договора/заявления/полиса
[insurances] [insurance] document TEXT Договор/Полис (PDF-файл) в формате Base64 в виде строки
[insurances] [insurance] product VARCHAR Наименование тарифа/продукта/акции
additionalFiles Блок данных по дополнительным документам/файлам по заявке
[additionalFiles] additionalFile Блок данных одного документа
[additionalFiles] [additionalFile] name VARCHAR Системное наименование файла:
personal — Анкета персональных данных
example — Образец подписания договора
remember — Памятка по оплате
barcode — Штрих-коды
qrcode — QR-код
specification — Спецификация товаров
[additionalFiles] [additionalFile] ext VARCHAR Расширение файла
[additionalFiles] [additionalFile] file TEXT Файл в формате Base64 в виде строки
error Блок данных об ошибке. Этот тег не обязателен и может отсутствовать, если ошибок не возникло.
code INT Код ошибки.
description VARCHAR Текстовое описание ошибки.

.

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

.

Отмена заявки / Ошибочный ввод

Исходящий запрос

Название тега Обязательность Тип данных Описание тега Справочник или комментарий
CancelShortOptyRequest да   — Блок данных заявки
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты

.

Пример запроса


.

Получение ответа

Имя поля Тип данных Комментарий
CancelShortOptyResponse   — Блок данных заявки
profileID INT Идентификатор анкеты
result VARCHAR Переведена ли заявка в ошибочный ввод:
success - успешная отмена заявки;
failed - произошла ошибка
error Блок данных об ошибке. Этот тег не обязателен и может отсутствовать, если ошибок не возникло.
code INT Код ошибки.
description VARCHAR Текстовое описание ошибки.

.

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

.

Подписание документов

Исходящий запрос

Название тега Обязательность Тип данных Описание тега Справочник или комментарий
SignDocShortOptyRequest да   — Блок данных заявки
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты
signStatus да INT Статус подписания документов 0 - документы не подписаны;
1 - документы успешно подписаны
documents да   — Блок данных о передаваемых документах   —
[documents] document да   — Блок данных одного файла   —
[documents] [document] ext да VARCHAR Расширение файла Разрешены только значения jpg/jpeg/png/pdf
[documents] [document] type да VARCHAR Тип файла scan - сканы документов;
photo - фотография клиента
[documents] [document] file да TEXT Файл в формате Base64 в виде строки   —

.

Пример запроса


.

Получение ответа

Имя поля Тип данных Комментарий
SignDocShortOptyResponse   — Блок данных заявки
profileID INT Идентификатор анкеты
result VARCHAR Решение по документам:
success - договор подписан, документы приняты;
waiting - договор подписан, ожидаем документы;
failed - договор не подписан, ошибочные документы
statusID INT Текущий статус заявки.
Список значений в блоке "Получение решения по заявке" - "Получение ответа"
error Блок данных об ошибке. Этот тег не обязателен и может отсутствовать, если ошибок не возникло.
code INT Код ошибки.
description VARCHAR Текстовое описание ошибки.

.

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

.