ym88659208ym87991671
Создание заявки на кредитный договор | Документация для разработчиков

Создание заявки на кредитный договор

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

Alt text /fintech/api/v1/credit-requests

Ресурс позволяет создать заявку на оформление кредитного договора. Отправьте POST-запрос /fintech/api/v1/credit-requests с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами заявки в теле запроса.

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


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

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

Request

/fintech/api/v1/credit-requests
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
CreditRequest {
  accountstringstring^[0-9]{1,34}$requiredРасчетный счет для зачисления денежных средств за заказ,
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСумма заказа,
  consentConsentobjectoptionalИнформация по согласиям от партнера,
  creditAmountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredЗапрошенная сумма кредита,
  creditProductCodestringstring^[0-9A-Za-z]{1,20}$optionalКод продукта кредитного предложения, в рамках которого оформляется заявка,
  creditTermnumbernumber^[0-9]{1,5}$requiredСрок кредита (в месяцах),
  deliveryAmountnumbernumber^[0-9]{1,16}\.[0-9]{2}$optionalСумма доставки,
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный партнером,
  limitAmountMarketplacenumbernumber^[0-9]{1,16}\.[0-9]{2}$optionalСумма кредита от маркетплейса,
  marketplaceDataMarketplaceDataobjectoptionalДанные от партнера об оборотах клиента,
  negativeOrderUrlstringURL^[a-zA-Z0-9. _ -]{1,1000}$requiredСсылка на заказ при отказе в выдаче кредита
  orderIdstringstring^[0-9A-Za-z]{1,50}$requiredИдентификатор заказа клиента (номер),
  orderInfoarray[OrderInfo]array[object]optionalИнформация о составе заказа,
  orderUrlstringURL^[a-zA-Z0-9. _ -]{1,1000}$requiredСсылка на заказ,
  payeeInfoPayeeInfoobjectrequiredРеквизиты получателя,
  purposestringstring^[a-zA-Z0-9. _ -]{1,120}$requiredНазначение платежа,
  vatAmountnumbernumber^[0-9]{1,16}\.[0-9]{2}$optionalСумма НДС
}
Consent {
  consentstringstring^(Yes|No)$requiredПолучено согласие ("Yes"/"No"),
  consentHashstringstring^[a-fA-F0-9]{256}$requiredSHA-256 хеш поля consentText,
  consentTextstringstring^[a-zA-Z0-9. _ -]$requiredТекст согласия,
  firstnamestringstring^[a-zA-Z0-9. _ -]{1,36}$requiredИмя представителя,
  lastnamestringstring^[a-zA-Z0-9. _ -]{1,36}$requiredФамилия представителя,
  middlenamestringstring^[a-zA-Z0-9. _ -]{1,36}$requiredОтчество представителя,
  positionstringstring^[a-zA-Z0-9. _ -]{1,36}$requiredДолжность представителя ("Директор"/"ИП"),
  startDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата подписания согласия
}
MarketplaceData {
  commissionsarray[Commission]array[object]optionalИнформация по комиссиям,
  sellingsarray[Selling]array[object]optionalИнформация по реализации товара,
  stockStockobjectoptionalИнформация по товарным остаткам
}
OrderInfo {
  numOfPositionintegerinteger^[0-9]{1,10}$optionalКоличество позиций/товаров,
  positionstringstring^[a-zA-Z0-9. _ -]{1,100}$optionalПозиция/Наименование товара,
  pricenumbernumber^[0-9]{1,16}\.[0-9]{2}$optionalСтоимость позиции,
  totalPricenumbernumber^[0-9]{1,16}\.[0-9]{2}$optionalИтоговая стоимость
}
PayeeInfo {
  payeeBankBicstringstring^[0-9]{9}$requiredБИК получателя,
  payeeCorrAccstringstring^[0-9]{20}$requiredКор счет получателя,
  payeeInnstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$requiredИНН получателя,
  payeeKppstringstring^([0-9]{9}|0)$requiredКПП получателя,
  payeeNamestringstring^[0-9a-zA-Zа-яА-ЯеЁ \t]+$requiredНаименование получателя
}
Commission {
  logisticnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredКомиссия за доставку и логистику,
  periodstringMM.YYYY^[0-9]{2}-[0-9]{4}$requiredМесяц реализации,
  stocknumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredНачисления за услуги склада (хранение и операции сборки-разборки, приемки и т.д.),
  transactionnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredТранзакционная комиссия
}
Selling {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredКоличество реализованного товара за период (реально выкупленный),
  fovnumbernumber^[0-9]{1,3}.[0-9]{1,2}$requiredFOV (Выкупаемость),
  gmvnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСовокупная стоимость товаров, проданных на торговой площадке за определенный период времени без учета возвратов, обмена и скидок,
  periodstringMM.YYYY^[0-9]{2}-[0-9]{4}$requiredМесяц реализации (мм.гггг),
  productDescriptionstringstring^[a-zA-Z0-9. _ -]{1,800}$requiredОписание продукта,
  revenuenumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredВыручка в руб. за период
}
Stock {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredКоличество остатка,
  assortimentintegerinteger^[0-9]{1,10}$requiredКоличество уникальных товаров (ассортимент),
  averagePricenumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСредняя цена товара,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата, на момент которой имеется остаток,
  durationintegerinteger^[0-9]{1,10}$requiredСколько дней в среднем товар лежит на складе (передается целое число, округленное математически),
  productDescriptionstringstring^[a-zA-Z0-9. _ -]{1,800}$requiredОписание продукта,
  registrationDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата регистрации партнера на площадке
  warehousingModelstringstring^[a-zA-Z0-9. _ -]{1,64}$requiredМодель работы с площадкой
}

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
CreditRequest {
  accountstringrequiredРасчетный счет для зачисления денежных средств за заказ,
  amountnumberrequiredСумма заказа,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа.
Возможные значение:
RECEIVED – запрос получен банком,
PROCESSED – кредитная заявка обработана клиентом,
  consentarray[Consent]optionalИнформация по согласиям от партнера,
  creditAmountnumberrequiredЗапрошенная сумма кредита,
  creditProductCodestringrequiredКод продукта кредитного предложения, в рамках которого оформляется заявка,
  creditTermnumberrequiredСрок кредита (в месяцах),
  deliveryAmountnumberrequiredСумма доставки,
  externalIdstringrequiredИдентификатор документа, присвоенный партнером,
  limitAmountMarketplacenumberoptionalСумма кредита от маркетплейса,
  marketplaceDataarray[MarketplaceData]optionalДанные от партнера об оборотах клиента,
  negativeOrderUrlstringrequiredСсылка на заказ при отказе в выдаче кредита
  orderIdstringrequiredИдентификатор заказа клиента (номер),
  orderInfoarray[OrderInfo]optionalИнформация о составе заказа,
  orderUrlstringrequiredСсылка на заказ,
  payeeInfoarray[PayeeInfo]optionalРеквизиты получателя,
  purposestringrequiredНазначение платежа,
  vatAmountnumberoptionalСумма НДС
}
Consent {
  consentstringrequiredПолучено согласие ("Yes"/"No"),
  consentHashstringrequiredSHA-256 хеш поля consentText,
  consentTextstringrequiredТекст согласия,
  firstnamestringrequiredИмя представителя,
  lastnamestringrequiredФамилия представителя,
  middlenamestringrequiredОтчество представителя,
  positionstringrequiredДолжность представителя ("Директор"/"ИП"),
  startDatestringrequiredДата подписания согласия
}
MarketplaceData {
  commissionsarray[Commission]optionalИнформация по комиссиям,
  sellingsarray[Selling]optionalИнформация по реализации товара,
  stockarray[Stock]optionalИнформация по товарным остаткам
}
OrderInfo {
  numOfPositionintegeroptionalКоличество позиций/товаров,
  positionstringoptionalПозиция/Наименование товара,
  pricenumberoptionalСтоимость позиции,
  totalPricenumberoptionalИтоговая стоимость
}
PayeeInfo {
  payeeBankBicstringrequiredБИК получателя,
  payeeCorrAccstringrequiredКор счет получателя,
  payeeInnstringrequiredИНН получателя,
  payeeKppstringrequiredКПП получателя,
  payeeNamestringrequiredНаименование получателя
}
Commission {
  logisticnumberrequiredКомиссия за доставку и логистику,
  periodstringrequiredМесяц реализации,
  stocknumberrequiredНачисления за услуги склада (хранение и операции сборки-разборки, приемки и т.д.),
  transactionnumberrequiredТранзакционная комиссия
}
Selling {
  amountnumberrequiredКоличество реализованного товара за период (реально выкупленный),
  fovnumberrequiredFOV (Выкупаемость),
  gmvnumberrequiredСовокупная стоимость товаров, проданных на торговой площадке за определенный период времени без учета возвратов, обмена и скидок,
  periodstringrequiredМесяц реализации (мм.гггг),
  productDescriptionstringrequiredОписание продукта,
  revenuenumberrequiredВыручка в руб. за период
}
Stock {
  amountnumberrequiredКоличество остатка,
  assortimentintegerrequiredКоличество уникальных товаров (ассортимент),
  averagePricenumberrequiredСредняя цена товара,
  datestringrequiredДата, на момент которой имеется остаток,
  durationintegerrequiredСколько дней в среднем товар лежит на складе (передается целое число, округленное математически),
  productDescriptionstringrequiredОписание продукта,
  registrationDatestringrequiredДата регистрации партнера на площадке
  warehousingModelstringrequiredМодель работы с площадкой
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULTНевозможно идентифицировать организацию плательщикаПроверьте корректность указанных реквизитов плательщика.
Документ с таким externalId уже существует в системеИспользуется externalId, который уже есть в системе (дубль). Сгенерируйте новый externalId и повторите запрос.
Отсутствует доступный открытый рублевый расчетный счет у организации плательщикаПлательщику требуется открыть рублевый расчетный счет в Сбербанке
Неизвестный счет получателя: <счет получателя платежа>Проверьте корректность указанного счета в атрибуте payeeAccount. Счет должен принадлежать компании, к которой принадлежит пользователей, чей access_token используется в authorization.
Указана некорректная ссылка на заказ
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
401 (Unauthorized Error)
CauseMessageDescription
UNAUTHORIZEDaccessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.

В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция GET_CREDIT_OFFERS. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
429 (Too Many Requests)
CauseMessageDescription
TOO_MANY_REQUESTSПревышен лимит запросов. Повторите операцию позже.Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее
НаименованиеТипОбязательностьОписание
Notice{
causestringoptionalПричина или основание сообщения,
referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.