Справочник API
Авторизация запросов
Все запросы в Sber API выполняются от имени конкретного пользователя СберБизнес. Для этого:
-
Получите токен доступа,
-
Передавайте токен доступа (access_token) пользователя в заголовке Header в параметре Authorization при каждом запросе.
Cвоевременно обновляйте токен доступа. Компаниям для исполнения запросов нужно выбрать одного пользователя в СберБизнес.
Scope: атрибуты и операции
При подключении к Sber API в запросе нужно указывать определенные атрибуты (claims) и также список операций.
-
Атрибуты (claims) это данные пользователя и организации, например,
accounts,email,orgKpp, и т. д. -
Операция это кодовое обозначение одного или нескольких ресурсов Sber API, доступных партнеру по договору (например,
ACCEPTANCE_ADVANCE,PAY_DOC_RU_INVOICE, и т. д.).
| Наименование атрибута (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": "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 | Транспортные пакеты |