ym88659208ym87991671
Справочник API | Документация для разработчиков
Version: 1

Справочник API

Доступ к API

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

Для доступа к Sber API нужен TLS-сертификат, изданный Сбером. Запросы, отправленные под другим TLS-сертификатом, не будут приняты. Сертификаты для тестового и промышленного стенда различаются.

Аутентификация на промышленном стенде

Установите цепочку сертификатов.

Получить TLS-сертификат на промышленном стенде для работы с Sber API вы можете одним из двух способов:

1. Генерация контейнера TLS в личном кабинете Sber API

  • Через личный кабинет Sber API в СберБизнес по инструкции. Цепочка сертификатов содержится в сгенерированном контейнере .p12.

2. Запрос TLS - сертификата через поддержку

  • Сформируйте закрытый ключ длиной 2048 бит с применением алгоритма RSA и CSR-запрос .csr с помощью СКЗИ, запрос на сертификат должен содержать обязательные атрибуты
  • С почты уполномоченного лица отправьте файл .csr в службу поддержки supportdbo2@sberbank.ru с просьбой выпустить сертификат
  • Получите сертификат .cer в ответ
  • Используйте сертификат с закрытым ключом для аутентификации
Обязательные атрибуты CSR

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

Жирным шрифтом отмечены фиксированные значения атрибутов, обычным шрифтом – значения, которые нужно заменить на пользовательские.

OIDПолеЗначение
2.5.4.3commonName (CN)CI02745214-PROM-{ClientID}
2.5.4.11organizationalUnitName (OU)sm
2.5.4.11organizationalUnitName (OU)sbbapi-client-1y
2.5.4.11organizationalUnitName (OU)ИНН организации
2.5.4.11organizationalUnitName (OU)CI02741778
2.5.4.10organizationName (O)Полное наименование организации
2.5.4.7localityName (L)Населенный пункт
2.5.4.8stateOrProvinceName (ST)Регион
2.5.4.6countryName (C)RU

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

Авторизация запросов

Все запросы в Sber API выполняются от имени конкретного пользователя СберБизнес. Для этого:

  1. Получите токен доступа,

  2. Передавайте токен доступа (access_token) пользователя в заголовке Header в параметре Authorization при каждом запросе.

Cвоевременно обновляйте токен доступа. Компаниям для исполнения запросов нужно выбрать одного пользователя в СберБизнес.

Scope: атрибуты и операции

При подключении к Sber API в запросе нужно указывать определенные атрибуты (claims) и также список операций.

  • Атрибуты (claims) это данные пользователя и организации, например, accounts, email, orgKpp, и т. д.

  • Операция это кодовое обозначение одного или нескольких ресурсов Sber API, доступных партнеру по договору (например, ACCEPTANCE_ADVANCE, PAY_DOC_RU_INVOICE, и т. д.).

Атрибуты (claims)
Наименование атрибута (claim)ОписаниеПример возвращаемого ответа
accountsСчет, БИК, корреспондентский счет компании"accounts": [ { "corrAccountNumber": "30101810400000000225", "accountNumber": "26812810325210000156", "bic": "044525225" }, { "corrAccountNumber": "30101810400000000225", "accountNumber": "86112810623000546644", "bic": "044525225" } ]
buyOnCreditMmbПризнак возможности покупки в кредит на сайте партнера (Малый и Микро Бизнес)"buyOnCreditMmb": false
creditLineAvailableSumСумма действующей ВКЛ (Возобновляемой кредитной линией)"creditLineAvailableSum": "3.14"
hasActiveCreditLineПризнак наличия у клиента действующей ВКЛ (Возобновляемой кредитной линией)"hasActiveCreditLine": false
innИНН"inn": "0102573875"
orgBusinessSegmentБизнес-сегмент"orgBusinessSegment": "1"
orgFullNameПолное наименование компании"orgFullName": "Открытое акционерное общество \"Тестовая организация СберБизнес ID\" "
orgJuridicalAddressЮридический адрес компании"orgJuridicalAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325"
orgKppКПП"orgKpp": "577145884"
orgLawFormОрганизационно-правовая форма (полное наименование)"orgLawForm": "Открытые акционерные общества"
orgLawFormShortОрганизационно-правовая форма (принятое сокращение)"orgLawFormShort": "ОАО"
OrgNameСокращенное наименование организации"OrgName": "ОАО \"Тест СберБизнес ID\""
orgOgrnОГРН"orgOgrn": "5186069854119"
orgOkpoОКПО"orgOkpo": "00040778"
orgOktmoОКТМО"orgOktmo": "40321000000"
orgUnconfirmedПризнак «Неподтвержденная организация»"orgUnconfirmed": false
terBankТерриториальный банк"terBank": "Московский Банк"
emailАдрес электронной почты"email": "avangard@sbbid.ru"
nonClientПризнак «Неклиент»
Неклиент - неверифицированный пользователь, у которого не подтверждены учетные данные, отсутствуют расчетный счет и право подписи документов		"nonClient": false
HashOrgIdХэш идентификатора организации (orgId)"HashOrgId": "378250884741d092b15be6ac84372b8a51e96947dd5a7005534cfe63d491e658"
individualExecutiveAgencyПризнак ЕИО (Единоличный исполнительный орган)"individualExecutiveAgency": 1
nameФамилия Имя Отчество"name": "Иванов Игнат Петрович"
offerExpirationDateДата окончания срока действия согласия (оферты)"offerExpirationDate": "2022-03-09T09:25:51+0300"
phone_numberНомер телефона"phone_number": "75555555555"
tbIdentCodeКод территориального банка"tbIdentCode": "10000367"
userPositionДолжность"userPosition": "Главный специалист"
userRolesРоли пользователя"userRoles": [ "bankClient", "specialistStructuralDeposit" ]
userSignatureTypeТип подписи"userSignatureType": "Единственная подпись"
userCryptoTypeТип криптографии"userCryptoType": "SMS"
Коды операции
Код операции для включения в scopeОписание
ACCEPTANCE_ADVANCEЗаявление на заранее данный акцепт (ЗДА)
BANK_CONTROL_STATEMENTВедомость банковского контроля (ВБК в банк)
BANK_CONTROL_STATEMENT_CHANGE_APPLICATIONЗаявление о внесении изменений в I раздел ВБК
BUSINESS_CARDS_TRANSFERПеревод по бизнес-картам
CARD_ISSUEЭлектронный реестр на открытие счетов и выпуск карт
CERTIFICATE_REQUESTЗапрос на сертификат
CONFIRMATORY_DOCUMENTS_INQUIRYСправка о подтверждающих документах
CORPORATE_CARDSБизнес-карты
CORRESPONDENT_CUR_ADDITIONALДополнительная информация по валютному контрагенту (бенефициару)
CREDIT_REQUESTЗапрос на создание заявок на кредит
CRYPTO_CERT_REQUEST_EIOЗапрос на выпуск сертификата для ЕИО
CURR_CONTROL_MESSAGE_FROM_BANKПисьмо для целей ВК (из банка)
CURR_CONTROL_MESSAGE_TO_BANKПисьмо для целей ВК (в банк)
CURRENCY_OPERATION_DETAILSСведения о валютной операции
DEPOSIT_REQUESTДепозиты
DICTСправочники
FILESВыгрузка/загрузка файлов
GENERIC_LETTER_FROM_BANKПисьмо свободного формата (из банка)
GENERIC_LETTER_TO_BANKПисьмо свободного формата (в банк)
GET_ADVANCE_ACCEPTANCESПолучение сведений о клиентах, подключенных к подпискам и пакетам услуг
GET_CLIENT_ACCOUNTSПолучение информации о счетах подключенного клиента
GET_CORRESPONDENTSПолучение списка контрагентов
GET_CREDIT_OFFERSПолучение информации по кредитным предложениям
GET_CRYPTO_INFOПолучение криптоинформации (КУЦ, криптопрофили и т.д.)
GET_CRYPTO_INFO_EIOПолучение сертификатов открытых ключей электронной подписи пользователей организации (ЕИО)
GET_STATEMENT_ACCOUNTПолучение выписки по счету клиента
GET_STATEMENT_TRANSACTIONПолучение операции по выписке
MINIMUMBALANCE_REQUESTНеснижаемый остаток
NOMINAL_ACCOUNTSБезопасные сделки
PAY_DOC_CURВалютное платежное поручение
PAY_DOC_RUРублевое платежное поручение
PAY_DOC_RU_INVOICE_ANYВыставление счета на оплату по свободным реквизитам
PAY_DOC_RU_INVOICE_BUDGETРублевое платежное поручение с бюджетным реквизитами, легкая форма
PAYMENT_REQUEST_INВходящее платежное требование
PAYMENT_REQUEST_OUTИсходящее платежное требование
PAYMENTS_REGISTRYРеестр платежей
PAYROLLЗарплатная ведомость
SALARY_AGREEMENTЗарплатный договор
SALARY_AGREEMENT_TRANSPORT_PACKAGEТранспортные пакеты
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей. Вы можете запретить сохранение cookie в настройках своего браузера.