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

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

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

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


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

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

  1. Pre-scoring
  2. Верификация клиента
  3. Открытие счёта и выдача кредита
  4. Вывод средств со счета на карту
  5. Информация по выданному кредиту
  6. График погашения кредита
  7. Платежи по кредиту
  8. Погашение кредита

Pre-scoring

Запрос на прескоринг является точкой входа в процесс выдачи микрозайма.

Описание API

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

Запрос:

Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1externalIdUUID+Внешний id заявки
2.2isAgreementAcceptedBoolean+Индикатор согласия клиента по оферте
2.3phoneNumberString+
  • • Допустимое число символов 12
  • • Только цифры
  • • Номер телефона должен начинаться с 998
Номер телефона, по которому регистрируется заявка
2.4clientDataObject+Информация по клиенту, полученная партнёром от My Id

Ответ:

Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1applicationIdUUIDID заявки
2.2messageStringСообщение об успешной регистрации заявки в pre-scoring
3errorObjectОбъект ошибки
3.1codeIntegerУникальный код ошибки
3.2messageStringСообщение ошибки

POST /microloans/applications/cancel

Вызов метода доступен для вызова Клиентом Только при нахождении им на этапе выбора Лимитов, после успешного прескоринга. В дальнейшем - вызов может осуществляться лишь бизнес партнёром и системой BAAS.

Перейти к подробному описанию эндпоинта

Запрос:

Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1applicationIdUUID+ID микрокредитной заявки
2.2initiatorEnum+ Источник отмены заявки. Возможные варианты: PARTNER, CLIENT

Ответ:

Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1messageStringСообщение об успешном начале post-scoring процессе по заявке
2.2applicationIdUUIDID заявки на микрокредит
3errorObjectОбъект ошибки
3.1codeIntegerУникальный код ошибки
3.2messageStringСообщение ошибки

Верификация

После успешного прохождения клиентом прескоринга, клиенту отправляется предложение с данными о лимитах микрокредита, доступного к выдаче клиенту.

Описание API

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

Запрос:

Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1applicationIdUUID+ID микрокредитной заявки
2.2amountLong+• Только позитивное числоСумма кредита
2.3percentDouble+
  • • Мин. значение 0
  • • Макс. 99.99
Процент кредита
2.4monthPeriodInteger+• Мин. значение 0Период оплаты в месяцах
2.5backupPhoneString+
  • • Только числа
  • • Длина 12 символов
  • • Номер должен начинаться с 998
Запасной номер телефона

Ответ:

Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1messageStringСообщение об успешном начале процесса
2.2phoneNumberStringНомер колл-центра для верификации
3errorObjectОбъект ошибки
3.1codeIntegerУникальный код ошибки
3.2messageStringСообщение ошибки

Открытие счёта и выдача кредита

Точкой входа в процесс выдачи кредита является отправка клиентом данных Myid в данный API:

Описание API

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

Запрос:

Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1applicationIdUUID+ID микрокредитной заявки
2.2clientDataObject+Сверка данных MyId, полученных при запросе на пре-скоринг, для данной applicationIdИнформация полученная от партнёра, из MyId

Ответ:

Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1messageStringСообщение об успешном начале процесса выдаче кредита
3errorObjectОбъект ошибки
3.1codeIntegerУникальный код ошибки
3.2messageStringСообщение ошибки

Для получение статуса и информации по заявке в течение процесса обработки, нужно вызвать данный API:

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

Запрос:

Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1applicationIdUUID+ID заявки

Ответ:

Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1applicationIdUUIDID заявки
2.2 status Enum NEW, PENDING, IN_PROGRESS, COMPLETED, REJECTED, CANCELED, FAILED, EXPIRED
2.3lastTaskObjectИнформация по последнему этапу заявки
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.3errorCodeIntegerКод ошибки этапа
2.3.4errorMessageStringОписание ошибки этапа
2.4preScoreResultObjectИнформация по пре-скорингу
2.4.1externalIdStringВнешний id заявки
2.4.2amountLimitLongЛимит кредитной суммы
2.4.3percentDoubleПроцент кредита
2.4.4monthPeriodIntegerСрок кредита
3errorObjectОбъект ошибки
3.1codeIntegerУникальный код ошибки
3.2messageStringСообщение ошибки

Вывод средств со счёта на карту

Для вывода средств со счёта «до востребования» на карту пользователя необходимо последовательно вызвать следующие методы:

  1. POST /transfers/account-to-card/create
  2. POST /transfers/account-to-card/confirm
  3. POST /transfers/check-status

Описание API: POST /transfers/account-to-card/create

Вызывается по запросу пользователя на стороне приложения партнёра. Создаёт заявку на проведение транзакции и возвращает идентификатор транзакции transactionId.

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1externalIdString+Внешний id
2.2applicationIdUUID+ID заявки
2.3panString+Полный PAN номера карты получателя
2.4receiverCardTypeEnum+HUMO или UZCARDТип процессинга карты
2.5cardHolderNameString+Имя держателя карты
2.6amountLong+Положительное числоСумма перевода
Ответ:
Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1transactionIdStringID транзакции
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Описание API: POST /transfers/account-to-card/confirm

Вызывается партнёром после получения transactionId. Подтверждает проведение транзакции и возвращает статус обработки запроса.

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1externalIdUUID+Внешний ID
2.2transactionIdUUID+ID транзакции
Ответ:
Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1externalIdStringВнешний ID
2.2statusStringСтатус запроса на транзакцию
2.3messageStringОписание статуса
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Описание API: POST /transfers/check-status

Вызывается партнёром после успешной регистрации запроса на проведение транзакции. Возвращает актуальный статус проведения транзакции.

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1externalIdUUID+Внешний ID
2.2transactionIdUUID+ID транзакции
Ответ:
Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1externalIdStringВнешний ID
2.2transactionIdUUIDID транзакции
2.3transactionDateDateTimeДата проведения транзакции
2.4statusStringСтатус запроса на транзакцию
2.5messageStringОписание статуса
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Информация по выданному кредиту

Для получения информации по выданному кредиту, а также для получения номера кредитного договора (loanId), необходимо вызывать метод: POST /microloans/info.

Вызов данного метода осуществляется минимум через 30 минут после получения партнёром статуса заявки LOAN_ISSUED.

Описание API: POST /microloans/info

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1applicationIdUUID+ID заявки
Ответ:
Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1applicationIdUUIDID заявки
2.2amountLongСумма кредита
2.3monthPeriodIntegerПериод кредита
2.4rateDoubleПроцент кредита
2.5 loanId String ID кредита
Может быть null. Появится после успешной обработки заявки, минимум через 30 минут после выдачи кредита.
2.6totalResidueLongОбщий остаток задолженности
2.7totalFineLongОбщая задолженность по просроченным платежам
3errorObjectРезультат запроса при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

График погашения кредита

Для получения графика погашения необходимо обращаться на метод: POST /microloans/schedule.

Получить график погашения можно сразу после получения номера кредитного договора (loanId) посредством метода POST /microloans/info.

Описание API

POST /microloans/schedule

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1loanIdString+ID кредитного договора
Ответ:

В ответе приходит массив объектов. Каждый объект представляет отдельный месяц. Количество объектов равно количеству месяцев кредита.

Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1scheduleObjectМассив с расписанием
2.1.1paymentDateDateTimeДата платежа
2.1.2periodDaysIntegerКоличество дней в периоде
2.1.3totalResidueLongОбщий остаток задолженности
2.1.4totalRepaymentAmountLongОбщая сумма погашения
2.1.5loanRepaymentAmountLongСумма основного долга
2.1.6accruedInterestAmountLongСумма начисленных процентов
2.1.7servicePercentageAmountLongСумма процентов обслуживания
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Платежи по кредиту

Для получения списка платежей по кредиту необходимо обращаться на метод: POST /microloans/payments, передавая в теле запроса loanId.

Описание API

POST /microloans/payments

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1loanIdString+ID кредитного договора
Ответ:

В ответе приходит массив объектов. Каждый объект — отдельная транзакция (не агрегируются по периодам).

Параметр Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1paymentsObjectМассив платежей
2.1.1paymentDateDateTimeДата платежа
2.1.2totalRepaymentAmountLongОбщая сумма погашения
2.1.3loanRepaymentAmountLongСумма основного долга
2.1.4accruedInterestAmountLongСумма начисленных процентов
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Погашение кредита

Для осуществления погашения кредита (по графику или досрочно) необходимо последовательно вызывать следующие методы:

  1. POST /repayment/loans/check
  2. POST /repayment/loans/pay
  3. POST /repayment/loans/status

Описание API: POST /repayment/loans/check

Метод вызывается по запросу пользователя на стороне приложения партнёра. Возвращает информацию по кредиту и идентификатор запроса оплаты (requestId).

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1loanIdString+ID кредитного договора
Ответ:
Название Тип Описание
1idUUIDID запроса
2resultObjectРезультат запроса
2.1requestIdStringID запроса для оплаты
2.2loanIdStringID кредитного договора
2.3clientNameStringФИО клиента
2.4accountBalanceLongОстаток основного счёта
2.5totalResidueLongОстаток основного долга
2.6mainDebtAmountLongЗадолженность по основному долгу
2.7overdueDebtAmountLongЗадолженность по просроченному долгу
2.8termInterestAmountLongЗадолженность по срочным процентам
2.9overdueInterestAmountLongЗадолженность по просроченным процентам
2.10interestFineAmountLongЗадолженность по пени
2.11maxAmountLongМаксимальная сумма оплаты (≤ totalResidue)
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Описание API: POST /repayment/loans/pay

Метод инициирует оплату по графику или досрочно.

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1loanIdString+ID кредитного договора
2.2paymentTypeEnum+TERM / EARLYТип платежа
2.3requestIdString+ID запроса из метода check
2.4debitIdString+Номер транзакции (utrno UZCARD / refnum HUMO)
2.5amountLong+ТийиныСумма списания
2.6processingTypeEnum+UZCARD / HUMOТип процессинга карты
Ответ:
Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1loanIdStringID кредитного договора
2.2requestIdStringID запроса транзакции
2.3statusStringСтатус запроса
2.4messageStringОписание статуса
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки

Описание API: POST /repayment/loans/status

Метод возвращает актуальный статус платежной транзакции.

Запрос:
Название Тип Проверка not-null Доп. проверка Описание
1idUUID+ID запроса
2paramsObject+Объект запроса
2.1requestIdUUID+ID запроса транзакции
2.2externalIdUUID+Внешний ID
Ответ:
Название Тип Описание
1idUUIDID запроса
2resultObjectОбъект ответа
2.1requestIdStringID запроса транзакции
2.2externalIdUUIDВнешний ID
2.3loanIdStringID кредитного договора
2.4transactionIdStringНомер транзакции в банке
2.5requestStatusStringСтатус запроса
2.6messageStringОписание статуса
3errorObjectРезультат при ошибке
3.1codeIntegerКод ошибки
3.2messageStringОписание ошибки