ym88659208ym87991671
Сервис «Кредит в корзине» | Документация для разработчиков

Сервис «Кредит в корзине»

Обновлено 20 сентября 2024

Информация о сервисе

Кредит в корзине – это сервис для организации расчетов между юридическими лицами (ЮЛ) и индивидуальными предпринимателями (ИП) с использованием денежных средств Банка. Сервис позволяет получать информацию по кредитным предложениям от Банка для Клиентов Платформы, создавать кредитные заявки, формировать и отслеживать статус платежного документа в СберБизнес плательщика.

Ядро механизма сервиса составляют платежные поручения, которые используются в качестве платежных документов для расчетов между компаниями.

Платежное требование

Платежное поручение – это документ, который используется для указания банку перевести определенную сумму денег с одного счета на другой. Обычно это делается, когда компания хочет произвести оплату за товары или услуги, перевести деньги индивидуальному предпринимателю или юридическому лицу.

Платежные поручения используются широким кругом лиц, включая индивидуальных предпринимателей, малый и средний бизнес, крупные корпорации и даже государственные учреждения. Их используют, когда нужно сделать перевод, который требует предварительного уведомления или планирования (например, оплата аренды, коммунальных услуг или выплата заработной платы).

Подробнее о сервисе можно прочитать на сайте Банка.

До начала разработки интеграции с сервисом потребуется:

  • Заключить договор с Банком на использование сервиса "Кредит в корзине".
  • Завершить интеграцию со СберБизнес ID.
    Без сервиса СберБизнес ID настроить работу сервиса невозможно.

Терминология

  • Платформа – любой web-ресурс (сайт, интернет-магазин, мобильное приложение и т.д.), который вы, как Партнер Банка, используете в рамках клиентского пути Клиентов
  • Клиент – пользователь СберБизнес, представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары на Платформе

Схема работы сервиса

Схема работы сервиса

Варианты реализации

Ниже, в качестве примера, приведена диаграмма вариантов использования:

Варианты реализации
Выбор способа оплаты покупки

Клиент добавляет в корзину товары/услуги и переходит к оплате.

Вы ему показываете доступные способы оплаты, среди которых есть "Кредит в корзине". Клиент видит данный способ без условий для него - до авторизации СберБизнес ID и получения информации по Клиенту у вас отсутствует возможность проверить возможность кредитования Клиента и условия. После авторизации через СберБизнес ID вы вновь показываете способы оплаты, среди которых "Кредит в корзине" с условиями для Клиента (если присутствует возможность кредитования).

В случаях, когда Клиент уже авторизован на Платформе, и у вас есть access_token пользователя Клиента, уже при первой отрисовке способов оплаты вы сможете проверить возможность кредитования и предоставить полную информацию.

В данном usecase рассматривается случай первой авторизации Клиента на вашей Платформе.

Шаги

  1. Показать доступные способы оплаты
  2. Получить access_token Клиента
  3. Проверить возможность кредитования
  4. Получить информацию о действующем кредите
  5. Получить информацию по условиям кредитования
  6. Предложить выбрать способ оплаты

Участники usecase

  • Клиент — представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары вашей компании;
  • Платформа — любой web-ресурс (сайт, интернет-магазин, мобильное приложение и т.д.), который Вы используете рамках клиентского пути Клиентов;
  • Банк — в контексте данного usecase представляет из себя методы и ресурсы Sber API, к которым обращается Платформа.

Предусловия

  • Клиент находится на Платформе
  • Клиент не авторизован через СберБизнес ID
  • Клиент (пользователь) имеет доступ к работе с кредитами в СберБизнес компании

Постусловия

  • Клиент выбрал способ для оплаты покупки
Выбор способа оплаты покупки

Используемые ресурсы

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/ic/sso/api/v2/oauth/authorizeПолучение кода авторизацииopenid2. Получить access_token
2Alt text/ic/sso/api/v2/oauth/tokenПолучение токена доступаopenid2. Получить access_token
3Alt text/ic/sso/api/v2/oauth/user-infoПолучение информацииopenid2. Получить access_token
и
3. Проверить возможность кредитования
4Alt text/fintech/api/v1/credit-offersПолучение информации по кредитным предложениямGET_CREDIT_OFFERS4. Получить информацию о действующем кредите
и
5. Получить информацию по условиям кредитования
5Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenidРесурс может потребоваться для обновления access_token на любом шаге
Оплата из нового кредита

Клиент данный способ оплаты может выбрать в случае отсутствия действующего кредитного договора, а также в случае его наличия и возможности оформления еще одного.

Шаги

  1. Создать кредитную заявку
  2. Подписать кредитную заявку
  3. Получить статус платежного поручения

Участники usecase

  • Клиент — представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары вашей компании;
  • Платформа — любой web-ресурс (сайт, интернет-магазин, мобильное приложение и т.д.), который Вы используете рамках клиентского пути Клиентов;
  • Банк — в контексте данного usecase представляет из себя методы и ресурсы Sber API, к которым обращается Платформа.

Предусловия

  • Клиент завершил сценарий "Выбор способа оплаты покупки"
  • Клиент выбрал способ оплаты "Оплатить в кредит" (новая кредитная заявка "Кредит в корзине")

Постусловия

  • Клиент оплатил покупку из денежных средств, полученных по новому кредиту
Выбор способа оплаты покупки

Используемые ресурсы

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenidРесурс может потребоваться для обновления access_token на любом шаге
2Alt text/ic/sso/api/v2/oauth/user-infoПолучение информацииopenid1. Создать кредитную заявку
Может потребоваться для получения реквизитов Клиента и вашей компании.
3Alt text/fintech/api/v1/credit-requestsСоздание заявки на кредитный договорCREDIT_REQUEST1. Создать кредитную заявку
4Alt text/fintech/api/v1/payments/{externalId}/stateПолучить статус платежного порученияPAY_DOC_RU_INVOICE_ANY3. Получить статус платежного поручения
Оплата из действующего кредита

Клиент данный способ оплаты может выбрать в случае наличия действующего кредитного договора.

Шаги

  1. Создать платежное поручение
  2. Подписать платежное поручение
  3. Получить статус платежного поручения

Участники usecase

  • Клиент — представитель ЮЛ/ИП, который от лица своей компании приобретает услуги или товары вашей компании;
  • Платформа — любой web-ресурс (сайт, интернет-магазин, мобильное приложение и т.д.), который Вы используете рамках клиентского пути Клиентов;
  • Банк — в контексте данного usecase представляет из себя методы и ресурсы Sber API, к которым обращается Платформа.

Предусловия

  • Клиент завершил сценарий "Выбор способа оплаты покупки"
  • Клиент выбрал способ оплаты "Оплатить с действующего кредита"

Постусловия

  • Клиент оплатил покупку из денежных средств действующего кредита
Выбор способа оплаты покупки

Используемые ресурсы

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenidРесурс может потребоваться для обновления access_token на любом шаге
2Alt text/ic/sso/api/v2/oauth/user-infoПолучение информацииopenid1. Создать платежное поручение
Может потребоваться для получения реквизитов Клиента и вашей компании.
3Alt text/fintech/api/v1/payments/from-invoice-anyСоздать черновик платежного порученияPAY_DOC_RU_INVOICE_ANY1. Создать платежное поручение
4Alt text/fintech/api/v1/payments/{externalId}/stateПолучить статус платежного порученияPAY_DOC_RU_INVOICE_ANY3. Получить статус платежного поручения

Scope сервиса

Scope
openid+CREDIT_REQUEST+GET_CREDIT_OFFERS+PAY_DOC_RU_INVOICE_ANY+buyOnCreditMmb+creditLineAvailableSum+hasActiveCreditLine+orgLawFormShort+userCryptoType+aud+iss+inn+sub+orgFullName+email+phone_number+HashOrgId+orgKpp

Условия доступности покупки в кредит

Возможность покупки в кредит на Платформе должна предоставляться только при выполнении условия:


Значение атрибута **buyOnCreditMmb**, возвращаемого на запрос `/fintech/api/v2/oauth/user-info`, должно быть **true**.

Также у Клиента может быть действующий кредитный договор, из денежных средств которого он может оплатить покупку. Необходимо проверить значение атрибута hasActiveCreditLine - признак наличия действующей возобновляемой кредитной линии (ВКЛ). При наличии ВКЛ проверьте атрибут creditLineAvailableSum - сумма действующей ВКЛ.

Наименование организационно-правовых форм, для которых доступны кредитные продукты и предложения для покупки в кредит:

Полное наименование организационно - правовой формыОбщепринятое сокращение
Общество с ограниченной ответственностьюООО
Индивидуальный предпринимательИП
Глава крестьянского (фермерского) хозяйстваГКФХ

Заполнение заявки на кредит

Правила заполнения полей сумма заказа (amount) и запрошенная сумма кредита (creditAmount):

  • Если сумма заказа (значение amount) больше максимальной суммы доступной для покупки в кредит (значение sumMax, полученное в ответе на запрос /v1/credit-offers), то уведомлять клиента о сумме заказа, которую он может оплатить.
  • Если клиенту доступна оплата несколькими платежами, то предлагать выбор: оплатить часть заказа или изменить сумму заказа (значение amount).
  • Если клиент выбирает оплатить часть заказа, то заполнять сумму заказа (значение amount) значением остатка по кредитной линии (availableSum, полученное в ответе на запрос /v1/credit-offers).
  • Если сумма заказа (значение amount) меньше минимальной суммы доступной для покупки в кредит (значение sumMin, полученное в ответе на запрос /v1/credit-offers), то заполнять сумму заказа значением amount, а запрошенную сумму кредита (creditAmount) заполнять минимальной суммой доступной для покупки в кредит (sumMin).
  • Если сумма заказа (значение amount) между минимальной (sumMin) и максимальной (sumMax) суммами доступными для покупки в кредит, то заполнять сумму заказа и запрошенную сумму кредита (creditAmount) значением amount.

Переадресация на кредитную заявку

Платформа создает заявку на кредитный договор в СберБизнес Клиента. Необходимо переадресовать пользователя Клиента в заявку для завершения оформления кредитного договора.

Пользователь Клиента, перейдя по ссылке на кредитную заявку, пройдет аутентификацию, заполнит кредитную заявку и подпишет ее для исполнения Банком. После получения положительного решения по заявке Клиенту автоматически будет создано платежное поручение для оплаты заказа.

Ссылка переадресации выглядит следующим образом:

{контур Банка}/ic/dcb/index.html#/credits/credit-financing/credit-partners?order={externalId}

ПеременнаяОписаниеДополнительная информация
{контур Банка}адрес Банка, на который делается запрос для открытия страницы сервиса оплатыДля корректного выбора контура Банка потребуется определить тип криптопрофиля пользователя Клиента.
В рамках запроса /ic/sso/api/v1/oauth/user-info вы получаете данные по Клиенту, в том числе атрибут userCryptoType.
Атрибут позволяет определить криптопрофиль пользователя - SMS (СМС) или Token (электронный ключ (токен)).

- Тестовый контур https://efs-sbbol-ift-web.testsbi.sberbank.ru:9443
- Промышленный контур СМС-пользователь https://sbi.sberbank.ru:9443
- Промышленный контур Токен-пользователь http://localhost:28016
{externalid}уникальный идентификатор платежного документаДанный идентификатор присваивает ваша Платформа на шаге создания кредитной заявки

Переадресация на платежное поручение

Чтобы Банк начал обработку платежного поручения, платежное поручение должно быть подписано. В клиентском пути сервиса платежное поручение формируется в клиентской части СберБизнес Клиента, поэтому и подписывать платежное поручение должен Клиент.

Для реализации бесшовного перехода в клиентскую часть СберБизнес необходима переадресация Клиента. Перейдя по ссылке в сервис оплаты, клиент пройдет аутентификацию, выберет счет списания и подпишет черновик платежного поручения для его исполнения Банком.

Ссылка переадресации выглядит следующим образом:

{контур Банка}/ic/dcb/index.html#/payment-creator/{externalid}?backUrl={backUrl}

ПеременнаяОписаниеДополнительная информация
{контур Банка}адрес Банка, на который делается запрос для открытия страницы сервиса оплатыДля корректного выбора контура Банка потребуется определить тип криптопрофиля пользователя Клиента.
В рамках запроса /v1/oauth/user-info вы получаете данные по Клиенту, в том числе атрибут userCryptoType.
Атрибут позволяет определить криптопрофиль пользователя - SMS (СМС) или Token (электронный ключ (токен)).

- Тестовый контур https://efs-sbbol-ift-web.testsbi.sberbank.ru:9443
- Промышленный контур СМС-пользователь https://sbi.sberbank.ru:9443
- Промышленный контур Токен-пользователь http://localhost:28016
{externalid}уникальный идентификатор платежного документаДанный идентификатор присваивает ваша Платформа на шаге создания платежного поручения
{backUrl}страница возврата, на которую Банк вернет пользователя Клиента после успешного подписания черновика платежного поручения- backUrl нужно закодировать URLEncode;
- Если не указать backUrl в ссылке, пользователи не смогут после подписания платежного поручения вернуться на Платформу;
- Если backUrl будет отличаться от адреса вашей платформы, который указали при регистрации в Банке, то при возврате клиента на backUrl он будет видеть ошибку.

Получение информации по кредитным предложениям

Alt text /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
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
QUERY-PARAMETERS
clientIDnumbernumber^(?![^]*[0-9]){14}$optionalИдентификатор сервиса,
lawFormstringstring^(ООО|ИП|ГКФХ)$optionalОбщепринятое сокращение организационно-правовой формы организации, для которой необходимо получить кредитные предложения

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
creditOffers [
  creditOfferarray[creditOffer]optionalКредитное предложение
]
creditOffer {
  checkSumnumberoptionalСумма займа, после которой потребуется выездная проверка по месту ведения бизнеса,
  clientIdnumberrequiredИдентификатор внешнего сервиса,
  delayRepaymentintegeroptionalЛьготный период,
  individualbooleanoptionalЯвляется ли клиент ФЛ,
  orgLawFormsarray[OrgLawForm]optionalПеречень организационно-правовых форм организаций, для которых доступен кредитный продукт,
  productCodestringrequiredКод кредитного продукта,
  productNamestringoptionalНаименование кредитного продукта,
  questionsarray[QuestionForm]optionalСписок топ вопросов с ответами по созданию кредитной заявки,
  ratestringoptionalСтавка по кредитному предложению (%),
  sumMaxnumberoptionalМаксимальная сумма доступная для покупки в кредит,
  sumMinnumberoptionalМинимальная сумма доступная для покупки в кредит,
  termMaxnumberoptionalМаксимальный срок кредита (в месяцах),
  termMinnumberoptionalМинимальный срок кредита (в месяцах),
  contractNumberstringoptionalНомер договора,
  availableSumstringoptionalСумма лимита,
  dateSincedateoptionalДата начала действия договора,
  dateUntildateoptionalДата окончания договора
}
OrgLawForm {
  namestringrequiredПолное наименование организационно-правовой формы,
  shortNamestringrequiredОбщепринятое сокращение организационно-правовой формы
}
QuestionForm {
  answerstringoptionalОтвет на вопрос по созданию кредитной заявки,
  questionstringoptionalВопрос по созданию кредитной заявки
}
204 (No Content)

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

НаименованиеТипОбязательностьОписание
Отсутствует
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request метода. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULTОшибка валидацииДанные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request метода, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.
НаименованиеТипОбязательностьОписание
ResourceFault {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
  checksarray[Check]optionalСписок проверок, приведших к ошибке,
  fieldNamesarray[string]optionalНазвания полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
  levelstringoptionalУровень результата = ['ERROR', 'WARNING'],
  messagestringoptionalСообщение,
  fieldsarray[string]optionalНазвания полей (при наличии связи с моделью)
}
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.
ACCESS_EXCEPTIONРабота с сервисом запроса кредитных предложений доступна только по собственной организацииВ authorization используется access_token пользователя, который не является сотрудником вашей компании.

Если требуется получить информацию по кредитным предложениям для Платформы - необходимо использовать access_token пользователя вашей компании.

Если требуется получить информацию о действующем кредитном договоре Клиента - необходимо использовать access_token пользователя Клиента и не заполнять query-параметр client_id.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

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

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Сообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.