Операции и URL для вызова Sber API

Обновлено 12 марта 2024

Раздел содержит перечень операций и ресурсы, доступ до которых предоставляет операция при включении в scope. Ресурсы доступны Приложению Партнеру после авторизации пользователя.

Все перечисленные API доступны по следующим host:

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

Тестовые контуры:

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

• Swagger UI тестового контура https://iftfintech.testsbi.sberbank.ru:9443/fintech/api/swagger-ui.html

• Swagger UI СберБизнесID тестового контура https://iftfintech.testsbi.sberbank.ru:9443/ic/sso/api/swagger-ui.html

Для вызова API на указанных host требуется TLS сертификат

Код операции для включения в scope: ACCEPTANCE_ADVANCE Описание: Заявление на заранее данный акцепт (ЗДА) Предоставляет доступ до ресурсов: POST /v1/acceptance-advances GET /v1/acceptance-advances/{externalId} GET /v1/acceptance-advances/{externalId}/state

Код операции для включения в scope: ACCEPTANCE_LETTER Описание: Заявление об акцепте (отказе от акцепта) Предоставляет доступ до ресурсов: POST /v1/acceptance-letters GET /v1/acceptance-letters/{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-contracts POST /v1/bank-control-statements/change-curr-cred-contracts GET /v1/bank-control-statements/change-applications/{externalId}/state

Код операции для включения в scope: BUSINESS_CARD_LIMIT Описание: Изменение лимита по бизнес-карте Предоставляет доступ до ресурсов: GET /v1/business-cards POST /v1/business-cards/limits GET /v1/business-cards/limits/{externalId}/state

Код операции для включения в 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: CLIENT_ACCRUAL Описание: Начисление платы за пользование сервисом Предоставляет доступ до ресурсов: POST /v1/client-accruals GET /v1/client-accruals/{externalId}

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

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

Код операции для включения в scope: CONTRACT_CLOSE_APPLICATION Описание: Заявление о снятии с учета контракта (кредитного договора) Предоставляет доступ до ресурсов: POST /v1/contract-close-applications GET /v1/contract-close-applications/{externalId}/state GET /v1/confirmatory-documents-inquiries/{externalId}/state GET /v1/contract-close-applications/{externalId}

Код операции для включения в scope: CORPORATE_CARD_REQUEST Описание: Заявление на открытие бизнес-карты Предоставляет доступ до ресурсов: POST /v1/corporate-card-request GET /v1/corporate-card-request/{externalId}/state

Код операции для включения в 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_BUY Описание: Покупка и конверсия валюты Предоставляет доступ до ресурсов: POST /v1/curr-buy GET /v1/curr-buy/{externalId}/state GET /v1/curr-buy/{externalId}

Код операции для включения в scope: CURR_CONTROL_INFO_REQ Описание: Запрос информации ВК Предоставляет доступ до ресурсов: POST /v1/curr-control-info-reqs

Код операции для включения в 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: CURR_SELL Описание: Продажа валюты Предоставляет доступ до ресурсов: POST /v1/curr-sell GET /v1/curr-sell/{externalId}/state GET /v1/curr-sell/{externalId}

Код операции для включения в scope: CURRENCY_NOTICES Описание: Уведомление о поступлении денежных средств на транзитный валютный счет Предоставляет доступ до ресурсов: GET /v1/currency-notices

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

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

Код операции для включения в scope: DICT Описание: Справочник Предоставляет доступ до ресурсов: POST /v1/obm-request/business-mission GET /v1/obm-request/{externalId}/state GET /v1/dicts?name={name}

Код операции для включения в scope: ENCASH_DOCUMENTS Описание: Получение и передача информации по документам инкассации Предоставляет доступ до ресурсов: GET /v1/encash/encash-contracts POST /v1/encash/encash-add-requests GET /v1/encash/encashment-object-center GET /v1/encash/encash-add-requests/{externalId}/state GET /v1/encash/encashment-offers POST /v1/encash/encashment-offers/{externalId}/acceptance

Код операции для включения в scope: EXPORT_CONTRACT_INSURE Описание: Заявление на страхование экспортного контракта Предоставляет доступ до ресурсов: GET /v1/export-contract-insure/{externalId} POST /v1/export-contract-insure/{externalId}/change-state

Код операции для включения в scope: EXTERNAL_SYSTEM_AUTH_PROFILE Описание: Авторизационные данные пользователя во внешних системах Предоставляет доступ до ресурсов: POST /v1/external-system-auth-profiles DELETE /v1/external-system-auth-profiles/{extSystemId}

Код операции для включения в 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_BANK_PRODUCTS Описание: Подключенные клиенту банковские продукты Предоставляет доступ до ресурсов: GET /v1/client-bank-products

Код операции для включения в 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_EXTSRV_PRODUCTS Описание: Подключенные клиенту внешние сервисы Предоставляет доступ до ресурсов: GET /v1/client-extservice-products

Код операции для включения в 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: GET_TARIFF_PLANS Описание: Запросы на получение тарифных планов организации Предоставляет доступ до ресурсов: GET /v1/tariff-plans/list-activated GET /v1/tariff-plans

Код операции для включения в scope: GET_TARIFF_PLANS_LIST_AVAILABLE Описание: Получение списка тарифных планов, доступных партнерскому сервису Предоставляет доступ до ресурсов: GET /v1/tariff-plans/list-available

Код операции для включения в scope: ORDER_MANDATORY_SALE Описание: Распоряжение на перевод с транзитного счета Предоставляет доступ до ресурсов: POST /v1/orders-mandatory-sale GET /v1/orders-mandatory-sale/{externalId}/state GET /v1/orders-mandatory-sale/{externalId}

Код операции для включения в 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: PERSONAL_OFFERS Описание: Персональные предложения Предоставляет доступ до ресурсов: GET /v1/personal-offers POST /v1/personal-offers/response

Код операции для включения в 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

Код операции для включения в scope: SELF_ENCASHER_BLOCK Описание: Блокировка вносителя самоинкассации Предоставляет доступ до ресурсов: POST /v1/self-encashers/block

Код операции для включения в scope: SELF_ENCASHER_NEW_PASSWORD Описание: Генерация нового пароля вносителя самоинкассации Предоставляет доступ до ресурсов: POST /v1/self-encashers/new-password

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

Код операции для включения в scope: SHIPPING_TARIFF Описание: Тариф по международной логистике Предоставляет доступ до ресурсов: GET /v1/shipping-tariffs

Код операции для включения в scope: TARIFF_PLAN_MANAGEMENT Описание: Запросы на управление тарифными планами организации Предоставляет доступ до ресурсов: POST /v1/tariff-plans/activation POST /v1/tariff-plans/account-update

Код операции для включения в scope: TARIFF_PLAN_MANAGEMENT_JWS Описание: Запросы на управление тарифными планами организации (формат JWS) Предоставляет доступ до ресурсов: POST /v1/tariff-plans/activation POST /v1/tariff-plans/account-update