Информация по общей структуре запросов/ответов для всех API указана по этой ссылке .
Все указанные API требуют авторизацию/аутентификацию, подробности — по этой ссылке .
Информация по кодам ошибок приведена здесь . Системные ошибки (1–999) могут возникать в любой момент и в описании конкретных API не дублируются.
Процесс выдачи микрокредита состоит из следующих этапов:
- Pre-scoring
- Верификация клиента
- Открытие счёта и выдача кредита
- Вывод средств со счета на карту
- Информация по выданному кредиту
- График погашения кредита
- Платежи по кредиту
- Погашение кредита
Pre-scoring
Запрос на прескоринг является точкой входа в процесс выдачи микрозайма.
Описание API
POST {base-url}/microloans/applications/pre-scoring/register
Перейти к подробному описанию эндпоинта
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | externalId | UUID | + | Внешний id заявки | |
| 2.2 | isAgreementAccepted | Boolean | + | Индикатор согласия клиента по оферте | |
| 2.3 | phoneNumber | String | + |
|
Номер телефона, по которому регистрируется заявка |
| 2.4 | clientData | Object | + | Информация по клиенту, полученная партнёром от My Id |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | applicationId | UUID | ID заявки |
| 2.2 | message | String | Сообщение об успешной регистрации заявки в pre-scoring |
| 3 | error | Object | Объект ошибки |
| 3.1 | code | Integer | Уникальный код ошибки |
| 3.2 | message | String | Сообщение ошибки |
POST /microloans/applications/cancel
Вызов метода доступен для вызова Клиентом Только при нахождении им на этапе выбора Лимитов, после успешного прескоринга. В дальнейшем - вызов может осуществляться лишь бизнес партнёром и системой BAAS.
Перейти к подробному описанию эндпоинтаЗапрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | applicationId | UUID | + | ID микрокредитной заявки | |
| 2.2 | initiator | Enum | + | Источник отмены заявки. Возможные варианты: PARTNER, CLIENT |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | message | String | Сообщение об успешном начале post-scoring процессе по заявке |
| 2.2 | applicationId | UUID | ID заявки на микрокредит |
| 3 | error | Object | Объект ошибки |
| 3.1 | code | Integer | Уникальный код ошибки |
| 3.2 | message | String | Сообщение ошибки |
Верификация
После успешного прохождения клиентом прескоринга, клиенту отправляется предложение с данными о лимитах микрокредита, доступного к выдаче клиенту.
Описание API
POST /microloans/applications/verify
Перейти к подробному описанию эндпоинта
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | applicationId | UUID | + | ID микрокредитной заявки | |
| 2.2 | amount | Long | + | • Только позитивное число | Сумма кредита |
| 2.3 | percent | Double | + |
| Процент кредита |
| 2.4 | monthPeriod | Integer | + | • Мин. значение 0 | Период оплаты в месяцах |
| 2.5 | backupPhone | String | + |
|
Запасной номер телефона |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | message | String | Сообщение об успешном начале процесса |
| 2.2 | phoneNumber | String | Номер колл-центра для верификации. Может быть пустым, если флаг phoneCallRequired false |
| 2.3 | phoneCallRequired | Bool | Флаг, показатель того, нужно ли пользователю проходить верификацию по звонку.
Либо true либо fallse Если отправляется true, то пользователю необходимо пройти верификацию по номеру телефона из параметра phoneNumber Если отправляется false, то необходимости в верификации нет и можно переходить на следующий этап выдачи кредита. |
| 3 | error | Object | Объект ошибки |
| 3.1 | code | Integer | Уникальный код ошибки |
| 3.2 | message | String | Сообщение ошибки |
Открытие счёта и выдача кредита
Точкой входа в процесс выдачи кредита является отправка клиентом данных Myid в данный API:
Описание API
POST /microloans/applications/issue
Перейти к подробному описанию эндпоинта
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | applicationId | UUID | + | ID микрокредитной заявки | |
| 2.2 | clientData | Object | + | Сверка данных MyId, полученных при запросе на пре-скоринг, для данной applicationId | Информация полученная от партнёра, из MyId |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | message | String | Сообщение об успешном начале процесса выдаче кредита |
| 3 | error | Object | Объект ошибки |
| 3.1 | code | Integer | Уникальный код ошибки |
| 3.2 | message | String | Сообщение ошибки |
Для получение статуса и информации по заявке в течение процесса обработки, нужно вызвать данный API:
POST /microloans/applications/infoПерейти к подробному описанию эндпоинта
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | applicationId | UUID | + | ID заявки |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | applicationId | UUID | ID заявки |
| 2.2 | status | Enum |
NEW, PENDING, IN_PROGRESS, COMPLETED, REJECTED, CANCELED, FAILED, EXPIRED
|
| 2.3 | lastTask | Object | Информация по последнему этапу заявки |
| 2.3.1 | name | Enum |
Название этапа PRE_SCORING,
PRE_SCORING_INFO,
POST_SCORING,
POST_SCORING_INFO,
OTP_SENT,
OTP_CONFIRM,
OPEN_ACCOUNT,
OPEN_LOAN_APPLICATION,
GET_OPEN_LOAN_APPLICATION_RESULT,
LOAN_ISSUANCE,
GET_LOAN_ISSUANCE_RESULT,
CLIENT_VERIFICATION
|
| 2.3.2 | status | Enum |
Статус этапа NEW, IN_PROGRESS, COMPLETED, PENDING, FAILED, REJECTED, EXPIRED
|
| 2.3.3 | errorCode | Integer | Код ошибки этапа |
| 2.3.4 | errorMessage | String | Описание ошибки этапа |
| 2.4 | preScoreResult | Object | Информация по пре-скорингу |
| 2.4.1 | externalId | String | Внешний id заявки |
| 2.4.2 | amountLimit | Long | Лимит кредитной суммы |
| 2.4.3 | percent | Double | Процент кредита |
| 2.4.4 | monthPeriod | Integer | Срок кредита |
| 3 | error | Object | Объект ошибки |
| 3.1 | code | Integer | Уникальный код ошибки |
| 3.2 | message | String | Сообщение ошибки |
Вывод средств со счёта на карту
Для вывода средств со счёта «до востребования» на карту пользователя необходимо последовательно вызвать следующие методы:
POST /transfers/account-to-card/createPOST /transfers/account-to-card/confirmPOST /transfers/check-status
Описание API: POST /transfers/account-to-card/create
Вызывается по запросу пользователя на стороне приложения партнёра. Создаёт заявку на проведение транзакции
и возвращает идентификатор транзакции transactionId.
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | externalId | String | + | Внешний id | |
| 2.2 | applicationId | UUID | + | ID заявки | |
| 2.3 | pan | String | + | Полный PAN номера карты получателя | |
| 2.4 | receiverCardType | Enum | + | HUMO или UZCARD | Тип процессинга карты |
| 2.5 | cardHolderName | String | + | Имя держателя карты | |
| 2.6 | amount | Long | + | Положительное число | Сумма перевода |
Ответ:
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | transactionId | String | ID транзакции |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Описание API: POST /transfers/account-to-card/confirm
Вызывается партнёром после получения transactionId. Подтверждает проведение транзакции и
возвращает статус обработки запроса.
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | externalId | UUID | + | Внешний ID | |
| 2.2 | transactionId | UUID | + | ID транзакции |
Ответ:
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | externalId | String | Внешний ID |
| 2.2 | status | String | Статус запроса на транзакцию |
| 2.3 | message | String | Описание статуса |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Описание API: POST /transfers/check-status
Вызывается партнёром после успешной регистрации запроса на проведение транзакции. Возвращает актуальный статус проведения транзакции.
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | externalId | UUID | + | Внешний ID | |
| 2.2 | transactionId | UUID | + | ID транзакции |
Ответ:
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | externalId | String | Внешний ID |
| 2.2 | transactionId | UUID | ID транзакции |
| 2.3 | transactionDate | DateTime | Дата проведения транзакции |
| 2.4 | status | String | Статус запроса на транзакцию |
| 2.5 | message | String | Описание статуса |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Информация по выданному кредиту
Для получения информации по выданному кредиту, а также для получения номера кредитного договора (loanId), необходимо вызывать метод:
POST /microloans/info.
Вызов данного метода осуществляется минимум через 30 минут после получения партнёром статуса заявки LOAN_ISSUED.
Описание API: POST /microloans/info
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | applicationId | UUID | + | ID заявки |
Ответ:
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | applicationId | UUID | ID заявки |
| 2.2 | amount | Long | Сумма кредита |
| 2.3 | monthPeriod | Integer | Период кредита |
| 2.4 | rate | Double | Процент кредита |
| 2.5 | loanId | String |
ID кредита Может быть null. Появится после успешной обработки заявки, минимум через 30 минут после выдачи кредита.
|
| 2.6 | totalResidue | Long | Общий остаток задолженности |
| 2.7 | totalFine | Long | Общая задолженность по просроченным платежам |
| 3 | error | Object | Результат запроса при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
График погашения кредита
Для получения графика погашения необходимо обращаться на метод:
POST /microloans/schedule.
Получить график погашения можно сразу после получения номера кредитного договора (loanId) посредством метода
POST /microloans/info.
Описание API
POST /microloans/schedule
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | loanId | String | + | ID кредитного договора |
Ответ:
В ответе приходит массив объектов. Каждый объект представляет отдельный месяц. Количество объектов равно количеству месяцев кредита.
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | schedule | Object | Массив с расписанием |
| 2.1.1 | paymentDate | DateTime | Дата платежа |
| 2.1.2 | periodDays | Integer | Количество дней в периоде |
| 2.1.3 | totalResidue | Long | Общий остаток задолженности |
| 2.1.4 | totalRepaymentAmount | Long | Общая сумма погашения |
| 2.1.5 | loanRepaymentAmount | Long | Сумма основного долга |
| 2.1.6 | accruedInterestAmount | Long | Сумма начисленных процентов |
| 2.1.7 | servicePercentageAmount | Long | Сумма процентов обслуживания |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Платежи по кредиту
Для получения списка платежей по кредиту необходимо обращаться на метод:
POST /microloans/payments, передавая в теле запроса loanId.
Описание API
POST /microloans/payments
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | loanId | String | + | ID кредитного договора |
Ответ:
В ответе приходит массив объектов. Каждый объект — отдельная транзакция (не агрегируются по периодам).
| № | Параметр | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | payments | Object | Массив платежей |
| 2.1.1 | paymentDate | DateTime | Дата платежа |
| 2.1.2 | totalRepaymentAmount | Long | Общая сумма погашения |
| 2.1.3 | loanRepaymentAmount | Long | Сумма основного долга |
| 2.1.4 | accruedInterestAmount | Long | Сумма начисленных процентов |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Погашение кредита
Для осуществления погашения кредита (по графику или досрочно) необходимо последовательно вызывать следующие методы:
POST /repayment/loans/checkPOST /repayment/loans/payPOST /repayment/loans/status
Описание API: POST /repayment/loans/check
Метод вызывается по запросу пользователя на стороне приложения партнёра. Возвращает информацию по кредиту и
идентификатор запроса оплаты (requestId).
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | loanId | String | + | ID кредитного договора |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Результат запроса |
| 2.1 | requestId | String | ID запроса для оплаты |
| 2.2 | loanId | String | ID кредитного договора |
| 2.3 | clientName | String | ФИО клиента |
| 2.4 | accountBalance | Long | Остаток основного счёта |
| 2.5 | totalResidue | Long | Остаток основного долга |
| 2.6 | mainDebtAmount | Long | Задолженность по основному долгу |
| 2.7 | overdueDebtAmount | Long | Задолженность по просроченному долгу |
| 2.8 | termInterestAmount | Long | Задолженность по срочным процентам |
| 2.9 | overdueInterestAmount | Long | Задолженность по просроченным процентам |
| 2.10 | interestFineAmount | Long | Задолженность по пени |
| 2.11 | maxAmount | Long | Максимальная сумма оплаты (≤ totalResidue) |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Описание API: POST /repayment/loans/pay
Метод инициирует оплату по графику или досрочно.
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | loanId | String | + | ID кредитного договора | |
| 2.2 | paymentType | Enum | + | TERM / EARLY | Тип платежа |
| 2.3 | requestId | String | + | ID запроса из метода check | |
| 2.4 | debitId | String | + | Номер транзакции (utrno UZCARD / refnum HUMO) | |
| 2.5 | amount | Long | + | Тийины | Сумма списания |
| 2.6 | processingType | Enum | + | UZCARD / HUMO | Тип процессинга карты |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | loanId | String | ID кредитного договора |
| 2.2 | requestId | String | ID запроса транзакции |
| 2.3 | status | String | Статус запроса |
| 2.4 | message | String | Описание статуса |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |
Описание API: POST /repayment/loans/status
Метод возвращает актуальный статус платежной транзакции.
Запрос:
| № | Название | Тип | Проверка not-null | Доп. проверка | Описание |
|---|---|---|---|---|---|
| 1 | id | UUID | + | ID запроса | |
| 2 | params | Object | + | Объект запроса | |
| 2.1 | requestId | UUID | + | ID запроса транзакции | |
| 2.2 | externalId | UUID | + | Внешний ID |
Ответ:
| № | Название | Тип | Описание |
|---|---|---|---|
| 1 | id | UUID | ID запроса |
| 2 | result | Object | Объект ответа |
| 2.1 | requestId | String | ID запроса транзакции |
| 2.2 | externalId | UUID | Внешний ID |
| 2.3 | loanId | String | ID кредитного договора |
| 2.4 | transactionId | String | Номер транзакции в банке |
| 2.5 | requestStatus | String | Статус запроса |
| 2.6 | message | String | Описание статуса |
| 3 | error | Object | Результат при ошибке |
| 3.1 | code | Integer | Код ошибки |
| 3.2 | message | String | Описание ошибки |