ym88659208ym87991671
ВЭД | Документация для разработчиков

ВЭД

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

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

Внешнеэкономическая деятельность (ВЭД) — представляет собой комплексную систему экономических отношений между субъектами хозяйствования страны и иностранными партнерами.

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

Основные функции Банка в ВЭД:

  • Валютные операции. Банки предоставляют услуги по обмену валюты, что позволяет клиентам совершать сделки с иностранными партнерами.
  • Международные расчеты. Банки обеспечивают проведение международных платежей, включая аккредитивы, инкассо и переводы. Это упрощает процесс оплаты товаров и услуг между контрагентами из разных стран.
  • Торговое финансирование. Банки предлагают различные формы финансирования для поддержки внешнеторговых операций, такие как кредиты, гарантии и аккредитивы.
  • Документарные операции. Банки осуществляют проверку документов, необходимых для проведения внешнеэкономических сделок, таких как контракты, счета-фактуры и транспортные документы.
  • Консультирование. Банки предоставляют консультации по вопросам валютного контроля, таможенного оформления и другим аспектам ВЭД.

Таким образом, банк является ключевым звеном в процессе осуществления внешнеэкономической деятельности, обеспечивая безопасность и эффективность финансовых операций между участниками ВЭД.


Авторизация

Все запросы в Sber API выполняются от имени конкретного пользователя СберБизнес, в том числе при интеграции для работы с информацией только по собственной компании. Запросы в Sber API в заголовке (Header) содержат параметр - Authorization. В нем требуется передавать токен доступа (access_token) пользователя. Получение токена доступа осуществляется с помощью сервиса СберБизнес ID. Подробно о подключении и работе сервиса авторизации рассказали в соответствующем разделе документации.

При интеграции по собственной компании потребуется выбрать одного пользователя СберБизнес и пройти им авторизацию через СберБизнес ID единоразово. В дальнейшем вам потребуется своевременно обновлять токен доступа при помощи токена обновления - обновить токен доступа.


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

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

Сценарии описали общие, для более легкого восприятия информации описания работы с продуктом Зарплатный проект в Sber API.

Можно использовать разные триггеры запуска того или иного сценария - действия пользователя, регламентный запуск по времени, наступление определенных событий и другие варианты.

Варианты реализации
Постановка контракта на учет

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


Для постановки контракта на учет в Банке потребуется загрузить документы. Для загрузки документов используйте сценарий Загрузка файлов в Банк (описан ниже).


Шаги

  1. Получить данные по контракту
  2. Загрузить файлы контракта в Банк
  3. Создать заявление на регистрацию контракта
  4. Получить статус заявления
  5. Получить полные данные контракта

Участники usecase

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

Предварительные условия

  • Пользователь имеет пользовательский профиль в СберБизнес своей компании
  • Пользователь находится в пространстве Платформы
  • Пользователь прошел авторизацию с помощью СберБизнес ID

Результат применения

  • Банк поставил на учет валютный контракт
Постановка контракта на учет

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/client-infoПолучение расширенной информацииGET_CLIENT_ACCOUNTS1. Получить данные по контракту
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить данные по контракту
3Alt text/fintech/api/v1/bank-control-statements/reg-curr-contractsСоздание валютного контракта с нерезидентомBANK_CONTROL_STATEMENT3. Создать заявление на регистрацию контракта
4Alt text/fintech/api/v1/bank-control-statements/{externalId}/stateПолучение статуса ведомости банковского контроляBANK_CONTROL_STATEMENT4. Получить статус заявления
5Alt text/fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}Получение документа валютный контракт с нерезидентомBANK_CONTROL_STATEMENT4. Получить статус заявления
Получение информации по контрактам

В рамках Sber API можно будет вывести информацию по валютным контрактам, которые были поставлены на учет также с помощью Sber API.

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


Шаги

  1. Получить все идентификаторы контрактов
  2. Получить информацию по контракту
  3. Вывести пользователю интересующий контракт

Участники usecase

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

Предварительные условия

  • Пользователь имеет пользовательский профиль в СберБизнес своей компании
  • Пользователь находится в пространстве Платформы
  • Пользователь прошел авторизацию с помощью СберБизнес ID
  • Платформа успешно поставила на учет хотя бы 1 валютный контракт с помощью сценария «Постановка контракта на учет»

Результат применения

  • Пользователь получил информацию по интересующему его валютному контракту
Получение информации по контрактам

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/bank-control-statements/reg-curr-contracts/listПолучение списка ВБК по контрактуBANK_CONTROL_STATEMENT1. Получить все идентификаторы контрактов
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить все идентификаторы контрактов
3Alt text/fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}Получение документа валютный контракт с нерезидентомBANK_CONTROL_STATEMENT2. Получить информацию по контракту
Получение СПД

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


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

Оформление СПД необходимо для соблюдения требований валютного законодательства Российской Федерации. Это позволяет банкам контролировать выполнение контрактных обязательств и предотвращать нарушения валютных правил.

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

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


Шаги

  1. Заполнить данные по СПД
  2. Загрузить документы в банк
  3. Отправить запрос на создание СПД
  4. Получить статус запроса

Участники usecase

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

Предварительные условия

  • Успешно выполнен сценарий "Получение информации по контрактам"
  • Платформа сохранила данные контракта, в рамках которого оформляется СПД
  • Пользователь находится в UI с валютным контрактом, по которому хочет сформировать СПД

Результат применения

  • Оформлена СПД в рамках валютного контракта, поставленного на учет в Сбере
Получение СПД

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/confirmatory-documents-inquiriesСоздание справки о подтверждающих документахCONFIRMATORY_DOCUMENTS_INQUIRY3. Отправить запрос на создание СПД
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid3. Отправить запрос на создание СПД
3Alt text/fintech/api/v1/confirmatory-documents-inquiries/{externalId}/stateПолучение статуса справки о подтверждающих документахCONFIRMATORY_DOCUMENTS_INQUIRY4. Получить статус запроса
4Alt text/fintech/api/v1/confirmatory-documents-inquiries/{externalId}Получение документа справка о подтверждающих документахCONFIRMATORY_DOCUMENTS_INQUIRY4. Получить статус запроса
Получение СВО

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


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


Шаги

  1. Заполнить данные по СВО
  2. Загрузить документы в банк
  3. Отправить запрос на создание СВО
  4. Получить статус запроса

Участники usecase

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

Предварительные условия

  • Пользователь имеет пользовательский профиль в СберБизнес своей компании
  • Пользователь находится в пространстве Платформы
  • Пользователь прошел авторизацию с помощью СберБизнес ID

Результат применения

  • Оформлена СВО
Получение СВО

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/currency-operation-detailsСоздание сведений о валютной операцииCURRENCY_OPERATION_DETAILS3. Отправить запрос на создание СВО
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid3. Отправить запрос на создание СВО
3Alt text/fintech/api/v1/currency-operation-details/{externalId}/stateПолучение статуса сведений о валютной операцииCURRENCY_OPERATION_DETAILS4. Получить статус запроса
4Alt text/fintech/api/v1/currency-operation-details/{externalId}Получение документа сведения о валютной операцииCURRENCY_OPERATION_DETAILS4. Получить статус запроса
Валютный перевод

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


Шаги

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

Участники usecase

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

Предварительные условия

  • Пользователь имеет пользовательский профиль в СберБизнес своей компании
  • Пользователь находится в пространстве Платформы
  • Пользователь прошел авторизацию с помощью СберБизнес ID

Результат применения

  • Создано и подписано валютное платежное поручение
Валютный перевод

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/client-infoПолучение расширенной информацииGET_CLIENT_ACCOUNTS1. Получить реквизиты перевода
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить реквизиты перевода
3Alt text/fintech/api/v1/pay-doc-curСоздание валютного платежного порученияPAY_DOC_CUR2. Создать и подписать валютное платежное поручение
Проверка статуса и корректности оплаты (В)

Время начала и частоту проверки статуса и корректности оплаты вы определяете самостоятельно исходя из своих бизнес-задач.


Шаги

  1. Получить статус оплаты
  2. Проверить корректность

Участники usecase

  • Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
  • Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предварительные условия

  • Успешно выполнен сценарий «Валютный перевод»
  • Платформа сохранила идентификатор (extertalId) валютного платежного поручения, созданного в рамках сценария «Валютный перевод»

Результат применения

  • Валютное платежное поручение оплачено
  • Проверена корректность проведенной оплаты
Проверка статуса и корректности оплаты (В)

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/pay-doc-cur/{externalId}/stateПолучение статуса валютного платежного порученияPAY_DOC_CUR1. Получить статус оплаты
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить статус оплаты
3Alt text/fintech/api/v1/pay-doc-cur/{externalId}Получение валютного платежного порученияPAY_DOC_CUR2. Проверить корректность
Рублевый перевод

В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


Шаги

  1. Получить реквизиты перевода
  2. Создать и подписать рублевое платежное поручение

Участники usecase

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

Предварительные условия

  • Пользователь имеет пользовательский профиль в СберБизнес своей компании
  • Пользователь находится в пространстве Платформы
  • Пользователь прошел авторизацию с помощью СберБизнес ID

Результат применения

  • Создано и подписано рублевое платежное поручение
Рублевый перевод

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/client-infoПолучение расширенной информацииGET_CLIENT_ACCOUNTS1. Получить реквизиты перевода
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить реквизиты перевода
3Alt text/fintech/api/v1/paymentsСоздание рублевого платежного порученияPAY_DOC_RU2. Создать и подписать рублевое платежное поручение
Проверка статуса и корректности оплаты (Р)

Время начала и частоту проверки статуса и корректности оплаты вы определяете самостоятельно исходя из своих бизнес-задач.


Шаги

  1. Получить статус оплаты
  2. Проверить корректность

Участники usecase

  • Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
  • Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предварительные условия

  • Успешно выполнен сценарий «Рублевый перевод»
  • Платформа сохранила идентификатор (extertalId) рублевого платежного поручения, созданного в рамках сценария «Рублевый перевод»

Результат применения

  • Рублевое платежное поручение оплачено
  • Проверена корректность проведенной оплаты
Проверка статуса и корректности оплаты (В)

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/pay-doc-cur/{externalId}/stateПолучение статуса валютного платежного порученияPAY_DOC_CUR1. Получить статус оплаты
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить статус оплаты
3Alt text/fintech/api/v1/pay-doc-cur/{externalId}Получение валютного платежного порученияPAY_DOC_CUR2. Проверить корректность
Отправка письма в валютный контроль

Сценарий позволит отправить обращение в Валютный контроль Банка по вопросам, связанным с работой ВЭД в рамках Сбера.

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


В схеме можно использовать автоматизированное подписание документа. Данная возможность доступна только при использовании ЭЦП сотрудника вашей компании (для отправки по собственной компании) или сотрудника дочерней компании (для отправки по дочерней компании).

Подробнее об использовании ЭЦП в Sber API можно почитать в одноименном разделе.


Шаги

  1. Получить данные для письма
  2. Загрузить документы в банк
  3. Создать и подписать письмо в банк
  4. Получить статус отправки письма

Участники usecase

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

Предварительные условия

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

Результат применения

  • Письмо отправлено и принято Валютным контролем Банка
Отправка письма в валютный контроль

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/curr-control-messages/to-bankСоздание письма для целей ВК (в банк)CURR_CONTROL_MESSAGE_TO_BANK3. Создать и подписать письмо в банк
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid3. Создать и подписать письмо в банк
3Alt text/fintech/api/v1/curr-control-messages/to-bank/{externalId}/stateПолучение статуса письма для целей ВК (в банк)CURR_CONTROL_MESSAGE_TO_BANK4. Получить статус отправки письма
Получение писем от валютного контроля

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


Шаги

  1. Получить письма из банка

Участники usecase

  • Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
  • Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предварительные условия

  • У Платформы есть токены доступа Пользователя, полученные с помощью СберБизнес ID

Результат применения

  • Платформа получила письма от Валютного контроля за период
Получение писем от валютного контроля

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/curr-control-messages/from-bankПолучение писем для целей ВК (из банка)CURR_CONTROL_MESSAGE_FROM_BANK1. Получить письма из банка
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить письма из банка
Загрузка файлов в Банк

Этот сценарий позволяет загружать файлы и документы в систему Банка. Ссылки на эти файлы и документы можно будет использовать в запросах API.


Мы рекомендуем использовать сценарий с автоматическим запуском в других сценариях.

Представим, что ваша Платформа предлагает Пользователю создать запрос на постановку контракта на учет через форму в пользовательском интерфейсе (UI). В этой форме Пользователь загружает документы контракта.

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


Шаги

  1. Получить ссылку для загрузки
  2. Загрузить файл
  3. Получить статус загрузки

Участники usecase

  • Платформа - любой web-ресурс (интернет-магазин, облачный сервис, мобильное приложение и т.д.) либо ваша внутренняя система (ERP, учетная система и др.), которую используют Пользователи
  • Sber API - в контексте usecase представляет из себя запросы и ресурсы Sber API, к которым обращается Платформа

Предварительные условия

  • Запускается внутри одного из сценариев *У Платформы есть токены доступа Пользователя, полученные с помощью СберБизнес ID

Результат применения

  • Файл загружен в Банк
  • Платформа получила ссылку на файл в системе Банка
Загрузка файлов в Банк

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

№МетодТочка вызоваОписаниеОперация в scopeШаг в схеме
1Alt text/fintech/api/v1/files/uploadЗапрос ссылки на загрузку файла в БанкFILES1. Получить ссылку для загрузки
2Alt text/ic/sso/api/v2/oauth/tokenОбновление токена доступаopenid1. Получить ссылку для загрузки
3Alt text/fintech/api/v1/files/upload/{fileId}/stateПолучение статуса загрузки файлаFILES3. Получить статус загрузки

Валютные платежные поручения

Создание валютного платежного поручения

Alt text /fintech/api/v1/pay-doc-cur

Ресурс позволяет создать валютное платежное поручение.

Для создания валютного платежного поручения необходимо отправить POST-запрос /fintech/api/v1/pay-doc-cur с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле запроса.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR для получения доступа к этому запросу.

  • Если в запросе на создание документа передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то документ будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/pay-doc-cur
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
PayDocCur {
  addInfostringstring^.{1,300}$optionalПримечание,
  additionalInfostringstring^.{1,220}$optionalИнформация получателю платежа (дополнительная информация), поле 72,
  amountTransferAmountCurrencyobjectrequiredСумма перевода,
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  b77infostringstring^.{1,109}$optionalИнформация для регулирующих органов,
  beneficiaryAccountstringISO 13616^[0-9]{1,34}$optionalСчет бенефициара,
  beneficiaryAddressstringstring???optionalАдрес бенефициара ,
  beneficiaryBankAccountstringstring???optionalКорреспондентский счет банка бенефициара ,
  beneficiaryBankAddressstringstring^.{1,255}$optionalАдрес банка бенефициара,
  beneficiaryBankBranchNamestringstring^.{1,70}$optionalНаименование филиала банка бенефициара,
  beneficiaryBankClearingCodeClearingCodeobjectoptionalКлиринговый код банка бенефициара,
  beneficiaryBankCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		requiredЦифровой код страны банка бенефициара,
  beneficiaryBankCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country		requiredISO-код страны банка бенефициара ,
  beneficiaryBankNamestringstring^.{1,140}$requiredНаименование банка бенефициара,
  beneficiaryBankPlacestringstring^.{1,255}$requiredМестонахождение банка бенефициара,
  beneficiaryBankSwiftstringBIC-код^([0-9]{8}|[0-9]{11})$optionalSWIFT-код банка бенефициара,
  beneficiaryBeiCodestringBEI-код^[0-9]{11}$optionalBEI-код банка бенефициара,
  beneficiaryCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		requiredЦифровой код страны бенефициара,
  beneficiaryCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country		requiredISO-код страны бенефициара,
  beneficiaryCountryNamestringstring^.{1,255}$optionalНаименование страны бенефициара на русском языке (краткое наименование),
  beneficiaryInnstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$optionalИНН бенефициара.

Не заполняется при paymentDirection \= 0,
  beneficiaryNamestringstring^.{1,140}$requiredНаименование бенефициара,
  beneficiaryPlacestringstring^.{1,35}$requiredГород (месторасположение) бенефициара,
  chargesTypestringstring^(BEN|SHA|OUR)$requiredТип комиссии за перевод.

BEN - ;
 SHA - ;
* OUR - ,
  codes23earray[Code23e]arrayoptional23E: Код инструкции,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.

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

О подписании дайджеста платежного документа подробно рассказали в соответствующем разделе документации.
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно,
  iMediaBankAddressstringstring^.{1,255}$optionalАдрес банка-посредника,
  iMediaBankCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		optionalЦифровой код страны банка-посредника,
  iMediaBankCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country		optionalISO-код страны банка-посредника,
  iMediaBankNamestringstring^.{1,140}$optionalНаименование банка-посредника,
  iMediaBankPlacestringstring^.{1,35}$optionalГород банка-посредника,
  iMediaBankSwiftstringBIC-код^([0-9]{8}|[0-9]{11})$optionalSWIFT-код банка-посредника,
  iMediaClearingCodeClearingCodeobjectoptionalКлиринговый код банка-посредника,
  iMediaFilialBankNamestringstring???optionalНаименование филиала банка-посредника,
  innstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$requiredИНН клиента,
  linkedDocsarray[LinkedDoc]arrayoptionalСвязанные документы,
  numberstringstring^[0-9]{1,7}$optionalНомер документа,
  option50astringstring^(K|F)$requiredОпция 50а.

K - ;
 F - ,
  option56astringstring^(A|D)$optionalОпция 56a.

A - ;
 **D** - ,
  option57astringstring^(A|D)$requiredОпция 57а.

A - ;
 D - ,
  option59astringstring^(A|F)$optionalОпция 59а.

A - ;
 F - ,
  orgNamestringstring^.{1,160}$requiredСокращенное наименование организации клиента,
  payerAccountstringstring^[0-9]{20}$requiredСчет плательщика,
  payerAddressstringstring^.{1,120}$requiredАдрес плательщика,
  payerBankBicstringstring^[0-9]{9}$requiredБИК банка плательщика,
  payerBankPlacestringstring^.{1,35}$optionalМестонахождение банка плательщика,
  payerCountryDigitalstringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		requiredЦифровой код страны перевододателя,
  payerCountryIso2stringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника Country		requiredISO-код страны перевододателя,
  payerCountryNamestringstring^.{1,255}$requiredНаименование страны перевододателя на русском языке (краткое наименование),
  payerNamestringstring^.{1,140}$requiredМеждународное наименование плательщика,
  payerPlacestringstring^.{1,35}$requiredГород (местонахождение) плательщика,
  paymentDetailsstringstring^.{1,140}$requiredНазначение платежа,
  paymentDirectionstringstring^(0|1)$requiredНаправление платежа (Платеж внутри или вне СБРФ).

1 - внутри;
 0 - вне,
  rateAgreebooleanboolean^(true|false)$requiredС курсом проведения конверсионной операции согласны,
  urgentbooleanboolean^(true|false)$requiredСрочность.

Значение true необходимо отправлять в случае, если по счету списания есть возможность отправлять неотложные платежи
}
AmountCurrency {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСумма,
  currencyCodestringISO 4217^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника CurDict		requiredЦифровой код валюты,
  currencyNamestringISO 4217^[A-Z]{3}$

Актуальный список значений можно получить с помощью справочника CurDict		requiredБуквенный ISO-код валюты
}
ClearingCode {
  clearingCodestringНКС^.{1,11}$ ???optionalКлиринговый код,
  countryCodestringISO 3166-1^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника ClearingStructure		optionalISO-код код страны,
  shortNamestringНКС^.{1,140}$

Актуальный список значений можно получить с помощью справочника ClearingStructure		optionalСокращенное наименование национального клирингового кода,
  symbolstringНКС^[A-Z]{2}$

Актуальный список значений можно получить с помощью справочника ClearingStructure		optionalОбозначение национального клирингового кода,
}
Code23e {
  codestringstring^[A-Z]{4}$

Актуальный список значений можно получить с помощью справочника Instruction23		requiredКод инструкции,
  descriptionstringstring^.{1,255}$optionalОписание,
  infostringstring^.{1,30}$optionalДополнительная информация
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateUuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа во внешней системе,
  typestringstring^[a-zA-Z0-9. \ _ -]{1,50}$requiredТип связанного документа
}

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
PayDocCur {
  acceptDatestringoptionalДата представления в банк ,
  addInfostringoptionalПримечание,
  additionalInfostringoptionalИнформация получателю платежа (дополнительная информация), поле 72,
  amountDebitTotalnumberoptionalФактическая сумма списанной валюты,
  amountTransferAmountCurrencyrequiredСумма перевода,
  amountTransferTotalnumberoptionalФактическая сумма переведенной валюты ,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  b77infostringoptionalИнформация для регулирующих органов,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  beneficiaryAccountstringoptionalСчет бенефициара,
  beneficiaryAddressstringoptionalАдрес бенефициара ,
  beneficiaryBankAccountstringoptionalКорреспондентский счет банка бенефициара ,
  beneficiaryBankAddressstringoptionalАдрес банка бенефициара,
  beneficiaryBankBranchNamestringoptionalНаименование филиала банка бенефициара,
  beneficiaryBankClearingCodeClearingCodeoptionalКлиринговый код банка бенефициара,
  beneficiaryBankCountryDigitalstringrequiredЦифровой код страны банка бенефициара,
  beneficiaryBankCountryIso2stringrequiredISO-код страны банка бенефициара ,
  beneficiaryBankNamestringrequiredНаименование банка бенефициара,
  beneficiaryBankPlacestringrequiredМестонахождение банка бенефициара,
  beneficiaryBankSwiftstringoptionalSWIFT-код банка бенефициара,
  beneficiaryBeiCodestringoptionalBEI-код банка бенефициара,
  beneficiaryCountryDigitalstringrequiredЦифровой код страны бенефициара,
  beneficiaryCountryIso2stringrequiredISO-код страны бенефициара,
  beneficiaryCountryNamestringoptionalНаименование страны бенефициара на русском языке (краткое наименование),
  beneficiaryInnstringoptionalИНН бенефициара,
  beneficiaryNamestringrequiredНаименование бенефициара,
  beneficiaryPlacestringrequiredГород (месторасположение) бенефициара,
  chargesTypestringrequiredТип комиссии за перевод,
  codes23earray[Code23e]optional23E: Код инструкции,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  factRatenumberoptionalФактический курс конверсии,
  iMediaBankAddressstringoptionalАдрес банка-посредника,
  iMediaBankCountryDigitalstringoptionalЦифровой код страны банка-посредника,
  iMediaBankCountryIso2stringoptionalISO-код страны банка-посредника,
  iMediaBankNamestringoptionalНаименование банка-посредника,
  iMediaBankPlacestringoptionalГород банка-посредника,
  iMediaBankSwiftstringoptionalSWIFT-код банка-посредника,
  iMediaClearingCodeClearingCodeoptionalКлиринговый код банка-посредника,
  iMediaFilialBankNamestringoptionalНаименование филиала банка-посредника,
  innstringrequiredИНН клиента,
  linkedDocsarray[LinkedDoc]optionalСвязанные документы,
  numberstringoptionalНомер документа,
  option50astringrequiredОпция 50а,
  option56astringoptionalОпция 56a,
  option57astringrequiredОпция 57а,
  option59astringoptionalОпция 59а,
  orgNamestringrequiredСокращенное наименование организации клиента,
  payerAccountstringrequiredСчет плательщика,
  payerAddressstringrequiredАдрес плательщика,
  payerBankBicstringrequiredБИК банка плательщика,
  payerBankPlacestringoptionalМестонахождение банка плательщика,
  payerCountryDigitalstringrequiredЦифровой код страны перевододателя,
  payerCountryIso2stringrequiredISO-код страны перевододателя,
  payerCountryNamestringrequiredНаименование страны перевододателя на русском языке (краткое наименование),
  payerNamestringrequiredМеждународное наименование плательщика,
  payerPlacestringrequiredГород (местонахождение) плательщика,
  paymentDetailsstringrequiredНазначение платежа,
  paymentDirectionstringrequiredНаправление платежа (Платеж внутри или вне СБРФ),
  rateAgreebooleanrequiredС курсом проведения конверсионной операции согласны,
  urgentbooleanrequiredСрочность,
  valueDatestringoptionalДата валютирования/возврата
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
ClearingCode {
  clearingCodestringoptionalКлиринговый код,
  countryCodestringoptional2-х символьный код страны,
  shortNamestringoptionalСокращенное наименование национального клирингового кода,
  symbolstringoptionalОбозначение национального клирингового кода
}
Code23e {
  codestringrequiredКод инструкции,
  descriptionstringoptionalОписание,
  infostringoptionalДополнительная информация
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateUuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
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, не указана операция PAY_DOC_RU. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение валютного платежного поручения

Alt text /fintech/api/v1/pay-doc-cur/{externalId}

Запрос позволяет получить полные данные ранее созданного валютного платежного поручения (далее - ВПП).

Для получения полных данных ВПП необходимо отправить GET-запрос /fintech/api/v1/pay-doc-cur/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/pay-doc-cur/{externalId}
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
PayDocCur {
  acceptDatestringoptionalДата представления в банк ,
  addInfostringoptionalПримечание,
  additionalInfostringoptionalИнформация получателю платежа (дополнительная информация), поле 72,
  amountDebitTotalnumberoptionalФактическая сумма списанной валюты,
  amountTransferAmountCurrencyrequiredСумма перевода,
  amountTransferTotalnumberoptionalФактическая сумма переведенной валюты ,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  b77infostringoptionalИнформация для регулирующих органов,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  beneficiaryAccountstringoptionalСчет бенефициара,
  beneficiaryAddressstringoptionalАдрес бенефициара ,
  beneficiaryBankAccountstringoptionalКорреспондентский счет банка бенефициара ,
  beneficiaryBankAddressstringoptionalАдрес банка бенефициара,
  beneficiaryBankBranchNamestringoptionalНаименование филиала банка бенефициара,
  beneficiaryBankClearingCodeClearingCodeoptionalКлиринговый код банка бенефициара,
  beneficiaryBankCountryDigitalstringrequiredЦифровой код страны банка бенефициара,
  beneficiaryBankCountryIso2stringrequiredISO-код страны банка бенефициара ,
  beneficiaryBankNamestringrequiredНаименование банка бенефициара,
  beneficiaryBankPlacestringrequiredМестонахождение банка бенефициара,
  beneficiaryBankSwiftstringoptionalSWIFT-код банка бенефициара,
  beneficiaryBeiCodestringoptionalBEI-код банка бенефициара,
  beneficiaryCountryDigitalstringrequiredЦифровой код страны бенефициара,
  beneficiaryCountryIso2stringrequiredISO-код страны бенефициара,
  beneficiaryCountryNamestringoptionalНаименование страны бенефициара на русском языке (краткое наименование),
  beneficiaryInnstringoptionalИНН бенефициара,
  beneficiaryNamestringrequiredНаименование бенефициара,
  beneficiaryPlacestringrequiredГород (месторасположение) бенефициара,
  chargesTypestringrequiredТип комиссии за перевод,
  codes23earray[Code23e]optional23E: Код инструкции,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  factRatenumberoptionalФактический курс конверсии,
  iMediaBankAddressstringoptionalАдрес банка-посредника,
  iMediaBankCountryDigitalstringoptionalЦифровой код страны банка-посредника,
  iMediaBankCountryIso2stringoptionalISO-код страны банка-посредника,
  iMediaBankNamestringoptionalНаименование банка-посредника,
  iMediaBankPlacestringoptionalГород банка-посредника,
  iMediaBankSwiftstringoptionalSWIFT-код банка-посредника,
  iMediaClearingCodeClearingCodeoptionalКлиринговый код банка-посредника,
  iMediaFilialBankNamestringoptionalНаименование филиала банка-посредника,
  innstringrequiredИНН клиента,
  linkedDocsarray[LinkedDoc]optionalСвязанные документы,
  numberstringoptionalНомер документа,
  option50astringrequiredОпция 50а,
  option56astringoptionalОпция 56a,
  option57astringrequiredОпция 57а,
  option59astringoptionalОпция 59а,
  orgNamestringrequiredСокращенное наименование организации клиента,
  payerAccountstringrequiredСчет плательщика,
  payerAddressstringrequiredАдрес плательщика,
  payerBankBicstringrequiredБИК банка плательщика,
  payerBankPlacestringoptionalМестонахождение банка плательщика,
  payerCountryDigitalstringrequiredЦифровой код страны перевододателя,
  payerCountryIso2stringrequiredISO-код страны перевододателя,
  payerCountryNamestringrequiredНаименование страны перевододателя на русском языке (краткое наименование),
  payerNamestringrequiredМеждународное наименование плательщика,
  payerPlacestringrequiredГород (местонахождение) плательщика,
  paymentDetailsstringrequiredНазначение платежа,
  paymentDirectionstringrequiredНаправление платежа (Платеж внутри или вне СБРФ),
  rateAgreebooleanrequiredС курсом проведения конверсионной операции согласны,
  urgentbooleanrequiredСрочность,
  valueDatestringoptionalДата валютирования/возврата
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
ClearingCode {
  clearingCodestringoptionalКлиринговый код,
  countryCodestringoptional2-х символьный код страны,
  shortNamestringoptionalСокращенное наименование национального клирингового кода,
  symbolstringoptionalОбозначение национального клирингового кода
}
Code23e {
  codestringrequiredКод инструкции,
  descriptionstringoptionalОписание,
  infostringoptionalДополнительная информация
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateUuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
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, не указана операция PAY_DOC_CUR. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение статуса валютного платежного поручения

Alt text /fintech/api/v1/pay-doc-cur/{externalId}/state

Запрос позволяет получить статус ранее созданного валютного платежного поручения (далее - ВПП).

Для получения статуса ВПП необходимо отправить GET-запрос /fintech/api/v1/pay-doc-cur/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис PAY_DOC_CUR для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/pay-doc-cur/{externalId}/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу
}
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, не указана операция PAY_DOC_CUR. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Статусы ВПП

bankStatus (string)
Код состояние документаНаименование статуса
Промежуточные статусы/Продолжать опрашивать
ACCEPTEDПринят
ACCEPTED_BY_ABSПринят АБС
ACCEPTED_BY_CFEПринят ВК
ACCEPTED_RZKАкцептован СБК
CARD2Картотека №2
CORRESPONDENT_APPROVE_WAITINGОжидает подтверждения контрагента
CREATEDСоздан
CHECKERRORОшибка контроля
CREATED_BANKСоздан Банком
CHECKERROR_BANKОшибка контроля, Банк
DELAYEDПриостановлен
DELIVEREDДоставлен
EXPORTEDВыгружен
FRAUDSMSТребуется подтверждение СМС-паролем
FRAUDREVIEWНа проверке у специалиста банка
FRAUDSENTОтправлен во ФРОД
FRAUDALLOWОдобрен ФРОД
FRAUDDENYОтвергнут ФРОД
IMPORTEDИмпортирован
IMPORTED_BANKИмпортирован Банком
NEED_REVIEWНеобходимы исправления
PROCESSINGВ обработке
PUBLISHED_BY_BANKИздан Банком
PARTSIGNEDЧастично подписан
PROCESSING_RZKОбрабатывается СБК
PROCESSEDОбработан
READY_TO_SENDЖдет отправки
RETURNEDВозвращен
RATE_CONFIRMATIONНа подтверждении курса
SIGNEDПодписан
SENDINGОтправляется
SENDEDОтправлен
SENDING_TO_RZKОтправляется в СБК
SIGNED_BANKПодписан Банком
SENT_TO_ADMINПередан администратору
TEMPLATEШаблон документа
TRIEDПроверен
TO_PROCESSING_RZKК отправке в СБК
TO_SIGN_IN_RZKПодписывается в СБК
TRIED_BY_CFEПроверяется ВК
USER_RESERVEDЗарезервированы логины
VALIDEDSЭП/АСП верна
Окончательные статусы/Прекратить опрос
CLOSEDЗакрыт
DELETEDУдален
EXPORTED_TO_1CВыгружен в реестр
INVALIDEDSЭП/АСП не верна
PROCESSERRORОтказан
REQUISITEERRORОшибка реквизитов
REFUSEDBYBANKОтвергнут Банком
REFUSEDBYABSОтказан АБС
RECALLОтозван
RECALL_BY_BANKОтозван Банком
REFUSED_BY_CFEОтказан ВК
UNABLE_TO_DECRYPTОшибка шифрования
UNABLE_TO_RECEIVEОшибка при приеме
Окончательные(Успешные) статусы/Прекратить опрос
IMPLEMENTEDИсполнен

Ведомости банковского контроля

Создание валютного контракта с нерезидентом (ВБК в банк)

Alt text /fintech/api/v1/bank-control-statements/reg-curr-contracts

Запрос позволяет создать заявление на регистрацию валютного контракта (ВК).

Для создания заявления на регистрацию ВК необходимо отправить POST-запрос /fintech/api/v1/bank-control-statements/reg-curr-contracts с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами на регистрацию контракта.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BANK_CONTROL_STATEMENT для получения доступа к этому запросу.

  • Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/bank-control-statements/reg-curr-contracts
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
CurrContract {
  amountnumberfloat^[0-9]{1,16}\.[0-9]{2}$optionalСумма платежа,
  bankControlStatementInfoBankControlStatementInfoobjectrequiredИнформация о ведомости банковского контроля,
  contractDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата контракта
  contractEndDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата окончания обязательств по контракту,
  contractNumberstringstring^.{1,100}$optionalНомер контракта,
  contractTypestringstring^(PRODUCT_EXPORT|SERVICE_EXPORT|MULTI_CONTRACT)$optionalКод вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта.

Заполнять обязательно, если creationMode=ICS_CONTRACT_INFORMATION,
  currencyCodestringЦифровой ISO-код валюты^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника CurDict		optionalКод валюты контракта.

Заполнять обязательно, если creationMode=ICS_CONTRACT_INFORMATION,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.
- Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу.
- Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес.

О подписании дайджеста документа подробно рассказали в соответствующем разделе документации.
  nonResidentsarray[BankControlStatementNonResident]arrayoptionalИнформация о нерезидентах,
  numberstringstring^[a-zA-Z0-9. \ _ -]{1,7}$optionalНомер документа,
}
BankControlStatementInfo {
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  bfAttachmentsarray[BfAttachment]arrayoptionalПрикрепленные большие файлы,
  creationModestringstring^(ICS_CONTRACT_INFORMATION|ICS_CONTRACT_REGISTRATION)$requiredРежим создания ВБК,

ICS_CONTRACT_REGISTRATION - указывается при регистрации контракта, когда необходимо отправить сам контракт во вложении, чтобы поставить его на учет.
ICS_CONTRACT_INFORMATION - заполняется в случае, если необходимо предоставить только информацию о контракте, для отправки СВО, к примеру (см. 181-И).
  currencyNamestringБуквенный ISO-код валюты^[a-zA-Z0-9. \ _ -]{3}$

Актуальный список значений можно получить с помощью справочника CurDict		optionalКод валюты контракта,
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
BankControlStatementNonResident {
  countryCodestringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		requiredЦифровой код страны,
  countryNamestringstring^.{1,255}$

Актуальный список значений можно получить с помощью справочника Country		requiredНаименование страны,
  isAffiliatedPersonbooleanboolean^(true|false)$optionalПризнак аффилированного лица,
  namestringstring^.{1,400}$requiredНаименование иностранного контрагента
}
BfAttachment {
  fileIdstringstring^[a-zA-Z0-9. \ _ -]+$optionalУникальный идентификатор файла
}

digestSignatures

Формат дайджеста
Наименование поляОписание поляПример
amountСумма контракта1.01
bankControlStatementInfo.authPersonNameФИО ответственного лицаПетров Петр Иванович
bankControlStatementInfo.authPersonTelfaxТелефон ответственного лица79263689379
bankControlStatementInfo.creationModeРежим создания ВБКICS_CONTRACT_REGISTRATION
bankControlStatementInfo.currencyNameБуквенный ISO-код валюты договораUSD
bankControlStatementInfo.externalIdИдентификатор документа в организации-партнере550e8400-e29b-41d4-a716-446655440000
contractDateДата договора2019-05-16
contractEndDateДата договора2019-05-16
contractNumberНомер контракта2442
contractTypeКод вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта (Режим создания ВБК)MULTI_CONTRACT
currencyCodeЦифровой код валюты договора840
dateДата создания документа по местному времени2019-05-16
TABLESЗначение указывается при наличии UUID-ов больших файлов или данных о нерезидентах
Table=BfAttachmentsЗначение указывается при наличии UUID-ов больших файлов
fileIdUUID больших файлов31663ef5-7975-4016-b0f3-f1d70a4e9c22
#Разделитель значений UUID-ов больших файлов
fileIdUUID больших файлов51663ef5-7975-4016-b0f3-f1d70a4e9c22
#Разделитель значений UUID-ов больших файлов
Table=NonResidents
countryCodeЦифровой код страны иностранного контрагента38
countryNameНаименование страны иностранного контрагентаКазахстан
nameНаименование иностранного контрагентаKazan
#Разделитель нерезидентов

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
CurrContract {
  amountnumberoptionalСумма платежа,
  balancenumberoptionalСальдо расчетов,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankControlStatementInfoBankControlStatementInforequiredИнформация о ведомости банковского контроля,
  bankStatusstringoptionalСтатус документа,
  contractDatestringrequiredДата контракта
  contractEndDatestringoptionalДата окончания обязательств по контракту,
  contractNumberstringoptionalНомер контракта,
  contractTypestringoptionalКод вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта,
  currencyCodestringoptionalКод валюты контракта,
  datestringrequiredДата составления документа,
  decNonresToResidentLiabSumnumberoptionalСумма по подтверждающим документам, уменьшающим обязательства нерезидента перед резидентом,
  decResidentToNonresLiabSumnumberoptionalСумма по подтверждающим документам, уменьшающим обязательства резидента перед нерезидентом,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  finalTransCurrencyCodestringoptionalЦифровой код страны,
  finalTransCurrencyNamestringoptionalБуквенный ISO-код валюты,
  incNonresidLiabilitySumnumberoptionalСумма по подтверждающим документам, увеличивающим обязательства нерезидента,
  incResidentLiabilitySumnumberoptionalСумма по подтверждающим документам, увеличивающим обязательства резидента,
  nonResidentsarray[BankControlStatementNonResident]optionalИнформация о нерезидентах,
  numberstringoptionalНомер документа,
  totalCreditnumberoptionalСумма денежных средств, поступивших по контракту в пользу резидента (всего зачислено),
  totalDebitnumberoptionalСумма денежных средств, переведенных по контракту в пользу нерезидента (всего списано),
  transDatestringoptionalДата расчета,
  xmlBodiesarray[string]optionalСписок кодированных xml-файлов ВБК
}
BankControlStatementInfo {
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentAuthorstringoptionalАвтор комментария,
  bankDatestringoptionalДата постановки контракта/договора на учет,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  chainIdstringoptionalId цепочки,
  creationModestringrequiredРежим создания ВБК,
  currencyNamestringoptionalКод валюты контракта,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно
  failReasonsarray[FailReason]optionalПричины отказа,
  isActualbooleanoptionalПризнак актуальности ВБК
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
BankControlStatementNonResident {
  countryCodestringrequiredЦифровой код страны,
  countryNamestringrequiredНаименование страны,
  isAffiliatedPersonbooleanoptionalПризнак аффилированного лица,
  namestringrequiredНаименование иностранного контрагента
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULTДокумент с такими реквизитами уже существуетВ АС Банка также присутствует проверка на дублирование документов по полям.
Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует."
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 и повторите запрос.
Некорректное значение Access TokenУказан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция BANK_CONTROL_STATEMENT. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение документа валютный контракт с нерезидентом (ВБК в банк)

Alt text /fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}

Запрос позволяет получить полные данные ранее созданного заявления на регистрацию валютного контракта (ВК).

Для получения полных данных заявления на регистрацию ВК необходимо отправить GET-запрос /fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором заявления (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BANK_CONTROL_STATEMENT для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
CurrContract {
  amountnumberoptionalСумма платежа,
  balancenumberoptionalСальдо расчетов,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankControlStatementInfoBankControlStatementInforequiredИнформация о ведомости банковского контроля,
  bankStatusstringoptionalСтатус документа,
  contractDatestringrequiredДата контракта
  contractEndDatestringoptionalДата окончания обязательств по контракту,
  contractNumberstringoptionalНомер контракта,
  contractTypestringoptionalКод вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта,
  currencyCodestringoptionalКод валюты контракта,
  datestringrequiredДата составления документа,
  decNonresToResidentLiabSumnumberoptionalСумма по подтверждающим документам, уменьшающим обязательства нерезидента перед резидентом,
  decResidentToNonresLiabSumnumberoptionalСумма по подтверждающим документам, уменьшающим обязательства резидента перед нерезидентом,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  finalTransCurrencyCodestringoptionalЦифровой код страны,
  finalTransCurrencyNamestringoptionalБуквенный ISO-код валюты,
  incNonresidLiabilitySumnumberoptionalСумма по подтверждающим документам, увеличивающим обязательства нерезидента,
  incResidentLiabilitySumnumberoptionalСумма по подтверждающим документам, увеличивающим обязательства резидента,
  nonResidentsarray[BankControlStatementNonResident]optionalИнформация о нерезидентах,
  numberstringoptionalНомер документа,
  totalCreditnumberoptionalСумма денежных средств, поступивших по контракту в пользу резидента (всего зачислено),
  totalDebitnumberoptionalСумма денежных средств, переведенных по контракту в пользу нерезидента (всего списано),
  transDatestringoptionalДата расчета,
  xmlBodiesarray[string]optionalСписок кодированных xml-файлов по ВБК
}
BankControlStatementInfo {
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentAuthorstringoptionalАвтор комментария,
  bankDatestringoptionalДата постановки контракта/договора на учет,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  chainIdstringoptionalId цепочки,
  creationModestringrequiredРежим создания ВБК,
  currencyNamestringoptionalКод валюты контракта,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно
  failReasonsarray[FailReason]optionalПричины отказа,
  isActualbooleanoptionalПризнак актуальности ВБК
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
BankControlStatementNonResident {
  countryCodestringrequiredЦифровой код страны,
  countryNamestringrequiredНаименование страны,
  isAffiliatedPersonbooleanoptionalПризнак аффилированного лица,
  namestringrequiredНаименование иностранного контрагента
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
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, не указана операция BANK_CONTROL_STATEMENT. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение статуса ведомости банковского контроля (ВБК в банк)

Alt text /fintech/api/v1/bank-control-statements/{externalId}/state

Запрос позволяет получить статус ранее созданного заявления на регистрацию валютного контракта (ВК).

Для получения статуса ранее созданного заявления необходимо отправить GET-запрос /fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором заявления (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BANK_CONTROL_STATEMENT для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId}/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу
}
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, не указана операция BANK_CONTROL_STATEMENT. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Статусы заявления на регистрацию ВК

bankStatus (string)
Код состояние документаНаименование статуса
Промежуточные статусы/Продолжать опрашивать
ACCEPTEDПринят
ACCEPTED_BY_ABSПринят АБС
CREATEDСоздан
DELIVEREDДоставлен
EXPORTEDВыгружен
TRIED_BY_CFEПроверяется ВК
WAITSENDDOCUMENTОжидает досыла документа
Окончательные статусы/Прекратить опрос
CHECKERRORОшибка контроля
INVALIDEDSЭП/АСП не верна
REQUISITEERRORОшибка реквизитов
REFUSEDBYABSОтказан АБС
REFUSED_BY_CFEОтказан ВК
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFEПринят ВК

Получение списка ВБК по контракту

Alt text /fintech/api/v1/bank-control-statements/reg-curr-contracts/list

Запрос позволяет получить список идентификаторов валютных контрактов (ВК), которые ранее были поставлены на учет в Банке с помощью Sber API.

Для получения списка идентификаторов ВК необходимо отправить GET-запрос /fintech/api/v1/bank-control-statements/reg-curr-contracts/list с токеном доступа (access_token) пользователя в параметре Authorization заголовка и параметрами поиска в query-параметрах.

В параметре scope ссылки авторизации пользователя должен быть указан сервис BANK_CONTROL_STATEMENT для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/bank-control-statements/reg-curr-contracts/list
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
QUERY PARAMETERS
datedate-timeISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата создания документа по местному времени.
isActualbooleanboolean^(true|false)$requiredПризнак актуальности ВБК.
pageintegerinteger^[0-9]+$optionalНомер страницы.

Если не заполнять параметр, по умолчанию будет выводиться 1 страница.

Responses

200 (OK)

На запрос первой страницы в ответе вернется список идентификаторов (если они существуют за выбранную дату) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next".

На запрос второй страницы в ответе вернется список идентификаторов и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.

Если следующей страницы нет, в полученном ответе перестанет приходить href c признаком "rel": "next".

НаименованиеТипОбязательностьОписание
FintechCurrContractsUUID {
  _linksarray[Link]optionalСсылки на связанные ресурсы,
  externalIdarray[string]optionalИдентификатор ВК ранее поставленного на учет в Банк
}
Link {
  hrefstringrequiredАбсолютный или относительный адрес
  relstringrequiredОтношение ссылки к текущей сущности (next, prev)
}
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, не указана операция BANK_CONTROL_STATEMENT. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Письма для целей ВК

Получение писем для целей ВК (из банка)

Alt text /fintech/api/v1/curr-control-messages/from-bank

Запрос позволяет получить входящие письма для целей валютного контроля (далее - ВК) от Банка.

Для получения входящих писем от ВК необходимо отправить GET-запрос /fintech/api/v1/curr-control-messages/from-bank с токеном доступа (access_token) пользователя в параметре Authorization заголовка и параметрами поиска в query-параметрах.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_FROM_BANK для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/curr-control-messages/from-bank
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
QUERY PARAMETERS
messageDatedate-timeISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата получения входящих писем.
pageintegerinteger^[0-9]+$requiredНомер страницы

Responses

200 (OK)

На запрос первой страницы в ответе вернется список входящих писем (если они существуют за выбранную дату) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next".

На запрос второй страницы в ответе вернется список входящих писем и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.

Если следующей страницы нет, в полученном ответе перестанет приходить href c признаком "rel": "next".

НаименованиеТипОбязательностьОписание
CurrControlMessagesFromBank {
  _linksarray[Link]optionalСсылки на связанные ресурсы,
  messagesarray[CurrControlMessageFromBank]optionalПисьма для целей ВК (из банка)
}
Link {
  hrefstringrequiredАбсолютный или относительный адрес
  relstringrequiredОтношение ссылки к текущей сущности (next, prev)
}
CurrControlMessageFromBank {
  attachmentsarray[Attachment]optionalВложенные документы,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalДанные о файлах, связанных с письмом для целей ВК,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  externalIdstringrequiredИдентификатор документа, который вы присвоили ему при создании,
  numberstringoptionalНомер документа,
  refDocumentLinkedDocoptionalДокумент ВК, по которому ведется переписка,
  rootMessageLinkedDocoptionalПисьмо ВК, на которое данное письмо является ответом,
  subjectstringrequiredТема письма,
  textstringrequiredТекст письма
}
Attachment {
  contentarray[string]optionalВложение закодированное в Base64,
  mimeTypestringoptionalТип формат файла,
  namestringoptionalИмя файла
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
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, не указана операция CURR_CONTROL_MESSAGE_FROM_BANK. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Создание письма для целей ВК (в банк)

Alt text /fintech/api/v1/curr-control-messages/to-bank

Запрос позволяет создавать документ «Письмо для целей ВК (в Банк)».

Для создания и отправки письма в ВК необходимо отправить POST-запрос /fintech/api/v1/curr-control-messages/to-bank с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами письма в теле.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_TO_BANK для получения доступа к этому запросу.

  • Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/curr-control-messages/to-bank
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
ConfirmatoryDocumentsInquiry {
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  bfAttachmentsarray[BfAttachment]arrayoptionalПрикрепленные большие файлы,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.

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

О подписании дайджеста документа подробно рассказали в соответствующем разделе документации.
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно,
  numberstringstring???optionalНомер документа,
  orgNamestringstring???requiredНаименование организации клиента,
  refDocumentLinkedDocobjectoptionalДокумент ВК, по которому ведется переписка,
  rootMessageLinkedDocobjectoptionalПисьмо ВК, на которое данное письмо является ответом.
Объект заполняется полученными данными из ответа на запрос /fintech/api/v1/curr-control-messages/from-bank,
  subjectstringstring???requiredТема письма,
  textstringstring???requiredТекст письма
}
BfAttachment {
  fileIdstringstring^[a-zA-Z0-9. \ _ -]+$optionalУникальный идентификатор файла
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа во внешней системе,
  typestringstring^(ConfDocInq_138I|CurrencyOperationDetails|InternalControlStatement|CCMessageFromBank)$requiredТип связанного документа.

ConfDocInq_138I - справка о подтверждающих документах (СПД);
 CurrencyOperationDetails - сведения о валютной операции (СВО);
InternalControlStatement - ведомость банковского контроля (ВБК);
 CCMessageFromBank - письмо от ВК
}

digestSignatures

Формат дайджеста
Наименование поляОписание поляПример
authPersonNameФИО ответственного лицаПетров Петр Иванович
authPersonTelfaxТелефон ответственного лица79263689379
dateДата документа28.02.2019
externalIdИдентификатор документа в организации-партнере550e8400-e29b-41d4-a716-446655440000
orgNameНаименование организации клиентаООО "ТЕСТ"
subjectТема письмаДоговор ВК
textТекс письмаДобрый день!
TABLESЗначение указывается при наличии UUID-ов больших файлов
Table=BfAttachmentsЗначение указывается при наличии UUID-ов больших файлов
fileIdUUID больших файлов31663ef5-7975-4016-b0f3-f1d70a4e9c22
#Разделитель значений UUID-ов больших файлов
fileIdUUID больших файлов51663ef5-7975-4016-b0f3-f1d70a4e9c22
#Разделитель значений UUID-ов больших файлов

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
ConfirmatoryDocumentsInquiry {
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  numberstringoptionalНомер документа,
  orgNamestringrequiredНаименование организации клиента,
  refDocumentLinkedDocoptionalДокумент ВК, по которому ведется переписка,
  rootMessageLinkedDocoptionalПисьмо ВК, на которое данное письмо является ответом,
  subjectstringrequiredТема письма,
  textstringrequiredТекст письма
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULTДокумент с такими реквизитами уже существуетВ АС Банка также присутствует проверка на дублирование документов по полям.
Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует."
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 и повторите запрос.
Некорректное значение Access TokenУказан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CURR_CONTROL_MESSAGE_TO_BANK. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение статуса письма для целей ВК (в банк)

Alt text /fintech/api/v1/curr-control-messages/to-bank/{externalId}/state

Запрос позволяет получить статус по ранее отправленному письму в Валютный контроль Банка.

Для получения статуса письма необходимо отправить GET-запрос /fintech/api/v1/curr-control-messages/to-bank/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_TO_BANK для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/curr-control-messages/to-bank/{externalId}/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу
}
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, не указана операция CURR_CONTROL_MESSAGE_TO_BANK. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Статусы письма

bankStatus (string)
Код состояние документаНаименование статусаНазначение
Промежуточные статусы/Продолжать опрашивать
ACCEPTEDПринятЭлектронный документ принят на стороне Банка
ACCEPTED_BY_ABSПринят АБСЭлектронный документ был принят к обработке в АБС Банка
CREATEDСозданДокумент записан в БД, проверки не выполнялись. Документ не отправлен в банк, требуется подпись
DELIVEREDДоставленЗапрос доставлен в ДБО и взят в обработку
EXPORTEDВыгруженЭлектронный документ выгружен Банком в АБС
SIGNEDПодписанЭД подписан предусмотренным для него комплектом подписей. Документ не отправлен в банк, требуется отправить
SUBMITTEDПредставленДокумент находится в обработке на стороне банка
TRIED_BY_CFEПроверяется ВКДокумент проверяется ВК
Окончательные статусы/Прекратить опрос
CHECKERRORОшибка контроляЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками.
INVALIDEDSЭП/АСП не вернаПроверка ЭП под ЭД на стороне Банка дала отрицательный результат
REFUSED_BY_CFEОтказан ВКДокумент отказан валютным контролем
REFUSEDBYABSОтказан АБСДокумент отказан АБС
REQUISITEERRORОшибка реквизитовЭД не прошел проверки при приеме на стороне Банка
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFEПринят ВКДокумент принят валютным контролем

Сведения о валютных операциях

Создание сведений о валютной операции

Alt text /fintech/api/v1/currency-operation-details

Запрос позволяет создавать документ «Сведения о валютных операциях» (далее СВО).

Для создания СВО необходимо отправить POST-запрос /fintech/api/v1/currency-operation-details с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURRENCY_OPERATION_DETAILS для получения доступа к этому запросу.

  • Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/currency-operation-details
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
**CurrencyOperationDetails {**
  accountNumberstringstring^[0-9]{20}$optionalНомер счета,
  addInfostringstring^.{1,2000}$optionalДополнительная информация,
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  bankNonResidentCountryNamestringstring^.{1,255}$

Актуальный список значений можно получить с помощью справочника Country		optionalНаименование страны,
  bankNonResidentCountryNumericCodestringОКСМ^[0-9]{3}$

Актуальный список значений можно получить с помощью справочника Country		requiredЦифровой код страны,
  bfAttachmentsarray[BfAttachment]arrayoptionalПрикрепленные большие файлы,
  correctionbooleanboolean^(true|false)$optionalПризнак корректировки,
  correctionNumberintegerinteger^[0-9]{1,3}$optionalПорядковый номер корректировки,
  currencyDocDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата валютного документа,
  currencyDocNumberstringstring^[0-9]{1,100}$optionalНомер документа по валютной операций,
  currencyDocTypestringstring^(PayDocCur|PayDocRu|CurrencyNotices)$optionalТип валютного документа.

PayDocCur - Валютное платежное поручение;
 PayDocRu - Рублевое платежное поручение;
* CurrencyNotices - Уведомление о зачислении (поступлении) иностранной валюты на транзитный валютный счет,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.
- Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу.
- Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес.

О подписании дайджеста документа подробно рассказали в соответствующем разделе документации.
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно,
  isAccountInOtherBankbooleanboolean^(true|false)$requiredПризнак счета в другом банке,
  isNumberAbsentbooleanboolean^(true|false)$requiredПризнак отсутствия номера валютного документа,
  linkedDocsarray[LinkedDoc]arrayoptionalCвязанные документы,
  numberstringstring^[0-9]{1,7}$optionalНомер документа,
  operationDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата операции,
  operationsarray[CurrencyOperationDetailsDoc]arrayrequiredДокументы валютного контроля,
  paymentAmountAmountCurrencyobjectrequiredСумма и валюта платежа,
  paymentDirectionstringstring^(1|2)$requiredНаправление платежа.

1 - зачисление;
 2 - списание,
  senderInnstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$requiredИНН резидента, указываемый в документе,
  senderNamestringstring^.{1,1024}$requiredПолное наименование организации, указываемое в документе,
  senderOkpostringstring^([0-9]{8}|[0-9]{10})$requiredОКПО клиента, указываемый в документе
}
BfAttachment {
  fileIdstringstring^[a-zA-Z0-9. \ _ -]+$optionalУникальный идентификатор файла
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
LinkedDoc {
  docExtIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа во внешней системе,
  typestringstring^[a-zA-Z0-9. \ _ -]{1,50}$requiredТип связанного документа
}
CurrencyOperationDetailsDoc {
  additionalInfostringstring^.{1,300}$optionalПримечание,
  amountAmountCurrencyobjectrequiredСумма платежа,
  contractDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата договора,
  contractNumberstringstring^[0-9]{1,100}$optionalНомер договора.

Указывается обязательно, если contractNumberType = 0 или 1
  contractNumberTypestringstring^(0|1|2)$optionalТип указание номера договора.

0 - Указывается номеру и дата договора;
 1 - Указывается только дата договора;
* 2 - Указывается уникальный номер контракта (кредитного договора),
  creditAmountAmountCurrencyobjectoptionalСумма платежа в валюте цены контракта.

Заполнение блока не требуется, если сумма и валюта договора совпадает с суммой и валютой платежа,
  dataCompositionstringstring^(1|2|3|4|5|6|8)$optionalСостав предоставляемой информации.

1 - Информация об Уникальном номере контракта;
 2 - Документы, связанные с проведением операции (кредитного договора);
3 - Информация о коде вида операции;
 4 - Информация о Коде вида операции + Информация об Уникальном номере контракта;
5 - Документы, связанные с проведением операции + Информация об Уникальном номере контракта;
 6 - Документы, связанные с проведением операции представлены ранее;
* 8 - Сведения Уполномоченного банка о проведении операции с указанием Уникального номера контракта (кредитного договора),
  expectedDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalОжидаемый срок.

Значение должно быть >= contractDate,
  operationCodestringstring^[0-9]{5}$requiredКод вида валютной операции,
  operationCodeDescriptionstringstring^.{1,2000}$requiredОписание валютной операции,
  operationReasonstringstring^(1|2|3|4)$requiredОснование проведения операции.
1 - Контракт (кредитный договор) с нерезидентом, сумма которого ≤ 600 000 рублей РФ;
 2 - Контракт (кредитный договор) с нерезидентом, не требующий постановки на учет, сумма которого > 600 000 рублей РФ;
**3** - Контракт (кредитный договор), поставленный на учет в банке;
 4 - Иные,
  passportNumberstringstring^([0-9]{2}((0[1-9])|(1[0-2]))[0-9]{2}[0-9A-Z]{1}[0-9]{1}/)[0-9]{4}/([G][U][0-9]{2}|[0-9]{4})/([1234569]/)[0-3]$optionalУникальный номер контракта (кредитного договора).

Указывается обязательно, если contractNumberType = 2,
  paymentConditionsstringstring^(1|2)$optionalУсловия расчета.
0 - Аванс;
 1 - По факту,
  serialNumberintegerinteger^[0-9]{1,3}$requiredНомер по порядку
}
AmountCurrency {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСумма,
  currencyCodestringISO 4217^[0-9]{1,3}$requiredЦифровой код валюты,
  currencyNamestringISO 4217^[A-Z]{3}$requiredБуквенный ISO-код валюты
}

digestSignatures

Формат дайджеста

Если в запросе contractNumberType = 2, то в дайджесте необходимо указать passportNumber.

Наименование поляОписание поляПример
accountNumberНомер счета40702810123643875107
addInfoДополнительная информацияДополнительная информация
authPersonNameФИО ответственного лицаИванов Иван Иванович
authPersonTelfaxТелефон ответственного лица+7 123 1456 56 56
bankNonResidentCountryNameНаименование страныСОЕДИНЕННОЕ КОРОЛЕВСТВО
bankNonResidentCountryNumericCodeКод страны826
correctionПризнак корректировкиfalse
correctionNumberНомер корректировки1
currencyDocDateДата валютного документа2019-05-16
currencyDocNumberНомер валютного документа54321
currencyDocTypeТип валютного документаPayDocCur
dateДата документа2019-05-16
externalIdИдентификатор документа в организации-партнере75d8d497-05cc-4cc6-9b78-070ae0a605fd
isAccountInOtherBankПризнак счета в другом банкеfalse
isNumberAbsentПризнак отсутствия номера валютного документаfalse
paymentAmount.amountСумма платежа2.02
paymentAmount.currencyCodeЦифровой код валюты платежа840
paymentAmount.currencyNameISO код валюты платежаUSD
paymentDirectionНаправление платежа1
senderInnИНН клиента7582099944
senderNameПолное наименование клиентаОрганизация NyJurbsIJTXzRTL
senderOkpoОКПО клиента1350995802
TABLESЗначение указывается при наличии UUID-ов больших файлов или Операций
Table=BfAttachmentsЗначение указывается при наличии UUID-ов больших файлов
fileIdUUID больших файлов08ba3412-118a-4f4d-be23-e93f81d58fdc
#Разделитель строк таблицы
fileIdUUID больших файлов81ff03ad-bceb-4a8a-b5bf-8c8439519bab
#Разделитель строк таблицы
Table=OperationsЗначение указывается при наличии операций
additionalInfoДополнительная информацияПримечание
amount.amountСумма платежа2.02
amount.currencyCodeЦифровой код валюты платежа840
amount.currencyNameISO код валюты платежаUSD
contractDateДата договора2019-05-16
contractNumberНомер договора123
contractNumberTypeТип заполнения номера договора0
creditAmount.amountСумма договора33.33
creditAmount.currencyCodeЦифровой код валюты договора840
creditAmount.currencyNameISO код валюты договораUSD
dataCompositionСостав предоставляемой информации3
expectedDateОжидаемый срок2019-05-16
operationCodeКод вида валютной операции20300
operationCodeDescriptionОписание валютной операцииОплата нерезидента резиденту по договору аренды движимого или недвижимого имущества
operationReasonОснование проведения операции1
passportNumberУникальный номер контракта (кредитного договора)120123A0/1234/GU23/1/2
paymentConditionsУсловия расчета1
serialNumberНомер по порядку0

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
CurrencyOperationDetails {
  acceptDatestringoptionalДата представления в банк,
  accountNumberstringoptionalНомер счета,
  addInfostringoptionalДополнительная информация,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankNonResidentCountryNamestringoptionalНаименование страны,
  bankNonResidentCountryNumericCodestringrequiredЦифровой код страны,
  bankStatusstringrequiredСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  correctionbooleanoptionalПризнак корректировки,
  correctionNumberintegeroptionalПорядковый номер корректировки,
  currencyDocDatestringoptionalДата валютного документа,
  currencyDocNumberstringoptionalНомер документа по валютной операций,
  currencyDocTypestringoptionalТип валютного документа,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  executorEmployeeNamestringoptionalДолжность ответственного лица,
  executorNamestringoptionalПодпись ответственного лица,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  failReasonsarray[FailReason]optionalПричины отказа,
  isAccountInOtherBankbooleanrequiredПризнак счета в другом банке,
  isNumberAbsentbooleanrequiredПризнак отсутствия номера валютного документа,
  linkedDocsarray[LinkedDoc]optionalCвязанные документы,
  numberstringoptionalНомер документа,
  operationDatestringoptionalДата операции,
  operationsarray[CurrencyOperationDetailsDoc]requiredДокументы валютного контроля,
  paymentAmountAmountCurrencyrequiredСумма и валюта платежа,
  paymentDirectionstringrequiredНаправление платежа,
  senderInnstringrequiredИНН резидента, указываемый в документе,
  senderNamestringrequiredПолное наименование организации, указываемое в документе,
  senderOkpostringrequiredОКПО клиента, указываемый в документе,
  valueDatestringoptionalДата принятия/возврата
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
CurrencyOperationDetailsDoc {
  additionalInfostringoptionalПримечание,
  amountAmountCurrencyrequiredСумма платежа,
  contractDatestringoptionalДата договора,
  contractNumberstringoptionalНомер договора,
  contractNumberTypestringoptionalТип указание номера договора,
  creditAmountAmountCurrencyoptionalСумма платежа в валюте цены контракта,
  dataCompositionstringoptionalСостав предоставляемой информации,
  expectedDatestringoptionalОжидаемый срок,
  operationCodestringrequiredКод вида валютной операции,
  operationCodeDescriptionstringrequiredОписание валютной операции,
  operationReasonstringrequiredОснование проведения операции,
  passportNumberstringoptionalУникальный номер контракта (кредитного договора),
  paymentConditionsstringoptionalУсловия расчета,
  serialNumberintegerrequiredНомер по порядку
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULTДокумент с такими реквизитами уже существуетВ АС Банка также присутствует проверка на дублирование документов по полям.
Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует."
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 и повторите запрос.
Некорректное значение Access TokenУказан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CURRENCY_OPERATION_DETAILS. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение документа сведения о валютной операции

Alt text /fintech/api/v1/currency-operation-details/{externalId}

Запрос позволяет получить полные данные ранее созданного документа «Справка о валютной операции» (далее СВО).

Для получения полных данных СВО необходимо отправить GET-запрос /fintech/api/v1/currency-operation-details/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURRENCY_OPERATION_DETAILS для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/currency-operation-details/{externalId}
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
CurrencyOperationDetails {
  acceptDatestringoptionalДата представления в банк,
  accountNumberstringoptionalНомер счета,
  addInfostringoptionalДополнительная информация,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankNonResidentCountryNamestringoptionalНаименование страны,
  bankNonResidentCountryNumericCodestringrequiredЦифровой код страны,
  bankStatusstringrequiredСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  correctionbooleanoptionalПризнак корректировки,
  correctionNumberintegeroptionalПорядковый номер корректировки,
  currencyDocDatestringoptionalДата валютного документа,
  currencyDocNumberstringoptionalНомер документа по валютной операций,
  currencyDocTypestringoptionalТип валютного документа,
  datestringrequiredДата составления документа,
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  executorEmployeeNamestringoptionalДолжность ответственного лица,
  executorNamestringoptionalПодпись ответственного лица,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  failReasonsarray[FailReason]optionalПричины отказа,
  isAccountInOtherBankbooleanrequiredПризнак счета в другом банке,
  isNumberAbsentbooleanrequiredПризнак отсутствия номера валютного документа,
  linkedDocsarray[LinkedDoc]optionalCвязанные документы,
  numberstringoptionalНомер документа,
  operationDatestringoptionalДата операции,
  operationsarray[CurrencyOperationDetailsDoc]requiredДокументы валютного контроля,
  paymentAmountAmountCurrencyrequiredСумма и валюта платежа,
  paymentDirectionstringrequiredНаправление платежа,
  senderInnstringrequiredИНН резидента, указываемый в документе,
  senderNamestringrequiredПолное наименование организации, указываемое в документе,
  senderOkpostringrequiredОКПО клиента, указываемый в документе,
  valueDatestringoptionalДата принятия/возврата
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
LinkedDoc {
  docExtIdstringrequiredИдентификатор документа во внешней системе,
  typestringrequiredТип связанного документа
}
CurrencyOperationDetailsDoc {
  additionalInfostringoptionalПримечание,
  amountAmountCurrencyrequiredСумма платежа,
  contractDatestringoptionalДата договора,
  contractNumberstringoptionalНомер договора,
  contractNumberTypestringoptionalТип указание номера договора,
  creditAmountAmountCurrencyoptionalСумма платежа в валюте цены контракта,
  dataCompositionstringoptionalСостав предоставляемой информации,
  expectedDatestringoptionalОжидаемый срок,
  operationCodestringrequiredКод вида валютной операции,
  operationCodeDescriptionstringrequiredОписание валютной операции,
  operationReasonstringrequiredОснование проведения операции,
  passportNumberstringoptionalУникальный номер контракта (кредитного договора),
  paymentConditionsstringoptionalУсловия расчета,
  serialNumberintegerrequiredНомер по порядку
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
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, не указана операция CURRENCY_OPERATION_DETAILS. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение статуса сведений о валютной операции

Alt text /fintech/api/v1/currency-operation-details/{externalId}/state

Запрос позволяет получить статус ранее созданного документа «Справка о валютной операции» (далее СВО).

Для получения статуса СВО необходимо отправить GET-запрос /fintech/api/v1/currency-operation-details/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CURRENCY_OPERATION_DETAILS для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/currency-operation-details/{externalId}/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу
}
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, не указана операция PAY_DOC_CUR. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Статусы СВО

bankStatus (string)
Код состояние документаНаименование статусаНазначение кода состояния
Промежуточные статусы/Продолжать опрашивать
CHECK_ERRORОшибка контроляСведения о валютной операции сохранены, но есть ошибки контроля
CREATEDСозданСведения о валютной операции созданы клиентом для отправки в банк (не подписаны).
IMPORTEDИмпортированСведения о валютной операции импортированы из систем клиента для отправки в банк (не подписаны).
CREATED_CSСоздан банкомСведения о валютной операции созданы банком в рамках оказания консалтинговой услуги (не подписаны)
SIGNEDПодписанСведения о валютной операции подписаны, готовы к отправке в банк
DELIVERED
EXPORTED
EXPORT_ERROR
ACCEPTED_BY_ABS		В обработкеКлиент отправил сведения о валютной операции на проверку в банк.
Окончательные статусы/Прекратить опрос
REFUSED_BY_ABSОшибкаСведения о валютной операции не приняты банком, валютный контроль пройден
REFUSED_BY_CFEОтказ ВКСведения о валютной операции отказаны после проверки валютным контролем
INVALID_SIGNПодпись невернаВозникла ошибка при подписании сведений о валютной операции
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFEПринят ВКСведения о валютной операции приняты банком, валютный контроль пройден
RECALLОтозванСведения и валютной операции отозваны клиентом до обработки документа банком

Справки о подтверждающих документах

Создание справки о подтверждающих документах

Alt text /fintech/api/v1/confirmatory-documents-inquiries

Запрос позволяет создавать документ «Справка о подтверждающих документах» (далее СПД).

Для создания СПД необходимо отправить POST-запрос /fintech/api/v1/confirmatory-documents-inquiries с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CONFIRMATORY_DOCUMENTS_INQUIRY для получения доступа к этому запросу.

  • Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
  • Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.

Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/confirmatory-documents-inquiries
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
BODY
ConfirmatoryDocumentsInquiry {
  authPersonNamestringstring^.{1,60}$optionalФИО ответственного лица,
  authPersonTelfaxstringstring^.{1,40}$optionalТелефон ответственного лица,
  bfAttachmentsarray[BfAttachment]arrayoptionalПрикрепленные большие файлы,
  customerBankBICstringstring^[0-9]{9}$optionalБИК банка резидента,
  customerINNstringstring^([0-9]{5}|[0-9]{10}|[0-9]{12}|0)$requiredИНН резидента,
  customerNamestringstring???requiredНаименование резидента,
  customerOKPOstringstring^([0-9]{8}|[0-9]{10})$requiredОКПО резидента,
  datestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата составления документа,
  dealDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$requiredДата справки
  digestSignaturesarray[Signature]arrayoptionalЭлектронные подписи по дайджесту документа.

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

О подписании дайджеста документа подробно рассказали в соответствующем разделе документации.
  docsarray[ConfirmatoryDocumentsInquiryDoc]arrayoptionalДокументы, включенные в справку,
  externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, который вы присваиваете самостоятельно,
  numberstringstring???optionalНомер документа,
  psNumberstringstring???optionalУникальный номер контракта (кредитного договора)
}
BfAttachment {
  fileIdstringstring^[a-zA-Z0-9. \ _ -]+$optionalУникальный идентификатор файла
}
Signature {
  base64Encodedstringbase64^[a-zA-Z0-9]+$requiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
ConfirmatoryDocumentsInquiryDoc {
  addInfostringstringoptionalДополнительная информация,
  confDocDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата подтверждающего документа,
  confDocNumberstringstring???optionalНомер подтверждающего документа,
  contractSumAmountCurrencyobjectoptionalСумма и валюта контракта,
  contractSumDelnumbernumber???optionalСумма, соответствующая признаку поставки 2 или 3, в валюте цены контракта (кредитного договора),
  correctionDatestringISO 8601 YYYY-MM-DD^[0-9]{4}-[0-9]{2}-[0-9]{2}$optionalДата корректировки,
  correctionNumberintegerinteger???optionalНомер корректировки,
  countryCodestringstring???optionalКод страны грузополучателя (грузоотправителя)
  countryNamestringstring???optionalНаименование страны грузополучателя (грузоотправителя),
  docCodestringstring???requiredКод вида документа,
  docNamestringstring???requiredНаименование вида документа,
  docSumAmountCurrencyobjectrequiredСумма и валюта документа,
  docSumDelnumbernumber???optionalСумма, соответствующая признаку поставки 2 или 3, в валюте документа,
  expectedLifestringstring???optionalОжидаемый срок,
  hasConfDocNumberbooleanboolean^(true|false)$requiredПризнак присутствия номера подтверждающего документа,
  ordinalNumberintegerinteger???requiredПорядковый номер строки в справке,
  supplyFeaturestringstring^(1|2|3|4)$optionalПризнак поставки
}
AmountCurrency {
  amountnumbernumber^[0-9]{1,16}\.[0-9]{2}$requiredСумма,
  currencyCodestringISO 4217^[0-9]{1,3}$requiredЦифровой код валюты,
  currencyNamestringISO 4217^[A-Z]{3}$requiredБуквенный ISO-код валюты
}

digestSignatures

Формат дайджеста

Если в запросе contractNumberType = 2, то в дайджесте необходимо указать passportNumber.

Наименование поляОписание поляПример
authPersonNameФИО уполномоченного сотрудника организации клиентаИванов Иван Иванович
authPersonTelfaxНомер телефона, факса уполномоченного сотрудника организации клиента4955005550
customerBankBicБИК банка клиента44525225
customerINNИНН клиента2406877205
customerNameНаименование резидентаОбщество с ограниченной ответственностью "Клиент"
customerOKPOОКПО клиента3698203661
dateДата документа20.05.2019
dealDateСправка от (дата справки)20.05.2019
externalIdИдентификатор документа в организации-партнере14d62475-e8da-4f24-bcc7-68e4add64131
psNumberУникальный номер контракта (Кредитного договора)11111111/0011/0000/1
TABLES
Table=Docs
addInfoПримечания по данной строкеДополнительная информация
confDocDateДата подтверждающего документа20.05.2019
confDocNumberНомер подтверждающего документа123
contractSumDelСумма, соответствующая признаку поставки 2 или 3, в валюте цены контракта (кредитного договора)01.янв
correctionDateДата корректируемой СПД20.05.2019
correctionNumberНомер корректировки1
countryCodeКод страны826
countryNameНаименование страныСОЕДИНЕННОЕ КОРОЛЕВСТВО
docCodeКод вида документа03_3
docNameНаименование вида документаО передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции
docSum.amountСумма04.март
docSum.currencyCodeЦифровой код валюты840
docSum.currencyNameТрехбуквенный код валюты ISO-код валютыUSD
docSumDelСумма, соответствующая признаку поставки 2 или 3, в валюте документа02.февр
expectedLifeОжидаемый срок20.05.2019
hasConfDocNumberПризнак номера документа:true
true - документ имеет номер;
false - документ без номера
ordinalNumberПорядковый номер строки в справке15
supplyFeatureПризнак поставки2
contractSum.amountСумма04.март
contractSum.currencyCodeЦифровой код валюты840
contractSum.currencyNameТрехбуквенный код валюты ISO-код валютыUSD
#Разделитель строк таблицы
Table=BfAttachmentsЗначение указывается при наличии UUID-ов больших файлов
fileIdUUID больших файлов08ba3412-118a-4f4d-be23-e93f81d58fdc
#Разделитель строк таблицы

Responses

201 (Created)
НаименованиеТипОбязательностьОписание
ConfirmatoryDocumentsInquiry {
  acceptDatestringoptionalДата представления в банк,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  customerBankBICstringoptionalБИК банка резидента,
  customerINNstringrequiredИНН резидента,
  customerNamestringrequiredНаименование резидента,
  customerOKPOstringrequiredОКПО резидента,
  datestringrequiredДата составления документа,
  dealDatestringrequiredДата справки
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  docsarray[ConfirmatoryDocumentsInquiryDoc]optionalДокументы, включенные в справку,
  executorEmployeeNamestringoptionalДолжность ответственного лица,
  executorNamestringoptionalПодпись ответственного лица,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  failReasonsArray[FailReason]optionalПричины отказа,
  numberstringoptionalНомер документа,
  psNumberstringoptionalУникальный номер контракта (кредитного договора)
  returnReason1booleanoptionalФлаг причины возврата 16.1.1,
  returnReason1CommentstringoptionalКомментарий причины возврата 16.1.1,
  returnReason2booleanoptionalФлаг причины возврата 16.1.3,
  returnReason2CommentstringoptionalКомментарий причины возврата 16.1.3,
  returnReason3booleanoptionalФлаг причины возврата 16.1.4,
  returnReason3CommentstringoptionalКомментарий причины возврата 16.1.4,
  returnReason4booleanoptionalФлаг причины возврата 16.1.5,
  returnReason4CommentstringoptionalКомментарий причины возврата 16.1.5,
  valueDatestringoptionalДата принятия/возврата
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
ConfirmatoryDocumentsInquiryDoc {
  addInfostringoptionalДополнительная информация,
  confDocDatestringoptionalДата подтверждающего документа,
  confDocNumberstringoptionalНомер подтверждающего документа,
  contractSumAmountCurrencyoptionalСумма и валюта контракта,
  contractSumDelnumberoptionalСумма, соответствующая признаку поставки 2 или 3, в валюте цены контракта (кредитного договора),
  correctionDatestringoptionalДата корректировки,
  correctionNumberintegeroptionalНомер корректировки,
  countryCodestringoptionalКод страны грузополучателя (грузоотправителя)
  countryNamestringoptionalНаименование страны грузополучателя (грузоотправителя),
  docCodestringrequiredКод вида документа,
  docNamestringrequiredНаименование вида документа,
  docSumAmountCurrencyrequiredСумма и валюта документа,
  docSumDelnumberoptionalСумма, соответствующая признаку поставки 2 или 3, в валюте документа,
  expectedLifestringoptionalОжидаемый срок,
  hasConfDocNumberbooleanrequiredПризнак присутствия номера подтверждающего документа,
  ordinalNumberintegerrequiredПорядковый номер строки в справке,
  supplyFeaturestringoptionalПризнак поставки
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
400 (Bad request)
CauseMessageDescription
DESERIALIZATION_FAULTНеверный формат запросаДанные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULTДокумент с такими реквизитами уже существуетВ АС Банка также присутствует проверка на дублирование документов по полям.
Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует."
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 и повторите запрос.
Некорректное значение Access TokenУказан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
403 (Forbidden)
CauseMessageDescription
ACTION_ACCESS_EXCEPTIONОперация не может быть выполнена: доступ к ресурсу запрещенИспользуемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API.
В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CONFIRMATORY_DOCUMENTS_INQUIRY. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение документа справка о подтверждающих документах

Alt text `/fintech/api/v1/confirmatory-documents-inquiries/{externalId}

Запрос позволяет получить полные данные ранее созданного документа «Справка о подтверждающих документах» (далее СПД).

Для получения полных данных СПД необходимо отправить GET-запрос /fintech/api/v1/confirmatory-documents-inquiries/{externalId} с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CONFIRMATORY_DOCUMENTS_INQUIRY для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/confirmatory-documents-inquiries/{externalId}
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
ConfirmatoryDocumentsInquiry {
  acceptDatestringoptionalДата представления в банк,
  authPersonNamestringoptionalФИО ответственного лица,
  authPersonTelfaxstringoptionalТелефон ответственного лица,
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  bfAttachmentsarray[BfAttachment]optionalПрикрепленные большие файлы,
  customerBankBICstringoptionalБИК банка резидента,
  customerINNstringrequiredИНН резидента,
  customerNamestringrequiredНаименование резидента,
  customerOKPOstringrequiredОКПО резидента,
  datestringrequiredДата составления документа,
  dealDatestringrequiredДата справки
  digestSignaturesarray[Signature]optionalЭлектронные подписи по дайджесту документа,
  docsarray[ConfirmatoryDocumentsInquiryDoc]optionalДокументы, включенные в справку,
  executorEmployeeNamestringoptionalДолжность ответственного лица,
  executorNamestringoptionalПодпись ответственного лица,
  externalIdstringrequiredИдентификатор документа, который вы присваиваете самостоятельно,
  failReasonsArray[FailReason]optionalПричины отказа,
  numberstringoptionalНомер документа,
  psNumberstringoptionalУникальный номер контракта (кредитного договора)
  returnReason1booleanoptionalФлаг причины возврата 16.1.1,
  returnReason1CommentstringoptionalКомментарий причины возврата 16.1.1,
  returnReason2booleanoptionalФлаг причины возврата 16.1.3,
  returnReason2CommentstringoptionalКомментарий причины возврата 16.1.3,
  returnReason3booleanoptionalФлаг причины возврата 16.1.4,
  returnReason3CommentstringoptionalКомментарий причины возврата 16.1.4,
  returnReason4booleanoptionalФлаг причины возврата 16.1.5,
  returnReason4CommentstringoptionalКомментарий причины возврата 16.1.5,
  valueDatestringoptionalДата принятия/возврата
}
BfAttachment {
  fileIdstringoptionalУникальный идентификатор файла,
  fileNamestringoptionalИмя файла
}
Signature {
  base64EncodedstringrequiredЗначение электронной подписи (ЭП), закодированное в Base64,
  certificateuuidstringrequiredУникальный идентификатор сертификата ключа проверки электронной подписи
}
ConfirmatoryDocumentsInquiryDoc {
  addInfostringoptionalДополнительная информация,
  confDocDatestringoptionalДата подтверждающего документа,
  confDocNumberstringoptionalНомер подтверждающего документа,
  contractSumAmountCurrencyoptionalСумма и валюта контракта,
  contractSumDelnumberoptionalСумма, соответствующая признаку поставки 2 или 3, в валюте цены контракта (кредитного договора),
  correctionDatestringoptionalДата корректировки,
  correctionNumberintegeroptionalНомер корректировки,
  countryCodestringoptionalКод страны грузополучателя (грузоотправителя)
  countryNamestringoptionalНаименование страны грузополучателя (грузоотправителя),
  docCodestringrequiredКод вида документа,
  docNamestringrequiredНаименование вида документа,
  docSumAmountCurrencyrequiredСумма и валюта документа,
  docSumDelnumberoptionalСумма, соответствующая признаку поставки 2 или 3, в валюте документа,
  expectedLifestringoptionalОжидаемый срок,
  hasConfDocNumberbooleanrequiredПризнак присутствия номера подтверждающего документа,
  ordinalNumberintegerrequiredПорядковый номер строки в справке,
  supplyFeaturestringoptionalПризнак поставки
}
FailReason {
  docFieldstringoptionalПоле документа,
  reasonCommentstringoptionalПравило заполнения/замечания,
  reasonIdstringoptionalКод причины отказа,
  returnCommentstringoptionalКомментарий
}
AmountCurrency {
  amountnumberrequiredСумма,
  currencyCodestringrequiredЦифровой код валюты,
  currencyNamestringrequiredБуквенный ISO-код валюты
}
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, не указана операция CONFIRMATORY_DOCUMENTS_INQUIRY. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Получение статуса справки о подтверждающих документах

Alt text /fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state

Запрос позволяет получить статус ранее созданного документа «Справка о подтверждающих документах» (далее СПД).

Для получения статуса СПД необходимо отправить GET-запрос /fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CONFIRMATORY_DOCUMENTS_INQUIRY для получения доступа к этому запросу.


Для обращения к ресурсу необходимо отправлять запрос на:

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

Request

/fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state
НаименованиеТипФорматRegexpОбязательностьОписание
HEADER
Authorizationstringstring^[a-zA-Z0-9]{38}$requiredAccess token пользователя, полученный через SSO.
PATH PARAMETER
externalIdstringUUID^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$requiredИдентификатор документа, присвоенный вами при его создании

Responses

200 (OK)
НаименованиеТипОбязательностьОписание
DocState {
  bankCommentstringoptionalБанковский комментарий к статусу документа,
  bankStatusstringoptionalСтатус документа,
  channelInfostringoptionalКомментарий, специфичный для документа, полученного по данному каналу
}
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, не указана операция CONFIRMATORY_DOCUMENTS_INQUIRY. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
404 (Not found)
CauseMessageDescription
NOT_FOUNDДокумент с указанным ID не найден
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
500 (Internal Server Error)
CauseMessageDescription
UNKNOWN_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}
503 (Service Temporarily Unavailable)
CauseMessageDescription
UNAVAILABLE_RESOURCE_EXCEPTIONВнутренняя ошибка сервераСделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.
НаименованиеТипОбязательностьОписание
Notice {
  causestringoptionalПричина или основание сообщения,
  referenceIdstringoptionalУникальный идентификатор ошибки (UUID),
  messagestringoptionalСообщение,
}

Статусы СПД

bankStatus (string)
СтатусЗначение
Промежуточный / Продолжать опрашивать
CREATEDСоздан
SIGNEDПодписан
DELIVEREDДоставлен
**POSTPONEDВ работе ВК
ACCEPTEDПринят
**EXPORTEDВыгружен
TRIED_BY_CFEПроверяется ВК
ACCEPTED_BY_ABSПринят АБС
Окончательные статусы/Прекратить опрос
CHECKERRORОшибка контроля
REFUSEDBYABSОтказан АБС
REFUSED_BY_CFEОтказан ВК
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFEПринят ВК

ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.