Общая информация

Информация по общей структуре запросов/ответов для всех API указана по этой ссылке .

Все указанные API требуют авторизацию/аутентификацию, подробности — по этой ссылке .

Информация по кодам ошибок приведена здесь . Системные ошибки (1–999) могут возникать в любой момент и в описании конкретных API не дублируются.

Процесс выдачи микрокредита

Процесс выдачи микрокредита состоит из четырёх этапов:

Pre-scoring
Привязка карт
Post-scoring
Создание контракта и выдача кредита

Pre-scoring

На этом этапе запрос с данными my-id отправляется в API банка. Метод, используя эти данные, ищет клиента в банке: если клиент уже существует — его данные обновляются; иначе создаётся новый клиент.

Затем все необходимые данные собираются и отправляются в пре-скоринг API CRM. Ответ по скорингу извлекается через другой API CRM, что может занять некоторое время. Когда результат готов, данные записываются в БД. Результат скоринга можно получить через специальный API.

API для регистрации заявки на Pre-scoring

POST /microloans/applications/pre-scoring/register
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Доп. проверка	Описание
1	id	UUID	+		ID запроса
2	params	Object	+		Объект запроса
2.1	productId	Integer	+		ID продукта
2.2	externalId	UUID	+		Внешний id заявки
2.3	isAgreementAccepted	Boolean	+		Индикатор согласие клиента по оферте
2.4	phoneNumber	String	+	Допустимое число символов 12 Только цифры Номер телефона должен начинаться с 998	Номер телефона по который регистрируется заявка
2.5	clientData	Object	+		Информация по клиенту, все данные берутся из my-id

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	applicationId	Ид заявки
2.2	message	Сообщение об успешном регистрации заявки в pre-scoring
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

API для получения информации по заявке

POST /microloans/applications/info
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Описание
1	id	UUID	+	ID запроса
2	params	Object	+	Объект запроса
2.1	applicationId	UUID	+	ID заявки

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	applicationId	ID заявки
2.2	status	Статус заявки
2.3	lastTask	Информация по последней этапе заявки
2.3.1	name	Название этапа
2.3.2	status	Статус этапа
2.3.3	errorCode	Код ошибки этапа
2.3.4	errorMessage	Описание ошибки этапа
2.4	loanInfo	Информация по кредиту
2.4.1	amount	Сумма кредита
2.4.2	monthPeriod	Период кредита
2.4.3	rate	Процент кредита
2.4.3	attachedCard	Карта для оплаты кредита
2.4.3.1	cardHolderName	Имя-Фамилия владельца карты
2.4.3.2	maskedPan	Маскированный номер карты
2.4.3.3	expiry	Срок годности карты
2.4.3.4	processingType	Тип процессинга (Uzcard, Humo)
2.4.4	loanCard	Кредитная карта
2.4.4.1	cardHolderName	Имя-Фамилия владельца карты
2.4.4.2	maskedPan	Маскированный номер карты
2.4.4.3	expiry	Срок годности карты
2.4.4.4	processingType	Тип процессинга (Uzcard, Humo)
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

API для статуса Pre-scoring

POST /microloans/applications/pre-scoring/status
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Описание
1	id	UUID	+	ID запроса
2	params	Object	+	Объект запроса
2.1	applicationId	UUID	+	ID заявки

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	externalId	Внешний ID заявки
2.2	amountLimit	Лимит суммы по микрозайму
2.3	percent	Лимит процента по микрозайму
2.4	monthPeriod	Лимит периода по оплате (в месяцах) по микрозайму
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

Привязка карт

Для продолжения выдачи микрокредита у клиента должны быть:

виртуальная карта от Ipotekabank;
дебетовая карта для последующего погашения кредита, привязанная в системе банка.

Документация по логике заказа карты — перейти.
Документация по привязке карт — перейти.

API для получения карт по PINFL

POST /cards/by-pin
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Доп. проверка	Описание
1	id	UUID	+		ID запроса
2	params	Object	+		Объект запроса
2.1	pinfl	String	+	Допустимая длина 12 символов Только цифры	Пинфл пользователя

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	attachedCardList	Список привязанных карт
2.1.1	cardId	ID карты
2.1.2	cardHolderName	Имя-Фамилия владельца карты
2.1.3	maskedPan	Маскированный номер карты
2.1.4	expiry	Срок годности карты
2.1.5	processingType	Тип процессинга (Uzcard, Humo)
2.2	loanCardList	Список открытых карт в банке Ipotekabank
2.2.1	cardId	ID карты
2.2.2	cardHolderName	Имя-Фамилия владельца карты
2.2.3	maskedPan	Маскированный номер карты
2.2.4	expiry	Срок годности карты
2.2.5	processingType	Тип процессинга (Uzcard, Humo)
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

Post-scoring

Когда клиент решает получить микрокредит, ему нужно будет отправить запрос на определённый API для начала post-scoring процесса. Во время post-scoring процесса, клиент отправляет запрос с данными по микрокредиту (желаемая сумма, процент, период оплаты) в API. Отправленный запрос заново проверяется скорингом банка, и если скоринг одобрит заявку, сервис требует подтверждение со стороны клиента на начало процесса выдачи микрокредита.

API для начала Post-scoring

POST /microloans/applications/post-scoring/register
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Доп. проверка	Описание
1	id	UUID	+		ID запроса
2	params	Object	+		Объект запроса
2.1	applicationId	UUID	+		ID микрокредитной заявки
2.2	amount	Long	+	Только позитивное число	Сумма кредита
2.3	percent	Double	+	Мин. значение 0, Макс. значение 99.99	Процент кредита
2.4	monthPeriod	Integer	+	Мин. значение 0	Период оплаты в месяцах
2.5	backupPhone	String	+	Только числа Разрешенная длина 12 символов Номер должен начинаться с 998	Запасной номер телефона для микрокредита
2.6	loanCardId	UUID	+		ID карты на которую переведут деньги микрокредита
2.7	attachedCardId	UUID	+		ID карты с которой будет снимать ежемесячная плата за микрокредит

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	message	Сообщение об успешном начале post-scoring процессе по заявке
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

API для отправки OTP-кода

POST /microloans/applications/issuing/otp/send
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Описание
1	id	UUID	+	ID запроса
2	params	Object	+	Объект запроса
2.1	applicaitonId	UUID	+	ID заявки по которой будет отправлен СМС код

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	message	Сообщение об успешном начале post-scoring процессе по заявке
2.2	phoneNumber	Номер телефона на который был отправлен СМС код
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

API для подтверждения OTP-кода

POST /microloans/applications/issuing/otp/confirm
Перейти к подробному описанию эндпоинта

Запрос:

№	Название	Тип	Обяз.	Доп. проверка	Описание
1	id	UUID	+		ID запроса
2	params	Object	+		Объект запроса
2.1	applicaitonId	UUID	+		ID заявки по которой был отправлен СМС код
2.2	code	String	+	Только цифры Ограничение по длине, 6 символов	СМС код

Ответ:

№	Название	Описание
1	id	ID запроса
2	result	Объект ответа
2.1	message	Сообщение об успешном подтверждении заявки на выдачу кредита
3	error	Объект ошибки
3.1	code	Уникальный код ошибки
3.2	message	Сообщение ошибки

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

После успешного подтверждения OTP-кода система формирует кредитный контракт и переводит средства на счёт клиента.