Получение кредитных предложений

Обновлено 29 ноября 2024

/fintech/api/v1/credit-offers

Ресурс позволяет получить информацию по кредитным предложениям от Банка для сервиса Партнера (Платформы), содержащую условия возможности покупки в кредит Клиентами.

Для получения информации по кредитным предложениям необходимо отправить GET-запрос /fintech/api/v1/credit-offers с токеном доступа (access_token) пользователя в параметре Authorization заголовка.

В параметре scope ссылки авторизации пользователя должен быть указан сервис GET_CREDIT_OFFERS для получения доступа к этому ресурсу.

При использовании:

• access_token вашей компании + client_id Платформы, вы получите информацию по кредитным предложениям от Банка для Платформы
• access_token Клиента, вы получите информацию о действующем кредитном договоре Клиента (при его наличии)

Для обращения к ресурсу необходимо отправлять запрос на:

• Тестовый контур https://iftfintech.testsbi.sberbank.ru:9443
• Промышленный контур https://fintech.sberbank.ru:9443

Request

/fintech/api/v1/credit-offers

• Модель
• Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
QUERY-PARAMETERS
clientID	number	number	^(?![^]*[0-9]){14}$	optional	Идентификатор сервиса,
lawForm	string	string	^(ООО|ИП|ГКФХ)$	optional	Общепринятое сокращение организационно-правовой формы организации, для которой необходимо получить кредитные предложения

GET /fintech/api/v1/credit-offers?lawForm=%D0%98%D0%9F HTTP/1.1
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678

Responses

200 (OK)

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
creditOffers [
creditOffer	array[creditOffer]	optional	Кредитное предложение
]
creditOffer {
checkSum	number	optional	Сумма займа, после которой потребуется выездная проверка по месту ведения бизнеса,
clientId	number	required	Идентификатор внешнего сервиса,
delayRepayment	integer	optional	Льготный период,
individual	boolean	optional	Является ли клиент ФЛ,
orgLawForms	array[OrgLawForm]	optional	Перечень организационно-правовых форм организаций, для которых доступен кредитный продукт,
productCode	string	required	Код кредитного продукта,
productName	string	optional	Наименование кредитного продукта,
questions	array[QuestionForm]	optional	Список топ вопросов с ответами по созданию кредитной заявки,
rate	string	optional	Ставка по кредитному предложению (%),
sumMax	number	optional	Максимальная сумма доступная для покупки в кредит,
sumMin	number	optional	Минимальная сумма доступная для покупки в кредит,
termMax	number	optional	Максимальный срок кредита (в месяцах),
termMin	number	optional	Минимальный срок кредита (в месяцах),
contractNumber	string	optional	Номер договора,
availableSum	string	optional	Сумма лимита,
dateSince	date	optional	Дата начала действия договора,
dateUntil	date	optional	Дата окончания договора
}
OrgLawForm {
name	string	required	Полное наименование организационно-правовой формы,
shortName	string	required	Общепринятое сокращение организационно-правовой формы
}
QuestionForm {
answer	string	optional	Ответ на вопрос по созданию кредитной заявки,
question	string	optional	Вопрос по созданию кредитной заявки
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

[
    {
        "clientId": 92233764567396,
        "productName": "Покупка в кредит",
        "productCode": "MB-F-ip-150",
        "sumMin": "10000.00",
        "sumMax": "5000000.00",
        "rate": "16.00",
        "termMin": 1,
        "termMax": 36,
        "orgLawForms": [
            {
                "name": "Индивидуальный предприниматель",
                "shortName": "ИП"
            }
        ],
        "delayRepayment": 46,
        "questions": [
            null,
            null,
            null
        ],
        "checkSum": null,
        "contractNumber": null,
        "availableSum": null,
        "dateSince": null,
        "dateUntil": null,
        "individual": false
    },
    {
        "clientId": 92233764567396,
        "productName": "Покупки в рассрочку",
        "productCode": "MB-K-ip-225",
        "sumMin": "100000.00",
        "sumMax": "3000000.00",
        "rate": "18.00",
        "termMin": 12,
        "termMax": 12,
        "orgLawForms": [
            {
                "name": "Индивидуальный предприниматель",
                "shortName": "ИП"
            }
        ],
        "delayRepayment": 30,
        "questions": [
            {
                "question": "Вопроc",
                "answer": "Ответ"
            },
            null,
            null
        ],
        "checkSum": "534342.00",
        "contractNumber": null,
        "availableSum": null,
        "dateSince": null,
        "dateUntil": null,
        "individual": false
    }
]

204 (No Content)

Для данной организационно-правовой формы отсутствуют предложения по кредитным продуктам

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Отсутствует

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "DESERIALIZATION_FAULT",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "Неверный формат запроса"
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8

{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959abbd54490aa9f9fb67fb7380fae5d4"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция GET_CREDIT_OFFERS. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
ACCESS_EXCEPTION	Работа с сервисом запроса кредитных предложений доступна только по собственной организации	В authorization используется access_token пользователя, который не является сотрудником вашей компании. Если требуется получить информацию по кредитным предложениям для Платформы - необходимо использовать access_token пользователя вашей компании. Если требуется получить информацию о действующем кредитном договоре Клиента - необходимо использовать access_token пользователя Клиента и не заполнять query-параметр client_id.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8

{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

429 (Too Many Requests)

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice{
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

json HTTP/1.1 429 Too Many Requests Content-Type: application/json;charset=UTF-8

{ "cause": " TOO_MANY_REQUESTS ", "referenceId": "5650c1e4-5039-4038-8cad-afab64003f61", "message": " Превышен лимит запросов. Повторите операцию позже" }

500 (Internal Server Error)

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

• Модель
• Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8

{
    "cause": "UNKNOWN_EXCEPTION",
    "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
    "message": "Внутренняя ошибка сервера"
}