Взаимодействие между POS-CREDIT и Партнером по сервису «Полная анкета»

Документация v3.0.0 от 26 декабря 2018 г.

Общее описание:

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

Формат взаимодействия:

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

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

Кредитный калькулятор

Получение справочных данных

Перед тем, как отправить запрос на расчет параметров по кредиту, необходимо запросить данные по доступным банкам и кредитным продуктам по желаемым условиям/параметрам кредитования.

Исходящий запрос на получение справочника

Параметр Обязательность Тип данных Описание Справочник или комментарий
CalculatorBookOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
goodsAmount да FLOAT Сумма всех товаров
firstAmount да FLOAT Первоначальный взнос
creditTerm да INT Срок кредита в месяцах
creditType да INT Тип оформления заявки 1 - кредит
2 - рассрочка
tradeID нет INT Код торговой точки

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

Параметр Тип данных Комментарий
CalculatorBookOptyResponse   — Блок данных ответа
selectedBanks ARRAY Список подключенных банков
—  selectedBank ARRAY Информация по конкретному банку
—  id INT ID банка в системе
—  value VARCHAR Наименование банка
—  creditProducts ARRAY Список подключенных кредитных продуктов по банку
—  creditProduct ARRAY Параметры конкретного продукта
—  id INT ID продукта в системе
—  value VARCHAR Наименование продукта
—  termFrom VARCHAR Срок кредита в месяцах от...
Пример различных вариантов:
6
6, 8, 10, 12
—  termTo VARCHAR Срок кредита в месяцах до
Пример различных вариантов:
12
({termFrom} - )12, 14, 24, 36
Может отсутствовать
—  amountFrom VARCHAR Сумма кредита от
Пример различных вариантов:
3000
—  amountTo VARCHAR Сумма кредита до
Пример различных вариантов:
250000
({amountFrom} - )100000, 150000 - 250000
—  firstPaymentFrom VARCHAR Первоначальный взнос от
Пример различных вариантов:
0
0, 10, 20, 30, 40, 50
—  firstPaymentTo VARCHAR Первоначальный взнос до
Пример различных вариантов:
90
({firstPaymentFrom} - )50, 60, 70
Может отсутствовать
—  creditRate FLOAT Ставка по кредиту в процентах

Получение параметров по кредиту

Сервис является необязательным для использования. Он выполняет функции расчета суммы кредита, суммы платежей, ежемесячного платежа, суммы удорожания товара и помогает посчитать, какую сумму кредита необходимо передавать в банк при использование рассрочки.

Исходящий запрос на расчет

Параметр Обязательность Тип данных Описание Справочник или комментарий
CalculatorOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
goodsAmount да FLOAT Сумма всех товаров
firstAmount да FLOAT Первоначальный взнос
creditTerm да INT Срок кредита в месяцах
creditType да INT Тип оформления заявки 1 - кредит
2 - рассрочка
selectedBanks да ARRAY Выбранные банки для расчета
—  selectedBank да ARRAY Информация по конкретному банку
—  id да INT ID выбранного банка
—  productID да INT ID выбранного кредитного продукта
selectedServices нет ARRAY Список дополнительных услуг
—  service нет INT Выбранный пакет дополнительной услуги 1 - сервис СМС-информирования
2 - страхование от несчастных случаев и потери жизни
3 - страхование от потери работы

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

Параметр Тип данных Комментарий
CalculatorOptyResponse   — Блок данных ответа
selectedBanks ARRAY Список параметров по каждому банку
—  selectedBank ARRAY Информация по конкретному банку
—  id INT ID банка в системе
—  creditAmount FLOAT Сумма кредита
—  creditPayment FLOAT Сумма платежей по кредиту
—  monthlyAmount FLOAT Ежемесячный платеж
—  goodsMorePayment FLOAT Сумма удорожания товара
—  firstPayment FLOAT Первоначальный взнос
—  creditTerm INT Срок кредита в месяцах
—  creditRate FLOAT Ставка по кредиту в процентах
—  creditPercentSale FLOAT Скидка (при рассрочке) по кредиту в процентах

Список подключенных продуктов

Исходящий запрос на получение справочника

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

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

Параметр Тип данных Комментарий
ConnectedProductsListResponse   — Блок данных ответа
selectedBanks ARRAY Список подключенных банков
—  selectedBank ARRAY Информация по конкретному банку
—  id INT ID банка в системе
—  value VARCHAR Наименование банка
—  bik VARCHAR БИК банка
—  creditProducts ARRAY Список подключенных кредитных продуктов по банку
—  creditProduct ARRAY Параметры конкретного продукта
—  id INT ID продукта в системе
—  value VARCHAR Наименование продукта
—  type INT Тип продукта
1 - кредит, 2 - рассрочка, 3 - оба
—  term VARCHAR Доступный срок кредита в месяцах
Пример возможных вариантов:
6
6, 8, 10 - 12, 24
—  termFrom VARCHAR Срок кредита в месяцах от (минимальное значение)
—  termTo VARCHAR Срок кредита в месяцах до (максимальное значение)
—  amount VARCHAR Доступная сумма кредита
Пример возможных вариантов:
25000 - 99000
10000 - 30000, 60000 - 150000
—  amountFrom VARCHAR Сумма кредита от (минимальное значение)
—  amountTo VARCHAR Сумма кредита до (максимальное значение)
—  firstPayment VARCHAR Доступный первоначальный взнос в процентах
Пример возможных вариантов:
0 - 90
10, 20, 30, 40 - 50
—  firstPaymentFrom VARCHAR Первоначальный взнос от (минимальное значение)
—  firstPaymentTo VARCHAR Первоначальный взнос до (максимальное значение)
—  creditRate VARCHAR Ставка по кредиту в процентах
Если значение "Вариативная", то ставка зависит от условий, см. блок variableCreditRate
—  variableCreditRate ARRAY Ставка по кредиту в процентах в зависимости от условий
Блок заполняется, если creditRate = "Вариативная"
—  variant ARRAY Информация по доступным вариантам
—  type INT Тип варианта
1 - кредит, 2 - рассрочка, 3 - оба
—  amount ARRAY Блок информации варианта по стоимости товара
—  range ARRAY Информация варианта (диапазон) по стоимости товара
—  min FLOAT Минимальное значение стоимости товара
—  max FLOAT Максимальное значение стоимости товара
—  term ARRAY Блок информации варианта по сроку кредита
—  range ARRAY Информация варианта (диапазон) по сроку кредита
—  min FLOAT Минимальное значение срока кредита
—  max FLOAT Максимальное значение срока кредита
—  firstPayment ARRAY Блок информации варианта по первоначальному взносу
—  range ARRAY Информация варианта (диапазон) по первоначальному взносу
—  min FLOAT Минимальное значение первоначального взноса
—  max FLOAT Максимальное значение первоначального взноса
—  rate FLOAT Значение процентной ставки по данному варианту
—  creditRebate VARCHAR Ссудный процент (скидка)
Если значение "Вариативная", то скидка зависит от условий, см. блок variableCreditPercentSale
—  variableCreditPercentSale ARRAY Ссудный процент (скидка) в зависимости от условий
Блок заполняется, если creditRebate = "Вариативная"
—  variant ARRAY Информация по доступным вариантам
—  amount ARRAY Блок информации варианта по стоимости товара
—  range ARRAY Информация варианта (диапазон) по стоимости товара
—  min FLOAT Минимальное значение стоимости товара
—  max FLOAT Максимальное значение стоимости товара
—  term ARRAY Блок информации варианта по сроку кредита
—  range ARRAY Информация варианта (диапазон) по сроку кредита
—  min FLOAT Минимальное значение срока кредита
—  max FLOAT Максимальное значение срока кредита
—  firstPayment ARRAY Блок информации варианта по первоначальному взносу
—  range ARRAY Информация варианта (диапазон) по первоначальному взносу
—  min FLOAT Минимальное значение первоначального взноса
—  max FLOAT Максимальное значение первоначального взноса
—  rebate FLOAT Значение скидки по данному варианту
—  accessGoodsCategory VARCHAR Ограничения по товарным категориям

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

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
CreateOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
selectedBanks да ARRAY Выбранные банки для расчета
—  bank да ARRAY Информация по конкретному банку
—  id да INT ID выбранного банка
—  productID да INT ID выбранного кредитного продукта
—  duration нет INT Срок кредита в месяцах
—  firstPayment нет FLOAT Первоначальный взнос клиента
selectedServices нет ARRAY Список дополнительных услуг
—  service нет ARRAY Блок дополнительной услуги
—  id нет INT Выбранный пакет дополнительной услуги 1 - сервис СМС-информирования
2 - страхование от несчастных случаев и потери жизни
3 - страхование от потери работы
21 - Финансовая защита от КапиталЛайф
22 - Финансовая защита+Потеря работы от КапиталЛайф
23 - Защита базис от КапиталЛайф
24 - Защита базис лайт от КапиталЛайф
31 - Страхование от несчастных случаев и болезней «ПОСтупай здорово!» от Д2 страхование
32 - Страхование цифровой и бытовой техники «Гарант-Мастер» от Д2 страхование
41 - Страхование жизни от Ренессанс Лайф
42 - Страхование потери работы от Ренессанс Лайф
43 - Ритейл Фикс 1 от Ренессанс Лайф
44 - Ритейл Фикс 2 от Ренессанс Лайф
45 - Ритейл Max Промо от Ренессанс Лайф
51 - Страхование жизни от ВСК
52 - Страхование жизни и потери работы от ВСК
53 - Техника в безопасности от ВСК
54 - Срок службы плюс от ВСК
55 - Сверх возможности от ВСК
firstPayment да FLOAT Первоначальный взнос клиента Может быть как целым числом, так и числом с фиксированной точкой.
duration да INT Срок кредита в месяцах
lastName да VARCHAR Фамилия клиента
firstName да VARCHAR Имя клиента
surName да VARCHAR Отчество клиента
nameChanged да INT Менялась ли Фамилия? 0 - не менялась
1 - менялась
nameChangedOld да VARCHAR Прежняя фамилия Если nameChanged = 0, то передаем пустой параметр
Если nameChanged = 1, то заполняем значением старой Фамилии клиента.
sex да INT Пол клиента 1 - мужской
2 - женский
birthPlace да VARCHAR Место рождения
birthDate да DATETIME Дата рождения Формат ДД.ММ.ГГГГ
educationID да INT Код Образования
familyStatus да INT Семейное положение
childrens да INT Количество детей
dependents да INT Количество иждивенцев Целое число до 6
0 - нет иждевенцев.
spouce ARRAY Блок данных с параметрами о супруге Обязательно к заполнению, если значение "familyStatus" равно 1 или 5
—  lastName да VARCHAR Фамилия супруга
—  firstName да VARCHAR Имя супруга
—  surName да VARCHAR Отчество супруга
—  occupation да VARCHAR Род занятий супруга
—  workName да VARCHAR Место работы супруга
—  birthDate да DATETIME Дата рождения супруга Формат ДД.ММ.ГГГГ
docSerial да VARCHAR Серия паспорта клиента
docNumber да VARCHAR Номер паспорта клиента
docIssuirer да VARCHAR Кем выдан паспорт
docDate да DATETIME Дата выдачи паспорта Формат ДД.ММ.ГГГГ
docCode да VARCHAR Код подразделения Формат XXX-XXX
workPhoneОбязателен к заполнению, если не заполнен Домашний телефон. да/нет - если пенсионер VARCHAR Рабочий телефон Номер телефона должен состоять из 10 символов и быть уникальным.
Если номер телефона не заполнен, опускаем параметр.
homePhoneОбязателен к заполнению, если не заполнен Рабочий телефон. да VARCHAR Домашний телефон Номер телефона должен состоять из 10 символов и быть уникальным.
Если номер телефона не заполнен, опускаем параметр
mobilePhone да VARCHAR Мобильный телефон Номер телефона должен состоять из 10 символов и быть уникальным.
contactPerson да ARRAY Блок данных с параметрами о контактном лице
—  lastName да VARCHAR Фамилия контактного лица
—  firstName да VARCHAR Имя контактного лица
—  surName да VARCHAR Отчество контактного лица
—  mobilePhone да VARCHAR Номер мобильного телефона контактного лица Номер телефона должен состоять из 10 символов и быть уникальным.
email нет VARCHAR Адрес электронной почты
regAddress да ARRAY Блок данных с параметрами об адресе регистрации клиента
—  index да VARCHAR Индекс адреса регистрации
—  city да VARCHAR Регион/Город/Населенный пункт Значение из КЛАДР по городам
Состоит из 13 цифр.
Пример: "7700000000000" - это значение для г. Москва,
"5000001900000" - для г. Фрязино Московской области
—  street да VARCHAR Улица Полное начение из КЛАДР по улицам
Состоит из 17 цифр.
Пример: "50000019000007000" - это значение для ул. Ленина
—  house да VARCHAR Дом Текстовое наименование дома
—  housing VARCHAR Корпус
—  flat VARCHAR Квартира
—  date да DATETIME Дата регистрации Формат ДД.ММ.ГГГГ
—  status да INT Статус недвижимости
postMatch да INT Фактический адрес совпадает с адресом регистрации? 0 - нет, отличается
1 - да, совпадает
Если равно "1", то блок данных "postAddress" не передаем
postAddress ARRAY Блок данных с параметрами об адресе проживания клиента (фактический адрес)
—  index да VARCHAR Индекс адреса регистрации
—  city да VARCHAR Регион/Город/Населенный пункт Значение из КЛАДР по городам
Состоит из 13 цифр.
Пример: "7700000000000" - это значение для г. Москва,
"5000001900000" - для г. Фрязино Московской области
—  street да VARCHAR Улица Полное начение из КЛАДР по улицам
Состоит из 17 цифр.
Пример: "50000019000007000" - это значение для ул. Ленина
—  house да VARCHAR Дом Текстовое наименование дома
—  housing VARCHAR Корпус
—  flat VARCHAR Квартира
—  period да INT Срок проживания в мес.
pensioner INT Признак пенсионер Клиент является пенсионером?
1 - да, 0 - нет
workType да/нет - если пенсионер INT Организационно-правовая форма организации-работодателя
workName да/нет - если пенсионер VARCHAR Название организации
workBranch да/нет - если пенсионер INT Отраслевая принадлежность организации
workType1 да/нет - если пенсионер INT Тип организации: государственная/негосударственная
workType2 да/нет - если пенсионер INT Тип организации: коммерческая/некоммерческая
workType3 да/нет - если пенсионер INT Тип организации: с иностр. капиталом/без иностр. капитала
workField да/нет - если пенсионер INT Направление Вашей деятельности
workPosition да/нет - если пенсионер INT Должность
workFieldTime да/нет - если пенсионер INT Время работы на данном направлении
workTime да/нет - если пенсионер INT Время работы в данной организации
workAddress да/нет - если пенсионер ARRAY Блок данных с параметрами о рабочем адресе (адрес места работы)
—  index да/нет - если пенсионер VARCHAR Индекс адреса регистрации
—  city да/нет - если пенсионер VARCHAR Регион/Город/Населенный пункт Значение из КЛАДР по городам
Состоит из 13 цифр.
Пример: "7700000000000" - это значение для г. Москва,
"5000001900000" - для г. Фрязино Московской области
—  street да/нет - если пенсионер VARCHAR Улица Полное начение из КЛАДР по улицам
Состоит из 17 цифр.
Пример: "50000019000007000" - это значение для ул. Ленина
—  house да/нет - если пенсионер VARCHAR Дом Текстовое наименование дома
—  housing VARCHAR Корпус
—  flat VARCHAR Квартира/Офис
additionalDoc INT Дополнительный документ
additionalDocName VARCHAR Реквизиты доп. документа Если параметр "additional_doc" равен 0 или не заполнен, то передаем пустой тег
isHome да INT Собственность - Индивидуальный дом для постоянного проживания 0 - нет, 1 - да
isFlat да INT Собственность - Квартира в многоквартирном доме 0 - нет, 1 - да
isVilla да INT Собственность - Земельный участок со строением (дача, деревенский дом...) 0 - нет, 1 - да
isEstate да INT Собственность - Земельный участок без строений 0 - нет, 1 - да
isGarage да INT Собственность - Гараж 0 - нет, 1 - да
isVehicle да INT Собственность - Автомобиль 0 - нет, 1 - да
Если указано "1", то блок данных "carProperty" обязателен для заполнения
carProperty нет ARRAY Блок данных с параметрами об автомобиле
—  brand VARCHAR Марка автомобиля
—  model VARCHAR Модель автомобиля
—  year INT Год выпуска автомобиля
—  country VARCHAR Страна-производитель автомобиля
—  number VARCHAR Номерной знак
—  source VARCHAR Способ приобретения автомобиля
priceMonth да FLOAT Среднемесячный доход
otherIncome да FLOAT Дополнительный доход
priceFamily да FLOAT Доход семьи
isSalary да INT Флаг дохода - Зарплата 0 - нет, 1 - да
isBusiness да INT Флаг дохода - Собственный бизнес 0 - нет, 1 - да
isRent да INT Флаг дохода - Собственность/Рента 0 - нет, 1 - да
isStudent да INT Флаг дохода - студент 0 - нет, 1 - да
isPension да INT Флаг дохода - Пенсия/Пособие 0 - нет, 1 - да
isOtherPrice да INT Флаг дохода - Иное 0 - нет, 1 - да
codeWord да VARCHAR Девичья фамилия матери Минимум 5 кириллических символов
goodsProperty да ARRAY Блок данных с параметрами о приобретаемых товарах
—  good да ARRAY Блок данных конкретного товара Обязательно должен быть заполнен хотя бы один блок
—  id да INT ID наименования товара Значение берется из справочника
—  model да VARCHAR Модель товара
—  brand да VARCHAR Бренд товара
—  price да FLOAT Стоимость товара
photo VARCHAR Фотография клиента JPG-изображение в Base64
Рекомендуемое разрешение изображения 640*480
passport_main VARCHAR паспорт (главная страница) JPG-изображение в Base64
Рекомендуемое разрешение изображения 640*480
passport_reg VARCHAR паспорт (регистрация) JPG-изображение в Base64
Рекомендуемое разрешение изображения 640*480
orderID VARCHAR Номер заказа в магазине
tradeID INT ID торговой точки, на которую оформляется кредит
calculatorType INT Тип расчета по заявке 1 — кредит
2 — рассрочка

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

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

Проверка статуса заявки

Обновление статуса заявки

Запрос на получение информации о статусе следует передавать не чаще одного раза в 30 секунд по конкретной заявке.

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

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

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

Параметр Тип данных Комментарий
StatusOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
results ARRAY Блок данных результата по банкам
—  result ARRAY Блок данных конкретного банка
—  bank INT ID банка в системе
—  decision INT Решение по заявке
-1 — в обработке, 0 — отказано, 1 — одобрено, 2 — ошибка
—  selectedVariant INT Код варианта выбранного предложения по кредиту
Передается значение, когда имеется на выбор несколько предложенных вариантов по кредиту
—  authStatus INT Статус авторизации договора
0 — не авторизован, 1 — договор авторизован
—  contractNumber VARCHAR Номер кредитного договора
—  authCode VARCHAR Код авторизации
—  requestCancel INT Статус отмены заявки
0 — нет, 1 — заявка отменена
—  authCancel INT Статус отмены авторизации
0 — нет, 1 — авторизация договора отменена
—  offer ARRAY Блок предложенных вариантов по кредиту
—  variantID INT Вариант предложения
Передается значение, когда имеется на выбор несколько предложенных вариантов по кредиту
—  product VARCHAR Название кредитного продукта
—  amount FLOAT Сумма одобренного кредита
—  terms INT Срок кредита в мес.
—  firstPayment FLOAT Первоначальный взнос
—  monthlyAmount FLOAT Ежемесячный платеж
—  insuranceAmount FLOAT Сумма страховой премии
—  otherAmount FLOAT Сумма дополнительных продуктов
—  rate FLOAT Процентная ставка по кредиту
—  rebate FLOAT Скидка
—  insurances ARRAY Блок данных по страховым компаниям и по дополнительным услугам
—  insurance ARRAY Блок данных по одной услуге
—  name VARCHAR Системное наименование сервиса/услуги:
renlife — Страхование Ренессанс Жизнь
rgs — Страхование КапиталЛайф
d2 — D2 страхование
—  amount FLOAT Страховая премия / Стоимость услуги
—  contract VARCHAR Номер договора/заявления/полиса
—  product VARCHAR Наименование тарифа/продукта/акции
—  branchCode VARCHAR Используется для определенных партнеров по требованию
Код торговой точки в банке
—  authUserCode VARCHAR Код пользователя, который произвел авторизацию договора
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Проверка статуса заявки для Интернет-магазина

Обновление статуса заявки

Данный запрос можно вызвать для получения решения по заявке, отправленной через скрипт с интернет-магазина.
Запрос на получение информации о статусе следует передавать не чаще одного раза в 30 секунд по конкретной заявке.

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

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

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

Параметр Тип данных Комментарий
StatusSelectedOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
orderID VARCHAR Идентификатор заказа на стороне интернет-магазина
clientName VARCHAR ФИО клиента
clientPhone VARCHAR Номер телефона клиента
birthDate VARCHAR Дата рождения клиента вида дд.мм.гггг
status INT Решение по заявке:
0 - новая заявка;
1 - в обработке;
2 - в кредите отказано;
3 - кредит предоставлен;
4 - ошибочный ввод;
5 - отказ клиента;
6 - договор авторизован;
7 - договор подписан клиентом;
bank INT Выбранный банк:
1 - ОТП Банк;
2 - Банк Ренессанс Кредит;
3 - Русфинанс Банк;
4 - Русский Стандарт Банк;
5 - Восточный Экспресс Банк;
6 - Альфа Банк;
7 - Почта Банк;
8 - Тинькофф Банк;
9 - Кредит Европа Банк;
10 - Сетелем Банк
bankName VARCHAR Название выбранного банка
product VARCHAR Наименование кредитного продукта по банку
productCode VARCHAR Код продукта в системе банка
amount FLOAT Сумма кредита в руб.
terms INT Срок кредита в месяцах
firstPayment FLOAT Первоначальный взнос в руб.
monthlyAmount FLOAT Ежемесячный платеж по кредиту в руб.
insuranceAmount FLOAT Сумма страховой премии в руб.
otherAmount FLOAT Сумма дополнительных услуг по банку в руб.
К примеру, сервис СМС-информирования
rate FLOAT Процентная ставка
percentSale FLOAT Скидка при рассрочке
authStatus INT Статус авторизации договора по кредиту:
0 - договор не авторизован;
1 - договор авторизован, товар можно выдавать клиенту
contractNumber VARCHAR Номер кредитного договора
authCode VARCHAR Код авторизации
delivery INT Статус подписания договора клиентом:
0 - договор не подписан;
1 - договор на подписание;
2 - договор подписан клиентом
date DATE Дата заведения заявки
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Все заяки за день

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

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

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

Параметр Тип данных Комментарий
StatusBlanksDayOptyResponse   — Блок данных ответа
blanks ARRAY Блок данных (список) по всем заявкам
—  blank ARRAY Блок данных конкретной заявки
—  profileID INT Идентификатор анкеты
—  statusID INT Решение по заявке:
0 - новая заявка;
1 - в обработке;
2 - в кредите отказано;
3 - кредит предоставлен;
4 - ошибочный ввод;
5 - отказ клиента;
6 - договор авторизован;
7 - договор подписан клиентом;
—  bankID INT Выбранный банк:
1 - ОТП Банк;
2 - Банк Ренессанс Кредит;
3 - Русфинанс Банк;
4 - Русский Стандарт Банк;
5 - Восточный Экспресс Банк;
6 - Альфа Банк;
7 - Лето Банк;
8 - Тинькофф Банк;
9 - Кредит Европа Банк;
10 - Сетелем Банк;
11 - Миг Кредит;
12 - МФО Квику;
13 - МТС Банк;
14 - Совесть
—  productName VARCHAR Наименование кредитного продукта по банку
—  amount FLOAT Сумма кредита в руб.
—  firstPayment FLOAT Первоначальный взнос в руб.
—  contractNumber VARCHAR Номер кредитного договора
—  lastName VARCHAR Фамилия клиента
—  firstName VARCHAR Имя клиента
—  surName VARCHAR Отчество клиента

Выбор предложения

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

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

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

Параметр Тип данных Комментарий
AcceptOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
success INT Успешно.
1 - да, 0 - нет
contract VARCHAR Кредитный договор PDF в Base64 Binary
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Авторизация договора

Замечание

Авторизовать договор возможно только текущим днем, когда заявка была отправлена в банк

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
AuthOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты
acceptBank да INT Заявку какого банка авторизуем
documents ARRAY Блок сканов документов для отправки Является обязательным для некоторых банков по согласованию
—  document ARRAY Блок одного скана документа для отправки
—  fileName VARCHAR Название файла
—  fileExt VARCHAR Расширение файла
—  fileType VARCHAR Код типа файла
—  fileData VARCHAR Файл в Base64 Binary

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

Параметр Тип данных Комментарий
AuthOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
success INT Успешно.
1 - да, 0 - нет
agreementNumber VARCHAR Номер договора
authCode VARCHAR Код авторизации
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Получение результата проверки сканов документов

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

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

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

Параметр Тип данных Комментарий
CheckScansOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
result INT Результат проверки
1 - успешно, 0 - проверяются, 2 - ошибка в документах, 3 - ошибка в договоре, 4 - договор аннулирован/отказ банка
documents ARRAY Блок сканов документов
—  document ARRAY Блок одного скана документа
—  fileType VARCHAR Код типа файла
—  response INT Статус проверки файла
1 - успешно проверен, 0 - проверяется, 2 - ошибка
—  reason VARCHAR Причина ошибки
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Получение списка необходимых скан-документов для отправки по заявке

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

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

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

Параметр Тип данных Комментарий
ListScansOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
documents ARRAY Блок необходимых документов
—  document ARRAY Блок одного необходимого документа
—  fileName VARCHAR Описание документа
—  fileType VARCHAR Код типа документа
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Отмена заявки

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

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

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

Параметр Тип данных Комментарий
CancelOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
success INT Успешно.
1 - да, 0 - нет
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Отмена авторизации

Замечание

Провести процедуру отмены авторизации возможно только текущим днем, когда заявка была авторизована в банке

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

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

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

Параметр Тип данных Комментарий
CancelAuthOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
success INT Успешно.
1 - да, 0 - нет
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Доставка договора

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
SignDeliveryOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
profileID да INT Идентификатор анкеты
deliveryType да INT Тип курьерской службы 1 - POS-CREDIT, 2 - Стриж
deliveryAddress да VARCHAR Адрес подписания договора В свободной форме
deliveryTime да INT Дата подписания договора Дата и время в формате UNIX time

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

Параметр Тип данных Комментарий
SignDeliveryOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
success INT Успешно.
1 - да, 0 - нет
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Проверка подписания договора

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

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

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

Параметр Тип данных Комментарий
SignCheckOptyResponse   — Блок данных ответа
profileID INT Идентификатор анкеты
deliveryType INT Тип курьерской службы, выполняющий подписание договора
deliveryAddress VARCHAR Адрес подписания договора
deliveryTime INT Дата и время подписания в формате UNIX time
status VARCHAR Текущий статус подписания договора в свободной форме
mobilePhone VARCHAR Номер мобильного телефона курьера
carNumber VARCHAR Гос. номер автомобиля
clientPhoto VARCHAR Фотография клиента JPG в Base64 Binery
clientScans ARRAY Блок данных со сканами документов
—  scan ARRAY Информация по конкретному документу
—  format VARCHAR Формат документа (расширение файла)
—  file VARCHAR Скан документа в Base64 Binary
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Создание черновика

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
CreateDraftOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
firstPayment да FLOAT Первоначальный взнос клиента Может быть как целым числом, так и числом с фиксированной точкой.
period нет INT Срок кредита в месяцах
lastName да VARCHAR Фамилия клиента
firstName да VARCHAR Имя клиента
surName да VARCHAR Отчество клиента
mobilePhone да VARCHAR Мобильный телефон Номер телефона должен состоять из 10 символов и быть уникальным.
docSerial да VARCHAR Серия паспорта клиента
docNumber да VARCHAR Номер паспорта клиента
birthDate да DATETIME Дата рождения Формат ДД.ММ.ГГГГ
tradeID да INT ID торговой точки, на которую оформляется кредит
orderID Нет VARCHAR Номер заказа в магазине
creditType нет INT тип заявки: 1 - Кредит, 2 - рассрочка
scanReceipt нет VARCHAR Скан чека, base64
creditOptionsProducts нет VARCHAR Список ID продуктов банка через запятую Пример: 3131,1000,2525
creditOptionsPromo нет VARCHAR Список OFL кодов через запятую Пример: OFL0012,OFL0024,OFL006
goods да ARRAY Блок данных с параметрами о приобретаемых товарах
—  good да ARRAY Блок данных конкретного товара Обязательно должен быть заполнен хотя бы один блок
—  name да VARCHAR наименование товара Значение берется из справочника
—  model да VARCHAR Модель товара
—  brand нет VARCHAR Бренд товара
—  price да FLOAT Стоимость товара
—  barcode нет VARCHAR штрихкод
—  discount нет FLOAT Скидка в %
Пример: 11
selectedServices нет ARRAY Список дополнительных услуг
—  service нет ARRAY Блок дополнительной услуги
—  id нет INT Выбранный пакет дополнительной услуги 1 - сервис СМС-информирования
2 - страхование от несчастных случаев и потери жизни
3 - страхование от потери работы
21 - Финансовая защита от КапиталЛайф
22 - Финансовая защита+Потеря работы от КапиталЛайф
23 - Защита базис от КапиталЛайф
24 - Защита базис лайт от КапиталЛайф
31 - Страхование от несчастных случаев и болезней «ПОСтупай здорово!» от Д2 страхование
32 - Страхование цифровой и бытовой техники «Гарант-Мастер» от Д2 страхование
41 - Страхование жизни от Ренессанс Лайф
42 - Страхование потери работы от Ренессанс Лайф
43 - Ритейл Фикс 1 от Ренессанс Лайф
44 - Ритейл Фикс 2 от Ренессанс Лайф
45 - Ритейл Max Промо от Ренессанс Лайф
51 - Страхование жизни от ВСК
52 - Страхование жизни и потери работы от ВСК
53 - Техника в безопасности от ВСК
54 - Срок службы плюс от ВСК
55 - Сверх возможности от ВСК

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

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

Получение доступа для клиента к системе самооформления в виде QR-кода

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
WinAccessOptyRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
mobilePhone да VARCHAR Мобильный телефон клиента Номер телефона должен состоять из 10 символов и быть уникальным.
tradeID да INT ID торговой точки, на которую оформляется кредит
getQrCode да INT Признак получения QR-кода Необходимо передать значение 1 для получения QR-кода
goods да ARRAY Блок данных с параметрами о приобретаемых товарах
—  good да ARRAY Блок данных конкретного товара Обязательно должен быть заполнен хотя бы один блок
—  name да INT Наименование товара Значение берется из справочника
—  model да VARCHAR Модель товара
—  brand да VARCHAR Бренд товара
—  price да FLOAT Стоимость товара

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

Параметр Тип данных Комментарий
WinAccessOptyResponse   — Блок данных ответа
success BOOLEAN Признак успешности запроса
qrCode VARCHAR Закодированное изображение QR-кода в формате base64. Присутствует только при успешном запросе
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Возврат/обмен

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
CorrectionRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
blankID да INT Код заявки
amount нет DOUBLE используется в случае type = 2
type да INT 1 - полный возврат, 2 - частичный возврат

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

Параметр Тип данных Комментарий
CorrectionResponse   — Блок данных ответа
success BOOLEAN Признак успешности запроса
uri VARCHAR
goods ARRAY Блок данных с параметрами о приобретаемых товарах
—  good ARRAY Блок данных конкретного товара
—  id INT Модель товара
—  category VARCHAR Модель товара
—  name INT Наименование товара
—  model VARCHAR Модель товара
—  brand VARCHAR Бренд товара
—  price FLOAT Стоимость товара
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Возврат/обмен

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
CorrectionGoodsRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
blankID да INT Код заявки
amount нет DOUBLE используется в случае type = 2
type да INT 1 - полный возврат, 2 - частичный возврат
goods да ARRAY Блок данных с параметрами о приобретаемых товарах
—  good да ARRAY Блок данных конкретного товара
—  id да INT Модель товара
—  category да VARCHAR Модель товара
—  name да INT Наименование товара Значение берется из справочника
—  model да VARCHAR Модель товара
—  brand да VARCHAR Бренд товара
—  price да FLOAT Стоимость товара

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

Параметр Тип данных Комментарий
CorrectionResponse   — Блок данных ответа
success BOOLEAN Признак успешности запроса
uri VARCHAR
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки

Возврат/обмен

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

Параметр Обязательность Тип данных Описание Справочник или комментарий
CorrectionConfirmRequest да   — Блок данных запроса
userID да INT Код партнера Значения предоставляются по запросу
userToken да VARCHAR Хэш-пароль партнера Значения предоставляются по запросу
blankID да INT Код заявки
amount нет DOUBLE используется в случае type = 2
type да INT 1 - полный возврат, 2 - частичный возврат

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

Параметр Тип данных Комментарий
CorrectionResponse   — Блок данных ответа
success BOOLEAN Признак успешности запроса
error ARRAY Блок данных об ошибке.
Параметр может отсутствовать, если ошибок не возникло.
—  code INT Код ошибки
—  description VARCHAR Текстовое описание ошибки