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

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

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
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 - страхование от потери работы
tradeID	нет	INT	Код торговой точки

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

Параметр	Тип данных	Комментарий
CalculatorOptyResponse	—	Блок данных ответа
selectedBanks	ARRAY	Список параметров по каждому банку
—  selectedBank	ARRAY	Информация по конкретному банку
—  id	INT	ID банка в системе
—  productID	INT	ID продукта
—  creditAmount	FLOAT	Сумма кредита
—  creditPayment	FLOAT	Сумма платежей по кредиту
—  monthlyAmount	FLOAT	Ежемесячный платеж
—  goodsMorePayment	FLOAT	Сумма удорожания товара
—  firstPayment	FLOAT	Первоначальный взнос
—  creditTerm	INT	Срок кредита в месяцах
—  creditRate	FLOAT	Ставка по кредиту в процентах
—  creditPercentSale	FLOAT	Скидка (при рассрочке) по кредиту в процентах
—  selectedServices	ARRAY	Список дополнительных услуг
—  service	ARRAY	Блок дополнительной услуги
—  id	INT	Выбранный пакет дополнительной услуги
—  price	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	Первоначальный взнос клиента
—  type		INT	Тип расчета по продукту	1 - кредит 2 - рассрочка
selectedServices		ARRAY	Список дополнительных услуг
—  service		ARRAY	Блок дополнительной услуги
—  id		INT	Выбранный пакет дополнительной услуги	1 — сервис СМС-информирования 2 — страхование от несчастных случаев и потери жизни 3 — страхование от потери работы 21 — Защита займа от КапиталЛайф 22 — Защита займа+ от КапиталЛайф 23 — Защита базис от КапиталЛайф 24 — Защита базис лайт от КапиталЛайф 31 — Страхование «ПОСтупай здорово!» от Д2 страхование 32 — Страхование «Гарант-Мастер» от Д2 страхование 41 — Страхование жизни_СЛП+И1,2ЛП+ВНТ от Ренессанс Лайф 42 — Страхование потери работы (для outside) от Ренессанс Лайф 43 — Ритейл Фикс 1 от Ренессанс Лайф 44 — Ритейл Фикс 2 от Ренессанс Лайф 45 — Ритейл Max Промо от Ренессанс Лайф 51 — Страхование жизни от ВСК 52 — Страхование жизни и потери работы от ВСК 53 — Техника в безопасности от ВСК 54 — Срок службы плюс от ВСК 55 — Сверх возможности от ВСК 77 — Сертификат НДФЛ-ка от НДФЛка 109 — Услуга "Комфорт+" от (не используется) АО «Группа Ренессанс Страхование» 185 — Комбо - Пакет 8 от Ренессанс Страхование 183 — Комбо - Пакет 10 от Ренессанс Страхование 177 — ПОСтупай здорово от Ренессанс Страхование 308 — Электронный сервис POSGUARD от Подписки Поскредит 385 — Финансовая защита от Подписки Поскредит
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	Код Образования	1 — Начальное или неполное среднее 2 — Среднее 3 — Среднее, в том числе специальное 4 — Неполное высшее 5 — Высшее 6 — 2 и более высших 7 — Ученая степень
familyStatus	да	INT	Семейное положение	1 — Женат/Замужем 2 — Холост/Не замужем 3 — Разведен(а) 4 — Вдовец/Вдова 5 — Гражданский брак
childrens		INT	Количество детей	1 — Нет 2 — 1 ребенок 3 — 2 ребенка 4 — 3 ребенка 5 — более 3-х
dependents		INT	Количество иждивенцев	Целое число до 6 0 - нет иждевенцев.
spouce		ARRAY	Блок данных с параметрами о супруге	Обязательно к заполнению, если значение "familyStatus" равно 1 или 5
—  lastName	да	VARCHAR	Фамилия супруга
—  firstName	да	VARCHAR	Имя супруга
—  surName	да	VARCHAR	Отчество супруга
—  occupation	да	VARCHAR	Род занятий супруга	RUNS_HIS_OWN_BUSINESS_FARMER — Индивидуальный предприниматель / Фермер SENIOR_MANAGEMENT — Руководитель высшего звена MIDDLE_MANAGEMENT — Руководитель среднего звена OFFICE_EMPLOYEE — Офисный работник SERVING_STAFF — Обслуживающий персонал (уборщица, домработница, няня и т.п.) GUARD_SECURITY_SERVICE — Сотрудник службы безопасности / охранная деятельность INDUSTRY_AGRICULTURE_BUILDER_DRIVER — Рабочий (промышленность/ с/х)/ Строитель/ Водитель MEDICINE_PERSONNEL — Младший медицинский персонал DOCTOR — Врач TEACHER — Учитель / Воспитатель ENGINEER — Инженер POLICEMAN_MILITARY_FIREMAN — Сотрудник МВД, ВС, МЧС, Пожарная охрана PUBLIC_EMPLOYEE — Работник государственных / муниципальных органов управления FIXED_TERM_WORK_CONTRACT_INTERIM — Временная занятость (временное трудовое соглашение) ART_WORKER — Творческий работник (художник, писатель, музыкант и т.п.) PROFESSOR_RESEARCHER — Преподаватель / Научный работник (НИИ, ВУЗ и т.д.) HOUSEWIFE — Домохозяйка STUDENT — Учащийся PENSIONER_RETIRED — Пенсионер / в отставке UNEMPLOYED — Безработный MISCELLANEOUS — Прочее LAWYER — Юрист TRADE_SERVICE_INDUSTRY — Работник торговли / сферы услуг
—  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	Статус недвижимости	174001 — Приобретенная собственность 174002 — Наем жилого помещения 174003 — Проживание у родственников/ знакомых 174004 — Приватизация/ муниципальная собственность 174005 — Иное
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	Квартира
pensioner		INT	Признак пенсионер	Клиент является пенсионером? 1 - да, 0 - нет
workType	да/нет - если пенсионер	INT	Организационно-правовая форма организации-работодателя	2 — ООО 6 — ОАО 7 — ЗАО 13 — ИП 147 — НАО 138 — АО 138 — ПАО 21 — Судебная инстанция 143 — НПФ 24 — АНОО 17 — МУЗ 14 — ЧП 15 — ФЛ-П 40 — ЖСК 39 — ДОАО 38 — ДЗР 37 — ГУ 36 — ГУП 26 — АНО 90 — ФИЛИАЛ ГУП 89 — ФИЛИАЛ 88 — ФУ 87 — ФКП 86 — ФГУ 85 — ФГУП 84 — ФБУ 83 — УЧРЕЖДЕНИЕ 82 — УП 81 — ТПП 80 — ТСЖ 77 — ТОВАРИЩЕСТВО НА ВЕРЕ 75 — СК 66 — ПО 64 — ПОЛНОЕ ТОВАРИЩЕСТВО 62 — ОНО 61 — ОДО 59 — ООД 58 — ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ 57 — ОБОСОБЛЕННОЕ ПОДРАЗДЕЛЕНИЕ ООО 56 — ОБОСОБЛЕННОЕ ПОДРАЗДЕЛЕНИЕ 55 — НЕКОММЕРЧЕСКОЕ ПАРТНЕРСТВО 54 — НЕКОММЕРЧЕСКАЯ ОРГАНИЗАЦИЯ 53 — МУ 52 — МУП 51 — МП 16 — АНО ДО 9 — НОУ 99 — Страховая компания 35 — ГПП 34 — ГП 33 — ГКП 32 — ГОНО 31 — ГУ ФСИН 18 — ГОУ ВПО 49 — МЕЖД. ЦЕНТР 47 — КФХ 44 — КЖХСЗ 43 — КОЛХОЗ 42 — КОЛЛ. АДВ. 3 — АОЗТ 5 — ПБОЮЛ 27 — АССОЦИАЦИЯ 98 — ЧУ 97 — ФОНД 95 — ФИЛИАЛ ФГУП 94 — ФИЛИАЛ ОАО 93 — ФИЛИАЛ ООО 91 — ФИЛИАЛ ЗАО 104 — КП 121 — ФОП 105 — ДП 122 — НЧОУ 125 — МДОУ 127 — НУДО 135 — ГБУЗ 136 — ЧОУДО 137 — АУ 141 — ЧУ ДПО 144 — АНО ДПО
workName	да/нет - если пенсионер	VARCHAR	Название организации
workBranch	да/нет - если пенсионер	INT	Отраслевая принадлежность организации	1 — Вооруженные силы 2 — Доб.промышленность(кроме ТЭК) 3 — Здравоохранение (госуд) 4 — Здравоохранение (коммерч) 5 — Издательская деятельность 6 — Информатика и телекоммуникации 7 — Коммун.хоз/Сфера услуг/Дорож.Сл 8 — Легкая и пищевая промышленность 9 — Машиностроение и металлообработка 10 — Наука и культура 11 — Образование (государственное) 12 — Образование (коммерческое) 13 — Общественное питание, в том числе предпр. быстрого 14 — Правоохранительные органы, таможня 15 — Реклама, PR агенства, СМИ 16 — Рестораны 17 — Салоны красоты и здоровья 18 — Сборочные производства (в т.ч. сборка мебели) 19 — Сельское хозяйство 20 — Строительство, производство стройматериалов 21 — Торговля оптовая, поср./риэлт. д 22 — Торговля розничная 23 — Транспорт и связь 24 — Туризм 25 — ТЭК 26 — Увеселит., игорный и шоу-бизнес 27 — Федер. и муниципальн. управление 28 — Финансы, банковское дело 29 — Химия, парфюмерия, фармацевтика 30 — Частн. детект. и/или охран. пред 31 — Юридические и нотариальн. услуги 32 — Иное
workType1	да/нет - если пенсионер	INT	Тип организации: государственная/негосударственная	1 — Государственное 2 — Негосударственное
workType2	да/нет - если пенсионер	INT	Тип организации: коммерческая/некоммерческая	1 — Коммерческое 2 — Некоммерческое
workType3	да/нет - если пенсионер	INT	Тип организации: с иностр. капиталом/без иностр. капитала	1 — С участием 2 — Без участия
workField	да/нет - если пенсионер	INT	Направление Вашей деятельности	1 — участие в основной деятельности 2 — бухгалтерия, финансы и планир-е 3 — прогр.-технич. обесп. и телекомм 4 — вспомогательный и техн. персонал 5 — реклама и маркетинг 6 — адм-хозяйствен. и трансп. служба 7 — снабжение и сбыт 8 — кадровая служба и секретариат 9 — юридическая служба 10 — служба безопасности
workPosition	да/нет - если пенсионер	INT	Должность	1 — Рук./ Зам. рук. организации 3 — Неруководящий работник 4 — Индивидуальный предприниматель 5 — Самозанятый
workFieldTime		INT	Время работы на данном направлении	1 — до 3-х лет 2 — 3-5 лет 3 — свыше 5 лет
workTime		INT	Время работы в данной организации	1 — до 1 года 2 — 1-3 лет 3 — свыше 3 лет
workAddress	да/нет - если пенсионер	ARRAY	Блок данных с параметрами о рабочем адресе (адрес места работы)
—  index	да/нет - если пенсионер	VARCHAR	Индекс адреса регистрации
—  city	да/нет - если пенсионер	VARCHAR	Регион/Город/Населенный пункт	Значение из КЛАДР по городам Состоит из 13 цифр. Пример: "7700000000000" - это значение для г. Москва, "5000001900000" - для г. Фрязино Московской области
—  street	да/нет - если пенсионер	VARCHAR	Улица	Полное начение из КЛАДР по улицам Состоит из 17 цифр. Пример: "50000019000007000" - это значение для ул. Ленина
—  house	да/нет - если пенсионер	VARCHAR	Дом	Текстовое наименование дома
—  housing		VARCHAR	Корпус
—  flat		VARCHAR	Квартира/Офис
additionalDoc		INT	Дополнительный документ	0 — Не предоставлен 1 — Карта Банка 2 — Действующий загранпаспорт 3 — Справка 2 НДФЛ 5 — Свид-во о рег. ТС 7 — Действ карта добрмедстрахования Клиента 8 — Налоговая декларация 10 — Авиабилет на имя клиента 11 — Посадочный талон на имя клиента 12 — Бонусная карта российской авиакомпании/№ участника 13 — Бонусная карта иностранной авиакомпании или Аэрофлот/№ участника 18 — Реестр сотрудников 26 — Пенсионное удостоверение для вклада Пенсионный 27 — Зачетная книжка студента 28 — Студенческий билет 29 — Паспорт Транспортного Средства 30 — Жилая недвижимость (Свидетельство о государственной регистрации права собственности) 31 — Водительское удостоверение 32 — Полис Обязательного медицинского страхования 34 — Страховое свидетельство обязательного пенсионного страхования 36 — Коммерческая недвижимость (Свидетельство о государственной регистрации права собственности) 37 — Земля(Свидетельство о государственной регистрации права собственности)
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	Способ приобретения автомобиля	PURCHASE_NEW_ONE — покупка у дилера PURCHASE_SECOND_HAND — покупка на вторичном рынке INHERITANCE — получение в дар/наследство
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	да	VARCHAR	Наименование товара	Значение берется из справочника
—  model	да	VARCHAR	Модель товара
—  brand	да	VARCHAR	Бренд товара
—  price	да	FLOAT	Стоимость товара
—  idGoodVendor		VARCHAR	Артикул товара
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 — рассрочка
deliveryType		VARCHAR	Тип доставки кредитного договора	1 — самовывоз 2 — курьер
oldProfileID		VARCHAR	Номер предыдущей заявки при дозаполнение	Передавать только после использования метода заведения заявки CreateAdditionalOpty

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

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

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

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

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

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

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

Параметр	Тип данных	Комментарий
StatusOptyResponse	—	Блок данных ответа
profileID	INT	Идентификатор анкеты
codeAgentMarket	VARCHAR	Код сотрудника в системе магазина
results	ARRAY	Блок данных результата по банкам
—  result	ARRAY	Блок данных конкретного банка
—  bank	INT	ID банка в системе
—  decision	INT	Решение по заявке: -1 — в обработке 0 — отказано 1 — одобрено 2 — ошибка 4 — требуется дозаполнение анкеты 5 — требуется корректировка данных или документов по заявке
—  error_text	VARCHAR	Текстовое описание ошибки при значении decision = 2
—  selectedVariant	INT	Код варианта выбранного предложения по кредиту Передается значение, когда имеется на выбор несколько предложенных вариантов по кредиту
—  authStatus	INT	Статус авторизации договора 0 — не авторизован, 1 — договор авторизован
—  contractNumber	VARCHAR	Номер кредитного договора
—  authCode	VARCHAR	Код авторизации
—  requestCancel	INT	Статус отмены заявки 0 — нет, 1 — заявка отменена
—  authCancel	INT	Статус отмены авторизации 0 — нет, 1 — авторизация договора отменена
—  increasedLimit	INT	Одобрен повышенный лимит 0 — нет, 1 — да
—  signType	INT	Доступен ли ПЭП по заявке и банку 0 — нет, 1 — доступен (повторный клиент), 2 — доступен (новый клиент)
—  signedType	INT	Выбранный тип подписания по заявке и банку 0 — бумажный, 1 — ПЭП; МТС: 0 — бумажный, 1 — ПЭП (повторный клиент), 2 — ПЭП (новый клиент)
—  signedTypeStatus	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	Код пользователя, который произвел авторизацию договора
—  isActiveSES	VARCHAR	Доступно ли ПЭП подписание (0 - нет, 1 - да)
—  isOldClientSES	VARCHAR	Является ли клиент повторным для банка (0 - нет, 1 - да)
error	ARRAY	Блок данных об ошибке. Параметр может отсутствовать, если ошибок не возникло.
—  code	INT	Код ошибки
—  description	VARCHAR	Текстовое описание ошибки

Проверка статуса заявки по выбранному банку

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

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

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

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

Параметр	Тип данных	Комментарий
StatusSelectedOptyResponse	—	Блок данных ответа
profileID	INT	Идентификатор анкеты
orderID	VARCHAR	Идентификатор заказа на стороне интернет-магазина
creditType	INT	Тип заявки: 0 - не определен; 1 - кредит; 2 - рассрочка; 3 - субсидированный;
clientName	VARCHAR	ФИО клиента
clientPhone	VARCHAR	Номер телефона клиента
birthDate	VARCHAR	Дата рождения клиента вида дд.мм.гггг
status	INT	Решение по заявке: 0 - новая заявка; 1 - в обработке; 2 - в кредите отказано; 3 - кредит предоставлен; 4 - ошибочный ввод; 5 - отказ клиента; 6 - договор авторизован; 7 - договор на проверке;
bank	INT	Выбранный банк: 1 - ОТП Банк; 2 - Банк Ренессанс Кредит; 4 - Русский Стандарт Банк; 6 - Альфа Банк; 7 - Почта Банк; 8 - Тинькофф Банк; 9 - Кредит Европа Банк; 11 - Миг Кредит; 12 - МФО Квику; 13 - МТС Банк; 27 - Совкомбанк
bankName	VARCHAR	Название выбранного банка
product	VARCHAR	Наименование кредитного продукта по банку
productCode	VARCHAR	Код продукта в системе банка
productBarcode	VARCHAR	Штрих код продукта
amount	FLOAT	Сумма для перечисления партнеру в руб.
creditAmount	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	Дата заведения заявки
authUserCode	VARCHAR	Код пользователя, который произвел авторизацию договора
sesType	VARCHAR	Блок данных о методе подписания договора.
insurances	ARRAY	Блок данных (список) по всем страховым компаниям
—  insurance	ARRAY	Блок данных конкретной страховой компании
—  name	VARCHAR	Название страховой компании
—  contract	VARCHAR	Номер договора
—  product	VARCHAR	Код продукта
—  premiumAmount	FLOAT	Страховая премия в руб.
—  insuranceAmount	FLOAT	Страховая сумма в руб.
—  productID	INT	ID продукта
—  goodID	INT	ID товара
—  productName	VARCHAR	Наименование тарифа/продукта/акции
goods	ARRAY	Блок данных (список) по товарам
—  good	ARRAY	Блок данных конкретного товара
—  brand	VARCHAR	бренд товара
—  model	VARCHAR	модель товара
—  price	FLOAT	цена товара
fullNameEmployee	VARCHAR	ФИО сотрудника, оформившего кредит
bankAgent	VARCHAR	Банк, сотрудником которого является пользователь
tradeFullName	VARCHAR	Название ТТ (Филиал оформления)
tradeAdditionalName	VARCHAR	Дополнительное название ТТ
codeAgentMarket	VARCHAR	Код сотрудника в системе магазина
idClient	INT	ID клиента (наш ID)
salesChannel	VARCHAR	Канал продаж
isLife	INT	Страхование жизни
isWork	INT	Страхование от потери работы
tradeId	INT	Код ТТ
numberBranch	INT	Признак филиала: 0 - банк без филиала; 1 - филиал банка / МКК / МФО;
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 - Банк Ренессанс Кредит; 4 - Русский Стандарт Банк; 6 - Альфа Банк; 7 - Лето Банк; 8 - Тинькофф Банк; 9 - Кредит Европа Банк; 11 - Миг Кредит; 12 - МФО Квику; 13 - МТС Банк; 27 - Совкомбанк
—  productName	VARCHAR	Наименование кредитного продукта по банку
—  productBarcode	VARCHAR	Штрих код продукта
—  amount	FLOAT	Сумма кредита в руб.
—  firstPayment	FLOAT	Первоначальный взнос в руб.
—  contractNumber	VARCHAR	Номер кредитного договора
—  lastName	VARCHAR	Фамилия клиента
—  firstName	VARCHAR	Имя клиента
—  surName	VARCHAR	Отчество клиента
—  goods	ARRAY	Блок данных (список) по товарам
—  good	ARRAY	Блок данных конкретного товара
—  brand	VARCHAR	бренд товара
—  model	VARCHAR	модель товара
—  price	FLOAT	цена товара
—  tradeFullName	VARCHAR	Название ТТ (Филиал оформления)
—  fullNameEmployee	VARCHAR	ФИО оформителя
—  orderID	VARCHAR	Идентификатор заказа на стороне интернет-магазина
—  fullNameEmployee	VARCHAR	ФИО сотрудника, оформившего кредит
—  date	DATE	Дата заведения заявки
—  insurances	ARRAY	Блок данных (список) по всем страховым компаниям
—  insurance	ARRAY	Блок данных конкретной страховой компании
—  name	VARCHAR	Название страховой компании
—  contract	VARCHAR	Номер договора
—  product	VARCHAR	Код продукта
—  premiumAmount	FLOAT	Страховая премия в руб.
—  insuranceAmount	FLOAT	Страховая сумма в руб.
—  productID	INT	ID продукта
—  goodID	INT	ID товара
—  otherAmount	FLOAT	Сумма дополнительных услуг по банку в руб. К примеру, сервис СМС-информирования
—  tradeId	INT	Код ТТ
—  creditType	INT	Тип заявки: 0 - не определен; 1 - кредит; 2 - рассрочка; 3 - субсидированный;
—  codeAgentMarket	VARCHAR	Идентификатор сотрудника, (Код сотрудника в системе магазина)
—  authUserCode	VARCHAR	Код пользователя, который произвел авторизацию договора
—  authUserFullName	VARCHAR	ФИО пользователя, который произвел авторизацию договора

Все заявки по номеру заказа

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

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

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

Параметр	Тип данных	Комментарий
StatusBlanksOrderOptyResponse	—	Блок данных ответа
blanks	ARRAY	Блок данных (список) по всем заявкам
—  blank	ARRAY	Блок данных конкретной заявки
—  profileID	INT	Идентификатор анкеты
—  statusID	INT	Решение по заявке: 0 - новая заявка; 1 - в обработке; 2 - в кредите отказано; 3 - кредит предоставлен; 4 - ошибочный ввод; 5 - отказ клиента; 6 - договор авторизован; 7 - договор подписан клиентом;
—  bankID	INT	Выбранный банк: 1 - ОТП Банк; 2 - Банк Ренессанс Кредит; 4 - Русский Стандарт Банк; 6 - Альфа Банк; 7 - Лето Банк; 8 - Тинькофф Банк; 9 - Кредит Европа Банк; 11 - Миг Кредит; 12 - МФО Квику; 13 - МТС Банк; 27 - Совкомбанк
—  productName	VARCHAR	Наименование кредитного продукта по банку
—  productBarcode	VARCHAR	Штрих код продукта
—  amount	FLOAT	Сумма кредита в руб.
—  firstPayment	FLOAT	Первоначальный взнос в руб.
—  contractNumber	VARCHAR	Номер кредитного договора
—  lastName	VARCHAR	Фамилия клиента
—  firstName	VARCHAR	Имя клиента
—  surName	VARCHAR	Отчество клиента
—  goods	ARRAY	Блок данных (список) по товарам
—  good	ARRAY	Блок данных конкретного товара
—  brand	VARCHAR	бренд товара
—  model	VARCHAR	модель товара
—  price	FLOAT	цена товара
—  tradeFullName	VARCHAR	Название ТТ (Филиал оформления)
—  fullNameEmployee	VARCHAR	ФИО оформителя
—  orderID	VARCHAR	Идентификатор заказа на стороне интернет-магазина
—  fullNameEmployee	VARCHAR	ФИО сотрудника, оформившего кредит
—  date	DATE	Дата заведения заявки
—  insurances	ARRAY	Блок данных (список) по всем страховым компаниям
—  insurance	ARRAY	Блок данных конкретной страховой компании
—  name	VARCHAR	Название страховой компании
—  contract	VARCHAR	Номер договора
—  product	VARCHAR	Код продукта
—  premiumAmount	FLOAT	Страховая премия в руб.
—  insuranceAmount	FLOAT	Страховая сумма в руб.
—  productID	INT	ID продукта
—  goodID	INT	ID товара
—  otherAmount	FLOAT	Сумма дополнительных услуг по банку в руб. К примеру, сервис СМС-информирования
—  tradeId	INT	Код ТТ
—  creditType	INT	Тип заявки: 0 - не определен; 1 - кредит; 2 - рассрочка; 3 - субсидированный;
—  codeAgentMarket	VARCHAR	Идентификатор сотрудника, (Код сотрудника в системе магазина)
—  authUserCode	VARCHAR	Код пользователя, который произвел авторизацию договора
—  authUserFullName	VARCHAR	ФИО пользователя, который произвел авторизацию договора

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

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

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

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

Параметр	Тип данных	Комментарий
AcceptOptyResponse	—	Блок данных ответа
profileID	INT	Идентификатор анкеты
success	INT	Успешно. 1 - да, 0 - нет
contract	VARCHAR	Кредитный договор PDF в Base64 Binary
agreementNumber	VARCHAR	Номер кредитного договора
accountNumber	VARCHAR	Номер счета клиента
additionalDocuments	ARRAY	Блок дополнительных документов по заявке
—  document	ARRAY	Блок одного дополнительного документа
—  fileType	VARCHAR	Код типа файла SPECIFICATION - Спецификация товара MEMO - Памятка по оформлению
—  fileData	VARCHAR	Файл в 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	Текстовое описание ошибки

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

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

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

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

Параметр	Тип данных	Комментарий
CheckStatusScanOptyResponse	—	Блок данных ответа
categoryList	ARRAY	Список из элементов category, категорий документов банка
—  category	ARRAY	Блок категории документов банка.
—  posCredName	VARCHAR	Наименование категории в системе PosCredit
—  exist	ARRAY	Один или более блоков успешно загруженных документов категории
—  pageData	ARRAY	Блок одного документа
—  realName	VARCHAR	Человекопонятное наименование документа
—  pageNumber	INT	Номер страницы в комплекте документов (только для ОТП банка)
—  status	INT	Статус проверки документа
—  message	VARCHAR	Сообщение о проверке документа в банке
—  finalComment	VARCHAR	Общий комметарий от банка по комплекту документов (только для ОТП банка)
—  missed	ARRAY	Один или более блоков нехватающих документов
—  pageData	ARRAY	Блок одного документа
—  realName	VARCHAR	Человекопонятное наименование документа
—  pageNumber	INT	Номер страницы в комплекте документов (только для ОТП банка)
error	ARRAY	Блок данных об ошибке. Параметр может отсутствовать, если ошибок не возникло.
—  code	INT	Код ошибки
—  description	VARCHAR	Текстовое описание ошибки

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

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

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

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

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

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

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
ManualScanUploadOptyRequest	да	—	Блок данных запроса
userID	да	INT	Код партнера	Значения предоставляются по запросу
userToken	да	VARCHAR	Хэш-пароль партнера	Значения предоставляются по запросу
profileID	да	INT	Идентификатор анкеты
bankID	да	INT	По заявке какого банка загружаются документы
authDocumentsList	да	ARRAY	Список документов
—  authDocument	да	ARRAY	Блок одного документа
—  documentCategory	да	VARCHAR	Наименование категории в системе PosCredit (значение берется из метода CheckStatusScanOpty, поле posCredName)
—  documentData	да	VARCHAR	Файл в Base64

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

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

Получение иходников файлов, загруженных для авторизации

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

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

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

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

Параметр	Тип данных	Комментарий
GetScanDataOptyResponse	—	Блок данных ответа
profileID	INT	Идентификатор анкеты
scanDataList	ARRAY	Блок списка данных по сканам.
—  scanData	ARRAY	Блок данных по скану
—  data	VARCHAR	base64 закодированный файл.
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	Текстовое описание ошибки

Отгрузка товара

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

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

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

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

Пробитие чека

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
SetChequeEventRequest	да	—	Блок данных запроса
userID	да	INT	Код партнера	Значения предоставляются по запросу
userToken	да	VARCHAR	Хэш-пароль партнера	Значения предоставляются по запросу
nRequestID	да	INT	Идентификатор анкеты	Уникальный код в системе брокер
bEvent	да	INT	Статус пробития чека	1 - да, 0 - нет
strSourceName	нет	VARCHAR	Уникальный код интеграции с партнером

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

Параметр	Тип данных	Комментарий
SetChequeEventResponse	—	Блок данных ответа
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	Отчество клиента
nameChanged	нет	INT	Менялась ли Фамилия?	0 - не менялась 1 - менялась
nameChangedOld	нет	VARCHAR	Прежняя фамилия	Если nameChanged = 0, то передаем пустой параметр Если nameChanged = 1, то заполняем значением прежней Фамилии клиента.
mobilePhone	да	VARCHAR	Мобильный телефон	Номер телефона должен состоять из 10 символов и быть уникальным.
docSerial	да	VARCHAR	Серия паспорта клиента
docNumber	да	VARCHAR	Номер паспорта клиента
docIssuirer	нет	VARCHAR	Кем выдан паспорт
docDate	нет	DATETIME	Дата выдачи паспорта	Формат ДД.ММ.ГГГГ
docCode	нет	VARCHAR	Код подразделения	Формат XXX-XXX
pensioner	нет	INT	Признак пенсионера	Клиент является пенсионером? 1 - да, 0 - нет
birthDate	да	DATETIME	Дата рождения	Формат ДД.ММ.ГГГГ
birthPlace	нет	VARCHAR	Место рождения
email	нет	VARCHAR	Адрес электронной почты
educationID	нет	INT	Код Образования	1 — Начальное или неполное среднее 2 — Среднее 3 — Среднее, в том числе специальное 4 — Неполное высшее 5 — Высшее 6 — 2 и более высших 7 — Ученая степень
familyStatus	нет	INT	Семейное положение	1 — Женат/Замужем 2 — Холост/Не замужем 3 — Разведен(а) 4 — Вдовец/Вдова 5 — Гражданский брак
postMatch	нет	INT	Фактический адрес совпадает с адресом регистрации?	"0 - нет, отличается 1 - да, совпадает
regAddress	нет	ARRAY	Блок данных с параметрами об адресе регистрации клиента
—  address_input	нет	VARCHAR
postAddress	нет	ARRAY	Блок данных с параметрами об адресе проживания клиента (фактический адрес)
—  address_input	нет	VARCHAR
workName	нет	VARCHAR	Название организации
workPosition	нет	VARCHAR	Должность	1 —Рук./ Зам. рук. организации 3 —Неруководящий работник 4 —Индивидуальный предприниматель 5 —Самозанятый
workAddress	нет	ARRAY	Блок данных с параметрами о рабочем адресе (адрес места работы)
—  address_input	нет	VARCHAR
tradeID	да	INT	ID торговой точки, на которой оформляется кредит
orderID	Нет	VARCHAR	Номер заказа в магазине
creditType	нет	INT	тип заявки: 1 - Кредит, 2 - рассрочка
scanReceipt	нет	VARCHAR	Скан чека, base64
creditOptionsProducts	нет	VARCHAR	Список ID продуктов банка через запятую	Пример: 3131,1000,2525
creditOptionsPromo	нет	VARCHAR	Список OFL кодов или id продуктов через запятую	Пример: OFL0012,1234,OFL0024,4466,OFL006
goods	да	ARRAY	Блок данных с параметрами о приобретаемых товарах
—  good	да	ARRAY	Блок данных конкретного товара	Обязательно должен быть заполнен хотя бы один блок
—  name	да	VARCHAR	наименование товара	Значение берется из справочника
—  model	да	VARCHAR	Модель товара
—  brand	нет	VARCHAR	Бренд товара
—  price	да	FLOAT	Стоимость товара
—  barcode	нет	VARCHAR	штрихкод
—  discount	нет	FLOAT	Скидка в % Пример: 11
—  liquidityRatio	нет	INT	Коэффициент ликвидности	Принимает значения от 0 до 6
—  serialNumber	нет	VARCHAR	Серийный номер
—  imei	нет	VARCHAR	Международный идентификатор мобильного оборудования
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 - Сверх возможности от ВСК
precalculatedProducts	нет	ARRAY	Список банковских продуктов
—  product	да	ARRAY	Блок банковского продукта
—  bankCode	да	VARCHAR	Код банка
—  productCode	да	VARCHAR	Код банковского продукта
—  amount	да	FLOAT	Сумма кредита
createShortBlank	нет	INT	Создание короткой анкеты в колл-центр
flagKnox	нет	INT	Признак участия заявки в программе развёртывания Knox (Knox Deployment Program)
sex	нет	INT	Пол клиента	1 - мужской 2 - женский
cardBarCode	нет	VARCHAR	Штрих код кредитной карты для привязки к заявке
flagNotResident	нет	INT	Признак не резидента РФ

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

Параметр	Тип данных	Комментарий
CreateDraftOptyResponse	—	Блок данных ответа
profileID	INT	Идентификатор анкеты
url	VARCHAR	URL анкеты
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	Стоимость товара
precalculatedProducts	нет	ARRAY	Список банковских продуктов
—  product	да	ARRAY	Блок банковского продукта
—  bankCode	да	VARCHAR	Код банка
—  productCode	да	VARCHAR	Код банковского продукта
—  amount	да	FLOAT	Сумма кредита
firstPayment	нет	FLOAT	Первоначальный взнос клиента	Может быть как целым числом, так и числом с фиксированной точкой.
orderID	нет	VARCHAR	Номер заказа партнера
creditOptionsPromo	нет	VARCHAR	Список OFL кодов или id продуктов через запятую	Пример: OFL0012,1234,OFL0024,4466,OFL006
linkLifetime	нет	INT	Время жизни ссылки в часах

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

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

Сформировать заявление на возврат

Замечание Формируется заявление на возврат по определенной заявке в определенном банке, которое необходимо подписать

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

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

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

Параметр	Тип данных	Комментарий
RefundOptyResponse	—	Блок данных ответа
refundID	INT	Код запроса на возврат
refundFile	OBJECT	Блок данных с файлом заявки
—  data	VARCHAR	Заявка в формате PDF в Base64 Binary
error	ARRAY	Блок данных об ошибке. Параметр может отсутствовать, если ошибок не возникло.
—  code	INT	Код ошибки
—  description	VARCHAR	Текстовое описание ошибки

Подтвердить процедуру возврата

Замечание Для подтверждения заявки на возврат необходимо приложить скан подписанного заявления на возврат, полученного ранее

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

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

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

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

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

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
CreateAdditionalOptyRequest	да	—	Блок данных запроса
userID	да	INT	Код партнера	Значения предоставляются по запросу
userToken	да	VARCHAR	Хэш-пароль партнера	Значения предоставляются по запросу
optyType	да	VARCHAR	Тип анкеты	SHORT - короткая анкета MIDDLE - средняя анкета
oldProfileID		VARCHAR	Номер предыдущей заявки при дозаполнение	Передавать только при optyType = MIDDLE
selectedBanks	да	ARRAY	Выбранные банки для расчета
—  bank	да	ARRAY	Информация по конкретному банку
—  id	да	INT	ID выбранного банка
—  productID	да	INT	ID выбранного кредитного продукта
—  duration		INT	Срок кредита в месяцах
—  firstPayment		FLOAT	Первоначальный взнос клиента
—  type		INT	Тип расчета по продукту	1 - кредит 2 - рассрочка
selectedServices		ARRAY	Список дополнительных услуг
—  service		ARRAY	Блок дополнительной услуги
—  id		INT	Выбранный пакет дополнительной услуги	1 - сервис СМС-информирования 2 - страхование от несчастных случаев и потери жизни 3 - страхование от потери работы
firstPayment	да	FLOAT	Первоначальный взнос клиента	Может быть как целым числом, так и числом с фиксированной точкой.
duration	да	INT	Срок кредита в месяцах
lastName	да	VARCHAR	Фамилия клиента
firstName	да	VARCHAR	Имя клиента
surName	да	VARCHAR	Отчество клиента
sex	да	INT	Пол клиента	1 - мужской 2 - женский
birthPlace	да	VARCHAR	Место рождения
birthDate	да	DATETIME	Дата рождения	Формат ДД.ММ.ГГГГ
familyStatus		INT	Семейное положение	Передавать только при optyType = MIDDLE 1 — Женат/Замужем 2 — Холост/Не замужем 3 — Разведен(а) 4 — Вдовец/Вдова 5 — Гражданский брак
docSerial	да	VARCHAR	Серия паспорта клиента
docNumber	да	VARCHAR	Номер паспорта клиента
docIssuirer	да	VARCHAR	Кем выдан паспорт
docDate	да	DATETIME	Дата выдачи паспорта	Формат ДД.ММ.ГГГГ
docCode	да	VARCHAR	Код подразделения	Формат XXX-XXX
workPhone		VARCHAR	Рабочий телефон	Передавать только при optyType = MIDDLE Номер телефона должен состоять из 10 символов и быть уникальным. Если номер телефона не заполнен, опускаем параметр.
mobilePhone	да	VARCHAR	Мобильный телефон	Номер телефона должен состоять из 10 символов и быть уникальным.
contactPerson		ARRAY	Блок данных с параметрами о контактном лице	Передавать только при optyType = MIDDLE
—  mobilePhone		VARCHAR	Номер мобильного телефона контактного лица	Номер телефона должен состоять из 10 символов и быть уникальным.
regAddress	да	ARRAY	Блок данных с параметрами об адресе регистрации клиента
—  index	да	VARCHAR	Индекс адреса регистрации
—  city	да	VARCHAR	Регион/Город/Населенный пункт	Значение из КЛАДР по городам Состоит из 13 цифр. Пример: "7700000000000" - это значение для г. Москва, "5000001900000" - для г. Фрязино Московской области
—  street	да	VARCHAR	Улица	Полное начение из КЛАДР по улицам Состоит из 17 цифр. Пример: "50000019000007000" - это значение для ул. Ленина
—  house	да	VARCHAR	Дом	Текстовое наименование дома
—  housing		VARCHAR	Корпус
—  flat		VARCHAR	Квартира
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	Квартира
pensioner	да	INT	Признак пенсионер	Клиент является пенсионером? 1 - да, 0 - нет
workType		INT	Организационно-правовая форма организации-работодателя	Передавать только при optyType = MIDDLE и pensioner = 0 2 — ООО 6 — ОАО 7 — ЗАО 13 — ИП 147 — НАО 138 — АО 138 — ПАО 21 — Судебная инстанция 143 — НПФ 24 — АНОО 17 — МУЗ 14 — ЧП 15 — ФЛ-П 40 — ЖСК 39 — ДОАО 38 — ДЗР 37 — ГУ 36 — ГУП 26 — АНО 90 — ФИЛИАЛ ГУП 89 — ФИЛИАЛ 88 — ФУ 87 — ФКП 86 — ФГУ 85 — ФГУП 84 — ФБУ 83 — УЧРЕЖДЕНИЕ 82 — УП 81 — ТПП 80 — ТСЖ 77 — ТОВАРИЩЕСТВО НА ВЕРЕ 75 — СК 66 — ПО 64 — ПОЛНОЕ ТОВАРИЩЕСТВО 62 — ОНО 61 — ОДО 59 — ООД 58 — ОБРАЗОВАТЕЛЬНОЕ УЧРЕЖДЕНИЕ 57 — ОБОСОБЛЕННОЕ ПОДРАЗДЕЛЕНИЕ ООО 56 — ОБОСОБЛЕННОЕ ПОДРАЗДЕЛЕНИЕ 55 — НЕКОММЕРЧЕСКОЕ ПАРТНЕРСТВО 54 — НЕКОММЕРЧЕСКАЯ ОРГАНИЗАЦИЯ 53 — МУ 52 — МУП 51 — МП 16 — АНО ДО 9 — НОУ 99 — Страховая компания 35 — ГПП 34 — ГП 33 — ГКП 32 — ГОНО 31 — ГУ ФСИН 18 — ГОУ ВПО 49 — МЕЖД. ЦЕНТР 47 — КФХ 44 — КЖХСЗ 43 — КОЛХОЗ 42 — КОЛЛ. АДВ. 3 — АОЗТ 5 — ПБОЮЛ 27 — АССОЦИАЦИЯ 98 — ЧУ 97 — ФОНД 95 — ФИЛИАЛ ФГУП 94 — ФИЛИАЛ ОАО 93 — ФИЛИАЛ ООО 91 — ФИЛИАЛ ЗАО 104 — КП 121 — ФОП 105 — ДП 122 — НЧОУ 125 — МДОУ 127 — НУДО 135 — ГБУЗ 136 — ЧОУДО 137 — АУ 141 — ЧУ ДПО 144 — АНО ДПО
workName		VARCHAR	Название организации	Передавать только при optyType = MIDDLE и pensioner = 0
workBranch		INT	Отраслевая принадлежность организации	Передавать только при optyType = MIDDLE и pensioner = 0 1 — Вооруженные силы 2 — Доб.промышленность(кроме ТЭК) 3 — Здравоохранение (госуд) 4 — Здравоохранение (коммерч) 5 — Издательская деятельность 6 — Информатика и телекоммуникации 7 — Коммун.хоз/Сфера услуг/Дорож.Сл 8 — Легкая и пищевая промышленность 9 — Машиностроение и металлообработка 10 — Наука и культура 11 — Образование (государственное) 12 — Образование (коммерческое) 13 — Общественное питание, в том числе предпр. быстрого 14 — Правоохранительные органы, таможня 15 — Реклама, PR агенства, СМИ 16 — Рестораны 17 — Салоны красоты и здоровья 18 — Сборочные производства (в т.ч. сборка мебели) 19 — Сельское хозяйство 20 — Строительство, производство стройматериалов 21 — Торговля оптовая, поср./риэлт. д 22 — Торговля розничная 23 — Транспорт и связь 24 — Туризм 25 — ТЭК 26 — Увеселит., игорный и шоу-бизнес 27 — Федер. и муниципальн. управление 28 — Финансы, банковское дело 29 — Химия, парфюмерия, фармацевтика 30 — Частн. детект. и/или охран. пред 31 — Юридические и нотариальн. услуги 32 — Иное
workFieldTime		INT	Время работы на данном направлении	Передавать только при optyType = MIDDLE и pensioner = 0 1 — до 3-х лет 2 — 3-5 лет 3 — свыше 5 лет
workPeriodDate		DATETIME	Дата начала работы	Формат ДД.ММ.ГГГГ
workAddress		ARRAY	Блок данных с параметрами о рабочем адресе (адрес места работы)	Передавать только при optyType = MIDDLE и pensioner = 0
—  index	да/нет - если пенсионер	VARCHAR	Индекс адреса регистрации
—  city	да/нет - если пенсионер	VARCHAR	Регион/Город/Населенный пункт	Значение из КЛАДР по городам Состоит из 13 цифр. Пример: "7700000000000" - это значение для г. Москва, "5000001900000" - для г. Фрязино Московской области
—  street	да/нет - если пенсионер	VARCHAR	Улица	Полное начение из КЛАДР по улицам Состоит из 17 цифр. Пример: "50000019000007000" - это значение для ул. Ленина
—  house	да/нет - если пенсионер	VARCHAR	Дом	Текстовое наименование дома
—  housing		VARCHAR	Корпус
—  flat		VARCHAR	Квартира/Офис
priceMonth	да	FLOAT	Среднемесячный доход
goodsProperty	да	ARRAY	Блок данных с параметрами о приобретаемых товарах
—  good	да	ARRAY	Блок данных конкретного товара	Обязательно должен быть заполнен хотя бы один блок
—  id	да	VARCHAR	Наименование товара	Значение берется из справочника
—  model	да	VARCHAR	Модель товара
—  brand	да	VARCHAR	Бренд товара
—  price	да	FLOAT	Стоимость товара
—  idGoodVendor		VARCHAR	Артикул товара
documents		ARRAY	Блок сканов документов для отправки
—  document		ARRAY	Блок одного скана документа для отправки
—  fileName		VARCHAR	Название файла
—  fileExt		VARCHAR	Расширение файла
—  fileType		VARCHAR	Код типа файла	CLIENT_PHOTO - Фотография PASSPORT_MAIN - Паспорт главная PASSPORT_REGISTRATION - Паспорт регистрация PERSONAL_DATA_PERMISSION - Согласие на все PASSPORT_MAIN_SIGNED - Заверенный паспорт главная PASSPORT_REGISTRATION_SIGNED - Заверенный паспорт регистрация
—  fileData		VARCHAR	Файл в Base64 Binary
tradeID		INT	ID торговой точки, на которой оформляется кредит
orderID		VARCHAR	Номер заказа в магазине

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

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

Метод корректировки чека - изменение товарной корзины для МТС Банка

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
GoodsChangeOptyRequest	да	—	Блок данных запроса
userID	да	INT	Код партнера	Значения предоставляются по запросу
userToken	да	VARCHAR	Хэш-пароль партнера	Значения предоставляются по запросу
profileID	да	INT	Идентификатор анкеты
isUnchanged	да	INT	Признак корректировки чека	0 - изменяем 1 - оставляем как есть
goodsProperty	да	ARRAY	Блок данных с параметрами о приобретаемых товарах
—  good	да	ARRAY	Блок данных конкретного товара	Обязательно должен быть заполнен хотя бы один блок
—  id	да	VARCHAR	Наименование товара	Значение берется из справочника
—  model	да	VARCHAR	Модель товара
—  brand	да	VARCHAR	Бренд товара
—  price	да	FLOAT	Стоимость товара
—  idGoodVendor		VARCHAR	Артикул товара

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

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

Подтверждение клиентских данных и обновление документов для МТС Банка

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

Параметр	Обязательность	Тип данных	Описание	Справочник или комментарий
UpdateClientDocumentsOptyRequest	да	—	Блок данных запроса
userID	да	INT	Код партнера	Значения предоставляются по запросу
userToken	да	VARCHAR	Хэш-пароль партнера	Значения предоставляются по запросу
profileID	да	INT	Идентификатор анкеты
isConfirmClientData		INT	Признак подтверждения клиентских данных	В случае подтверждения клиентских данных необходимо отправлять значение "1"
previousData		ARRAY	Блок предыдущих данных клиента	Обязательно при передаче isConfirmClientData = 1
—  lastName		VARCHAR	Предыдущая фамилия клиента
—  firstName		VARCHAR	Предыдущее имя клиента
—  surName		VARCHAR	Предыдущее отчество клиента
—  docSerial		VARCHAR	Серия предыдущего паспорта клиента
—  docNumber		VARCHAR	Номер предыдущего паспорта клиента
—  docDate		DATETIME	Дата выдачи предыдущего паспорта клиента	Формат ДД.ММ.ГГГГ
documents	да	ARRAY	Блок сканов документов для отправки
—  document	да	ARRAY	Блок одного скана документа для отправки
—  fileName	да	VARCHAR	Название файла
—  fileExt	да	VARCHAR	Расширение файла
—  fileType	да	VARCHAR	Код типа файла	CLIENT_PHOTO - Фотография PASSPORT_MAIN - Паспорт главная PASSPORT_REGISTRATION - Паспорт регистрация PERSONAL_DATA_PERMISSION - Согласие на все PASSPORT_MAIN_SIGNED - Заверенный паспорт главная PASSPORT_REGISTRATION_SIGNED - Заверенный паспорт регистрация APPLICATION - Заявление PASSPORT_STAMP - Страница паспорта со штампом NAME_CHANGE_CERTIFICATE - Свидетельство о перемене имени
—  fileData	да	VARCHAR	Файл в Base64 Binary

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

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

Отправка сканов документов в банк

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

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

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

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

Запрос отправки смс кода клиенту

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

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

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

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

Отправка смс кода в банк

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

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

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

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