Version: 1

Справочник API

Обновлено 18 декабря 2024

Доступ к API

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

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

Тестовый стенд

На тестовом стенде используйте тестовый TLS-сертификат (пароль для установки: testtest) и установите цепочку тестовых доверенных TLS-сертификатов.

Промышленный стенд

На промышленном стенде получите и используйте TLS-сертификат и установите цепочку доверенных TLS-сертификатов.

Способ получения TLS-сертификата для промышленного стенда зависит от выбранного набора API-ресурсов:

1. Компаниям и Холдингам нужно получить сертификат в Личном кабинете;
2. В иных случаях получите сертификат по инструкции для Windows или инструкции для Linux и MacOS.

После получения промышленных сертификатов сообщите об этом в Сбер.

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

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

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

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

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

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

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

• Атрибуты (claims) это данные пользователя и организации, например, accounts, activityType, 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" } ]
activityType				Вид деятельности Пример возвращаемого ответа: "activityType": {"code": "94","name": "Животноводство"}
branch				Информация о подразделении Пример возвращаемого ответа: "branch": { "name": "Публичное акционерное общество \"Сбербанк России\"", "address": null, "code": null }
buyOnCreditMmb				Признак возможности покупки в кредит на сайте партнера (Малый и Микро Бизнес) Пример возвращаемого ответа: "buyOnCreditMmb": false
creditLineAvailableSum				Сумма действующей ВКЛ (Возобновляемой кредитной линией) Пример возвращаемого ответа: "creditLineAvailableSum": "3.14"
dboContracts				Договоры обслуживания организации Пример возвращаемого ответа: "dboContracts": [ { "number": "406c158a-1f9d-40a4-9df1-2dcc9a440792", "date": "2021-09-10", "financeBlock": false }
hasActiveCreditLine				Признак наличия у клиента действующей ВКЛ (Возобновляемой кредитной линией) Пример возвращаемого ответа: "hasActiveCreditLine": false
industry				Отрасль организации Пример возвращаемого ответа: "industry": { "code": 16, "name": "Лизинг" }
inn				ИНН Пример возвращаемого ответа: "inn": "0102573875"
orgActualAddress				Адрес местонахождения компании Пример возвращаемого ответа: "orgActualAddress": "141002, RUSSIAN FEDERATION, Московская область, Мытищинский, г.Долгопрудный, ул.Мира, д.1, кв.325"
orgBusinessSegment				Бизнес-сегмент Пример возвращаемого ответа: "orgBusinessSegment": "1"
orgBusinessSegmentName				Сегмент Пример возвращаемого ответа: "orgBusinessSegmentName": "Микро"
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
regDateINN				Дата регистрации ИНН Пример возвращаемого ответа: "regDateINN": "2020-01-20"
regDateOGRN				Дата регистрации ОГРН Пример возвращаемого ответа: "regDateOGRN": "2020-01-20"
resident				Признак «резидент/нерезидент» Пример возвращаемого ответа: "resident": true
terBank				Территориальный банк Пример возвращаемого ответа: "terBank": "Московский Банк"
email				Адрес электронной почты Пример возвращаемого ответа: "email": "avangard@sbbid.ru"
emailConfirmed				Адрес электронной почты пользователя подтвержден Пример возвращаемого ответа: "emailConfirmed": true
nonClient				Признак «Неклиент» Неклиент - неверифицированный пользователь, у которого не подтверждены учетные данные, отсутствуют расчетный счет и право подписи документов Пример возвращаемого ответа: "nonClient": false
HashOrgId				Хэш идентификатора организации (orgId) Пример возвращаемого ответа: "HashOrgId": "378250884741d092b15be6ac84372b8a51e96947dd5a7005534cfe63d491e658"
individualExecutiveAgency				Признак ЕИО (Единоличный исполнительный орган) Пример возвращаемого ответа: "individualExecutiveAgency": 1
isCorpCardHolder				Признак наличия у клиента бизнес-карты Пример возвращаемого ответа: "isCorpCardHolder": false
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 Описание: Заявление на заранее данный акцепт (ЗДА) Предоставляет доступ до ресурсов: POST /v1/acceptance-advances GET /v1/acceptance-advances/{externalId} GET /v1/acceptance-advances/{externalId}/state

Код операции для включения в scope: BANK_CONTROL_STATEMENT Описание: Ведомость банковского контроля (ВБК в банк) Предоставляет доступ до ресурсов: GET /v1/bank-control-statements/{externalId}/state GET /v1/bank-control-statements/reg-curr-contracts/{externalId} GET /v1/bank-control-statements/reg-curr-contracts/list POST /v1/bank-control-statements/send-curr-contracts GET /v1/bank-control-statements/send-curr-contracts/{externalId}

Код операции для включения в scope: BANK_CONTROL_STATEMENT_CHANGE_APPLICATION Описание: Заявление о внесении изменений в I раздел ВБК Предоставляет доступ до ресурсов: POST /v1/bank-control-statements/change-curr-cred-contracts

Код операции для включения в scope: CARD_ISSUE Описание: Электронный реестр на открытие счетов и выпуск карт Предоставляет доступ до ресурсов: POST /v1/card-issues POST /v1/card-issues/{externalId}/state POST /v1/card-issues/{externalId}

Код операции для включения в scope: CERTIFICATE_REQUEST Описание: Запрос на сертификат Предоставляет доступ до ресурсов: POST /v1/crypto/cert-requests GET /v1/crypto/cert-requests/{externalId}/state POST /v1/crypto/cert-requests/{externalId}/activate GET /v1/crypto/cert-requests/{externalId}/print

Код операции для включения в scope: CONFIRMATORY_DOCUMENTS_INQUIRY Описание: Справка о подтверждающих документах Предоставляет доступ до ресурсов: POST /v1/confirmatory-documents-inquiries GET /v1/confirmatory-documents-inquiries/{externalId}/state GET /v1/confirmatory-documents-inquiries/{externalId}

Код операции для включения в scope: CORPORATE_CARDS Описание: Бизнес-карты Предоставляет доступ до ресурсов: GET /v1/corporate-card/{corpCardId} GET /v1/corporate-cards GET /v1/corporated-cards/transactions

Код операции для включения в scope: CORRESPONDENT_CUR_ADDITIONAL Описание: Дополнительная информация по валютному контрагенту (бенефициару) Предоставляет доступ до ресурсов: PUT /v1/correspondents/cur/{externalId}/additional

Код операции для включения в scope: CREDIT_REQUEST Описание: Запрос на создание заявок на кредит Предоставляет доступ до ресурсов: POST /v1/credit-requests

Код операции для включения в scope: CRYPTO_CERT_REQUEST_EIO Описание: Запрос на выпуск сертификата для ЕИО Предоставляет доступ до ресурсов: POST /v1/crypto/cert-requests/eio GET /v1/crypto/cert-requests/eio/{externalId}/state POST /v1/crypto/cert-requests/eio/{externalId}/activate

Код операции для включения в scope: CURR_CONTROL_MESSAGE_FROM_BANK Описание: Письмо для целей ВК (из банка) Предоставляет доступ до ресурсов: GET /curr-control-messages/from-bank

Код операции для включения в scope: CURR_CONTROL_MESSAGE_TO_BANK Описание: Письмо для целей ВК (в банк) Предоставляет доступ до ресурсов: POST /v1/curr-control-messages/to-bank GET /v1/curr-control-messages/to-bank/{externalId}/state

Код операции для включения в scope: CURRENCY_OPERATION_DETAILS Описание: Сведения о валютной операции Предоставляет доступ до ресурсов: POST /v1/currency-operation-details GET /v1/currency-operation-details/{externalId}/state GET /v1/currency-operation-details/{externalId}

Код операции для включения в scope: FILES Описание: Выгрузка/загрузка файлов Предоставляет доступ до ресурсов: POST /v1/files/download POST /v1/files/downloadState GET /v1/files/tasks-for-download POST /v1/files/upload GET /v1/files/upload/{fileId}/state

Код операции для включения в scope: GENERIC_LETTER_FROM_BANK Описание: Письмо свободного формата (из банка) Предоставляет доступ до ресурсов: GET /v1/generic-letters/from-bank

Код операции для включения в scope: GENERIC_LETTER_TO_BANK Описание: Письмо свободного формата (в банк) Предоставляет доступ до ресурсов: POST /v1/generic-letters/to-bank GET /v1/generic-letters/to-bank/{externalId}/state GET /v1/generic-letters/to-bank/{externalId}

Код операции для включения в scope: GET_ADVANCE_ACCEPTANCES Описание: Получение сведений о клиентах, подключенных к подпискам и пакетам услуг Предоставляет доступ до ресурсов: GET /v1/partner-info/advance-acceptances GET /v1/partner-info/package-of-services GET /v1/partner-info/offers

Код операции для включения в scope: GET_CLIENT_ACCOUNTS Описание: Получение информации о счетах подключенного клиента Предоставляет доступ до ресурсов: GET /v1/client-info

Код операции для включения в scope: GET_CORRESPONDENTS Описание: Получение списка контрагентов Предоставляет доступ до ресурсов: GET /v1/correspondents/cur GET /v1/correspondents/rur

Код операции для включения в scope: GET_CREDIT_OFFERS Описание: Получение информации по кредитным предложениям Предоставляет доступ до ресурсов: GET /v1/credit-offers

Код операции для включения в scope: GET_CRYPTO_INFO Описание: Получение криптоинформации (КУЦ, криптопрофили и т.д.) Предоставляет доступ до ресурсов: GET /v1/crypto

Код операции для включения в scope: GET_CRYPTO_INFO_EIO Описание: Получение сертификатов открытых ключей электронной подписи пользователей организации (ЕИО) Предоставляет доступ до ресурсов: GET /v1/crypto/eio

Код операции для включения в scope: GET_STATEMENT_ACCOUNT Описание: Получение выписки по счету клиента Предоставляет доступ до ресурсов: GET /v1/statement/transactions GET /v1/statement/transactions/{id} GET /v1/statement/summary GET /v1/statement/files

Код операции для включения в scope: GET_STATEMENT_TRANSACTION Описание: Получение операции по выписке Предоставляет доступ до ресурсов: GET /v1/statement/transactions/{transactionId}/print

Код операции для включения в scope: PAY_DOC_CUR Описание: Валютное платежное поручение Предоставляет доступ до ресурсов: POST /v1 /pay-doc-cur GET /v1/pay-doc-cur/{externalId}/state GET /v1/pay-doc-cur/{externalId}

Код операции для включения в scope: PAY_DOC_RU Описание: Рублевое платежное поручение Предоставляет доступ до ресурсов: POST /v1/payments GET /v1/payments/{externalId}/state GET /v1/payments/{externalId}

Код операции для включения в scope: PAY_DOC_RU_INVOICE_ANY Описание: Выставление счета на оплату по свободным реквизитам Предоставляет доступ до ресурсов: POST /v1/payments/from-invoice-any

Код операции для включения в scope: PAY_DOC_RU_INVOICE_BUDGET Описание: Рублевое платежное поручение с бюджетным реквизитами, легкая форма Предоставляет доступ до ресурсов: POST /v1/payments/from-invoice-budget

Код операции для включения в scope: PAYMENT_REQUEST_IN Описание: Входящее платежное требование Предоставляет доступ до ресурсов: GET /v1/payment-requests/incoming GET /v1/payment-requests/incoming/{externalId}/state

Код операции для включения в scope: PAYMENT_REQUEST_OUT Описание: Исходящее платежное требование Предоставляет доступ до ресурсов: POST /v1/payment-requests/outgoing GET /v1/payment-requests/outgoing/{externalId}/state

Код операции для включения в scope: PAYMENTS_REGISTRY Описание: Реестр платежей Предоставляет доступ до ресурсов: GET /v1/payments-registry PUT /v1/payments-registry/{externalId}/change-state

Код операции для включения в scope: PAYROLL Описание: Зарплатная ведомость Предоставляет доступ до ресурсов: POST /v1/payrolls GET /v1/payrolls/{externalId}/state GET /v1/payrolls/{externalId}

Код операции для включения в scope: SALARY_AGREEMENT Описание: Зарплатный договор Предоставляет доступ до ресурсов: GET /v1/salary-agreements GET /v1/salary-agreement/transport-packages

Код операции для включения в scope: SALARY_AGREEMENT_TRANSPORT_PACKAGE Описание: Транспортные пакеты Предоставляет доступ до ресурсов: GET /v1/salary-agreement/transport-packages/{externalId}/print