Приступая к работе
ВАЖНО! Банк может изменять реквизитный состав возвращаемой информации, добавлять новые необязательные элементы. Партнёр должен это учитывать и в своих имплементациях корректно реагировать на появление новых атрибутов в REST сервисах SberBusinessAPI.
SberBusinessAPI (ранее Fintech API)
- SberBusinessAPI предназначен для работы с данными корпоративных клиентов ПАО Сбербанк.
- SberBusinessAPI реализован на базе протокола авторизации OAuth 2.0.
- Доступ Партнеров/Клиентов к SberBusinessAPI осуществляется после проведения процедур настройки на стороне Банка.
- Для подключения необходимо направить заявку в свободной форме (ИНН и название организации, сайт, если есть, свои контакты или контакты Вашего клиентского менеджера) на адрес электронной почты fintech_API@sberbank.ru или заполнить заявку на сайте.
- Подключение к SberBusinessAPI осуществляется на платной основе, на основе заявки будет рассчитана стоимость подключения.
- Ознакомиться с тарифами вы можете на сайте.
Взаимодействие происходит посредством REST-запросов к определённым методам SberBusinessAPI. Для организации взаимодействия необходимо выполнить доработку Вашей системы в соответствии со спецификацией SberBusinessAPI.
Для доступа к методам SberBusinessAPI требуется использовать TLS-сертификат, изданный банком.
Получение клиентского TLS сертификата
После выпуска сертификат будет добавлен в белый список и привязан к сервису. Запросы, отправленные под иным TLS-сертификатом, не будут валидными.
Формирование запроса на сертификат
Чтобы сформировать запрос на сертификат необходимо:
1. Войти в Windows с правами локального администратора;
2. На рабочем столе Windows нажать кнопку «Пуск».
3. В строке поиска ввести «certmgr.msc».
4. Нажать на найденную программу в верхней части окна, как на рисунке ниже.
5. В открывшейся оснастке перейти в папку «Личное».
6. На элемент «Сертификаты» нажать правой кнопкой мыши.
7. В открывшемся меню выбрать Все задачи/Дополнительные операции/Создать настраиваемый запрос.
8. В окне «Перед началом работы» нажать кнопку Далее.
9. В окне «Выбор политики регистрации сертификатов» необходимо выбрать пункт «Продолжить без политики регистрации» и нажать кнопку Далее.
10. В окне «Пользовательский запрос» выбрать шаблон «Старый ключ (без шаблона)», указать формат запроса «PKCS#10». Нажать кнопку Далее.
11. В окне «Сведения о сертификате» необходимо нажать на рядом с полем «Подробности» (обведено красным кружком).
12. В появившемся блоке необходимо нажать кнопку «Свойства».
13. В окне «Свойства сертификата» необходимо заполнить атрибуты запроса на сертификат согласно требованиям УЦ, предъявляемым к запросам на SSL сертификат.
Все атрибуты должны заполняться только латинскими буквами.
На вкладке «Общие», в поле «Понятное имя» ввести удобное для пользователя название сертификата.
14. На вкладке «Субъект» требуется заполнить следующие атрибуты:
Атрибут | Значение |
---|---|
«Общее имя» (Common Name) | Атрибут должен заполняться по шаблону: FINTECH+[KeyNum], где [KeyNum] – номер ключа от 01 до 99, который должен быть уникален для каждого запроса на сертификат. То есть при формировании первого запроса на сертификат пользователь должен указать номер ключа «01», при выпуске следующего запроса указать «02» и т.д. Пример правильного значения поля: FINTECH01 |
«Электронная почта» (E-mail) | В поле должен указываться действующий электронный адрес сотрудника на стороне клиента, который отвечает за получение TLS сертификатов из УЦ Сбербанка |
«Страна» (Country/Region) | В поле должен указываться двухбуквенный код страны. Код своей страны можно узнать в Интернете по ссылке https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 |
«Организация» (Company) | В поле должно указываться наименование организации латинскими буквами |
«Подразделение» (Organizational Unit) | ИНН организации |
В блоке «Имя субъекта» необходимо по очереди выбирать названия нужных атрибутов в ниспадающем списке «Тип», вводить значение атрибута в поле «Значение», а затем нажать кнопку Добавить.
Ниже представлен пример заполнения атрибутов сертификата:
15. На вкладке «Расширения» необходимо в разделе «Использование ключа» добавить элементы «Шифрование данных» и «Цифровая подпись».
16. В разделе «Расширенное использование ключа (политики применения)» добавить элемент «Проверка подлинности клиента».
17. На вкладке «Закрытый ключ» в разделе «Поставщик службы шифрования» необходимо выбрать элемент «Microsoft RSA SChannel Cryptographic Provider (Шифрование)».
18. В разделе «Параметры ключа» установить «Размер ключа» равный 2048 и параметр «Сделать закрытый ключ экспортируемым».
19. После установки всех параметров нажать кнопку ОК.
20. В окне «Сведения о сертификате» нажать кнопку Далее.
21. В окне «Где вы хотите сохранить автономный запрос?» необходимо:
- В поле «Имя файла» указать имя файла, в который будет сохранен запрос на сертификат.
- Выбрать формат файла «Base64» (выделено красным цветом).
- Нажать кнопку Готово.
Окно регистрации сертификата будет закрыто, а система сформирует файл с запросом, с именем файла указанном на предыдущем шаге.
Формирование запроса на сертификат для систем отличных от Windows
Пример формирования через openssl:
$ openssl req -nodes -newkey rsa:2048 -keyout example.key -out example.csr -subj "/C=RU/O=Org/CN=FINTECH01/E=e-mail@example.com/OU=0123456789"
Атрибут | Значение |
---|---|
openssl req | certificate request generating utility |
-nodes | if a private key is created it will not be encrypted |
-newkey | creates a new certificate request and a new private key |
rsa:2048 | generates an RSA key 2048 bits in size |
-keyout | the filename to write the newly created private key to |
-out | specifies the output filename |
-subj | sets certificate subject |
«Общее имя» (Common Name) | Атрибут должен заполняться по шаблону: FINTECH+[KeyNum], где [KeyNum] – номер ключа от 01 до 99, который должен быть уникален для каждого запроса на сертификат. То есть при формировании первого запроса на сертификат пользователь должен указать номер ключа «01», при выпуске следующего запроса указать «02» и т.д. Пример правильного значения поля: FINTECH01 |
«Электронная почта» (E-mail) | В поле должен указываться действующий электронный адрес сотрудника на стороне клиента, который отвечает за получение TLS сертификатов из УЦ Сбербанка |
«Страна» (Country/Region) | В поле должен указываться двухбуквенный код страны. Код своей страны можно узнать в Интернете по ссылке https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 |
«Организация» (Company) | В поле должно указываться наименование организации латинскими буквами |
«Подразделение» (Organizational Unit) | ИНН организации |
Чтобы получить клиентский TLS-сертификат, пользователю необходимо файл с запросом на сертификат:
- Передать своему куратору в Сбербанке, для отправки в УЦ Сбербанка.
- Направить в УЦ Сбербанка через запрос на supportdbo2@sberbank.ru по шаблону:
Тема: SberBusinessAPI / Наименование организации / Регистрация сертификата
ТЕСТ
Наименование организации
ИНН
ClientID
Просьба зарегистрировать сертификат во вложении для тестирования.
Установка сертификата
После того, как УЦ выпустит TLS сертификат, необходимо:
Получить сертификат у своего куратора в Сбербанке.
Установить цепочку доверенных сертификатов Сбербанка (если их еще нет) в каталог "Доверенные корневые центры сертификации".
Установить TLS сертификат (в каталог "Личные") на том же компьютере и под тем же пользователем, под которыми создавался запрос на этот сертификат.
Примеры тестовых сертификатов.zip
Генерацию запроса на создание сертификата необходимо сделать на одной машине и под одним конкретным пользователем. После издания банком сертификата его необходимо добавить на пк, где формировался запрос.
Изданный ключ и сертификат можно выгрузить в виде файла контейнера, защищенного паролем, и перенести на другой пк.
Для работы на тестовом стенде необходимо установить Цепочка тестовых TLS-сертификатов.zip
Для работы на промышленном стенде необходимо установить Цепочка промышленных TLS-сертификатов.zip
Для OS Linux
В OS Windows файл контейнера сертификата имеет формат .pfx. Для корректной работы в OS Linux конвертировать в более подходящий для системы формат (.pem) с помощью openssl.
Команды openssl для конвертации:
To convert a PFX file to a PEM file that contains both the certificate and private key, the following command needs to be used:
$ openssl pkcs12 -in filename.pfx -out cert.pem -nodes
Conversion to separate PEM files We can extract the private key form a PFX to a PEM file with this command:
$ openssl pkcs12 -in filename.pfx -nocerts -out key.pem
Exporting the certificate only:
$ openssl pkcs12 -in filename.pfx -clcerts -nokeys -out cert.pem
Проверка сертификата
Для проверки TLS сертификата (тест/пром), необходимо перейти по соответствующим ссылкам:
Тестовый swagger:
https://edupirfintech.sberbank.ru:9443/fintech/api/swagger-ui.html
Промышленный swagger:
https://fintech.sberbank.ru:9443/fintech/api/swagger-ui.html
При переходе на ресурс запрашивается TLS сертификат. Если сертификат не установлен или установлен некорректно, то возникнет ошибка.
Памятка по интеграции
1. Введение
Сервис SberBusinessAPI построен на базе современных технологий, которые предоставляют возможность взаимодействия с Банком через сеть Интернет. Посредством вызова программных функций с заранее определенным списком параметров Клиент может производить обмен электронными документами с Банком, в том числе передавать черновики платежных поручений в адрес пользователей системы «Сбербанк Бизнес Онлайн», получать выписки по счетам клиентов-юридических лиц с их согласия, направлять платежные поручения и платежные требования на списание денежных средств со счетов клиентов в рамках заранее данных акцептов за услуги Клиента. Взаимодействие с Сервисом осуществляется через функциональность, встроенную в автоматизированную систему Клиента (далее – АС Клиент), которая должна вызывать функции сервиса и обрабатывать результаты их работы.
Подключение АС Клиента к сети Интернет влечет риски, связанные с несанкционированным доступом к данным, хранящимся на сервере АС.
Соблюдение приведенных ниже рекомендаций позволит Вам максимально безопасно взаимодействовать с сервисом SberBusinessAPI и свести риски работы через сеть Интернет к минимуму.
2. Схема взаимодействия
Взаимодействие АС Клиента с сервисом SberBusinessAPI рекомендуется осуществлять в соответствии со схемой, изображенной на рис.1.
Рис.1. Схема взаимодействия АС Клиента с сервисом SberBusinessAPI.
При реализации схемы следует учесть следующие рекомендации:
2.1. Настройками внутреннего межсетевого экрана (Internal Firewall) доступ к серверу АС Клиента рекомендуется разрешить только для серверов и рабочих станций организации, необходимых для использования в производственном процессе:
- сервера контроллеров домена, обновлений системного и антивирусного ПО;
- АРМ администраторов сервера АС Клиента.
2.2. Для подключения АС Клиента к Шлюзу сервиса SberBusinessAPI Банка на межсетевом экране (External Firewall) необходимо разрешить взаимодействие с интернет-ресурсом fintech.sberbank.ru c использованием протокола HTTPS и передачей ip-пакетов в обоих направлениях для TCP-порта 9443.
2.3. Подписание ЭД с использованием устройств VPN-Key-TLS рекомендуется осуществлять в отдельном сегменте корпоративной сети.
2.4. Доступ рабочего места, предназначенного для подписания ЭД с использованием устройств VPN-Key-TLS, к ресурсам и сервисам сети Интернет должен быть исключен.
3. Меры по защите от вредоносного ПО
На сервере АС Клиента необходимо:
3.1. Использовать современное антивирусное программное обеспечение и следить за его регулярным обновлением.
3.2. Регулярно выполнять антивирусную проверку для своевременного обнаружения вредоносных программ.
3.3. Своевременно устанавливать обновления операционной системы серверов и АРМ администратора, рекомендуемые компанией-производителем в целях устранения выявленных уязвимостей ОС.
3.4. Использовать дополнительное программное обеспечение, позволяющее повысить уровень защиты компьютеров – персональные межсетевые экраны, программы поиска шпионских компонент, программы защиты от «спам»- рассылок и пр.
3.5. Обеспечить отсутствие несанкционированно установленных программ удаленного доступа (TeamViewer, BeTwin, RAdmin и др.), программ работы с вирусоопасными ресурсами и сервисами сети Интернет, включая почтовые клиенты.
3.6. Исключить установку, полученного из не заслуживающих доверия источников, а также нелицензионного и свободно-распространяемого ПО на сервере с системой. Обращаем Ваше внимание, что сотрудники ПАО «Сбербанк» не рассылают дистрибутивы ПО по электронной почте.
4. Меры, направленные на защиту от копирования ключевой и парольной информации
4.1. Client_Secret – это конфиденциальная информация. Ни при каких обстоятельствах не раскрывайте эти данные никому, включая сотрудников Банка.
4.2. При подозрениях на компрометацию постоянного Client_Secret, следует незамедлительно остановить работу с сервисом SberBusinessAPI, направить письмо с запросом о замене Client_Secret и провести смену Client_Secret после его получения от Банка.
4.3. В случае компрометации Client_Secret необходимо незамедлительно выполнить его блокировку в соответствии с п.4.2.3 Соглашения.
4.4. При доступе АС Клиента к функциям SberBusinessAPI хранение Client_Secret необходимо осуществлять в ключевом хранилище. Настройками безопасности ОС доступ к ключевому хранилищу рекомендуется предоставлять только для учетной записи АС.
4.5. Процедуру замены Client_Secret необходимо проводить в автоматизированном режиме средствами АС без вмешательства пользователей.
4.6. При обращении от имени Банка по телефону, электронной почте, через SMS-сообщения лиц с просьбами сообщить или передать конфиденциальную информацию (Client_Secret) ни при каких обстоятельствах не сообщайте данную информацию.
4.7. В период, когда Система не используется, необходимо отключать носители с ключами ЭП от сервера, и убирать в места хранения (сейф, и т.п.).
4.8. Необходимо выполнять незамедлительную блокировку и смену ключей ЭП в случаях их компрометации, а также по истечении срока действия ключей с периодичностью, установленной договорами и документацией.
4.9. ПИН-коды доступа устройств «VPN-Key-TLS» - это конфиденциальная информация. Ни при каких обстоятельствах не раскрывайте эти данные никому, включая сотрудников Банка.
5. Меры, направленные на защиту от выполнения несанкционированных списаний
5.1. Следует регулярно контролировать состояние корреспондентских счетов организации и незамедлительно информировать обслуживающее подразделение Банка обо всех подозрительных или несанкционированных операциях.
5.2. В случае неожиданного выхода из строя серверов с модулем подписания с использованием устройств VPN-Key-TLS необходимо прекратить эксплуатацию данных серверов, отключив их от всех видов сетей, включая локальную корпоративную сеть, срочно запросить выписку по счету непосредственно в Банке. При обнаружении несанкционированных платежных операций написать заявление в Банк, а также обратиться с соответствующим заявлением в правоохранительные органы. Работоспособность скомпрометированных серверов не восстанавливать до проведения технической экспертизы. Подписание электронных документов осуществлять с использованием устройств VPN-Key-TLS на других серверах. При этом обязательно произвести смену ключей ЭП.
6. Меры по поддержанию уровня информационной безопасности
Для обеспечения высокого уровня информационной безопасности при эксплуатации АС Клиента в организации должен быть назначен ответственный, который осуществляет:
6.1. Постоянный контроль соблюдения мер информационной безопасности, предусмотренных настоящей памяткой;
6.2. Выявление, устранение и информирование руководства организации обо всех выявленных нарушениях;
6.3. Контроль устранения выявленных нарушений;
6.4. Документирование результатов проведенных работ и проверок;
6.5. Организацию и проведение мероприятий по усилению безопасности в соответствии с информационными сообщениями, которые направляются Банком официальными письмами, а также публикуются на сайте Банка.
Тестовые и промышленные URL SberBusinessAPI
Адреса для тестирования и работы в промышленном контуре с SberBusinessAPI и Сбер Бизнес ID.
Host ТЕСТ | Host ПРОМ | Необходимость сертификата TLS | Описание | Ресурс |
---|---|---|---|---|
https://edupir.testsbi.sberbank.ru:9443 | https://sbi.sberbank.ru:9443 | Нет | Авторизация пользователя (тип пользователя СМС или тип пользователя неизвестен) | Сбер Бизнес ID: GET/ic/sso/api/v2/oauth/authorize?{параметры} |
http://localhost:28016 | http://localhost:28016 | Работа клиента через устройство VPNkey-TLS | Авторизация пользователя (тип пользователя Token) | Сбер Бизнес ID: GET/ic/sso/api/v2/oauth/authorize?{параметры} |
https://edupirfintech.sberbank.ru:9443 | https://fintech.sberbank.ru:9443 | Да | Back-to-Back взаимодействия | Сбер Бизнес ID: POST/ic/sso/api/v1/change-client-secret POST/ic/sso/api/v2/oauth/token GET/ic/sso/api/v1/oauth/user-info SberBusinessAPI: GET/fintech/api/v1/client-info GET/fintech/api/v1/crypto POST/fintech/api/v1/crypto/cert-requests POST/fintech/api/v1/crypto/cert-requests/{externalId}/activate GET/fintech/api/v1/crypto/cert-requests/{externalId}/state GET/fintech/api/v1/crypto/eio POST/fintech/api/v1/crypto/cert-requests/eio GET/fintech/api/v1/crypto/cert-requests/eio/{externalId}/state POST/fintech/api/v1/crypto/cert-requests/eio/{externalId}/activate PUT/fintech/api/v1/client-tariffs POST/fintech/api/v1/client-accruals GET/fintech/api/v1/client-accruals/{externalId} GET/fintech/api/v1/partner-info/advance-acceptances GET/fintech/api/v1/partner-info/offer POST/fintech/api/v1/payment-requests/outgoing GET/fintech/api/v1/payment-requests/outgoing/{externalId}/state POST/fintech/api/v1/payments POST/fintech/api/v1/payments/from-invoice POST/fintech/api/v1/payments/from-invoice-any GET/fintech/api/v1/payments/{externalId}/state GET/fintech/api/v1/payments/{externalId} POST/fintech/api/v1/periodic-payments/to-partner GET/fintech/api/v1/periodic-payments/{externalId}/state GET/fintech/api/v1/statement/summary GET/fintech/api/v1/statement/transactions POST/fintech/api/v1/cash-hold/hold GET/fintech/api/v1/cash-hold/hold/{externalId}/state POST/fintech/api/v1/cash-hold/unhold GET/fintech/api/v1/cash-hold/unhold/{externalId}/state POST/fintech/api/v1/cash-hold/unhold-transfer GET/fintech/api/v1/cash-hold/unhold-transfer/{externalId}/state PUT/fintech/api/v1/webhooks/{webhookId} GET/fintech/api/v1/correspondents/cur GET/fintech/api/v1/correspondents/rur PUT/fintech/api/v1/correspondents/cur/{externalId}/additional POST/fintech/api/v1/tariff-plans/activation GET/fintech/api/v1/tariff-plans/list-activated GET/fintech/api/v1/tariff-plans/list-available POST/fintech/api/v1/credit/credit-requests POST/fintech/api/v1/files/download GET/fintech/api/v1/files/downloadstate GET/fintech/api/v1/payments-registry PUT/fintech/api/v1/payments-registry/{externalId}/change-state POST/fintech/api/v1/salary-agreement-requests GET/fintech/api/v1/salary-agreement-requests/{externalId}/state POST/fintech/api/v1/card-issues GET/fintech/api/v1/card-issues/{externalId}/state GET/fintech/api/v1/card-issues/{externalId} GET/fintech/api/v1/salary-agreements POST/fintech/api/v1/payrolls GET/fintech/api/v1/payrolls/{externalId}/state GET/fintech/api/v1/payrolls/{externalId} POST/fintech/api/v1/debt-registries GET/fintech/api/v1/debt-registries/{externalId}/state POST/fintech/api/v1/files/upload GET/fintech/api/v1/files/upload/{fileId}/state POST/fintech/api/v1/generic-letters/to-bank GET/fintech/api/v1/generic-letters/to-bank/{externalId}/state GET/fintech/api/v1/generic-letters/to-bank/{externalId} GET/fintech/api/v1/generic-letters/from-bank POST/fintech/api/v1/confirmatory-documents-inquiries GET/fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state GET/fintech/api/v1/confirmatory-documents-inquiries/{externalId} POST/fintech/api/v1/currency-operation-details GET/fintech/api/v1/currency-operation-details/{externalId}/state GET/fintech/api/v1/currency-operation-details/{externalId} POST/fintech/api/v1/curr-control-messages/to-bank GET/fintech/api/v1/curr-control-messages/to-bank/{externalId}/state GET/fintech/api/v1/curr-control-messages/from-bank GET/fintech/api/v1/currency-notices POST/fintech/api/v1/bank-control-statements/reg-curr-contracts GET/fintech/api/v1/bank-control-statements/{externalId}/state GET/fintech/api/v1/bank-control-statements/reg-curr-contracts/{externalId} POST/fintech/api/v1/bank-control-statements/reg-curr-cred-contracts GET/fintech/api/v1/bank-control-statements/{externalId}/state GET/fintech/api/v1/bank-control-statements/reg-curr-cred-contracts/{externalId} POST/fintech/api/v1/bank-control-statements/change-curr-contracts POST/fintech/api/v1/bank-control-statements/change-curr-cred-contracts GET/fintech/api/v1/bank-control-statements/change-applications/{externalId}/state POST/fintech/api/v1/pay-doc-cur GET/fintech/api/v1/pay-doc-cur/{externalId}/state GET/fintech/api/v1/pay-doc-cur/{externalId} POST/fintech/api/v1/curr-buy GET/fintech/api/v1/curr-buy/{externalId}/state GET/fintech/api/v1/curr-buy/{externalId} POST/fintech/api/v1/curr-sell GET/fintech/api/v1/curr-sell/{externalId}/state GET/fintech/api/v1/curr-sell/{externalId} POST/fintech/api/v1/orders-mandatory-sale GET/fintech/api/v1/orders-mandatory-sale/{externalId}/state GET/fintech/api/v1/orders-mandatory-sale/{externalId} POST/fintech/api/v1/collection-orders GET/fintech/api/v1/collection-orders/{externalId}/state GET/fintech/api/v1/collection-orders/{externalId} POST/fintech/api/v1/acceptance-letters GET/fintech/api/v1/acceptance-letters/{externalId}/state GET/fintech/api/v1/payment-requests/incoming GET/fintech/api/v1/payment-requests/incoming/{externalId}/state GET/fintech/api/v1/encash/encash-contracts POST/fintech/api/v1/encash/encash-add-requests GET/fintech/api/v1/encash/encash-add-requests/{externalId}/state GET/fintech/api/v1/encash/encashment-offers POST/fintech/api/v1/encash/encashment-offers/{externalId}/acceptance POST/fintech/api/v1/self-encashers-requests GET/fintech/api/v1/self-encashers-requests/{externalId}/state GET/fintech/api/v1/self-encashers-requests/{externalId} POST/fintech/api/v1/self-encashers/block POST/fintech/api/v1/self-encashers/new-password |
https://edupir.testsbi.sberbank.ru:9443 | https://sbi.sberbank.ru:9443 | Нет | Открыть форму оплаты счета (тип пользователя СМС) | GET /ic/dcb/index.html#/payment-creator/{externalId из ответа по статусу документа}?backUrl={адрес возврата клиента после оплаты} |
https://edupir.testsbi.sberbank.ru:9443 | https://sbi.sberbank.ru:9443 | Нет | Войти в Интернет-банк СберБизнес (тип пользователя СМС) | GET /ic/dcb |
http://localhost:28016 | http://localhost:28016 | Работа клиента через устройство VPNkey-TLS | Открыть форму оплаты счета (тип пользователя СМС) | GET /ic/dcb/index.html#/payment-creator/{externalId из ответа по статусу документа}?backUrl={адрес возврата клиента после оплаты} |
http://localhost:28016 | http://localhost:28016 | Работа клиента через устройство VPNkey-TLS | Войти в Интернет-банк СберБизнес (тип пользователя Токен) | GET /ic/dcb |
https://edupirfintech.sberbank.ru:9443 | Да | Swagger UI | GET /fintech/api/swagger-ui.html |
Личный кабинет SberBusinessAPI
В Личном кабинете SberBusinessAPI доступны методы:
- Авторизация Сбер Бизнес ID;
- Заявка на удаленное подключение Зарплатного проекта;
- Запрос на сертификат;
- Рублёвое платёжное поручение;
- Зарплатный договор;
- Валютное платежное поручение;
- Письмо свободного формата (из банка);
- Получение информации о счетах подключенного клиента;
- Получение выписки по счёту клиента;
- Зарплатная ведомость;
- Получение криптоинформации (КУЦ, криптопрофили и т.д.);
- Справочник.
Чтобы получить доступ к Личному кабинету SberBusinessAPI, оставьте заявку на сайте.
В течение 1-3 рабочих дней с вами свяжется менеджер.
Инструкция по подключению
Шаги
- Подключить услугу через СберБизнес
- Заполнить и подписать заявление
- Настройка тестового полигона
- Настройка промышленного полигона
- Контакты для связи
Шаг 1. Подключить услугу через СберБизнес
1.1. Авторизуйтесь в СберБизнес.
1.2. Перейдите в раздел меню Все продукты и услуги, выберите SberBusinessAPI.
В появившемся окне с информацией о продукте нажмите Подключить.
Ознакомиться с условиями подключения можно по ссылке https://www.sberbank.ru/ru/legal/finapi?tab=terms .
Шаг 2. Заполнить и подписать заявление
2.1. Заполните заявление и укажите контактный телефон, электронную почту и ответственное лицо за настройку сервиса. Для добавления ответственного лица нажмите кнопку Добавить и из раскрывающегося списка выберите пункт Создать нового сотрудника.
2.2. В открывшемся окне заполните данные ответственного сотрудника и нажмите Добавить.
Ознакомьтесь с условиями предоставления услуг и установите флажок Согласие с условиями предоставления услуг. Нажмите кнопку Создать.
2.3. Отправьте заявление в банк.
Подпишите документ с помощью СМС-кода или токена и отправьте его в банк.
Отследить статус заявления вы можете в разделе Моя организация > Заявления.
Шаг 3. Настройка тестового полигона
3.1. После того, как заявление успешно подписано, откроется личный кабинет SberBusinessAPI.
3.2. Разверните вкладку Параметры тестового полигона.
Учетные данные пользователя:
- Логин и пароль — для авторизации в web Интернет-банк СберБизнес.
Параметры сервиса:
- Redirect_url — маска адреса по которой пользователь будет перенаправлен с кодом авторизации;
- Client_id — банковский идентификатор сервиса полученный от менеджера при регистрации;
- Client_secret — авторизационный ключ сервиса. Генерируется банком в момент заведения сервиса;
- Scope для авторизации v2 — для выполнения авторизации по методу v2/oauth/authorize.
3.3. Отправьте информацию вашим разработчикам.
Нажмите Отправить настройки.
Укажите адрес электронной почты. Нажмите кнопку Отправить.
Нажмите Скопировать в буфер обмена, чтобы скопировать настройки тестового полигона.
Для изменения настроек тестового полигона необходимо направить запрос на supportdbo2@sberbank.ru.
Шаг 4. Настройка промышленного полигона
4.1. Сформируйте TLS-сертификат по инструкции или в Личном кабинете SberBusinessAPI. Направьте с указанием услуги SberBusinessAPI: наименование организации, ИНН, среда ТЕСТ или ПРОМ, client_id на supportdbo2@sberbank.ru.
4.2. Разверните вкладку Параметры промышленного полигона.
Параметры сервиса:
- Redirect_url — маска адреса по которой пользователь будет перенаправлен с кодом авторизации;
- Client_id — банковский идентификатор сервиса полученный от менеджера при регистрации;
- Client_secret — авторизационный ключ сервиса;
- Scope для авторизации v1 — для выполнения авторизации по методу /v1/oauth/authorize;
- Scope для авторизации v2 — для выполнения авторизации по методу v2/oauth/authorize.
4.3. Отправьте информацию вашим разработчикам.
Нажмите Отправить настройки.
В открывшемся окне укажите адрес электронной почты. Нажмите кнопку Отправить.
Нажмите Скопировать в буфер обмена, чтобы скопировать настройки промышленного полигона.
4.4. Укажите Redirect URI.
Redirect URI — ссылка на ресурс вашей компании, на который будет осуществляться возврат после прохождения авторизации.
Нажмите на кнопку:
Введите значение Redirect URI. Нажмите Сохранить.
Экспертная поддержка:
E-mail: supportdbo2@sberbank.ru
Режим работы: Понедельник-Пятница 09:00 - 19:00 (по московскому времени)
Инструкция по работе
- Сменить client-secret
- Сгенерировать TLS-сертификат
- Установить TLS-сертификат
- Отозвать TLS-сертификат
- Получить/обновить/удалить AccessToken
- Просмотреть тарифы
- Просмотреть сумму комиссии банка за конкретный месяц
- Скачать отчет по потреблению сервиса SberBusinessAPI в форматах pdf/xls
- Настроить оповещения
- Отключить сервис
- Назначить сотруднику роль Разработчик SberBusinessAPI
Сменить client-secret
Сменить client-secret могут пользователи, у которых:
- ЭП с полномочиями ЕИО (Единоличный исполнительный орган)
- Единственная подпись
- Первая подпись
- Роль Разработчик SberBusinessAPI
1. Разверните вкладку Параметры промышленного полигона.
2. Сгенерируйте новый client-secret.
В поле Client-secret нажмите кнопку:
3. Подтвердите генерацию.
Нажмите Подтвердить.
После генерации необходимо скопировать client-secret. Иначе он замаскируется и потребуется повторная генерация.
Сгенерировать TLS-сертификат
1. Разверните вкладку Сертификаты шифрования.
2. Сгенерируйте сертификат.
Нажмите кнопку Сгенерировать сертификат. Рядом с кнопкой отображается количество доступных для генерации сертификатов.
В открывшемся окне укажите один или несколько адресов электронной почты.
Придумайте и введите пароль доступа к сертификату.
Требования к паролю:
- Содержит минимум 7 символов.
- Содержит цифры и буквы.
- Не содержит трех одинаковых символов подряд.
Нажмите кнопку Отправить.
Если TLS-сертификат успешно сгенерирован и отправлен на почту, в окне появится подтверждение.
На указанный адрес электронной почты придет письмо с вложенным зашифрованным контейнером PKCS#12.
Сгенерированные сертификаты появятся на вкладке Сертификаты шифрования.
Нажмите кнопку Загрузить, чтобы скачать цепочку доверенных TLS-сертификатов.
Нажмите кнопку Инструкция, чтобы открыть инструкцию по установке сертификатов.
Установить TLS-сертификат
1. Установите Цепочка доверенных TLS-сертификатов.zip(если их еще нет) в каталог "Доверенные корневые центры сертификации".
2. Установите TLS-сертификат в каталог "Личные" на том же компьютере.
Для работы на тестовом стенде необходимо установить Цепочка тестовых TLS-сертификатов.zip.
Отозвать TLS-сертификат
Чтобы отозвать TLS-сертификат, обратитесь к менеджеру или направьте запрос на supportdbo2@sberbank.ru.
Получить/обновить/удалить AccessToken
Для доступа к разделу обратитесь к менеджеру или направьте запрос на supportdbo2@sberbank.ru.
1. Разверните вкладку Ключи доступа.
2. Получите AccessToken.
Нажмите кнопку Создать ключ.
После создания необходимо скопировать AccessToken. Иначе ключ замаскируется и потребуется его повторное создание.
3. Чтобы обновить AccessToken, нажмите кнопку:
4. Чтобы удалить AccessToken, нажмите кнопку:
Подтвердите удаление ключа доступа. Нажмите кнопку Удалить.
В разделе Другие ключи отображаются:
- ФИО сотрудников вашей организации, которые выпустили AccessToken.
- Срок действия AccessToken.
Чтобы удалить AccessToken, нажмите кнопку и подтвердите действие.
Удаление AccessToken из раздела Другие ключи доступно только пользователю ЕИО.
Просмотреть тарифы
Нажмите кнопку Показать все тарифы.
Слева в колонке Стоимость Количество запросов отобразятся тарифные ставки.
Просмотреть сумму комиссии банка за конкретный месяц
Наведите курсор на соответствующий столбец графика.
Отобразится окно с информацией по выбранному месяцу.
Скачать отчет по потреблению сервиса SberBusinessAPI в форматах pdf/xls
Нажмите кнопку PDF или XLS.
Содержание отчета:
- Дата формирования запросов;
- Наименование запросов;
- Количество выполненных банком запросов;
- Расчетный период;
- Для каждого расчетного месяца указаны: количество запросов, сумма комиссии банка;
- Реквизиты банка для оплаты вознаграждения банка.
Настроить оповещения
1. Нажмите кнопку Настроить оповещения.
2. Выберите необходимые уведомления: при смене тарифных зон, при определенном значении запросов.
Укажите количество запросов.
Нажмите Сохранить.
При достижении указанного количества запросов для уведомления при определенном значении запросов придет письмо на электронную почту.
Отключить сервис
1. В правом верхнем углу нажмите кнопку Отключить сервис.
Отключение сервиса доступно при наличии подключенных незаблокированных сервисов.
2. Заполните заявление.
Укажите контактные данные представителя и дату, с которой необходимо отключить SberBusinessAPI. Нажмите Создать.
Будут отключены все сервисы, подключенные через СберБизнес и отделения банка.
3. Отправьте заявление в банк.
Подпишите документ с помощью СМС-кода или токена и отправьте его в банк.
Отследить статус заявления вы можете в разделе Моя организация > Заявления.
До отключения в Личном кабинете будет отображаться информационное сообщение.
Назначить сотруднику роль Разработчик SberBusinessAPI
Роль Разработчик SberBusinessAPI — роль сотрудника для доступа в ЛК SberBusinessAPI. У такого сотрудника не будет доступа к документам и и разделам ЦКП.
1. Выберите роль.
При заполнении карточки Новый пользователь нажмите кнопку Выбрать роль.
2. Назначьте роль Разработчик SberBusinessAPI.
В строке Полномочия найдите роль Разработчик SberBusinessAPI.
Нажмите кнопку Назначить.
3. Внесите данные о сотруднике.
Заполните поля: сотрудник, логин, счета и телефон. Нажмите Создать.
4. Отправьте заявление в банк.
Подпишите документ с помощью СМС-кода или токена и отправьте его в банк.
Отследить статус заявления вы можете в разделе Моя организация > Заявления.
Глоссарий
- Access Token — авторизационный токен к данным организации.
- Refresh Token — токен обмена, который предназначен для получения нового Access Token и Refresh Token в случае компрометации или истечения времени жизни Access Token.
- redirect_uri — маска адреса по которой пользователь будет перенаправлен с кодом авторизации (допускается совпадение redirect_uri с URL сервиса).
- scope — должен содержать обязательный параметр "openid" и через пробел перечисляются scope-ы доступных claim и сервисов, полученных от менеджера партнёра при регистрации приложения (обязательный параметр при обращении к ресурсу).
- Прямая Интеграция Host-2-Host — вы получаете информацию по своей компании через SberBusinessAPI.
Прямая интеграция Host-2-Host (Получение и отправка документов по своей организации)
2.1 Сервис авторизации-Сбер Бизнес ID
Общая информация
API сервиса авторизации реализован по Authorization Code Flow. Авторизация и аутентификация выполняется путем переадресации пользователя с запросом /authorize на страницу входа в Сбербанк Бизнес Онлайн и запроса /token для получения Access token.
Возможности сервиса
- Единая аутентификация.
SberBusinessAPI позволяет аутентифицированному, в АС Интернет-банке СберБизнес, пользователю получить доступ к сервису без повторной аутентификации. - Авторизация.
Пользователь выдает сервису право на совершение операции со своими данными, подписывая электронно оферту. Согласие на передачу данных и документарных операций (оферта) может быть отозвано по инициативе пользователя, по причине окончания срока ее действия. - Доступ к пользовательским данным.
SberBusinessAPI позволяет идентифицировать пользователя для его последующей авторизации. Получение данных о пользователе позволяет сервису выполнять упрощённую регистрацию для новых пользователей своих сервисов. Точный набор передаваемых атрибутов пользователя формируется для каждого сервиса индивидуально.
Требования к сервису
- Приложение должно быть реализовано с поддержкой OpenIDConnect/OAuth 2.0 и обеспечивать следующую функциональность:
- Проверка подлинности пользователя (формирование и проверка параметров State и Nonce).
- Формирование запроса кода авторизации (Authorization Code).
- Обработка ответа ресурса /v1/oauth/authorize.
- Формирование запроса на получение авторизационного токена для доступа к данным клиента (Access Token).
- Обработка ответа ресурса /v1/oauth/token (в том числе расшифровка ID Token).
- Формирование запроса на получение нового авторизационного токена для доступа к данным пользователя (с помощью Refresh Token).
- Формирование запроса на получение информации о пользователе.
- Обработка ответа ресурса /v1/oauth/user-info.
В случае возникновения ошибок работы сервиса, для анализа вопроса, Банком будут запрошены логи обмена со стороны сервиса. Рекомендуем реализовать логирование всех взаимодействий с Банком с фиксацией отправляемых/получаемых пакетов.
2.1.1 Авторизация пользователя
GET /v2/oauth/authorize-Код авторизации
POST /v2/oauth/token-Авторизационный токен
GET /v1/oauth/user-info-Информация о пользователе
POST /v1/change-client-secret-Смена авторизационного ключа
Смс пользователь — пользователь, который использует SMS-подтверждение (одноразовый SMS-пароль).
Токен пользователь — пользователь, который использует устройство защиты (токен).
Смс и токен пользователям можно установить три типа подписи:
- Первая.
- Вторая.
- Единственная.
Для авторизации ( /v2/oauth/authorize ) смс пользователя необходимо отправлять запрос на:
- Тестовый контур https://edupir.testsbi.sberbank.ru:9443
- Промышленный контур https://sbi.sberbank.ru:9443
Для авторизации (/v2/oauth/authorize) токен пользователя необходимо отправлять запрос на:
- Тестовый контур http://localhost:28016
- Промышленный контур http://localhost:28016
Для обращения к ресурсам /v2/oauth/token, /v1/oauth/user-info, /v1/change-client-secret необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Работа с тестовым токеном
1. Для работы токен пользователей, на тестовом стенде, необходимо получить VPNKeyTLS токен у своего менеджера или написать на fintech_API@sberbank.ru.
2. Авторизация в токене происходит после запуска .exe файла в токене и ввода ПИН-кода. Список ПИН-кодов направляется клиенту, после передачи токена, в электронном виде.
3. После авторизации в интерфейсе токена необходимо выбрать БС EDUPIR (бизнес система тестового стенда EDUPIR) и авторизоваться в Интернет-банке СберБизнес.
4. Для возможности подписывать документы необходимо выпустить сертификат ЭП:
4.1. Через интерфейс Интернет-банка СберБизнес по документации.
4.2. Через SberBusiness API по документации.
5. После создания запроса необходимо отправить информацию в поддержку supportdbo2@sberbank.ru, для регистрации сертификата в УЦ Банка, в формате:
- Стенд:EDUPIR
- ClientId и логин тестового пользователя
- BicryptID (КУЦ + номер сертификата)
- Логин владельца сертификата или название организации
- Дата отправки запроса на сертификат
- Текст/Комментарий: (при необходимости)
6. После регистрации в УЦ поступит ответ от supportdbo2@sberbank.ru о готовности сертификата.
7. Необходимо активировать сертификат:
7.1. Через интерфейс Интернет-банка СберБизнес по документации.
7.2. Через SberBusiness API по документации.
8. Сертификат активирован и готов к работе.
Ресурс /v2/oauth/authorize
Если вы работаете с сервисами авторизации версии v1, нажмите здесь.
Для получения возможности работы пользователя через ваш сервис необходимо получить разрешение на выполнение операции от имени пользователя Интернет-банк СберБизнес - пройти авторизацию. Для этого необходимо перенаправить пользователя на oauth-сервер Сбер Бизнес ID.
При первом переходе пользователя дочерней организации на Сбер Бизнес ID ему будет предложено подписать оферту, дающую право сервису на отправку запросов по организации пользователя.
Пример запроса с экранированием
# You can also use wget
curl -X GET https://edupir.testsbi.sberbank.ru:9443/ic/sso/api/v2/oauth/authorize?scope=openid PAY_DOC_RU inn email&response_type=code&client_id=74617&state=af0ifjsldkj&nonce=n-0S6_WzA2Mj&redirect_uri=https%3A%2F%2example.ru \
-H 'Accept: */*'
Пример запроса без экранирования
# You can also use wget
curl -X GET https://edupir.testsbi.sberbank.ru:9443/ic/sso/api/v2/oauth/authorize?scope=openid PAY_DOC_RU inn email&response_type=code&client_id=74617&state=af0ifjsldkj&nonce=n-0S6_WzA2Mj&redirect_uri=https://example.ru \
-H 'Accept: */*'
GET /v2/oauth/authorize
При отправке запроса необходимо экранировать специальные символы, если сформированная ссылка открывается напрямую в браузере, экранирования не требуется.
Parameters
Name | Description |
---|---|
scope | Должен содержать обязательный параметр "openid" и через пробел перечисляются scope-ы доступных claim и сервисов, полученных от менеджера партнёра при регистрации приложения (обязательный параметр при обращении к ресурсу) |
response_type | Тип запроса (значение должно быть всегда "code" согласно требованию по обеспечению безопасности, разрешающее использовать исключительно Auth Code Flow (обязательный параметр)) |
client_id | Банковский идентификатор сервиса полученный от менеджера при регистрации приложения (обязательный параметр ) |
state | Параметр для предотвращения CSRF-атак (обязательный параметр) |
nonce | Значение используется для защиты от атак с повторением токенов (указанное в запросе значение должно соответствовать nonce-значению, возвращаемому в ответе, при этом значение nonce должно быть уникальным в сеансе пользователя и сложным для угадывания (обязательный параметр)) |
redirect_uri | Ссылка на страницу сервиса, на которую необходимо перенаправить пользователя после успешной авторизации (обязательный параметр) |
code_challenge | Код вызова, полученный из кода проверки (code_verifier) путем применения метода преобразования code_challenge_method (необязательный параметр) |
code_challenge_method | Метод преобразования, который был применен к коду проверки (code_verifier), для получения значения кода вызова (code_challenge) (необязательный параметр) |
location (read only) | Значение redirect_uri для client_id, указанного в запросе авторизации |
сode (read only) | Значение кода авторизации. Значение кода авторизации формируется произвольно в формате UUID (случайное значение) плюс "1" или "2" через дефис, например, CD6A56FD-A9C7-4152-AA1D-FA57E550F6AC-2. |
Пример ответа для запроса с экранированием
302 Response
https://example.ru/?code=f710576d-7263-4ec6-a01b-8404aca2850d-1&state=af0ifjsldkj&nonce=n-0S6_WzA2Mj
Пример ответа для запроса без экранирования
302 Response
https://example.ru/?code=f710576d-7263-4ec6-a01b-8404aca2850d-1&state=af0ifjsldkj&nonce=n-0S6_WzA2Mj
Responses
Status | Meaning | Description | Reason | Schema |
---|---|---|---|---|
302 | invalid_grant | Unknown code = хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан неверный код авторизации: а)несуществующий код авторизации; б)код авторизации, время жизни которого истекло; в)код авторизации,ранее использованный для получения access_token; | None |
302 | invalid_grant | Invalid client secret for authz code 'хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан неверный client_secret или client_id или client_secret и client_id. | None |
302 | invalid_grant | Redirect uri 'https://.ru' is invalid | Неверный redirect_uri. | None |
302 | invalid_grant | Unknown refresh token = хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан неверный refresh_token: а)несуществующий refresh_token; б)refresh_token, время жизни которого истекло; в)refresh_token, ранее использованный для получения нового access_token и refresh_token; | None |
302 | invalid_grant | Invalid client secret for refresh token хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан неверный client_secret (Запрос на получение новых access_token и refresh_token по действующему refresh_token) | None |
302 | invalid_grant | Ext service for authz code хххххххх-хххх-хххх-хххх-хххххххххххх-х is blocked | Внешний сервис заблокирован в системе (запрос на получение access_token и refresh_token по коду авторизации) Неверно указан адрес sso для подключения. | None |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
В случае обнаружения ошибок client_id и redirect_uri банк сформирует ответ HTTP 400 с ошибкой invalid_grant и описанием:
- Redirect uri https://example.ru is invalid - неверный redirect_uri
- Invalid client secret for authz code 'хххххххх-хххх-хххх-хххх-хххххххххххх-х'
В случае если банк вернёт ответ с ошибкой авторизации, сервис должен корректно его обработать. Так как первый шаг взаимодействия (аутентификация) осуществляется через браузер пользователя, банк вернёт HTTP ответ 302 Found. Это необходимо для того, чтобы сервис имел возможность обработать ошибку и отобразить пользователю необходимую ему страницу, например, страницу авторизации (рекомендовано).
Список доступных claim
Параметр | Описание |
---|---|
sid2 | Идентификатор сессии токена |
sbbol | Признак использования "Дизайн Интернет-банк СберБизнес 3.0" |
sub | Хэш идентификатора пользователя |
iss | URL Интернет-банк СберБизнес |
aud | Идентификатор внешнего сервиса |
dboContracts | Договоры обслуживания организации |
name | Фамилия Имя Отчество |
inn | ИНН организации |
Адрес электронной почты | |
phone_number | Номер телефона |
HashOrgId | Хэш от идентификатора организации (orgId) |
orgId | Идентификатор организации в Интернет-банк СберБизнес |
orgGuid | Глобальный идентификатор организации |
orgKpp | КПП |
orgFullName | Название компании |
OrgName | Наименование организации |
orgOgrn | ОГРН компании |
orgOkpo | ОКПО организации |
orgOktmo | Общероссийский классификатор территорий муниципальных образований |
orgActualAddress | Фактический адрес компании |
orgJuridicalAddress | Юридический адрес компании |
accounts | Счет, БИК, Кор. счет компании. Примечание:не заполняется при запросе Партнёром информации о пользователе своей организации. |
terBank | Полное наименование подразделения кредитной организации |
offerExpirationDate | Дата окончания оферты |
userPosition | Должность |
userRoles | Список роли пользователя |
userSignatureType | Тип подписи |
userGuid | Идентификатор пользователя клиента, который обратился к сервису |
userId | Внутренний идентификатор пользователя |
userGroups | Группы пользователя |
sbbol3 | Признак использования клиентом нового дизайна Интернет-банк СберБизнес 3.0 |
userCryptoType | Тип криптопрофиля |
tbIdentCode | Код территориального банка |
individualExecutiveAgency | Признак Единоличный Исполнительный Орган |
inquiryOrder | Признак доступности у пользователя функциональности получения справок |
isIdentified | Признак идентификации пользователя |
offerSmartCredit | Предодобренные предложения по смарт кредитам |
shortName | Сокращенное название компании |
summOfferSmartCredit | Сумма предодобренного предложения по смарт-кредитам |
resident | Признак является организация резидент/нерезидент |
orgBusinessSegment | Бизнес сегмент. Возможные значения: 02-Микро бизнес (микро), 03-Малый бизнес, 04-Средний бизнес, 05-Крупный бизнес, 06-Крупнейший бизнес, 07-Клиенты машиностроения (ОПК), 08-Рег. госсектор, 09-БМО, 10-Фин. институты, 999-Не найдено сегмента в CRM Корпоративном. |
buyOnCreditMmb | Признак возможности покупки в кредит на сайте партнера |
orgLawFormShort | Организационно-правовая форма (принятое сокращение) |
branch | Сокращенные наименования подразделений, адреса подразделений, номера подразделений |
orgIndustryInfo | Отрасль организации |
orgRegDateINN | Дата регистрации ИНН |
orgRegDateOGRN | Дата регистрации ОГРН |
orgKindActivityInfo | Информация о виде деятельности организации |
orgBusinessSegmentName | Наименование бизнес-сегмента |
Список доступных сервисов
Операция | Описание операции |
---|---|
PAY_DOC_RU_INVOICE | Выставление счета на оплату по фиксированным реквизитам |
GET_CLIENT_ACCOUNTS | Полючении информации о счетах подключенного клиента |
GET_STATEMENT_ACCOUNT | Получение выписки по счету клиента |
PAY_DOC_RU | Рублевое платежное поручение |
PAYROLL | Зарплатная ведомость |
FILES | Выгрузка/загрузка файлов |
CARD_ISSUE | Электронный реестр на открытие счетов и выпуск карт |
SALARY_AGREEMENT | Зарплатный договор |
DICT | Справочник |
SALARY_AGREEMENT_REQUEST | Заявка на удаленное подключение Зарплатного проекта |
PAYMENTS_REGISTRY | Реестр платежей |
DEBT_REGISTRY | Реестр задолженности |
CURRENCY_OPERATION_DETAILS | Сведения о валютной операции |
PAY_DOC_CUR | Валютное платежное поручение |
CURR_CONTROL_MESSAGE_TO_BANK | Письмо для целей ВК (в банк) |
GENERIC_LETTER_TO_BANK | Письмо свободного формата (в банк) |
CONFIRMATORY_DOCUMENTS_INQUIRY | Справка о подтверждающих документах |
PAYMENTS_REQUEST_OUT | Исходящее платежное требование |
GET_ADVANCE_ACCEPTANCES | Получение сведений о клиентах, подключенных к подпискам и пакетам услуг |
GET_PARTNER_OFFERS | Получение информации об офертах с внешним сервисом |
GET_CRYPTO_INFO | Получение криптографической информации |
CERTIFICATE_REQUEST | Запрос на сертификат |
PAY_DOC_RU_INVOICE_ANY | Выставление счета на оплату по свободным реквизитам |
CLIENT_TARIFF | Актаулизация тарифа по подключенным сервисам |
GENERIC_LETTER_FROM_BANK | Письмо свободного формата (из банка) |
CURR_CONTROL_MESSAGE_FROM_BANK | Письмо для целей ВК (из банка) |
GET_CUSTOMER_INFO | Получение информации по клиенту (реквизиты организации и пользователей) |
GET_CRYPTO_INFO_EIO | Получение сертификатов открытых ключей электронной подписи пользователей организации (ЕИО) |
GET_CLIENTS_CHANGES | Получение списка клиентов, по которым произошли изменения |
EI_FLAG_MASTER_CONNECT | Запрос на изменение признака регистрации пользователя в E-invoicing |
EI_DOC_COUNT | Уведомление об актаульном количестве документов в E-invoicing |
GET_CLIENTS_ADDED | Получение списка клиентов, подключенных в ВСП |
GET_STATEMENT_RUR_ID | Получение рублевой операции по выписке |
ORDER_MANDATORY_SALE | Распоряжение на перевод с транзитного счета |
CURRENCY_NOTICES | Уведомление о поступлении денежных средств на транзитный валютный счет |
BANK_CONTROL_STATEMENT | Ведомость банковского контроля (ВБК в банк) |
CURR_BUY | Покупка и конверсия валюты |
CURR_SELL | Продажа валюты |
EI_CLOSING_DOCUMENTS | Наличие закрывающих документов по платежному поручению |
CASH_HOLD | Сервисы холдирования денежных средств на расчетном счете клиента |
BANK_CONTROL_STATEMENT_CHANGE_APPLICATION | Заявление о внесении изменений в I раздел ВБК |
CRYPTO_CERT_REQUEST_EIO | Запрос на выпуск сертификата для ЕИО |
CLIENT_ACCRUAL | Начисление платы за пользование сервисом |
ENCASH_DOCUMENTS | Получение и передача информации по документам инкассации |
CONTRACT_CLOSE_APPLICATION | Заявление о снятии с учета контракта (кредитного договора) |
PAYMENTS_REQUEST_IN | Входящее платежное требование |
COLLECTION_ORDERS | Рублевое инкассовое поручение |
ACCEPTANCE_LETTERS | Заявление об акцепте (отказе от акцепта) |
GET_CORRESPONDENTS | Получение списка контрагентов |
WEBHOOK | Внутренний |
SELF_ENCASHER_NEW_PASSWORD | Генерация нового пароля вносителя самоинкассации |
SELF_ENCASHER_BLOCK | Блокировка вносителя самоинкассации |
SELF_ENCASHER_REQUEST | Заявление на создание нового вносителя самоинкассации |
GET_TARIFF_PLANS_LIST_ACTIVATED | Получение списка тарифных планов пользователя организации |
GET_TARIFF_PLANS_LIST_AVAILABLE | Получение списка тарифных планов, доступных партнерскому сервису |
CREDIT_REQUEST | Запрос на создание заявок на кредит |
CORRESPONDENT_CUR_ADDITIONAL | Дополнительная информация по валютному контрагенту (бенефициару) |
TARIFF_PLAN_ACTIVATION_JSON | Запрос на подключение/отключение тарифного плана организации в формате JSON |
TARIFF_PLAN_ACTIVATION_JOSE | Запрос на подключение/отключение тарифного плана организации в формате JWS |
EXTERNAL_SYSTEM_AUTH_PROFILE | Авторизационные данные пользователя во внешних системах |
GET_REQUEST_STATISTICS | Запрос на получение статистики по количеству запросов в API |
NOTIFY_MESSAGES | Запрос на отправку уведомления клиенту |
PAY_DOC_RU_INVOICE_BUDGET | Рублевое платежное поручение с бюджетными реквизитами, легкая форма |
PAYMENT_SUBSCRIPTION | Списание средств по подписке |
GET_CLIENTS_ADDED_VSP | Получение списка клиентов, подключенных в ВСП за период |
SBERRATING_VALUES | Запрос на изменение параметров услуги "Внутренние источники" |
SBERRATING_VALUES_GET | Детальная информация по СберРейтинг |
GET_CREDIT_OFFERS | Получение информации по кредитным предложениям |
Формирование параметра State
Параметр служит для защиты от CSRF-атак. Для каждого сервиса в банке указывается ссылка на страницу сервиса, на которую необходимо перенаправить пользователя из банка после успешной авторизации (redirect_uri). При поступлении на redirect_uri запроса с кодом авторизации сервис должен проверять, что обмен данными происходит в рамках инициированного им самим взаимодействия.
Значение State должно быть защищено от подбора и храниться таким образом, чтобы его не мог изменить никто, кроме сервиса. Рекомендуется использовать идентификатор сессии в сервисе или один из его производных (например, хэш этого идентификатора), при этом может использоваться любой другой механизм генерации случайного значения достаточной длины для предотвращения подбора. В общем случае оптимально использовать строку длиной не менее 36 символов с проверкой регистра.
Формирование параметра Nonce
Параметр служит для защиты от replay-атак, то есть для предотвращения обработки одного и того же запроса несколько раз. Значение Nonce должно быть защищено от подбора и храниться таким образом, чтобы его не мог изменить никто, кроме сервиса. Рекомендуется использовать случайное значение, сохраняемое в сессии пользователя в сервисе. Для повторного запроса это значение должно заменяться новым. В общем случае оптимально использовать строку длиной не менее 10 символов с проверкой регистра.
Оферта
Для взаимодействия с сервисами пользователю необходимо подписать оферту, в которой указано к каким данным и на какой срок предоставлен доступ сервису. При подписании Оферты, пользователь в явном виде указывает доступность счетов.
После получения банком запросов со стороны сервиса, касающихся пользовательских данных, выполняется проверка наличия между сервисом и пользователь активной оферты, а при её отсутствии или истечения срока действия сервису возвращается сообщение об ошибке доступа к данным пользователя. Для возобновления работы с данными пользователя необходимо переадресовать пользователя на форму авторизации с запросом /authorize.
Формирование хоста для отправки запроса Authorization Code
В зависимости от типа пользователя алгоритм формирования хоста для запросов авторизации должен быть различным:
- Если SMS-пользователь, то значение хоста будет, например, https://edupir.testsbi.sberbank.ru:9443/ic/sso/api/v2/oauth/authorize?{параметры}
- Если Token-пользователь, то значение хоста будет, например, http://localhost:28016/ic/sso/api/v2/oauth/authorize?{параметры} , где 28016 — значение параметра callbackPort, переданного при первом переходе пользователя из банка на сервис.
Указанные выше значения хостов приведены для примера. Реальные значения сообщаются по не автоматизируемым каналам.
Ресурс /v2/oauth/token
После получения кода авторизации и проверки корректности успешного ответа необходимо запросить авторизационный токен к данным пользователя Access Token, который возвращается вместе с ID Token, содержащим пользовательские идентификационные данные, и ключом Refresh Token.
Шаги
- Получить код авторизации
- Отправить запрос
- Декодировать ID Token
- Актуализация авторизационного токена
Обмен кода авторизации на Access Token происходит через меж серверные каналы (REST-сервис), поэтому значение хоста не зависит от типа пользователя (userType). В случае возникновения ошибки при попытке получить AccessToken по коду авторизации по каким-либо причинам (например, неправильно передан client_secret) код авторизации удаляется и все дальнейшие попытки получить по нему AccessToken (даже с корректными параметрами) будут приводить к ошибке с текстом "Unknown code = <код_авторизации>". Запрос должен производиться только методом POST с типом данных application/x-www-form-urlencoded.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/ic/sso/api/v2/oauth/token?grant_type=string&client_id=string \
-H 'Accept: application/jose'
POST /v2/oauth/token
При отправке запроса необходимо экранировать специальные символы, если сформированная ссылка открывается напрямую в браузере, экранирования не требуется.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
grant_type | query | string | true | Значение должно быть "authorization_code" (обязательный параметр) |
code | query | string | false | Значение кода авторизации (обязательный параметр) |
client_id | query | string | true | Банковский идентификатор сервиса полученный от менеджера при регистрации приложения (обязательный параметр) |
redirect_uri | query | string | false | Ссылка на страницу сервиса, на которую необходимо перенаправить пользователя после успешной авторизации (обязательный параметр) |
refresh_token | query | string | false | Токен обмена |
client_secret | query | string | false | Авторизационный ключ сервиса (обязательный параметр). Генерируется банком в момент заведения сервиса и передается оффлайн. После получения требуется, в обязательном порядке, сменить client_secret методом /v1/change-client-secret или в Личном кабинете SberBusinessAPI (Fintech API). В дальнейшем, требуется менять client_secret до истечения срока жизни, составляющий 40 дней. |
code_verifier | query | string | false | Код проверки, на основе которого получили код вызова (code_challenge) путем применения метода преобразования code_challenge_method (необязательный параметр) |
Example responses
200 Response
{
"access_token": "93b1afbd-a9ce-446e-88ce-14f652320001-1",
"expires_in": 3600,
"id_token": "eyJhbGciOiJub0.ICAgImlzcyI6Mjg5NzYxMDAxIiwNCiAgICJhdWQiO.",
"refresh_token": "771e239f-e30d-404f-825a-004314b56011-1",
"scope": "openid exampleservice exampleclaim",
"token_type": "Bearer"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | ОК | SSOTokenResponseSuccess |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
В случае обнаружения ошибок client_id и redirect_uri банк сформирует ответ HTTP 400 с ошибкой invalid_grant и описанием:
- Redirect uri https://example.ru is invalid - неверный redirect_uri
- Invalid client secret for authz code 'хххххххх-хххх-хххх-хххх-хххххххххххх-х'
В случае если банк вернёт ответ с ошибкой авторизации, сервис должен корректно его обработать. Так как первый шаг взаимодействия (аутентификация) осуществляется через браузер пользователя, банк вернёт HTTP ответ 302 Found. Это необходимо для того, чтобы сервис имел возможность обработать ошибку и отобразить пользователю необходимую ему страницу, например, страницу авторизации (рекомендовано).
При получении ответа сервис должен проверить его корректность в соответствии со спецификацией. Рекомендации по проверке ответа на запрос Access Token описаны в спецификациях:
- https://tools.ietf.org/html/rfc6749#section-5
- http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
- http://openid.net/specs/openid-connect-core-1_0.html#CodeFlowTokenValidation
Декодирование ID Token
При необходимости декодировать ID Token следует воспользоваться алгоритмом Base64URL Encoding.
Пример ответа Id Token
eyJhbGciOiJnb3N0MzQtMTAuMjAxMiJ9.eyJzdWIiOiJhMWNhOGYyMTQ4MDc1M2IyMzI1MTZiYzk4NmNiZmM4Yjc5MjNiYWI3ODczODQzZWM0ZjQ1MTA4MmI0YTg3NjFjIiwiaXNzIjoiaHR0cDovL3NidC1vYWZzLTYzODo5MDgwL2ljZGsiLCJhdWQiOiIyMDg1IiwiZXhwIjoxNTE4Njg2MDI1LCJpYXQiOjE1MTg2ODU3MjUsImF1dGhfdGltZSI6MTUxODY4NTM4NSwiYWNyIjoibG9hLT
MiLCJhbXIiOiJ7cHdkLCBtY2EsIG1mYSwgb3RwLCBzbXN9IiwiYXpwIjoiMjA4NSIsIm5vbmNlIjoiOTc2MjgwY2ZmZTg5In0=.AGnvv73vv73vv71iFGM977+9We+/vUvvv73vv704Re+/ve+/vWnvv73vv71y77+9dQh+77+9GR1377+9Ml8T77+9ae+/vTbvv73Gle+/vU1t77+977+977+977+97LKk77+9XyQRPFEl77+977+9
Пример декодированного ответа
{
"typ": "JWT",
"alg": "gost34.10-2012"
}
{
"sub": "a1ca8f21480753b232516bc986cbfc8b7923bab7873843ec4f451082b4a8761c",
"iss": "https://edupirfintech.sberbank.ru:9443",
"aud": "2085",
"exp": 1518686025,
"iat": 1518685725,
"auth_time": 1518685385,
"acr": "loa-3",
"amr": "{pwd, mca, mfa, otp, sms}",
"azp": "2085",
"nonce": "976280cffe89"
}
AGnvv73vv73vv71iFGM977+9We+/vUvvv73vv704Re+/ve+/vWnvv73vv71y77+9dQh+77+9
GR1377+9Ml8T77+9ae+/vTbvv73Gle+/vU1t77+977+
977+977+97LKk77+9XyQRPFEl77+977+9
Согласно спецификации JSON Web Token (JWT) ID Token должен быть представлен структурой вида:
- Алгоритм подписи (по сертификату технологического криптопрофиля Банка, который можно получить запросом /crypto), Header(Заголовок);
- ID_token, Payload (Полезная нагрузка);
- Электронная подпись
Каждая часть ответа, разделённая точкой, должна декодироваться отдельно. Для проверки подписи в поле id_token на стороне пользователя, необходимо вычислить подпись публичным ключом Банка, декодировав блок Payload по Base64URL (содержимое между двумя точками). Далее необходимо сравнить полученное значение c блоком Электронная подпись (содержимое после второй точки), декодированным по Base64URL.
Если банку не удаётся предоставить какие-то данные, такой атрибут отсутствует в ответе (не должно быть атрибутов со значением NULL).
Параметр | Описание |
---|---|
sid2 | Идентификатор сессии токена |
sub | Хэш идентификатора пользователя |
iss | URL Интернет-банк СберБизнес |
aud | Идентификатор внешнего сервиса |
nonce | Значение параметра nonce из запроса кода авторизации |
exp | Время, после которого ID Token не принимается для обработки. Формат поля Unix time |
iat | Время формирования ID Token. Формат поля Unix time |
auth_time | Время банковской аутентификации пользователя. Формат поля Unix time |
acr | Уровень аутентификации пользователя: - acr=loa-2 (пользователь аутентифицируется с помощью устройства защиты) - acr=loa-3 (пользователь использует подтверждение по одноразовому SMS-паролю для аутентификации) |
amr | Методы аутентификации: - amr=pwd (пользователь аутентифицируется с помощью устройства защиты) - amr={pwd, mca, mfa, otp, sms} (пользователь использует подтверждение по одноразовому SMS-паролю для аутентификации) |
azp | Идентификатор сервиса (рекомендуется проверить идентификатор сервиса, для которого был сформирован полученный ID Token) |
HashOrgId | Хэш от идентификатора организации, с которой связан пользователь |
Проверка подписи Банка
Согласно стандарту OpenID Connect проверка электронной подписи, полученной в ID Token (содержимое ответа ID Tokena после второй точки), выполняется, используя алгоритм, указанный в параметре заголовка JWT alg . Партнёру необходимо проверить подпись сертификатом Банка.
Актуализация авторизационного токена
Ключ Refresh Token предназначен для получения нового Access Token и Refresh Token в случае компрометации или истечения времени жизни Access Token.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/ic/sso/api/v2/oauth/token?grant_type=string&client_id=string \
-H 'Accept: application/jose'
POST /v2/oauth/token
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
grant_type | query | string | true | Значение должно быть "refresh_token" (обязательный параметр) |
client_id | query | string | true | Банковский идентификатор сервиса полученный от менеджера при регистрации приложения (обязательный параметр ) |
client_secret | query | string | false | Авторизационный ключ сервиса (обязательный параметр). Генерируется банком в момент заведения сервиса и передается оффлайн. После получения требуется, в обязательном порядке, сменить client_secret методом /v1/change-client-secret или в Личном кабинете SberBusinessAPI (Fintech API). В дальнейшем, требуется менять client_secret до истечения срока жизни, составляющего 40 дней. |
refresh_token | query | string | false | Токен обмена |
scope | query | string | false | Должен содержать обязательный параметр "openid" и через пробел перечисляются scope-ы доступных claim и сервисов, полученных от менеджера партнёра при регистрации приложения (обязательный параметр при обращении к ресурсу) |
Example responses
200 Response
{
"access_token": "6e55338d-7a7a-4b66-bc78-248d52eeb1dc-1",
"expires_in": 3600,
"refresh_token": "668c708e-865a-42b1-8fe9-846b92b8b14e-1",
"scope": "openid exampleservice exampleclaim",
"token_type": "Bearer"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | ОК | SSOTokenResponseSuccess |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
Рекомендуется обновлять ключи доступа (Access Token/Refresh Token) как минимум один раз за время жизни Refresh Token. В случае если Refresh Token потеряет актуальность (не будет обновлён до истечения времени жизни), сервис сможет получить актуальные ключи доступа только после повторной авторизации пользователя в сервисе через Интернет-банк СберБизнес.
Если при обновлении ключей доступа по Refresh Token не был получен ответ из банка, то рекомендуется повторно отправить запрос на актуализацию ключей в течение 1 часа от момента отправки первой попытки, используя тот же Refresh Token. Успешное формирование ответа на стороне банка с новой парой ключей (Access Token/Refresh Token) переводит использованный раннее Refresh Token в статус резервного. Срок жизни резервного Refresh Token составляет 2 часа с момента выпуска новой пары ключей (Access Token/Refresh Token). Для последующих обновлений ключей доступа необходимо использовать Refresh Token из новой пары ключей (Access Token/Refresh Token).
Ресурс /v1/oauth/user-info
Ресурс позволяет получать данные о подключенном сервисе (если пользователь "разрешил" сервису доступ к своим данным), которые могут включать в себя информацию об организации пользователя, например:
- идентификатор организации пользователя (hashOrgId)
Каждому сервису при регистрации подключают, одинаковый для всех сервисов, обязательный системный scope, который включает в себя только идентификатор пользователя. Помимо этого для каждого сервиса подключается дополнительный уникальный scope. Перечень данных дополнительного scope определяется индивидуально менеджером.
Шаги
- Получить код авторизации
- Получить токен авторизации
- Отправить запрос
Запрос User Info должен производиться методом GET с использованием заголовка Authorization и передаваемых в нём значения Bearer (всегда должно соответствовать ответу в параметре token_type=) и значения из access_token. При запросе сервисом информации о пользователе своей организации не заполняется claim "accounts".
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/ic/sso/api/v1/oauth/user-info \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/oauth/user-info
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | false | Authorization |
Example responses
200 Response
Пример ответа
w0Y8g0L_QvtC00L_QuNGB0YwiLCJzdW1tT2ZmZXJTbWFydENyZWRpdCI6MCwib3JnQWN0dWFsQWRkcmVzcyI6ItCg0J7QodCh0JjQmdCh0JrQkNCvINCk0JXQlNCV0KDQkNCm0JjQrywgMTIxMzUxLCDQsy7QnNC-0YHQutCy0LAsINGD0LsuINCa0L7RhtGO0LHQuNC90YHQutC0LPQviwg0LTQvtC8IDQsINGB0YLRgC4gMywg0L7RhC4gMTLQpiIsIkhhc2hPcmdJZCI6ImIzNGI2YTQ1MzM4NjJlNTE2N2U5ODc4NWIxZDIzYWE3ODlkYWMyMTYwYjNjN2M5Y2MzOTIyMWJkMzNmZmM4NWEiLCJpc0lkZW50aWZpZWQiOnRydWUsIm9yZ1BwcmJJZCI6MTE5MzkwMzUwMjcyNTI2MTcxMSwidXNlclBvc2l0aW9uIjoi0JHRg9GF0LPQsNC70YLQtdGAIiwiZW1haWwiOiJtZWRpYSsrQHNidC5ydSIsIm9yZ0d1aWQiOiIxMTFjOWMxMy02NGRhLTQ3OTAtOWM5Mi00YjA1NDk5YjZjNGIiLCJpbm4iOiI3NzMzODEyOTIwIiwib3JnSnVyaWRpY2FsQWRkcmVzcyI6ItCg0J7QodCh0JjQmdCh0JrQkNCvINCk0JXQlNCV0KDQkNCm0JjQrywgMTI1MzY3LCDQsy7QnNC-0YHQutCy0LAsINC_0YDQvtC10LfQtC4g0JLRgNCw0YfQtdCx0L3Ri9C5LCDQtNC-0LwgMTAsINC-0YQuIDEiLCJhY3RpdmUiOjEsIm9yZ0Z1bGxOYW1lIjoi0J7QsdGJ0LXRgdGC0LLQviDRgSDQvtCz0YDQsNC90LjRh9C10L3QvdC-0Lkg0L7RgtCy0LXRgtGB0YLQstC10L3QvdC-0YHRgtG
M0Y4gXCLQnNC10LQg0K3QutGB0L_RgNC10YHRgVwiIiwidGJJZGVudENvZGUiOiIzOCIsInVzZXJHdWlkIjoiOTQ3M2YyMzUtMDljOS00ZmNhLTgxYWUtYzAyZTkyYjNiNWRiIiwidXNlcklkIjo3NjgwNTgsInRlckJhbmsiOiLQnNC-0YHQutC0LLRgdC60LjQuSDQkdCw0L3QuiDQodCx0LXRgNCx0LDQvdC60LAg0KDQpCIsImF1ZCI6Ijc0NjQzIiwidXNlclJvbGVzIjpbImJhbmtDbGllbnQiXSwib3JnQnVzaW5lc3NTZWdtZW50IjoiMDMiLCJ1c2VyQ3J5cHRvVHlwZSI6IlNNUyIsInVzZXJHcm91cHMiOiLQoNGD0LrQvtCy0L7QtNC40YLQtdC70YwiLCJvcmdPa3BvIjoiMTE0MzkyMDciLCJzYmJvbDMiOnRydWUsIm9yZ09ncm4iOiIxMTI3NzQ2NjU5MDQwIiwib2ZmZXJTbWFydENyZWRpdCI6ZmFsc2UsIm5hbWUiOiLQn9Cw0YDRgtC90LXRgCDQn9Cw0YDRgtC90LXRgCDQn9Cw0YDRgtC90LXRgCIsImlucXVpcnlPcmRlciI6dHJ1ZX0.cIDbvnQrmmx1eVCku7OmyL6aUfEHZ0pD7FhNLU1FvAA0Yu454vDHtfgJSAkSxJiOgceUr2VGg40u8dw4sYk2A
Пример декодированного ответа
{
"sub": "7f5e5e42cc66973f31fe8f65bfc4460a808fc197d955582989a01282fac14c9c",
"orgOktmo": "45000000000",
"orgKpp": "773301001",
"iss": "http://edupirfintech.sberbank.ru:9443",
"OrgName": "ООО \"Мед Экспресс\"",
"orgId": 1123234,
"individualExecutiveAgency": 1,
"userSignatureType": "Единственная подпись",
"summOfferSmartCredit": 0,
"orgActualAddress": "РОССИЙСКАЯ ФЕДЕРАЦИЯ, 121351, г.Москва, ул. Коцюбинского, дом 4, стр. 3, оф. 12Ц",
"HashOrgId": "b34b6a4533862e5167e98785b1d23aa789dac2160b3c7c9cc39221bd33ffc85a",
"isIdentified": true,
"orgPprbId": 1193903502725261800,
"userPosition": "Бухгалтер",
"email": "media++@sbt.ru",
"orgGuid": "111c9c13-64da-4790-9c92-4b05499b6c4b",
"inn": "7733812920",
"orgJuridicalAddress": "РОССИЙСКАЯ ФЕДЕРАЦИЯ, 125367, г.Москва, проезд. Врачебный, дом 10, оф. 1",
"active": 1,
"orgFullName": "Общество с ограниченной ответственностью \"Мед Экспресс\"",
"tbIdentCode": "38",
"userGuid": "9473f235-09c9-4fca-81ae-c02e92b3b5db",
"userId": 768058,
"terBank": "Московский Банк Сбербанка РФ",
"aud": "74643",
"userRoles": [
"bankClient"
],
"orgBusinessSegment": "03",
"userCryptoType": "SMS",
"userGroups": "Руководитель",
"orgOkpo": "11439207",
"sbbol3": true,
"orgOgrn": "1127746659040",
"offerSmartCredit": false,
"name": "Партнер Партнер Партнер",
"inquiryOrder": true
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | string |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
Каждая часть ответа, разделённая точкой, должна декодироваться отдельно.
Согласно спецификации JSON Web Token (JWT) User Info должен быть представлен структурой вида:
- Алгоритм подписи (Определяется по сертификату технологического криптопрофиля Банка, который можно получить запросом /crypto), Header (Заголовок);
- User-info, Payload (Полезная нагрузка);
- Электронная подпись;
При получении ответа сервис должен его декодировать и опционально проверить электронную подпись ответа. Система отправит ответ HTTP 200 OK с типом данных jwt.
User-info необходимо декодировать c помощью алгоритма base64url Encoding (по спецификации JWT). Преобразование BASE64URL, отличается от BASE64. Условно алгоритм можно представить следующим образом: Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’). Здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
В user-info включаются обязательные системные и дополнительные атрибуты пользователя для сервиса. Обязательные системные атрибуты: sub, iss, aud. Если банку не удаётся предоставить какие-то данные, такой атрибут отсутствует в ответе (не должно быть атрибутов со значением NULL). Проверка электронной подписи (3-я часть ответа) является опциональной и может выполняться сервисом при необходимости проверки неизменности данных user-info.
- Список доступных параметров User-info
Ресурс /v1/change-client-secret
Client_secret можно сменить в Личном кабинете SberBusinessAPI. Срок жизни составляет 40 дней.
Начальное значение client_secret генерируется Банком и передаётся вместе со значением client_id при первичной регистрации. После получения требуется сменить client_secret.
Шаги
- Получить AccessToken
- Отправить запрос
Для смены client_secret необходимо отправить POST-запрос (/v1/change-client-secret), в заголовке которого передать авторизационный токен к собственным данным (Access Token), старое значение client_secret.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/ic/sso/api/v1/change-client-secret?access_token=string&client_secret=string&new_client_secret=string \
-H 'Accept: */*'
POST /v1/change-client-secret
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
access_token | query | string | true | Действующее значение access token |
client_secret | query | string | true | Действующее значение client secret |
new_client_secret | query | string | true | Новое значение client secret |
client_id | query | string | false | Идентификатор сервиса |
Example responses
200 Response
{
"clientSecretExpiration":40
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Успешно | Inline |
400 | Bad Request | Ошибка запроса | None |
401 | Unauthorized | Ошибка авторизации | None |
403 | Forbidden | Ошибка доступа | None |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
503 | Service Unavailable | Сервис временно недоступен | None |
Дополнительная информация
Параметр | Описание |
---|---|
sid2 | Идентификатор сессии токена |
sub | Хэш идентификатора пользователя |
iss | URL Интернет-банк СберБизнес |
aud | Идентификатор внешнего сервиса |
name | Фамилия Имя Отчество |
inn | ИНН организации |
Адрес электронной почты | |
phone_number | Номер телефона |
HashOrgId | Хэш от идентификатора организации (orgId) |
orgId | Идентификатор организации в Интернет-банк СберБизнес |
orgKpp | КПП |
orgFullName | Название компании |
OrgName | Наименование организации |
orgOgrn | ОГРН компании |
orgOkpo | ОКПО организации |
orgOktmo | Общероссийский классификатор территорий муниципальных образований |
orgActualAddress | Фактический адрес компании |
orgJuridicalAddress | Юридический адрес компании |
accounts | Счет, БИК, Кор. счет компании. Примечание: не заполняется при запросе Партнёром информации о пользователе своей организации. |
terBank | Полное наименование подразделения кредитной организации |
offerExpirationDate | Дата окончания оферты |
userPosition | Должность |
userRoles | Список роли пользователя |
userSignatureType | Тип подписи |
userGuid | Идентификатор пользователя клиента, который обратился к сервису |
userId | Внутренний идентификатор пользователя |
userGroups | Группы пользователя |
sbbol3 | Признак использования клиентом нового дизайна Интернет-банк СберБизнес 3.0 |
userCryptoType | Тип криптопрофиля |
tbIdentCode | Код территориального банка |
individualExecutiveAgency | Признак Единоличный Исполнительный Орган |
inquiryOrder | Признак доступности у пользователя функциональности получения справок |
isIdentified | Признак идентификации пользователя |
offerSmartCredit | Предодобренные предложения по смарт кредитам |
summOfferSmartCredit | Сумма предодобренного предложения по смарт-кредитам |
resident | Признак является организация резидент/нерезидент |
orgBusinessSegment | Бизнес сегмент. Возможные значения: 02-Микро бизнес (микро), 03-Малый бизнес, 04-Средний бизнес, 05-Крупный бизнес, 06-Крупнейший бизнес, 07-Клиенты машиностроения (ОПК), 08-Рег. госсектор, 09-БМО, 10-Фин. институты, 999-Не найдено сегмента в CRM Корпоративном. |
buyOnCreditMmb | Признак возможности покупки в кредит на сайте партнера |
orgLawFormShort | Организационно-правовая форма (принятое сокращение) |
2.1.2 Опциональные ресурсы
Ресурс /v1/oauth/revoke
Ресурс позволяет отозвать авторизационный токен в случае его компрометации.
Для отзыва оферты необходимо отправить POST-запрос (/v1/oauth/revoke).
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/ic/sso/api/v1/oauth/revoke?client_id=string&client_secret=string&token=string \
-H 'Accept: */*'
POST /v1/oauth/revoke
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
client_id | query | string | true | Идентификатор сервиса |
client_secret | query | string | true | Старое значение ClientSecret (client_secret >= 8 символов и <= 256 символов |
token | query | string | true | Токен, который необходимо отозвать |
token_type_hint | query | string | false | Подсказка о типе отзываемого токена |
Example responses
500 Response
{
"ex": "string",
"url": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Успешно | None |
400 | Bad Request | Ошибка запроса | None |
500 | Internal Server Error | Внутренняя ошибка сервера | Error |
503 | Service Unavailable | Сервис временно недоступен | None |
2.2 Информация об организации
GET /v1/client-info - Получение данных об организации и счетах пользователя
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/client-info
Ресурс позволяет получить расширенную информацию об организации пользователя и её счетах (если пользователь дал согласие на доступ к своим данным см. 2.1 Сервис авторизации-Сбер Бизнес ID), которая может включить в себя следующие данные:
- сокращённое наименование организации;
- полное наименование организации пользователя;
- счета организации пользователя, доступные сервису для запроса выписок и создания платёжных документов;
- признак резидента;
- ОГРН;
- ИНН;
- ОКПО;
- ОКАТО;
- полный адрес организации.
Сокращённую информацию о пользователе можно получить через запрос пользовательских данных (ресурс /v1/oauth/user-info в разделе 2.1 Сервис авторизации-Сбер Бизнес ID.Информация по счетам пользователя передаётся только в том в случае, когда при подписании оферты пользователь в явном виде указал номера счетов, по которым разрешает передачу информации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информации необходимо отправить GET-запрос (/v1/client-info), в котором передать авторизационный токен к данным пользователя (accessToken).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_CLIENT_ACCOUNTS.
В примере указаны валидные данные, которые можно получить на тестовом стенде. Для этого необходимо использовать ключ доступа Access token 8190f687-c916-453b-9d68-0ce22f4f3f9d-1.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/client-info \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/client-info
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
Example responses
200 Response
{
"accounts": [
{
"bic": "string",
"blockedQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSumQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSums": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"business": false,
"businessNewType": false,
"cdiAcptDocQnt": 0,
"cdiAcptDocSum": 0,
"cdiCart2DocQnt": 0,
"cdiCart2DocSum": 0,
"cdiPermDocQnt": 0,
"cdiPermDocSum": 0,
"closeDate": "2019-08-24T14:15:22Z",
"comment": "string",
"creditBlocked": false,
"creditBlockedBeginDate": "2019-08-24T14:15:22Z",
"creditBlockedCause": "string",
"creditBlockedEndDate": "2019-08-24T14:15:22Z",
"creditBlockedInitiator": "string",
"creditBlockedTaxAuthorityCode": "string",
"currencyCode": "string",
"dbo": false,
"debitBlocked": false,
"debitBlockedBeginDate": "2019-08-24T14:15:22Z",
"debitBlockedCause": "string",
"debitBlockedEndDate": "2019-08-24T14:15:22Z",
"debitBlockedInitiator": "string",
"debitBlockedTaxAuthorityCode": "string",
"minBalance": 0,
"mode": "STANDART",
"name": "string",
"notDelay": false,
"number": "string",
"openDate": "2019-08-24T14:15:22Z",
"overdraft": 0,
"passive": false,
"state": "OPEN",
"type": "assuranceRegistration",
"urgent": false
}
],
"addresses": [
{
"area": "string",
"building": "string",
"city": "string",
"comment": "string",
"country": "string",
"flat": "string",
"fullAddress": "string",
"house": "string",
"region": "string",
"settlement": "string",
"settlementType": "string",
"street": "string",
"type": "string",
"zip": "string"
}
],
"branch": {
"address": "г.Москва, Кутузовский проспект, 34",
"code": "138592",
"name": "Доп офис 1654"
},
"cardNum": "string",
"dboContracts": [
{
"date": "2018-12-31",
"financeBlock": true,
"number": "14/2/000001"
}
],
"fullName": "string",
"inn": "string",
"kpps": [
"string"
],
"offerSmartCredit": false,
"ogrn": "string",
"okato": "string",
"okpo": "string",
"orgBusinessSegment": "string",
"orgBusinessSegmentName": "string",
"orgCrmId": "string",
"orgForm": "string",
"orgGuid": "string",
"orgId": 0,
"orgIndustryInfo": {
"code": 0,
"name": "string"
},
"orgKindActivityInfo": {
"code": 0,
"name": "string"
},
"orgPprbId": 0,
"orgRegDateINN": "string",
"orgRegDateOGRN": "string",
"resident": false,
"shortName": "string",
"summOfferSmartCredit": 0,
"territorialBank": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ClientInfo |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
2.3 Платежное поручение
POST /v1/payments - Платежное поручение по свободным реквизитам
GET /v1/payments/{externalId}/state - Получение статуса документа
GET /v1/payments/{externalId} - Получение платежного поручения
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/payments
Ресурс позволяет партнёру создавать дебетовые платёжные поручения по собственным счетам.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания рублёвого платёжного поручения необходимо отправить POST-запрос (/v1/payments), в котором передать авторизационный токен к данным собственной организации (Access Token) и реквизиты одного платёжного поручения. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_RU.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/payments
Body parameter
{
"amount": 1.01,
"crucialFieldsHash": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "2",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | Payment | true | Платёжное поручение |
Example responses
201 Response
{
"amount": 1.01,
"crucialFieldsHash": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "2",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | Payment |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
- Если требуется проверить неизменность реквизитов получателя платежа, до получения выписки с информацией о проведенном документе, необходимо сравнить хэш реквизитов получателя(crucialFieldsHash), полученные при создании черновика документа, с crucialFieldsHash полученным при запросе статуса документа. Для вычисления значения хэша ключевых полей формируется строка из реквизитов, соединённых между собой: БИК банка получателя, счёт получателя платежа, сумма платежа, (разделитель-точка).
- Для корректной работы необходимо передавать параметры в следующем сочетании.
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля, когда пользователь Партнёра создается в Банке.
Формирование электронной подписи (ГОСТ 2012)
Ресурс /v1/payments/{externalId}/state
Ресурс позволяет получить статус платежного поручение.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/payments/{externalId}/state), в котором передать авторизационный токен к данным собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_RU.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payments/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID платежного поручения |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string",
"crucialFieldsHash": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PaymentDocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/payments/{externalId}
Ресурс позволяет получить атрибуты ранее отправленного рублевого платежного поручения.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения платежного документа необходимо отправить GET-запрос (/v1/payments/{externalId}), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор платежного поручения. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_RU.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payments/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID платёжного поручения |
Example responses
200 Response
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"crucialFieldsHash": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "2",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Payment |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Для корректной работы необходимо передавать параметры в следующем сочетании :
- Если блок vat не указан, то по умолчанию будут присвоены и придут в ответе на запрос следующие значения :
"vat": {
"type": "NO_VAT",
"rate": "0",
"amount": "0.00"
}
В поле "Назначение платежа" необходимо обязательно отправлять "НДС не облагается". - При выбранном "type":"INCLUDED" (НДС включен в сумму платежа) атрибут "amount" указывать не нужно.
Если же атрибут "amount" указывается в запросе, то должен иметь значение 0 во избежание ошибок. Атрибут "rate" должен принимать только значения 10, 20.
В поле "Назначение платежа" необходимо обязательно указать посчитанное значение суммы с учетом НДС.
Пример ПРАВИЛЬНОГО заполнения:
НДС10%_-_100.63 рублей (" _ " - нижнее подчеркивание является признаком пробела, символ проставлять не нужно).
Если процентное значение не указано, то дефис перед суммой указывать не нужно: НДС_100.63 рублей. - При выбранном "type":"MANUAL" (Ручной ввод НДС) атрибут "amount" указывать не обязательно, но в этом случае по умолчанию сумма НДС примет значение 0 рублей. Если же атрибут "amount" указывается в запросе,
то в нем нужно указать желаемое значение НДС, соответствующее формату.
Если процентное значение не указано, то дефис перед суммой указывать не нужно: НДС_100.63 рублей.
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары клиента (используется приватный ключ парный сертификату клиента с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.4 Криптографические ресурсы
GET /v1/crypto-Получение криптографической информации
POST /v1/crypto/cert-requests-Создание запроса на новый сертификат
GET /v1/crypto/cert-requests/{externalId}/state-Получение статуса
POST /v1/crypto/cert-requests/{externalId}/activate-Активация сертификата
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурсы предназначены для получения информации и выпуска сертификатов для token-пользователей. Для перехода на token-криптопрофиль необходимо заполнить корректирующее заявление и обратиться в отделение.
Ресурс /v1/crypto
Ресурс позволяет получить информацию по крипто-профилю и сертификатам пользователя, сертификатам удостоверяющих центров, и сертификату технологического криптопрофиля банка. Полученную информацию возможно использовать в криптографических операциях (в операциях с сертификатами и операциях с электронной подписью).
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информации необходимо отправить GET-запрос (/v1/crypto), в котором необходимо передать авторизационный токен (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_CRYPTO_INFO.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/crypto \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/crypto
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
Example responses
200 Response
{
"certBank": "string",
"certBankUuid": "string",
"certCenterCode": "А000",
"certCenterNum": "02",
"certsCA": [
"string"
],
"cryptoProfileInfos": [
{
"alias": "Profile alias",
"certificateInfos": [
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"typeName": "Инфокрипт"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CryptoInfo |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/crypto/cert-requests
Ресурс позволяет создавать запросы на выпуск нового сертификата.
Для этого необходимо:
Выполнить OAuth-авторизацию, в результате которой получить авторизационный токен.
Обратиться к ресурсу /v1/crypto и получить код удостоверяющего центра (КУЦ) - certCenterCode.
На основании полученного КУЦ необходимо сгенерировать уникальный тег bicryptId, состоящий из: КУЦ +порядковый номер выпущенного организацией сертификат(нумерация 00..ZZ)+символ «s». Параметр bicryptId должен содержать не менее 9-ти символов, при необходимости дополнить слева нулями порядковый номер сертификата, после чего добавляется фамилия и инициалы владельца сертификата.
Шаги
- Получить AccessToken
- Отправить запрос
- Получить статус
- Активировать сертификат
Для создания документа на выпуск нового сертификата ЭП необходимо отправить POST-запрос (/v1/crypto/cert-requests), в котором передать авторизационный токен (Access Token) и данные по выпускаемому сертификату. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CERTIFICATE_REQUEST.
В примере параметр cms заполнен для СКЗИ-Инфокрипт VPN-KEY-TLS. Для альтернативной СКЗИ необходимо заполнять следующим образом: "cms": "----- BEGIN CERTIFICATE REQUEST -----\n ... MIIIj ... \n----- END CERTIFICATE REQUEST -----".
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/crypto/cert-requests \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/crypto/cert-requests
Body parameter
{
"bankComment": "string",
"bankStatus": "string",
"email": "address@email.ru",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Организация\"",
"pkcs10": {
"bicryptId": "A001NVA3",
"cms": "-----BEGIN CMS-----\n ... MIIIj ... \n-----END CMS-----"
},
"userName": "Иванов Иван Иванович",
"userPosition": "Операционист"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | CertRequest | true | Запрос на новый сертификат |
Example responses
201 Response
{
"bankComment": "string",
"bankStatus": "string",
"email": "address@email.ru",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Организация\"",
"pkcs10": {
"bicryptId": "A001NVA3",
"cms": "-----BEGIN CMS-----\n ... MIIIj ... \n-----END CMS-----"
},
"userName": "Иванов Иван Иванович",
"userPosition": "Операционист"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | CertRequest |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/crypto/cert-requests/{externalId}/state
Ресурс позволяет получить информацию по статусу запроса на новый сертификат. Полученную информацию возможно использовать для контроля и анализа статуса запроса на новый сертификат.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информации по статусу необходимо отправить GET-запрос (/v1/crypto/cert-requests/{externalId}/state), в котором необходимо передать авторизационный токен (Access Token) и идентификатор запроса на новый сертификат (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CERTIFICATE_REQUEST.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/crypto/cert-requests/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/crypto/cert-requests/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID запроса на новый сертификат |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/crypto/cert-requests/{externalId}/activate
Ресурс позволяет создавать запросы на активацию выпущенного сертификата, для дальнейшей возможности подписывать документы и запросы.
Шаги
- Получить AccessToken
- Отправить запрос
Для активации сертификата ЭП необходимо отправить POST-запрос (/v1/crypto/cert-requests/{externalId}/activate), в котором передать авторизационный токен к данным пользователя (Access Token) и идентификатор документа externalId из запроса cert-requests. авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CERTIFICATE_REQUEST.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/crypto/cert-requests/{externalId}/activate \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/crypto/cert-requests/{externalId}/activate
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID запроса на новый сертификат |
Example responses
400 Response
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | None |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
2.5 Получение операций по счету
GET /v1/statement/transactions - Получение выписки
GET /v1/statement/transactions/{id} - Получение выписки по операции
GET /v1/statement/summary - Суммарная информация об остатках и оборотах за период
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Максимальное количество операций, возвращаемых на одной странице выписки, равно 100. Запросы выписки подсчитываются исходя из количества опрашиваемых счетов и количества заданных обновлений выписки.
Ресурс /v1/statement/transactions
Сервис позволяет получить выписку по счёту собственной/дочерней организации за выбранную дату.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения выписки по счету пользователя необходимо отправить GET-запрос (/v1/statement/transactions), в котором передать авторизационный токен к данным собственной/дочерней организации (Access Token), номер счёта (accountNumber), дату выписки (Date) и номер запрашиваемой страницы (Page=1). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/transactions?accountNumber=string&statementDate=2019-08-24T14%3A15%3A22Z&page=1 \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/statement/transactions
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
accountNumber | query | string | true | Номер счета (^[0-9]{20}$) |
statementDate | query | string(date-time) | true | Дата выписки (yyyy-MM-dd) |
page | query | integer(int32) | true | Номер страницы (начиная с 1) |
curFormat | query | string | false | Формат операции по валютному счету |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"transactions": [
{
"amount": {
"amount": 1.01,
"currencyName": "USD"
},
"amountRub": {
"amount": 1.01,
"currencyName": "USD"
},
"correspondingAccount": "30101810400000000225",
"curTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"direction": "CREDIT",
"documentDate": "2018-12-31",
"filial": "ОСБ 3",
"number": "4",
"operationCode": "01",
"operationDate": "2018-12-31T23:59:59",
"paymentPurpose": "Оплата заказа №123. НДС нет.",
"priority": "5",
"revaln": "ПК",
"rurTransfer": {
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
},
"swiftTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"transactionId": 11111,
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | StatementTransactions |
202 | Accepted | Запрос принят | Notice |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Запрошенная выписка недоступна | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Примечание: Выписка может приходить как по рублевым, так и по валютным счетам. Для рублёвого счёта не заполняется параметр curFormat, данные передаются в обычном формате. Параметр curFormat влияет на формат данных для валютных счетов и принимает следующие значения: curTransfer, swiftTransfer. Если curFormat = swiftTransfer, то данные по счету будут переданы в формате МТ103. Если curFormat = curTransfer, то данные по валютному счёту будут переданы в том же формате, что и данные по рублёвому счету. По умолчанию для валютных счетов curFormat = swiftTransfer.
Необходимо запрашивать постранично данные операции, начиная с первой страницы и опрашивать следующую до того момента, как в полученном ответе перестанет приходить href c признаком "rel": "next", что будет означать, что следующей страницы нет. На запрос первой страницы в ответе вернётся список операций (Если существуют операции за выбранную дату и счёт) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next". На запрос второй страницы в ответе вернётся список операций и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии. Дата запрашиваемой выписки не может быть ранее 1.01.2017. В получаемой выписке внутри каждой операции сначала отображается информация по плательщику, а затем информация по получателю.
В примере указаны валидные данные, которые можно получить на тестовом стенде. Для этого необходимо использовать ключ доступа Access token 9e1efef1-e584-4c6f-9da3-34a04d203308-1.
Ресурс /v1/statement/transactions/{id}
Сервис позволяет Партнеру получить выписку по операции, предварительно получив вебхук с идентификатором операции.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения выписки по операции необходимо отправить GET-запрос (/v1/statement/transactions/{id}), в котором передать авторизационный токен к данным собственной организации (Access Token) и идентификатор операций. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.
В примере указаны валидные данные, которые можно получить на тестовом стенде. Для этого необходимо использовать ключ доступа Access token 8190f687-c916-453b-9d68-0ce22f4f3f9d-1.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/transactions/{id} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/statement/transactions/{id}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
id | path | integer(int64) | true | Идентификатор операции |
Example responses
200 Response
{
"amount": {
"amount": 1.01,
"currencyName": "USD"
},
"amountRub": {
"amount": 1.01,
"currencyName": "USD"
},
"correspondingAccount": "30101810400000000225",
"curTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"direction": "CREDIT",
"documentDate": "2018-12-31",
"filial": "ОСБ 3",
"number": "4",
"operationCode": "01",
"operationDate": "2018-12-31T23:59:59",
"paymentPurpose": "Оплата заказа №123. НДС нет.",
"priority": "5",
"revaln": "ПК",
"rurTransfer": {
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
},
"swiftTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"transactionId": 11111,
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | StatementTransaction |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/statement/summary
Ресурс позволяет получить информацию о входящих/исходящих остатках и суммарных оборотах за один день. Дата запрашиваемой информации об остатках не может быть ранее 1.01.2017.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информации о входящих/исходящих остатках и суммарных оборотах необходимо отправить GET-запрос (/v1/statement/summary), в котором передать авторизационный токен к данным пользователя (Access Token), номер счёта (accountNumber) и дату выписки (statementDate). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_STATEMENT_ACCOUNT.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/statement/summary?accountNumber=string&statementDate=2019-08-24T14%3A15%3A22Z \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/statement/summary
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
accountNumber | query | string | true | Номер счета (^[0-9]{20}$) |
statementDate | query | string(date-time) | true | Дата выписки (yyyy-MM-dd) |
Example responses
200 Response
{
"closingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"closingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"composedDateTime": "2018-12-31T23:59:59",
"creditTransactionsNumber": 1,
"creditTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"creditTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTransactionsNumber": 1,
"debitTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"lastMovementDate": "2018-12-31",
"openingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"openingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"openingRate": 1.01
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | StatementSummary |
202 | Accepted | Запрос принят | Notice |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Запрошенная выписка недоступна | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
В примере указаны валидные данные, которые можно получить на тестовом стенде. Для этого необходимо использовать ключ доступа Access token 8190f687-c916-453b-9d68-0ce22f4f3f9d-1.
Дополнительная информация
Формирование JOSE в представлении JWS Compact Serialization
Ответы формируются в виде компактной сериализации JWS по международной спецификации RFC 7515: JSON Web Signature (JWS).
JWS состоит из трех частей:
- заголовок (Header)
- JSON-объект с реквизитным составом ответа (Payload)
- подпись (Signature)
и формируется как Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Заголовок (Header): JSON-объект, содержащий тип токена, в данном случае JOSE; алгоритм подписи, в данном случае gost34.10-2012, и UUID сертификата технологического криптопрофиля Банка парный приватному ключу, которым подписан JOSE.
Пример:
{
"typ": "JOSE",
"alg": "gost34.10-2012",
"kid": "b994381d-d886-4b5a-9407-1672952610aa"
}
JSON-объект с реквизитным составом документа (Payload): содержимое Payload изменяется в зависимости от реквизитного состава и типа запроса.
Подпись (Signature): подпись данных приватной частью ключевой пары Интернет-банк СберБизнес (используется приватный ключ парный сертификату технологического криптопрофиля Банка с UUID, указанному в Заголовке (Header) в параметре kid).
Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных:
Base64Url(Header) || ‘.’ || Base64Url(Payload)
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
2.6 Зарплатный проект
2.6.1 Зарплатная ведомость
GET /v1/salary-agreements - Получение информации по зарплатному договору
POST /v1/payrolls - Зарплатная ведомость
GET /v1/payrolls/{externalId}/state - Получение статуса
GET /v1/payrolls/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/salary-agreements
Ресурс позволяет получить актуальную информацию по зарплатному договору, которую необходимо использовать при формировании зарплатной ведомости и электронного реестра на открытие счетов и выпуск карт.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информации необходимо отправить GET-запрос (/v1/salary-agreements), в котором в качестве входящего параметра передать авторизационный токен к данным (Acces Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SALARY_AGREEMENT.
В случае отсутствия в ответе блока полей commissionInfo необходимо повторить выполнение GET-запроса (/v1/salary-agreements) позднее или обратиться в Банк.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/salary-agreements \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/salary-agreements
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
Example responses
200 Response
[
{
"admissionValueTypes": [
{
"admissionCode": "01",
"admissionName": "Заработная плата",
"admissionType": "Зарплатный"
}
],
"branchBic": "044525225",
"branchName": "ПАО СБЕРБАНК",
"cardTypes": [
{
"bonusProgramCode": "11",
"depositSubtypeCode": "11",
"depositTypeCode": "11",
"endDate": "2018-12-31",
"peopleGroupCode": "111",
"peopleGroupName": "Зарплатная",
"typeCode": "11",
"typeName": "Visa Classic"
}
],
"commissionInfo": {
"actualDateTime": "2018-12-31T23:59:59",
"currentRate": 1.01,
"diffTariffs": [
{
"admissionTypeCode": "Other",
"endAmount": 1.01,
"fromAmount": 1.01,
"tariffRate": 1.01
}
],
"invoiceDate": "2018-12-31",
"otherRate": 1.01,
"periodInfo": {
"commissionAmount": 1.01,
"endDate": "2018-12-31",
"payAmount": 1.01,
"startDate": "2018-12-31"
},
"salaryRate": 1.01,
"totalDebitAmount": 1.01
},
"contractEndDate": "2018-12-31",
"contractNumber": "10000001",
"contractStartDate": "2018-12-31",
"isReserve": false,
"orgTaxNumber": "7707083893",
"osb": "1111",
"placesOfService": [
{
"osb": "1111",
"placeAddress": "г.Москва, Кутузовский проспект, 34",
"placeCode": "1111111111",
"placeName": "Доп офис 1111",
"tb": "11",
"vsp": "1111"
}
],
"tb": "11"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [SalaryAgreement] | false | none | [Зарплатный договор] |
admissionValueTypes | [SalaryAgreementAdmissionValueType] | false | none | Виды зачислений |
admissionCode | string | false | none | Код зачисления |
admissionName | string | false | none | Наименование зачисления |
admissionType | string | false | none | Тип зачисления |
branchBic | string | false | none | БИК подразделения |
branchName | string | false | none | Наименование подразделения |
cardTypes | [SalaryAgreementCardType] | false | none | Типы пластиковых карт |
bonusProgramCode | string | false | none | Код бонусной программы |
depositSubtypeCode | string | false | none | Код подвида вклада |
depositTypeCode | string | false | none | Код вида вклада |
endDate | string(date-time) | false | none | Дата закрытия возможности выпуска карт |
peopleGroupCode | string | false | none | Код категории населения |
peopleGroupName | string | false | none | Название категории населения |
typeCode | string | false | none | Код вида карты |
typeName | string | false | none | Вид карты |
commissionInfo | SalaryAgreementCommissionInfo | false | none | Информация о комиссии за зачисление |
actualDateTime | string(date-time) | false | none | Дата и время последнего обновления информации банком о неоплаченной комиссии |
currentRate | number | false | none | Текущая ставка тарифа за реестровые зачисления (%) |
diffTariffs | [SalaryAgreementDiffTariff] | false | none | Дифференцированные тарифы для зарплатных реестров |
admissionTypeCode | string | true | none | Тип зачисления |
endAmount | number | true | none | Конечная сумма диапазона выплат |
fromAmount | number | true | none | Начальная сумма диапазона выплат |
tariffRate | number | true | none | Тарифная ставка (%) |
invoiceDate | string(date-time) | false | none | Дата выставления счета и направления детализации |
otherRate | number | false | none | Фиксированная ставка по прочим зачислениям (%) |
periodInfo | SalaryAgreementPeriodInfo | false | none | Информация за расчетный период |
commissionAmount | number | true | none | Сумма начисленной комиссии за расчетный период |
endDate | string(date-time) | true | none | Дата окончания расчетного периода |
payAmount | number | true | none | Сумма выплат за расчетный период |
startDate | string(date-time) | true | none | Дата начала расчетного периода |
salaryRate | number | false | none | Фиксированная ставка комиссии по зарплатным зачислениям (%) |
totalDebitAmount | number | false | none | Общая сумма неоплаченной комиссии |
contractEndDate | string(date-time) | false | none | Дата окончания действия договора |
contractNumber | string | false | none | Номер договора |
contractStartDate | string(date-time) | false | none | Дата начала действия договора |
isReserve | boolean | false | none | Признак резервирования |
orgTaxNumber | string | false | none | ИНН организации клиента |
osb | string | false | none | Номер отделения сберегательного банка |
placesOfService | [SalaryAgreementPlaceOfService] | false | none | Места обслуживания |
osb | string | false | none | Номер отделения сберегательного банка |
placeAddress | string | false | none | Адрес подразделения |
placeCode | string | false | none | Код подразделения |
placeName | string | false | none | Наименование подразделения |
tb | string | false | none | Номер территориального банка |
vsp | string | false | none | Номер внутреннего структурного подразделения |
tb | string | false | none | Номер территориального банка |
Enumerated Values
Property | Value |
---|---|
admissionTypeCode | Other |
admissionTypeCode | Salary |
Ресурс /v1/payrolls
Ресурс позволяет отправлять зарплатную ведомость.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания зарплатной ведомости необходимо отправить POST-запрос (/v1/payrolls), в котором передать авторизационный токен (Access Token) и реквизиты зарплатной ведомости. Авторизационный токен передается в параметре Authorization заголовка запроса.
- Если зарплатный договор с резервированием, PayrollPayDoc не заполняется.
- В случае отсутствия в ответe блока commissionInfo необходимо повторить выполнение GET-запроса (/v1/payrolls/{externalId}) позднее или обратиться в Банк.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYROLL.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payrolls \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/payrolls
Body parameter
{
"account": "40802810600000200000",
"admissionValue": "01",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "8(495)1234567",
"bic": "044525225",
"commissionInfo": {},
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeSalaries": [
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"withheldAmount": 1.01
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "1",
"loanAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"loanDate": "2018-12-31",
"loanNumber": "1234567890",
"month": "Январь",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893",
"payDocs": [
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
],
"year": "2019"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | Payroll | true | Зарплатная ведомость |
Example responses
201 Response
{
"account": "40802810600000200000",
"admissionValue": "01",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "8(495)1234567",
"bankComment": "string",
"bankStatus": "string",
"bic": "044525225",
"commissionInfo": {
"actualRate": 1.01,
"actualSum": 1.01,
"estimatedRate": 1.01,
"estimatedSum": 1.01,
"invoiceDate": "2018-12-31"
},
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeSalaries": [
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"bankMessage": "string",
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"result": "string",
"withheldAmount": 1.01
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "1",
"loanAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"loanDate": "2018-12-31",
"loanNumber": "1234567890",
"month": "Январь",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893",
"payDocs": [
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
],
"year": "2019"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | Payroll |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью (JWS)
- Коды возврата
Ресурс /v1/payrolls/{externalId}/state
Ресурс позволяет получить статус ранее отправленной зарплатной ведомости.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/payrolls/{externalId}/state), в котором передать авторизационный токен (Access Token) и идентификатор документа ( externalId ). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYROLL.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payrolls/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payrolls/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID зарплатной ведомости |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocStateShort |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/payrolls/{externalId}
Ресурс позволяет получить документ заранее отправленной зарплатной ведомости с информацией о зачислении по каждому сотруднику.
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/payrolls/{externalId}), в котором передать авторизационный токен (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYROLL.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payrolls/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payrolls/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID зарплатной ведомости |
Example responses
200 Response
{
"account": "40802810600000200000",
"admissionValue": "01",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "8(495)1234567",
"bankComment": "string",
"bankStatus": "string",
"bic": "044525225",
"commissionInfo": {
"actualRate": 1.01,
"actualSum": 1.01,
"estimatedRate": 1.01,
"estimatedSum": 1.01,
"invoiceDate": "2018-12-31"
},
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeSalaries": [
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"bankMessage": "string",
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"result": "string",
"withheldAmount": 1.01
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "1",
"loanAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"loanDate": "2018-12-31",
"loanNumber": "1234567890",
"month": "Январь",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893",
"payDocs": [
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
],
"year": "2019"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Payroll |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.6.2 Удалённое подключение зарплатного проекта
POST /v1/salary-agreement-requests - Удаленное подключение зарплатного проекта
GET /v1/salary-agreement-requests/{externalId}/state - Получение статуса
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/salary-agreement-requests
Ресурс позволяет создавать заявку на удалённое подключение зарплатного проекта.
Шаги
- Получить AccessToken
- Отправить запрос
- Получить статус
Для создания заявки на удалённое подключение зарплатного проекта необходимо отправить POST-запрос (/v1/salary-agreement-requests), в котором передать авторизационный токен к данным пользователя (Access Token), а так же реквизиты организации и сведения об уполномоченных лицах. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SALARY_AGREEMENT_REQUEST.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/salary-agreement-requests \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/salary-agreement-requests
Body parameter
{
"account": "40802810600000200000",
"admissionType": "2",
"amount": 1.01,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTel": "8(495)1234567",
"bic": "044525225",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"identityDoc": {
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"firstName": "Иван",
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"lastName": "Иванов",
"middleName": "Иванович",
"number": "123456",
"serial": "1234",
"typeCode": "21",
"typeName": "Паспорт гражданина Российской Федерации"
},
"number": "1",
"offerAgree": false,
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | SalaryAgreementRequest | true | Заявка на удаленное подключение «Зарплатного проекта» |
Example responses
201 Response
{
"account": "40802810600000200000",
"admissionType": "2",
"amount": 1.01,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTel": "8(495)1234567",
"bankComment": "string",
"bankStatus": "string",
"bic": "044525225",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"identityDoc": {
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"firstName": "Иван",
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"lastName": "Иванов",
"middleName": "Иванович",
"number": "123456",
"serial": "1234",
"typeCode": "21",
"typeName": "Паспорт гражданина Российской Федерации"
},
"number": "1",
"offerAgree": false,
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | SalaryAgreementRequest |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование ЭП
- Из документа формируется строковая последовательность (ключевой буфер или дайджест), включающая все значимые данные документа.
- Затем от дайджеста вычисляется хеш по стандарту ГОСТ 34.11-94 с параметрами GostR3411-94-CryptoProParamSet.
- Полученное значение хеш-функции подписывается по стандарту ГОСТ 34.10-2001 с параметрами GostR3410-2001-CryptoPro-B-ParamSet.
- 64 байта, полученные в результате шага 3 и представленные в виде, описанном в пункте 3.1 RFC 4490 и есть сформированная электронная подпись.
Дайджест имеет текстовый формат, поэтому в значении полей могут быть переданы любые символы.
Ресурс /v1/salary-agreement-requests/{externalId}/state
Ресурс позволяет получить статус заявки на удалённое подключение зарплатного проекта.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса исполнения заявки необходимо отправить GET-запрос (/v1/salary-agreement-requests/{externalId}/state), в котором в качестве входящего параметра передать авторизационный токен к данным Access Token и идентификатор документа (externalId).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SALARY_AGREEMENT_REQUEST.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/salary-agreement-requests/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/salary-agreement-requests/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID Заявки на удаленное подключение «Зарплатного проекта» |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.6.3 Электронный реестр на открытие счетов и выпуск карт
POST /v1/card-issues - Электронный реестр на открытие счетов и выпуск карт
GET /v1/card-issues/{externalId}/state - Получение статуса
GET /v1/card-issues/{externalId} - Получение электронного реестра
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/card-issues
Ресурс позволяет создавать электронный реестр на открытие счетов и выпуск карт по собственной и дочерней организации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для создания электронного реестра на открытие счетов и выпуск карт необходимо отправить POST-запрос (/v1/card-issues), в котором передать авторизационный токен к данным (Access Token) и реквизиты Электронного реестра. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/card-issues \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/card-issues
Body parameter
{
"accept": false,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "4955005550",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeCardIssue": [
{
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | CardIssue | true | Электронный реестр |
Example responses
201 Response
{
"accept": false,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeCardIssue": [
{
"accountNumber": "40802810600000200000",
"bankMessage": "Счет успешно открыт",
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"issCard": false,
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"result": "Счет открыт",
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | CardIssue |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование ЭП
- Из документа формируется строковая последовательность (ключевой буфер или дайджест), включающая все значимые данные документа.
- Затем от дайджеста вычисляется хеш по стандарту ГОСТ 34.11-94 с параметрами GostR3411-94-CryptoProParamSet.
- Полученное значение хеш-функции подписывается по стандарту ГОСТ 34.10-2001 с параметрами GostR3410-2001-CryptoPro-B-ParamSet.
- 64 байта, полученные в результате шага 3 и представленные в виде, описанном в пункте 3.1 RFC 4490 и есть сформированная электронная подпись.
Дайджест имеет текстовый формат, поэтому в значении полей могут быть переданы любые символы.
Ресурс /v1/card-issues/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного реестра на открытие счетов и выпуск карт.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения необходимо отправить GET-запрос (/v1/card-issues/{externalId}/state), в котором передать авторизационный токен (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/card-issues/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/card-issues/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID электронного реестра |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/card-issues/{externalId}
Ресурс позволяет получить заранее отправленный электронный реестр на открытие счетов и выпуск карт с информацией о выпуске карт по каждому сотруднику.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/card-issues/{externalId}), в котором передать авторизационный токен (Access Token) и идентификатор документа (externalId). Ключ безопасности передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/card-issues/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/card-issues/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID электронного реестра |
Example responses
200 Response
{
"accept": false,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeCardIssue": [
{
"accountNumber": "40802810600000200000",
"bankMessage": "Счет успешно открыт",
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"issCard": false,
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"result": "Счет открыт",
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CardIssue |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.6.4 Шифрование зарплатной ведомости
Сертификаты шифрования для ПРОМ-контура
Для шифрования зарплатной ведомости необходимо установить Банковский сертификат шифрования.zip.
Сертификат действителен до 18.04.2024
Новый сертификат будет опубликован за 30 дней до окончания срока действия текущего. Новый сертификат будет действителен на следующий день от даты окончания текущего.
Пошаговый алгоритм шифрования и расшифрования описаны для VPNKeyTLS, Рутокен.
Формирование JOSE в представлении JWE Compact Serialization
Для того, чтобы отправить и получить зарплатную ведомость в зашифрованном виде необходимо в POST-запрос (/v1/payrolls) передать http-заголовок Content-Type со значением application/jose и Accept со значением application/jose , тогда запрос будет обрабатываться в формате в JOSE в представлении JWE Compact Serialization и сформированный не ошибочный ответ (код ответа 201) будет представлен в JOSE в представлении JWE Compact Serialization. При этом в ответе также будет содержаться http-заголовок Content-Type со значением application/jose.
Логика формирования JOSE в представлении JWE Compact Serialization
1). Преобразуем запрос JSON в формат JWS Compact Serialization
JWS Compact Serialization имеет следующий вид: BASE64URL(Header) || '.' || BASE64URL(Payload) || '.' || BASE64URL(Signature)
Подписание запроса транспортной подписью
Content-Type может содержать одно из двух значений:
1. application/json – запрос без подписи
2. application/jose– запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
1. Заголовка (Header) 2. JSON-документа с реквизитным составом поручения (Payload) 3. Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2). Формирование JWE Compact Serialization
JWE Compact Serialization состоит из 5 частей, разделитель между частями - символ '.'
Для запроса в SberBusinessAPI структура JWE Compact Serialization будет иметь следующий вид: BASE64URL(UTF8(JWE Protected Header)) || '.' '.' '.' || BASE64URL(JWE Ciphertext) || '.'
Правило формирования Protected Header
В запросе защищенный заголовок (Protected Header) будет иметь следующий вид:
{
"typ": "JOSE",
"enc": "Алгоритм, по которому был зашифрован запрос gost28147-89",
"alg": "dir"
}
Правило формирования Ciphertext
В качестве шифруемого текста (Ciphertext) используем запрос в формате JWS Compact Serialization (см. п1)
3). Выполняем шифрование Protected Header и Ciphertext
Алгоритм шифрования
Логика шифрования с помощью токена (Рутокен, Инфокрипт) описана в разделе 19 документации VPNKEY-httpinterface_2_28.doc
Для шифрования с помощью токена (VPNKeyTLS, Рутокен) необходимо выполнить следующие действия:
- Проинициализировать устройство (INIT_ENCIPHER_ID).
- Внести данные сторонних cертификатов (ADD_RECIPIENT_Y_ID – 1 или более вызовов).
- Внести данные для шифрования (ENCIPHER_ID – 1 или более вызовов).
- Получить данные начала и окончания CMS (GET_ENCIPHER_CMS_ID).
- Cформировать CMS с использованием зашифрованных данных в соответствии со схемой:
- Шифрованныеданныев_формате_CMS = base64( head +[Recipient_info] + suffix + зашифрованные данные)
Запросы необходимо отправлять на http://localhost:28016/vpnkeylocal/
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/6LbqY8D4zqDqTMIzeqoBTSto5rS6Ehq3ay/?id=INIT_ENCIPHER_ID&datasize=11425&mode=1\
Инициализация шифрования
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | INIT_ENCIPHER_ID | id функции | |
datasize | NUMBER | 2^32-1 | размер данных для шифрования | |
mode | ENUM | 1,2 | Стандарт криптооперации: КС1 - токен только генерирует ключевую пару, данные шифруются "стартом.ехе"; КС2 - токен генерирует ключевюу пару и шифрует данные. | С версии 500; опционально |
Example responses
200 Response
{
"ctx_handle": "xXrKOSKc",
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
ctx_handle | HANDLE | 8 байт | хендл контекста операции | |
retcode | ENUM | 2 байта | код возврата ф-ии |
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/6LbqY8D4zqDqTMIzeqoBTSto5rS6Ehq3ay/?id=ADD_RECIPIENT_Y_ID&data=MIIGFTCCBcKgAwIBAgIKeJsrF2cm48r4SDAKBggqhQMHAQEDAjCCAWsxGzAZBgNVBAgMEjc3INCzLtCc0L7RgdC60LLQsDEYMBYGA1UEBwwP0LMu0JzQvtGB0LrQstCwMRowGAYIKoUDA4EDAQESDDAwNzcwNzA4Mzg5MzEmMCQGA1UECQwd0YPQuy4g0JLQsNCy0LjQu9C%2B0LLQsCwg0LQuMTkxGDAWBgUqhQNkARINMTAyNzcwMDEzMjE5NTELMAkGA1UEBhMCUlUxKzApBgNVBAoMItCf0JDQniDQodCx0LXRgNCx0LDQvdC6ICjQotCV0KHQoikxQzBBBgNVBAsMOtCU0LXQv9Cw0YDRgtCw0LzQtdC90YIg0LHQtdC30L7Qv9Cw0YHQvdC%2B0YHRgtC4ICjQotCV0KHQoikxMjAwBgNVBAMMKdCf0JDQniDQodCx0LXRgNCx0LDQvdC6INCj0KYgKNCi0JXQodCiIFEpMSEwHwYJKoZIhvcNAQkBFhJjYXNicmZAc2JlcmJhbmsucnUwHhcNMjAxMDIyMTA0ODAwWhcNMjIwMTIyMTA0OTI5WjCCATQxHzAdBgNVBAoMFtCh0LHQtdGA0KLQtdGF0KLQtdGB0YIxCzAJBgNVBAYTAlJVMRwwGgYDVQQIDBM3NyDQsy4g0JzQvtGB0LrQstCwMRgwFgYDVQQHDA%2FQsy7QnNC%2B0YHQutCy0LAxJjAkBgNVBAkMHdGD0LsuINCS0LDQstC40LvQvtCy0LAsINC0LjE5MRowGAYIKoUDA4EDAQESDDAwNzcwNzA4Mzg5MzEYMBYGBSqFA2QBEg0xMDI3NzAwMTMyMTk1MSEwHwYDVQQDDBjQkNCR0KEg0LHQtdC3INC40LzQtdC90LgxSzBJBgNVBAsMQtCi0LXRgdGC0L7QstC%2B0LUg0L%2FQvtC00YDQsNC30LTQtdC70LXQvdC40LUg0KHQsdC10YDQotC10YXQotC10YHRgjBmMB8GCCqFAwcBAQEBMBMGByqFAwICIwIGCCqFAwcBAQICA0MABEAmfYuzX1XxLTRcOsQWUtFam4OG9B805y8oO%2Bb9x90ZYWiaV9qPfRuJ0IgVB3z3s%2Fx6HUmF4etCGbk0v2s7aLQLo4ICcjCCAm4wPQYHKoUDA3sDAQQyDDBTQlRKMzhEUWHQotC10YHRgl%2FQodCx0LXRgNCR0LjQt9C9XzIwMTLRiNC40YTRgEQwCQYDVR0TBAIwADAdBgNVHQ4EFgQUM2ki7znTdFVluwFGBlEYpjrrvcQwPQYDVR0fBDYwNDAyoDCgLoYsaHR0cDovL3d3d2wuc2JlcmJhbmsucnUvY2EvdGVzdF8yMDEyeDUwOS5jcmwwDgYDVR0PAQH%2FBAQDAgP4MIIBsgYDVR0jBIIBqTCCAaWAFER%2BsfJUNI8vPMx8c81kE7FatnguoYIBf6SCAXswggF3MRswGQYDVQQIDBI3NyDQsy7QnNC%2B0YHQutCy0LAxGDAWBgNVBAcMD9CzLtCc0L7RgdC60LLQsDEaMBgGCCqFAwOBAwEBEgwwMDc3MDcwODM4OTMxJjAkBgNVBAkMHdGD0LsuINCS0LDQstC40LvQvtCy0LAsINC0LjE5MRgwFgYFKoUDZAESDTEwMjc3MDAxMzIxOTUxCzAJBgNVBAYTAlJVMSswKQYDVQQKDCLQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiAo0KLQldCh0KIpMUMwQQYDVQQLDDrQlNC10L%2FQsNGA0YLQsNC80LXQvdGCINCx0LXQt9C%2B0L%2FQsNGB0L3QvtGB0YLQuCAo0KLQldCh0KIpMT4wPAYDVQQDDDXQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiDQmtC%2B0YDQvdC10LLQvtC5ICjQotCV0KHQoiBaKTEhMB8GCSqGSIb3DQEJARYSY2FzYnJmQHNiZXJiYW5rLnJ1ggp2jiCd6wxHHf%2ByMAoGCCqFAwcBAQMCA0EAJLkIOn%2FzEIATZ6PdgFsuOAPatfY%2BO4%2FZQbLompRyizcCNt2%2BO0QIQYKhPAXyL94QNeZfr5ddh1znthFL3xrvbw%3D%3D&ctx_handle=xXrKOSKc\
Добавление стороннего сертификата получателя
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | ADD_RECIPIENT_Y_ID | id функции | |
data | BASE64 | Для прошивок 399+: 6144 URL-encoded байтов base64;Для прошивок 500+: 15360 байтов бинарных данных (размер base64, требуемый для их кодировки, не регламентирован) | размер данных для шифрования | данные стороннего сертификата в base64 |
ctx_handle | HANDLE | 8 байт | хендл контекста операции |
Example responses
200 Response
{
"data": "MIICUgIBADCCAXswggFrMRswGQYDVQQIDBI3NyDQsy7QnNC+0YHQutCy0LAxGDAWBgNVBAcMD9CzLtCc0L7RgdC60LLQsDEaMBgGCCqFAwOBAwEBEgwwMDc3MDcwODM4OTMxJjAkBgNVBAkMHdGD0LsuINCS0LDQstC40LvQvtCy0LAsINC0LjE5MRgwFgYFKoUDZAESDTEwMjc3MDAxMzIxOTUxCzAJBgNVBAYTAlJVMSswKQYDVQQKDCLQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiAo0KLQldCh0KIpMUMwQQYDVQQLDDrQlNC10L/QsNGA0YLQsNC80LXQvdGCINCx0LXQt9C+0L/QsNGB0L3QvtGB0YLQuCAo0KLQldCh0KIpMTIwMAYDVQQDDCnQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiDQo9CmICjQotCV0KHQoiBRKTEhMB8GCSqGSIb3DQEJARYSY2FzYnJmQHNiZXJiYW5rLnJ1Agp4mysXZybjyvhIMB8GCCqFAwcBAQEBMBMGByqFAwICIwIGCCqFAwcBAQICBIGsMIGpMCgEIIxzsG0Af4ShXKB+aCQPQDaEJS4gEWnaeatPMi/t4ChSBASSfJgYoH0GCSqFAwcBAgUBAaBmMB8GCCqFAwcBAQEBMBMGByqFAwICIwIGCCqFAwcBAQICA0MABECBkzEtLzyUEh91WlL4yxG2+zEok4tNgPobBfzAXMoLFE3tjo0ZiNEjFVIJQSVzumK6ROBzpvvoREmjDKkmWh5sBAhSNQI2lmQKCg==",
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
data | BASE64 | Для прошивок 399+: 6144 URL-encoded байтов base64;Для прошивок 500+: 15360 байтов бинарных данных (размер base64, требуемый для их кодировки, не регламентирован) | часть данных для формирования CMS, содержит информацию о получателе | |
retcode | ENUM | 2 байта | код возврата ф-ии |
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/6LbqY8D4zqDqTMIzeqoBTSto5rS6Ehq3ay/?id=ENCIPHER_ID&data=ZXlKaGJHY2lPaUpuYjNOME16UXVNVEF0TWpBeE1pSXNJbXRwWkNJNkltVmpOVEV6WkdFMUxUVTRaVFV0TkdZME55MWlPV0V3TFRJellUQTNNVEl5WW1VeFlTSjkuZXlBaVlXTmpiM1Z1ZENJNklDSTBNRGd3TWpneE1EWXdNakF3TURBd01EQXdNU0lzSUNKaFpHMXBjM05wYjI1V1lXeDFaU0k2SUNJd01TSXNJQ0poYlc5MWJuUWlPaUI3SUNKaGJXOTFiblFpT2lBeE1EQXVNREFzSUNKamRYSnlaVzVqZVVOdlpHVWlPaUFpT1RjNElpd2dJbU4xY25KbGJtTjVUbUZ0WlNJNklDSlNWVUlpSUgwc0lDSmhkWFJvVUdWeWMyOXVUbUZ0WlNJNklDTFFuOUMxMFlMUmdOQy0wTElnMEpfUXRkR0MwWUFnMEpfUXRkR0MwWURRdnRDeUlpd2dJbUYxZEdoUVpYSnpiMjVVWld4bVlYZ2lPaUFpTnprM056RXhNVEl5TWpJaUxDQWlZbWxqSWpvZ0lqQTBNREUzTXpZd05DSXNJQWtpWTI5dWRISmhZM1JFWVhSbElqb2dJakl3TWpBdE1UQXRNakVpTENBSkltTnZiblJ5WVdOMFRuVnRZbVZ5SWpvZ0lqZzRNRGN3TmpJeElpd2dJbVJoZEdVaU9pQWlNakF5TUMweE1pMHdNaUlzSUNKcGJtTnZiV1ZVZVhCbFEyOWtaU0lnT2lBeExDQWliRzloYmtGdGIzVnVkQ0k2SUhzZ0ltRnRiM1Z1ZENJNklERXdNQzR3TUN3Z0ltTjFjbkpsYm1ONVEyOWtaU0k2SUNJNU56Z2lMQ0FpWTNWeWNtVnVZM2xPWVcxbElqb2dJbEpWUWlJZ2ZTd2dJbVZ0Y0d4dmVXVmxVMkZzWVhKcFpYTWlPaUJiZXlBaVlXTmpiM1Z1ZENJNklDSTBNRGd4TnpneE1EWXpPREV5TlRJd01UWXdPQ0lzSUNKaGJXOTFiblFpT2lCN0lDSmhiVzkxYm5RaU9pQXhNREF1TURBc0lDSmpkWEp5Wlc1amVVTnZaR1VpT2lBaU9UYzRJaXdnSW1OMWNuSmxibU41VG1GdFpTSTZJQ0pTVlVJaUlIMHNJQ0ozYVhSb2FHVnNaRUZ0YjNWdWRDSWdPaUFpTXk0d01DSXNJQ0ptYVhKemRFNWhiV1VpT2lBaVRrRkxVMGNpTENBaWJHRnpkRTVoYldVaU9pQWlWRXhaUWtaTUlpd2dJbTFwWkdSc1pVNWhiV1VpT2lBaVNsZE9UMDRpSUgwZ1hTd2dJbVY0ZEdWeWJtRnNTV1FpT2lBaU1XRmlaakU1TXprdE1tTTFOQzAwWm1KaExXRTVaV010WldNd09ESTJOR015TjJFNElpd2dJbTF2Ym5Sb0lqb2dJdEM4MExEUXVTSXNJQ0psYlhCc2IzbGxaWE5PZFcxaVpYSWlPaUFpTVNJc0lDQWliM0puVG1GdFpTSTZJQ0xRbU5DZDBKVFFtTkNTMEpqUWxOQ2owSkRRbTlDczBKM1FxOUNaSU5DZjBLRFFsZENVMEpfUW9OQ1kwSjNRbU5DYzBKRFFvdENWMEp2UXJDRFFtTkNTMEpEUW5kQ2UwSklnMEpndUlOQ1lJaXdnSW05eVoxUmhlRTUxYldKbGNpSTZJQ0kzTmpZM056YzVNalV5TlRBaUxDQWllV1ZoY2lJNklDSXlNREU1SWl3Z0ltUnBaMlZ6ZEZOcFoyNWhkSFZ5WlhNaU9pQmJJSHNnSW1KaGMyVTJORVZ1WTI5a1pXUWlPaUFpVFVsSlRXWm5XVXBMYjFwSmFIWmpUa0ZSWTBOdlNVbE5ZbnBEUTBSSGMwTkJVVVY0UkdwQlRVSm5aM0ZvVVUxSVFWRkZRMEZuVlVGTlFYTkhRMU54UjFOSllqTkVVVVZJUVdGRFEwTldaM2RuWjFKQlRVbEpSRGRoUVVSQlowVkRRV2R3TkhGRFdtRjNXVWh0YUdwQldVMUJiMGREUTNGR1FYZGpRa0ZSVFVOTlNVbENZWHBGWWsxQ2EwZEJNVlZGUTBGM1UwNTZZMmN3VEUxMU1FcDZVWFowUjBJd1RISlJjM1JEZDAxU1ozZEdaMWxFVmxGUlNFUkJMMUZ6ZVRkUmJrNURLekJaU0ZGMWRFTjVNRXhCZUVkcVFWbENaMmR4YUZGTlJHZFJUVUpCVWtsTlRVUkJNMDU2UVROTlJHZDZUMFJyZWsxVFdYZEtRVmxFVmxGUlNrUkNNMUpuT1VNM1RHbEVVV3QwUTNjd1RFeFJkVTVETnpCTU4xRnpkRU4zVEVORVVYUkROSGhQVkVWWlRVSlpSMEpUY1VaQk1sRkNSV2N3ZUUxRVNUTk9la0YzVFZSTmVVMVVhekZOVVhOM1ExRlpSRlpSVVVkRmQwcFRWbFJGY2sxRGEwZEJNVlZGUTJkM2FUQktMMUZyVGtObFNVNURhREJNU0ZGMFpFZEJNRXhJVVhOT1F6a3dURzluUzA1RGFUQktXRkZ2WkVOcFMxUkdSRTFGUlVkQk1WVkZRM2QzTmpCS1ZGRjBaRU12TUV4RVVtZE9SME13VEVSUmRrNURNVEJNTTFKbmFVUlJjMlJETVRCTVpsRjJkRU12TUV4RVVtZGtRemt3VERkU1oyUkhRekJNWjJkTFRrTnBNRXBZVVc5a1EybExWRVY1VFVSQlIwRXhWVVZCZDNkd01Fb3ZVV3RPUTJWSlRrTm9NRXhJVVhSa1IwRXdURWhSYzA1RE9UQk1iMmN3UzFCUmNHbEJiekJMVEZGc1pFTm9NRXRKWjFWVGEzaEpWRUZtUW1kcmNXaHJhVWM1ZHpCQ1ExRkZWMFZ0VG1oak1rcDVXbXRDZWxsdFZubFpiVVoxWVhrMWVXUlVRV1ZHZHpCNVRVUkZlRTFVV1hkUFZFMHlUVVJDWVVaM01IbE5la1Y0VFZSWmQwOVVUVE5PUkU1aFRVbElhRTFTVVhkRloxbEVWbEZSUkVSQmRIaGtNbFZuWTFoa2JFbElSak5hVkVWTlRVRnZSMEV4VlVWQ1FYZEVZMWhrYkUxU1FYZEVaMWxFVmxGUmNVUkJaSGhrTWxWblkxaGtiRTFSYzNkRFVWbEVWbEZSUjBWM1NsTldWRVpaVFVaWlIwRXhWVVZEWjNoUU1FcHFVVzVrUTFVd1NtcFJhM1JEV1RCS1ZGRnZPVU5STUVwMlVYSk9RMlF3UzNaUmJWTkVVVzQ1UTJjd1NsaFJiRTVEWmpCTFJGRnRUa05rTUVwcVVXNU9RMUV3UzB4UmJHUkRZakJMZDJjd1NtcFJhM1JEVVRCS00xRnVkRU5UU1U1RFdVeHBSRkZ0UkVWV1RVSk5SMEV4VlVWSlVYZE5ZVmhDVVZsWVNqQmliVlo1VGxSQmQwMVRjM2RMVVZsS1MyOWFTV2gyWTA1QlVXdENSbWg0VkdSWFVuWmtiazV5WVZocmRWVjVOVmRaVlVKMllsZFdibGxUTlhwWmJrcHRURzVLTVUxSE9IZExRVmxKUzI5VlJFSjNSVUpCVVVWM1NFRlpTRXR2VlVSQlowbHFRV2RaU1V0dlZVUkNkMFZDUVdkSlIwSjVjVVpCZDBsRFNIZEZSRkYzUVVWUlQwUk5aeXRHUlRCTE4zVTNUWFJJVjBnMFNXSlFPRFpLYUVWMVQyTk9SRVJEVm00NGIwMVBNVGRhTTBOdVRVUjNjV3RpVGtGcWJsaHViSFZ6UzNSc1pYTjJjM2hPVVdWdWEzUjVaMWx3VkRVeWRtbDViSFZxWjJWcmQyZGxXWGRNVVZsR1MyOVZSRnBIT0VWS1FYZHBWbXhDVDB4VmRHeGxVekZWVkVaTlp6Qk1hbEpuWkVNdk1FdzNVWFU1UXprd1RGaFJkbVJETkRCTVZXZE5ha0ZhUW1kamNXaFJUVVJsZDAxR1FrRTBUVVJHVWsxVmVrRjNUMVJKTVUxVVdUQlJha0ZVUW1kT1ZraFRRVVZFUkVGTFRVRm5SMEpwY1VaQk1sSjRRVlJCWmtKblkzRm9VVTFFWlhkTlFrSkNVVTFGYTBWM1VWVmpkMDFFU1RGak0wWXpXbE5DVWt4cFFsSk1ha0ZWUW1kamNXaFJUVVJsZDAxRlFrRnJSMEo1Y1VaQmQwNDNRbEZSZDBSbldVUldVakJRUVZGSUwwSkJVVVJCWjFBMFRVSXdSMEV4VldSRVoxRlhRa0pSVFZCM1ZsZG5ObFk1UldNclp6azVObVZVUlZKdVlraHZVVGRxUVdaQ1owNVdTRk5OUlVkRVFWZG5RbEpGWm5KSWVWWkVVMUJNZW5wTlpraFFUbHBDVDNoWGNsbzBUR3BCUzBKblozRm9VVTFJUVZGRlJFRm5Ua0pCUkZSR1VXNUZhVkZNT1ZGc1JIaE1NSGxIZGtkVFUzWlJLM0JGUkhrNWNVVTVZVTF3UlV4MWFWZDBTa0ZNVFM5eFVXa3hURVF6YkdSa1JEUmtielZhVlRWbWRpOTZOMHBEVVZGSldUYzBXVUp0VG1OS05rbDNaMmRWVVUxSlNVVjJZVUZFUVdkRlEwRm5jREpxYVVOa05uZDRTRWhtSzNsTlFXOUhRME54UmtGM1kwSkJVVTFEVFVsSlFtUjZSV0pOUW10SFFURlZSVU5CZDFOT2VtTm5NRXhOZFRCS2VsRjJkRWRDTUV4eVVYTjBRM2ROVW1kM1JtZFpSRlpSVVVoRVFTOVJjM2szVVc1T1F5c3dXVWhSZFhSRGVUQk1RWGhIYWtGWlFtZG5jV2hSVFVSblVVMUNRVkpKVFUxRVFUTk9la0V6VFVSbmVrOUVhM3BOVTFsM1NrRlpSRlpSVVVwRVFqTlNaemxETjB4cFJGRnJkRU4zTUV4TVVYVk9RemN3VERkUmMzUkRkMHhEUkZGMFF6UjRUMVJGV1UxQ1dVZENVM0ZHUVRKUlFrVm5NSGhOUkVrelRucEJkMDFVVFhsTlZHc3hUVkZ6ZDBOUldVUldVVkZIUlhkS1UxWlVSWEpOUTJ0SFFURlZSVU5uZDJrd1NpOVJhMDVEWlVsT1EyZ3dURWhSZEdSSFFUQk1TRkZ6VGtNNU1FeHZaMHRPUTJrd1NsaFJiMlJEYVV0VVJrUk5SVVZIUVRGVlJVTjNkell3U2xSUmRHUkRMekJNUkZKblRrZERNRXhFVVhaT1F6RXdURE5TWjJsRVVYTmtRekV3VEdaUmRuUkRMekJNUkZKblpFTTVNRXczVW1ka1IwTXdUR2RuUzA1RGFUQktXRkZ2WkVOcFMxUkZLMDFFZDBkQk1WVkZRWGQzTVRCS0wxRnJUa05sU1U1RGFEQk1TRkYwWkVkQk1FeElVWE5PUXprd1RHOW5NRXB5VVhaMFIwRXdURE5SZEdSRGVUQk1OMUYxVTBGdk1FdE1VV3hrUTJnd1MwbG5WMmxyZUVsVVFXWkNaMnR4YUd0cFJ6bDNNRUpEVVVWWFJXMU9hR015U25sYWEwSjZXVzFXZVZsdFJuVmhlVFY1WkZSQlpVWjNNSGhQUkVFMVRXcG5kMDlFUVRWT1ZGWmhSbmN3ZVU1RVFUVk5hbWQzVDBSQk5VNVVWbUZOU1VsQ1lYcEZZazFDYTBkQk1WVkZRMEYzVTA1NlkyY3dURTExTUVwNlVYWjBSMEl3VEhKUmMzUkRkMDFTWjNkR1oxbEVWbEZSU0VSQkwxRnplVGRSYms1REt6QlpTRkYxZEVONU1FeEJlRWRxUVZsQ1oyZHhhRkZOUkdkUlRVSkJVa2xOVFVSQk0wNTZRVE5OUkdkNlQwUnJlazFUV1hkS1FWbEVWbEZSU2tSQ00xSm5PVU0zVEdsRVVXdDBRM2N3VEV4UmRVNUROekJNTjFGemRFTjNURU5FVVhSRE5IaFBWRVZaVFVKWlIwSlRjVVpCTWxGQ1JXY3dlRTFFU1ROT2VrRjNUVlJOZVUxVWF6Rk5VWE4zUTFGWlJGWlJVVWRGZDBwVFZsUkZjazFEYTBkQk1WVkZRMmQzYVRCS0wxRnJUa05sU1U1RGFEQk1TRkYwWkVkQk1FeElVWE5PUXprd1RHOW5TMDVEYVRCS1dGRnZaRU5wUzFSR1JFMUZSVWRCTVZWRlEzZDNOakJLVkZGMFpFTXZNRXhFVW1kT1IwTXdURVJSZGs1RE1UQk1NMUpuYVVSUmMyUkRNVEJNWmxGMmRFTXZNRXhFVW1ka1F6a3dURGRTWjJSSFF6Qk1aMmRMVGtOcE1FcFlVVzlrUTJsTFZFVjVUVVJCUjBFeFZVVkJkM2R3TUVvdlVXdE9RMlZKVGtOb01FeElVWFJrUjBFd1RFaFJjMDVET1RCTWIyY3dTMUJSY0dsQmJ6QkxURkZzWkVOb01FdEpaMVZUYTNoSlZFRm1RbWRyY1docmFVYzVkekJDUTFGRlYwVnRUbWhqTWtwNVdtdENlbGx0Vm5sWmJVWjFZWGsxZVdSVVFtMU5RamhIUTBOeFJrRjNZMEpCVVVWQ1RVSk5SMEo1Y1VaQmQwbERTWGRKUjBORGNVWkJkMk5DUVZGSlEwRXdUVUZDUlVOSFl6UllTV3RzZWpRMGJXaGFVazVhUzI5M1dtdE1NRkpVTTNVdldFNU9LMHBVVG5OMFdXMXNjMlZrWnpSWlpHNVFRbWcyTUUxUVpTczRLMWRMVjFsb2J6RXpkR05zYUdkRGMzcElOemxDZVdWQmJqQk9ielJKUWt0cVEwTkJVMWwzU0ZGWlJGWlNNRTlDUWxsRlJrVlNLM05tU2xWT1NUaDJVRTE0T0dNNE1XdEZOMFpoZEc1bmRVMUNPRWRCTVZWa1NYZFJXVTFDWVVGR1VIVTBRM0pTUmtoeFMyeERUamxIU2pSU2VrTTFiVWRJY0ZGTlRVUmpSMEV4VldSSWQxRjNUVU0wZDB4TFFYRnZRMmxIU20xb01HUklRVFpNZVRrelpETmpkV015U214amJVcG9ZbTF6ZFdOdVZYWlpNa1YyVVd4V1JFMXFWWGRQVjNOMVdUTktjMDFFVlVkQ1UzRkdRVEpTZGtKRGQwMUxkRU5TTUV4cVVYVjBSMEV3VEdwUmRqbEhRMGxFVlhWTlEwUlJkVTVIUWpCTUwxRjJkRU0zTUV3elVYUmtRemt3VEdwUmRGTkJlRTFFUVRWQ1oyTnhhRkZOUkdWM1RVSkNRelJOVEVSQmQxRXdSWGROZWxWM1kyUkRhVEJNV0ZKblpFZERNRXczVVhOMFIwd3dUR3RuTUV0UVVYQnBSRkZyT1VObE1FdElVVzlwUVhsTlJFVjVUVUU0UjBFeFZXUkZkMFZDTDNkUlJrMUJUVUpCWmpoM1IwRlpSRlpTTUd4Q1FrVjNSSGRaUlZaU01HeEJRVmxJUzI5VlJFRXpjMFpCVkVGUFFtZE9Wa2hST0VKQlpqaEZRa0ZOUTBGaldYZERaMWxKUzI5VlJFSjNSVUpCZDBsRVVWRkJWblpIYzJaT05EVjVTMHBxWWs5V1lWSjRjVTA0YzA1SVRYSnlOa3g2WkVkRE1GcHdkVTFTTjFCT1dHMVJXV1pXYkhKdVNUSjVSMUYwVVV0Q1pGWnhhM0pCU1ZKcmRWRk9NR3A1TUhGVGIwbzVhR3gxV2sxWlNVTTJla05EUVhWalEwRlJSWGRuWjBZM1RVbEpRbUY2UldKTlFtdEhRVEZWUlVOQmQxTk9lbU5uTUV4TmRUQktlbEYyZEVkQ01FeHlVWE4wUTNkTlVtZDNSbWRaUkZaUlVVaEVRUzlSYzNrM1VXNU9ReXN3V1VoUmRYUkRlVEJNUVhoSGFrRlpRbWRuY1doUlRVUm5VVTFDUVZKSlRVMUVRVE5PZWtFelRVUm5lazlFYTNwTlUxbDNTa0ZaUkZaUlVVcEVRak5TWnpsRE4weHBSRkZyZEVOM01FeE1VWFZPUXpjd1REZFJjM1JEZDB4RFJGRjBRelI0VDFSRldVMUNXVWRDVTNGR1FUSlJRa1ZuTUhoTlJFa3pUbnBCZDAxVVRYbE5WR3N4VFZGemQwTlJXVVJXVVZGSFJYZEtVMVpVUlhKTlEydEhRVEZWUlVObmQya3dTaTlSYTA1RFpVbE9RMmd3VEVoUmRHUkhRVEJNU0ZGelRrTTVNRXh2WjB0T1Eya3dTbGhSYjJSRGFVdFVSa1JOUlVWSFFURlZSVU4zZHpZd1NsUlJkR1JETHpCTVJGSm5Ua2RETUV4RVVYWk9RekV3VEROU1oybEVVWE5rUXpFd1RHWlJkblJETHpCTVJGSm5aRU01TUV3M1VtZGtSME13VEdkblMwNURhVEJLV0ZGdlpFTnBTMVJGZVUxRVFVZEJNVlZGUVhkM2NEQktMMUZyVGtObFNVNURhREJNU0ZGMFpFZEJNRXhJVVhOT1F6a3dURzluTUV0UVVYQnBRVzh3UzB4UmJHUkRhREJMU1dkVlUydDRTVlJCWmtKbmEzRm9hMmxIT1hjd1FrTlJSVmRGYlU1b1l6SktlVnByUW5wWmJWWjVXVzFHZFdGNU5YbGtVVWxMWlV0bmJWZHpSMEkxYjFsM1IwUkJUVUpuWjNGb1VVMUlRVkZGUTBGblZVRnZTVWxDUWxSQlVrSm5iM0pDWjBWRlFXVmpOa0pSU1VaTlVVMURRVkZWZDBWbldVdExkMWxDUWtGSWJrOW5WVU5DZWtWRlFXZExRbk5FUVZsQ1oydHhhR3RwUnpsM01FSkRVVTE0UTNkWlNrdHZXa2xvZG1OT1FWRmpRazFDYzBkRGFYTkhRVkZSUWpWNmIwWkJaMFY0UkZGWlRFdDNXVUpDUVVodVQyZFZRMEZSUlhkSGQxbExTM2RaUWtKQlNHNVBaMVZEUVdwRlRrSm5jM0pDWjBWRlFXVmpOa0pSU1VOQlZFRmlRbWR2Y2tKblJVVkJaV00yUWxGSlJFMVJNRWREZVhOSFFWRlJRalY2YjBaQlowMUNUVUozUjBOVGNVZFRTV0l6UkZGRlNrSlVSVkJHZHpCNVRVUkZlVTFFU1hoT1ZFMHdUa1JPWVUxQ2QwZERhWE5IUVZGUlFqVjZiMFpCWjFGNFJHZDNUVlpGZUZSTlJFRTFUV3BWZUU1cVVrTk5RemhIUTFOeFIxTkpZak5FVVVWS1FrUkZhVUpEUkc1eVdYaE5NVlJDZWxRMWJVbDBka1ZFUkRSVVRreE1NMUpqVlV4alJVUjBhWEpWUzNacGNXMVFlSHBCUzBKblozRm9VVTFJUVZGRlFrRlJVa0ZDZFVsaGNIaFlkSEp2VVUxNGRrbzBVM2RJVWxsQ2JFbDFTMWxrVDBWdlpVbHBSRGxSTm1SVmRrUktkVVV5WmxaSVpXdFNhWGR6UlZwTWEyMUdZalYxUlRaUFpFRk5UVzAwTmpsNGFrWldSVXAzYUdoYVVUMDlJaXdnSW1ObGNuUnBabWxqWVhSbFZYVnBaQ0k2SUNKbFl6VXhNMlJoTlMwMU9HVTFMVFJtTkRjdFlqbGhNQzB5TTJFd056RXlNbUpsTVdFaUlIMGdYU0I5SUNBLk1JSU1mZ1lKS29aSWh2Y05BUWNDb0lJTWJ6Q0NER3NDQVFFeERqQU1CZ2dxaFFNSEFRRUNBZ1VBTUFzR0NTcUdTSWIzRFFFSEFhQ0NDVmd3Z2dSQU1JSUQ3YUFEQWdFQ0FncDRxQ1phd1lIbWhqQVlNQW9HQ0NxRkF3Y0JBUU1DTUlJQmF6RWJNQmtHQTFVRUNBd1NOemNnMExNdTBKelF2dEdCMExyUXN0Q3dNUmd3RmdZRFZRUUhEQS9Rc3k3UW5OQyswWUhRdXRDeTBMQXhHakFZQmdncWhRTURnUU1CQVJJTU1EQTNOekEzTURnek9Ea3pNU1l3SkFZRFZRUUpEQjNSZzlDN0xpRFFrdEN3MExMUXVOQzcwTDdRc3RDd0xDRFF0QzR4T1RFWU1CWUdCU3FGQTJRQkVnMHhNREkzTnpBd01UTXlNVGsxTVFzd0NRWURWUVFHRXdKU1ZURXJNQ2tHQTFVRUNnd2kwSi9Ra05DZUlOQ2gwTEhRdGRHQTBMSFFzTkM5MExvZ0tOQ2kwSlhRb2RDaUtURkRNRUVHQTFVRUN3dzYwSlRRdGRDLzBMRFJnTkdDMExEUXZOQzEwTDNSZ2lEUXNkQzEwTGZRdnRDLzBMRFJnZEM5MEw3UmdkR0MwTGdnS05DaTBKWFFvZENpS1RFeU1EQUdBMVVFQXd3cDBKL1FrTkNlSU5DaDBMSFF0ZEdBMExIUXNOQzkwTG9nMEtQUXBpQW8wS0xRbGRDaDBLSWdVU2t4SVRBZkJna3Foa2lHOXcwQkNRRVdFbU5oYzJKeVprQnpZbVZ5WW1GdWF5NXlkVEFlRncweU1ERXhNVFl3T1RNMk1EQmFGdzB5TXpFeE1UWXdPVE0zTkROYU1JSGhNUlF3RWdZRFZRUUREQXR4ZDJVZ2NYZGxJSEYzWlRFTU1Bb0dBMVVFQkF3RGNYZGxNUkF3RGdZRFZRUXFEQWR4ZDJVZ2NYZGxNUXN3Q1FZRFZRUUdFd0pTVlRGWU1GWUdBMVVFQ2d4UDBKalFuZENVMEpqUWt0Q1kwSlRRbzlDUTBKdlFyTkNkMEt2UW1TRFFuOUNnMEpYUWxOQ2YwS0RRbU5DZDBKalFuTkNRMEtMUWxkQ2IwS3dnMEpqUWt0Q1EwSjNRbnRDU0lOQ1lMaURRbURFVk1CTUdBMVVFSVF3TWFYQlFZWEowYm1WeU5UQXdNU3N3S1FZSktvWklodmNOQVFrQkZoeFRkV1J2ZG5OcmFYa3VVeTVXWVVCdmJXVm5ZUzV6WW5KbUxuSjFNRzh3S0FZSUtvVURCd0VCQVFFd0hBWUhLb1VEQWdJakFnWUlLb1VEQndFQkFnSUdCeXFGQXdJQ0h3RURRd0FFUU9ETWcrRkUwSzd1N010SFdINEliUDg2SmhFdU9jTkREQ1ZuOG9NTzE3WjNDbk1Ed3FrYk5Bam5Ybmx1c0t0bGVzdnN4TlFlbmt0eWdZcFQ1MnZpeWx1amdla3dnZVl3TFFZRktvVURaRzhFSkF3aVZsQk9MVXRsZVMxVVRGTWcwTGpSZ2RDLzBMN1F1OUM5MExYUXZkQzQwTFVnTWpBWkJnY3FoUU1EZXdNRkJBNE1ERlJNVXpBd09USTFNVFkwUWpBVEJnTlZIU0FFRERBS01BZ0dCaXFGQTJSeEFUQWZCZ2NxaFFNRGV3TUJCQlFNRWtFd1FVY3dNREkxYzNGM1pTQlJMaUJSTGpBVUJnY3FoUU1EZXdNRUJBa0dCeXFGQXdON0JRUXdEZ1lEVlIwUEFRSC9CQVFEQWdQNE1CMEdBMVVkRGdRV0JCUU1Qd1ZXZzZWOUVjK2c5OTZlVEVSbmJIb1E3akFmQmdOVkhTTUVHREFXZ0JSRWZySHlWRFNQTHp6TWZIUE5aQk94V3JaNExqQUtCZ2dxaFFNSEFRRURBZ05CQURURlFuRWlRTDlRbER4TDB5R3ZHU1N2UStwRUR5OXFFOWFNcEVMdWlXdEpBTE0vcVFpMUxEM2xkZEQ0ZG81WlU1ZnYvejdKQ1FRSVk3NFlCbU5jSjZJd2dnVVFNSUlFdmFBREFnRUNBZ3AyamlDZDZ3eEhIZit5TUFvR0NDcUZBd2NCQVFNQ01JSUJkekViTUJrR0ExVUVDQXdTTnpjZzBMTXUwSnpRdnRHQjBMclFzdEN3TVJnd0ZnWURWUVFIREEvUXN5N1FuTkMrMFlIUXV0Q3kwTEF4R2pBWUJnZ3FoUU1EZ1FNQkFSSU1NREEzTnpBM01EZ3pPRGt6TVNZd0pBWURWUVFKREIzUmc5QzdMaURRa3RDdzBMTFF1TkM3MEw3UXN0Q3dMQ0RRdEM0eE9URVlNQllHQlNxRkEyUUJFZzB4TURJM056QXdNVE15TVRrMU1Rc3dDUVlEVlFRR0V3SlNWVEVyTUNrR0ExVUVDZ3dpMEovUWtOQ2VJTkNoMExIUXRkR0EwTEhRc05DOTBMb2dLTkNpMEpYUW9kQ2lLVEZETUVFR0ExVUVDd3c2MEpUUXRkQy8wTERSZ05HQzBMRFF2TkMxMEwzUmdpRFFzZEMxMExmUXZ0Qy8wTERSZ2RDOTBMN1JnZEdDMExnZ0tOQ2kwSlhRb2RDaUtURStNRHdHQTFVRUF3dzEwSi9Ra05DZUlOQ2gwTEhRdGRHQTBMSFFzTkM5MExvZzBKclF2dEdBMEwzUXRkQ3kwTDdRdVNBbzBLTFFsZENoMEtJZ1dpa3hJVEFmQmdrcWhraUc5dzBCQ1FFV0VtTmhjMkp5WmtCelltVnlZbUZ1YXk1eWRUQWVGdzB4T0RBNU1qZ3dPREE1TlRWYUZ3MHlOREE1TWpnd09EQTVOVFZhTUlJQmF6RWJNQmtHQTFVRUNBd1NOemNnMExNdTBKelF2dEdCMExyUXN0Q3dNUmd3RmdZRFZRUUhEQS9Rc3k3UW5OQyswWUhRdXRDeTBMQXhHakFZQmdncWhRTURnUU1CQVJJTU1EQTNOekEzTURnek9Ea3pNU1l3SkFZRFZRUUpEQjNSZzlDN0xpRFFrdEN3MExMUXVOQzcwTDdRc3RDd0xDRFF0QzR4T1RFWU1CWUdCU3FGQTJRQkVnMHhNREkzTnpBd01UTXlNVGsxTVFzd0NRWURWUVFHRXdKU1ZURXJNQ2tHQTFVRUNnd2kwSi9Ra05DZUlOQ2gwTEhRdGRHQTBMSFFzTkM5MExvZ0tOQ2kwSlhRb2RDaUtURkRNRUVHQTFVRUN3dzYwSlRRdGRDLzBMRFJnTkdDMExEUXZOQzEwTDNSZ2lEUXNkQzEwTGZRdnRDLzBMRFJnZEM5MEw3UmdkR0MwTGdnS05DaTBKWFFvZENpS1RFeU1EQUdBMVVFQXd3cDBKL1FrTkNlSU5DaDBMSFF0ZEdBMExIUXNOQzkwTG9nMEtQUXBpQW8wS0xRbGRDaDBLSWdVU2t4SVRBZkJna3Foa2lHOXcwQkNRRVdFbU5oYzJKeVprQnpZbVZ5WW1GdWF5NXlkVEJtTUI4R0NDcUZBd2NCQVFFQk1CTUdCeXFGQXdJQ0l3SUdDQ3FGQXdjQkFRSUNBME1BQkVDR2M0WElrbHo0NG1oWlJOWktvd1prTDBSVDN1L1hOTitKVE5zdFltbHNlZGc0WWRuUEJoNjBNUGUrOCtXS1dZaG8xM3RjbGhnQ3N6SDc5QnllQW4wTm80SUJLakNDQVNZd0hRWURWUjBPQkJZRUZFUitzZkpVTkk4dlBNeDhjODFrRTdGYXRuZ3VNQjhHQTFVZEl3UVlNQmFBRlB1NENyUkZIcUtsQ045R0o0UnpDNW1HSHBRTU1EY0dBMVVkSHdRd01DNHdMS0Fxb0NpR0ptaDBkSEE2THk5M2QzY3VjMkpsY21KaGJtc3VjblV2WTJFdlFsVkRNalV3T1dzdVkzSnNNRFVHQlNxRkEyUnZCQ3dNS3RDUjBMalF1dEdBMExqUXY5R0NJRFV1TUNEUXVOR0IwTC9RdnRDNzBMM1F0ZEM5MExqUXRTQXhNREE1QmdjcWhRTURld01CQkM0TUxEQXdRMEV3TXpVd2NkQ2kwTFhSZ2RHQzBMN1FzdEdMMExrZzBLUFFwaURRazlDZTBLSFFvaUF5TURFeU1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0dBWURWUjBsQkJFd0R3WUVWUjBsQUFZSEtvVURBM3NGQVRBT0JnTlZIUThCQWY4RUJBTUNBY1l3Q2dZSUtvVURCd0VCQXdJRFFRQVZ2R3NmTjQ1eUtKamJPVmFSeHFNOHNOSE1ycjZMemRHQzBacHVNUjdQTlhtUVlmVmxybkkyeUdRdFFLQmRWcWtyQUlSa3VRTjBqeTBxU29KOWhsdVpNWUlDNnpDQ0F1Y0NBUUV3Z2dGN01JSUJhekViTUJrR0ExVUVDQXdTTnpjZzBMTXUwSnpRdnRHQjBMclFzdEN3TVJnd0ZnWURWUVFIREEvUXN5N1FuTkMrMFlIUXV0Q3kwTEF4R2pBWUJnZ3FoUU1EZ1FNQkFSSU1NREEzTnpBM01EZ3pPRGt6TVNZd0pBWURWUVFKREIzUmc5QzdMaURRa3RDdzBMTFF1TkM3MEw3UXN0Q3dMQ0RRdEM0eE9URVlNQllHQlNxRkEyUUJFZzB4TURJM056QXdNVE15TVRrMU1Rc3dDUVlEVlFRR0V3SlNWVEVyTUNrR0ExVUVDZ3dpMEovUWtOQ2VJTkNoMExIUXRkR0EwTEhRc05DOTBMb2dLTkNpMEpYUW9kQ2lLVEZETUVFR0ExVUVDd3c2MEpUUXRkQy8wTERSZ05HQzBMRFF2TkMxMEwzUmdpRFFzZEMxMExmUXZ0Qy8wTERSZ2RDOTBMN1JnZEdDMExnZ0tOQ2kwSlhRb2RDaUtURXlNREFHQTFVRUF3d3AwSi9Ra05DZUlOQ2gwTEhRdGRHQTBMSFFzTkM5MExvZzBLUFFwaUFvMEtMUWxkQ2gwS0lnVVNreElUQWZCZ2txaGtpRzl3MEJDUUVXRW1OaGMySnlaa0J6WW1WeVltRnVheTV5ZFFJS2VLZ21Xc0dCNW9Zd0dEQU1CZ2dxaFFNSEFRRUNBZ1VBb0lJQkJUQVJCZ29yQmdFRUFlYzZCUUlGTVFNQ0FRVXdFZ1lLS3dZQkJBSG5PZ1VDQnpFRUFnS0JzekFZQmdrcWhraUc5dzBCQ1FNeEN3WUpLb1pJaHZjTkFRY0JNQnNHQ2lzR0FRUUI1em9GQWdFeERRWUxLd1lCQkFIbk9nVUNBUUV3R3dZS0t3WUJCQUhuT2dVQ0FqRU5CZ3NyQmdFRUFlYzZCUUlDQVRBYkJnb3JCZ0VFQWVjNkJRSURNUTBHQ3lzR0FRUUI1em9GQWdNQk1Cd0dDU3FHU0liM0RRRUpCVEVQRncweU1ERXlNREl4TlRNM01qVmFNQndHQ2lzR0FRUUI1em9GQWdReERnd01WRXhUTURBNU1qVXhOalJDTUM4R0NTcUdTSWIzRFFFSkJERWlCQ0RQc0UxTjRmeENPZ1l6Nk8yRTk0bEIveDZNNXFYWVY3c3ZWVjFXdFAwY1NEQUtCZ2dxaFFNSEFRRUJBUVJBUkxjeExhQXQyaFBrR3NtSFFTUFFPSklOMkZIZ3R0dUFWdnFZVzFoelFqSkpJM2ZXS3pDVWdJK0FuU1RPaE4wVStFVHdxY1dLQlo4VEE0TmNUVStXUmc9PQ&ctx_handle=xXrKOSKc
Шифрование данных
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | ENCIPHER_ID | id функции | |
data | BASE64 | Для прошивок 399+: 6144 URL-encoded байтов base64;Для прошивок 500+: 15360 байтов бинарных данных (размер base64, требуемый для их кодировки, не регламентирован)Для режима КС1: 16777216 байтов бинарных данных (размер base64, требуемый для их кодировки, не регламентирован) | данные для шифрования в base64; размер декодированных данных должен быть кратным 8 | данные стороннего сертификата в base64 |
ctx_handle | HANDLE | 8 байт | хендл контекста операции |
Example responses
200 Response
{
"enciphered_blob": "M3m0JDtJbNNzBrOnEX16UIf9rWdF8/K5tK7LFHJGGBrRFsTrBxw9HhmJTnI9Q1f0jmG/T9u0mmAuAnuOZmZwcYm3uDVW5Mgi5TIHIuDUuigP9Y+SvHgGmIyqqA19ZYUKSTtPuFRkErxOOCp1MEr2WV4Ff7H9PW1Vt/UJhm6j0qP/hqZWeGCuaDZmtswmEeEfh/Rrvk4SqReVz+az6PwvaxClbUIYH4l+o/1zuGERHgk3UYkNg6WGfuIS91JJ8xxXRqOu5SESeV2YAoraX7hD5Z+W0KIPdXu/+ftboRBJEnaLT2nD8Uy/1QL7SmNEd1j70txv0eH4ZTMXi70CJCo5ANpY4yLos/hpNblUQF288ogdSgNpdxieibOrep+vxx3nV4NBPV0qvOVzHU+b0ic6fwR83bvHFClpoLaWsiT4XFjwEaQBHeH868bRox7H8v+4O4x/B6eNbcsa89yNPnmXml0S8bEbEsos53hHwTHuGzaIsm9FEZSzr43T41Ml/WeICoAoyIEjSfigNtXO9UegnYz1CjuKNliCXNbRCvbMnhayUSEnq5/f5WKiQgxX6w6QBHimQ1FBoszmC9jYaN264uA6d7qgMjly6qrhysVYMCvyMpHfKpFniEaQSxUhmwzICVq5d8r3kSLkLy4Ut8BQ0sLu3KCtC3QksLyQRxUKsMPE1NSUyB4bLCQ5G7j2FE/bWPtCmpgTbhcSon1keJGmsGxUwdhTZYV7ky+Tfmhv85FfQwAHpJIa1ZzoA9nQ1ssQcCEGp0ZBo0aGbgpWSgB84I1i4SzmAiY7OSFohQV0mkbSfBoxKSQGXJ8QxpJFfqXgwOLNE8GyMh1Ysu8eVsE8kYVHUq2mNjbZoZZLSmNNpeRUgRYbHD8J9GcSs2ClM/KjhcKylbkgie/8bBwTb9tHLe+gHJUB05w6d7VipOtHRky+IVuT8FheafEru//Fp4A7y34hhj34dShXU3h4HgpIHb5j47q6/pd+LfrWA4VXYaehKrCo/6Wi6+QVNXX0yw8SmKLjftpzD2nwEKET3rPXONdHJnI8oFBrifiQcZnjz9mnY8JeRRbVbn4EOkBBHriyf7svVVjs4TXnPpwNbibFiA+hvYkw94cx1rAMbBTP0N1Zun8xNESfnR727qLCy7a8s2ENLNlwoONig+YVEvWm+dM7S3vjHYr/VZtHSxBh/q08ulKO/6FPMubGOdCqRauqfxB00eUDYn2NRc9b6lP5t+QX9SYDWoTdcTPPgYgKXxnzLGVRjF0AMDa3uyIyYL4vvQ42+87PjXnKKi9KG6VUORamrYAtfAM+gOOSR2gC/2FADuBAbNngeXoNuCKyaRkHfX5eZ01S358uHs4eoO73ZFVa76eybNFGvSq6+qF/TFi2R41xqGlCL0/ldoWuk0EkxOlCStCA/ph4+BpP9FPggtagilx5c5MRAijTuk46uuPDGg/ejn+U2Hg0TLVY+MwpiwxYPpVX5VdPPmBY0Rrk1KFyq3oOPJm5olF1EZ13AQfYPAQqwWYMkynIPk65M3UtKsPqPgd6UnYEhzPmu4dHwZx6BR7Hi1uynxGgGQEzrYf67t+LtepIZHhgBoO761872f3W36y9YbHw+ZEdXXd13O3dXLCIg9dhLwhdLhyzrJXpswmOQYiess4tHppu4tFBekDYtUy24TT0iO6cYrMrymvXoWypX4mG5LUMkTZVrE34A4dkisE4rxPNW+UDHjqddYbHLbqJ/+phlm16fyOhZ2G2Hd7Mo4GXswSzHg9fieuYBjjISiK9p4VVHwhxOX+K8Uzs6R7zJlXKkeRS72S1PpmbVKMG7byvYfO+U6uo8dK5Q0fvNqFu40m63R6xhR89vVdd44f6o29NO0/vHqyljGhvFl+3X9QxyIHnAIJtpwgpgSvG4sg03wLV4OSVhURqDtvW5mOlvK7j0O5QQ/TbZO8d8V01r3RJvbPeq7jOHiLRXgLAqUeDGWxtJbhSZvGFuwArYnx8hUmLF3iFVUkdLpy2wpzLaHeD+WD7ygJSfO7YTnukzSYMBoUv+sdG6ELK6KjOIy7143WwwiiN+2zxa8t4GeC1m952+GXaszFYcmMOD0os9HpniK6dOAgKgM1wbdAuMNzwhUF4SnDCCqjFDNfqIZsq6XaSp9xkmqT6TjuNuSTj5N2sd7wZr9eeD1MlUUoCnxwX4Avhr1jk1p0lcUq4LdjiuRd2YCgRCesbqwgeo5bR8krB9vQK68yAsZV5EEc9sFkVQFTdFe257lzKufT+Zfe/LeyjXcNxtRqFCCgnVwum4PEmH0sXzYxxxf3wv+BA89TiYMNSIeIPJQkteJBdTvv17Wau+HBNMzwQOJP9Rq/sdn383danE2gxKZuDyRwKGXc5Yo3ll4oIw/i/N1wHK3z9yUaAtl0hN/H712JIe4Dnmq/vujHFR8d9Ktzdhb9V5NMPcoOtLtkz0BJ+slVqTglpWFwoJzBukaGNs+JOF6Rd9DXY6kWXdpbFH8kDpUF87m89mDXCsZERzWxtpjIwpT10JxdlDqe306WdT90aPokz2h5NrMbHkyPgOHrlNMfA3MKuqKUVp0S04nq/t8nfTioboxUx5Hd19+OjQaMV36rWttDvs/6UOBCGnKKnumn10LhMbIPkHCwjNKG4j/l/jVcSfNvQHPfueCnZsVfPnlmUFhXSkmG8Ry91aHKDIgL5+bSltmEWuOPv1ucnqoLyoDEcEKB8si8weLCpL8/iw5INvvKEVkJuKfEKDXQ+7yhGBNLSTfT/XuH8APRzPRrsOnxKtTHsoRo83MeffQ2td19DQSe8U0rS5t05CnrcCPbsoUDSIhyAcXWPAr2lWlxNp4TYgsZHyHMKEtalgs2Sa8J6ofSV2499rpZmxncXAwZtqBSL4tayQPmlBt5V/IFceJNyiYx11N2CnnBDW4Ew0Bm4uRjHgANPTqwz2WTOJPfK/MIDPH+uu1z/NcgLT8J1/mh+ow8lMgZCtLRJ4uIWrBOTsyKMSxSGstGuaTtq7rnk/rkWoKSK9XLm+0v9bFHAv2wIDeSom2xw0bKdmp5xYCZREphlSj4hweVWbsUHMITpWyvIjj07OO2kuFTRvityarGMEhA00nSdiWxsaG0XBOe9jmXd3FUaIJNsLKpCAylRkc1TZW9tFpRdqHEr7owWiPr3w3xjSlaYFXsEgH2/eAnscggcj5BXM1M+6f17hDubIDnGMh4JG+EnEblDvbzj/DNQoL7cPG7N033emMaAuLtWlMnmfB06NgX26Ajh6yK/pGcovzKsWpb0TWJLdS8j3lmmh8JwCBCrO4NPGpE0lnNLmLLWrIcweEHCtvujXE0hxOEvBCCFsAa8gAg5NypD8zS6KNH4wJTeq4EePLABjh6EyL9DSyOJb5Qetnkt+dLQd2FBiqflfGZTLCHQPgXthtJE6eqwy1xdbUSy+v1tvi/ezVBMaascwChJBTuP2c+P1rNjiSmZR2g8N6L1dwmZfaJUOx7nXy4T65ZJ8C1LkiQohFJhZx13SLS2TgPtsfhgG7p6ugYTlP6Ibnu2YsuExcmVtOSx2RtfCYoDYONpB3foX1+o5haGCBvbCwTWeRXYrsBv5wdEg1E7NxrQCaGCTx8TnkvA+XKZ3PNDdvVSXVlPWrsZKv3brefGgNjcNl++eUmMtN9d9Vd/ypT8StWE9kkJ9VHEk3wkdbp9XNnsu4B/wwzbttKQwlVWM6HW7AyUk1A6/u8FQYIqQEj3l5DwmLH3uJgz78pGVL4lCeXc0NxxyyhcFFEoDIChYE7ozpCj14deDbHcMDO1zJeEK5/UjzoJJBghFkpKKuW76YTuCBPTPi1DmOde+Q05AO+grxUrzQMRlVo38NyrCCFWHTKxMMygea25lf4LDOMUVe1zhBa/HauFIyDfNg0u/G+TsxPkDbaZIRnlrSNrjjFumXiRZKD7dG3AvJwC6+sN3gdlYwOms+yv6wCAlAYNsjzjtkb+h8MccowO81Gcrx5NlFY6aJj5tWiJQgb10cTANG4pvahec81RUvznlSYqz1rXnG37oLN/hFo/OrCLCKypHWqn98VVBiyICWpcC0vE1dgZK/inOStYQT2xxKgjGEeVCZfH8yPCzzvrwO+QLPtS//q3FtBLbtJy6M6Uzkbdplf6tkOEg53xh9Dpvbl08qQA4rcfT5P/Kl42/0O8WwoR9V8JWoGemf4ynAJUJ2PNe6NtelsGsIS0FE7Wxjkl2FXxD6dykod2EYQ8vw9sJ+DbSmPZ1BCkoIfDIgpBjOOMvSzmzkLhbCv40pPhNSA4rQvJlI1PyXYD9tUT7I2R5hL+aJX6MEPLn57zblEiAX+Lrysfsd2EV5egKMdL0QRI0HZPHu9kyvVn78Rdu7QuG38vMfDQ+UdXLH663hy8MktT/jrgfxYLUUJZ9D0e5r2eVIOzgCQa4+og6I1v8il/P0JVvVCA7XUVdW5PvL31wqK+ok4xF1jjlQQWGU2C8sktxPSs+20QxLEAeT4lKh52LQkVxDB3Mn159aCEoYsmLvIJbW8vdf0MVbrQRsp6ot9HgvNdgsh6lipKMqVyBj6WWHC0AhMkgtQdcq6FFJb+RDjIYiWRqLP5qIPIIBfSgl9DRw9EPY27ViVoityYK3XkCMwzNbHv6NiznIrd1hbHXxhFXkmszF5GME1doNafjRxOCW0D6VCuAxkSsolZd7EqPjy9fRofTILXEqdl9MyvRwk+3fZzzRAClx0bt7ahWx+rYIuq3flbNGWwnJwrMojcrq1SGzwP0+4HJxDBnp//wjFnVW9U9qvuSowHeTpu2fv0k1g5JQ87NMiI6mgTlBL32VguMcr8Kdd5Zade2xyzChENvT7ojFZczu/bKkDaWQ6D0BLV70UxPOjqpfrxLS/gwPVAMvxcwK4Ojg1jQF/rw4cOVsCL9DlpDPSRJJoabrVbd5/QKPJxKu4n0K6Zp1vGwKCf+XonsOOqsalzVOJqD9PE9hfQQBZVlLv+isdUNiPYdgFTGRawqcI3BDoS7+ZOc2SNDYMZ3Rn0dvl90dMc3gtnKqSAvexO3QB6V5m70VSXIGAHWD7LqS3prOW3Hg3rcbgR8psEUDzvmkDIUj1DRhUF0bMyOyxuJreKrNos/hWnjJMuYLXc+lCzTrgdUXK18DT4/83eYz2NWM7B0j1kUAjfmtDVeyuPUgGkDU7vTXnJQygvHPNStLmGGlSVqbyEb1POOyG1h4FuujecOTrrgmMyw9m5ltmy1KLxXVAhNIc3e76lQC5aiOSPOxDqPTcJ+o6uR75k0Z3s7IEU2Bm5aPljeHmKpLDArn8a2L7VAQwFjCKQmgUru3188W3MUjHQ20HseBBzztMezYGvhgJ5MOdKb68THHrH1O7TL4xlzxY86XbJyKKS/EDGB/xO8myDcBig2iwrTyO9IgXqhf5TWXfsceUqPm0Qsd9BAGzaPlOft6pRpXeTDODPw1/YrLKgJSwY55/0K+FfaMk5hudr5n65jTafxh4wAUrfZfwMmc1hHxedGejXbmRM2TjldhZzngouK/uP2V7XOHVwV5tQeF+cVqD0gFU+HkH6O+NfNPpCFCYN/inftIxuPD8FEsQyjYHcKpdCguh6e4mNl6SpqHPBTkQo/7F8Slxe3tOuNAqW2gPA1aiFsyKJx4azJoHxQAX1AEIpL37xs2hPqTszxkjqxeY/sws7QfuCfkZ9Z6lUKxC7jsyKXHKmlmUWNLlcNfM/nOT4momrFsLD1FA8d6KWzMPTluxQKAlDkD/VYYjpuAiPqw5cH7lJKecu8h2nnsOy7GaZCExcXJYMnBXLrre0JdyUoIlROFtEcz3grPltEhvaN5/aOXDHwCRgg6vNXJGh+AjtxgKq9LRq+Bwz7k64ucL68QqX6DmyPAVxkgvnJGO8psfRQlP03vzqxG8PQLJKMmXzo+dpReC1o0R3SqSYTnuyoYBe1BLRTX+MjTKRxRO6B1cXrvnfYtC0mSUifKf7KvDznReNsUd+AkZ38E8rp8Itvmbh8AsuDkXZHxpICN+jdruU+2I20uH7++BBCRHi4k6qo/3LI7ZEu2XQmZYdLvygR30DnvpDw1ynK1m+K3gvvTW0FUaWcJMiSn0/QB59+1CoR5CMiNSqkLEbsn5t60bW7wMUmETvJ6c7ug/sfTgzadr/zHniyTpkYBm7kPwHT7OlxUDU7C4h+3PQ9o3s/StEcsBfw/FjqnJVL8kznUKmVhMy0hmpcFEwr0eEslXEPtgixGIbg6elBNX6J7bj1hfrb2oozL4bXjtX94SAG84mmvObz4q2yXXmnh21rvf0ngOO9oMZgfN6tD0rlnNF+MV8HPftAmnlhoUySbjmeOJdDnAgAtntBv+K5df7dOFI1ncEqBKGazK6gTaaCsCw9dZRgekRqWZmPCxp3YMR8mbciIcmK1C6L4ar0tpUvWU8ExJXT8HTn/HX2zn8RUvgWXAjeHobBdNXc0dDk05Sy9CbDeLZbrCT84RXvn1Lj8ZGtr9E3i0u6zf09hFZVcSAePIULCkMLTG8BSugTZazMHYXEgGW4QGtlsDBaaX8I94qhEONHJ6TVBRJp+TDILQJonRpZYOEYoP0f6OAGqobaay5FNvQ9kCaovaTdliUanr0IGxxVLEVDLkPgZL94QGEOA3iTnXRd49ex3sxH/6AlIlyIA9otfba2XJEOpQy1e/V2mA2WNfcTf54vj14M3XtVkq41BcpNptUagYb+v0Bsav1vxQhf3zSmxM0S9tXAPbKm8bl77NFr9kDpguCtCv5Rsiv1sKtsFtDbjF74uyBGpjRrq1MEwsoXiv+RrQORBd27nq8IMJJQ+zDrK2pWoNtPsz4P02tm8vVUajkExxy5VAcyzlmFOuVrouu+DcKg+Bvc4Enqcsm4+rV92mplRNyoueumn41753cNlbVbQ10JEnVeKma8gVgPjeZE6QKsDkV+X0B3+Rmr8FOiF6wAfeUIUSKZyEAwTSSByg2miDjRnqAMVKzz6WsZRmQhBI1SZoHCa40lpSuzCVGdX0+KkuHm4a0YT/8GO68ZUUhNfmY2jw90cGeC5WxhCiOKUlaGJa8fCA1VONrIlOvryzgBVozVlrCDHysdCeEsLRHBX0a0oQ5+96V3Ewe8UBteCCXPUXc/ZWbFWX0ZtWmf6X7EUh1Lu1CtTGwi7gWcQObOE6F0mRZSXu9VzRLmRez5HvMpb5t/h7R5AXFMMl29fr/EjsnzmevGiFbzKyR7lip6nZUE26vYgZXJDzRd3Tn0kKLnPaSTXeOT1CZdY66cPS9o/Mvwf6gIvS92r/xYqvKKdlU5k0+bQ7Yn/B85Sd8ko/mW25YR/7DxYueiwdkBJW01amkUzJc4nF8fNF5IQRASebnzYHZ4cPGBnpqTHStBCurZnQujwHWvD8FxTd++Tk6C6WH56tQ/Cf+boFfi3tSEVIyWBPXJxyBpX33fo/SVQoJRK0S3Vno+EXzdNLY+bZjMeMaSDkM8uIqf5IrBvTXylFq3/58mHZB1SX9KuiqGFB3Mnq8DXIrPUyToun+sEn9u0fz/9MhXQVh3tIsU8AsQgDHUXaYWaOLBi42NZpg4wMM6B4YkdrC1M97fL7zFvvA8OhRDUFezhAWybaOh+sbrEq/+OPgJbtSGj+QrT5RbsusqYYrgl75abPtPS/RsRf/gvW2bbrawxgbJWjir5fno+sokRt9dJ2CzFIFmJNIPnTeBG6C5I61xuADtdDMWLab3liAKG684ZNvBkyljlv/59+mSnL0esceNVEzf57DPHzw1GKmKgS2YwmNJJO9x1N1uaLMsfUNPocHFKJPuQxMpgqjKVxM/8NtGNNUQdgzr5/HisFBZ7AIhKskxlWvRlQUPlkOosavEnLQyAhGdHzDUD5d6GDDdWWW8LJSx6vf+BM5v73xMO12AbeXS8YCl7Y2YVdWVSXLMoyC4MIO1THCWdPWhLSduBsYKtXA4y1CUSfVh7YQ5dPBQuZl+xNRG0BMPKIHNgkVnERNY8J4GLPPuOHWGf/RKOIKCbQQ3UnlbjS9zGH1yTOM6lnuGIXg1nCT2/i6Fie4+WC0E5zGT7o+ObUi/QjX/1eYPELSJni22ykVR1ls9pN3pkieWtU+c+X8/jiLlNyVAwG/MwzBhgH6JY/ThOBlTguydMk2dKbb4xLkE86LhBxOxdBZLj9uiR6YsUFA4G/Bw+vBGwIYodEvpt4z7Q7X+41P55PFO5gTawtTYUCStzcJoPyhgMIUgs0oMx+YLfLr8q/LxZAtyQWYg86sXjPlVHJYU1p4/xy0gI1k6h07yIszob43JvwflBcskLW6XNHomyWyeLdqTZCb1hJ70y9vQGtH1kyZ/pLhLLA95mVlEC0A490zgtMqTnqwl8/iOBUiBcFKAWeCXbUI4pZIjd7R0IHxLAcqxYMoa5OVbF0e6mpHMsuVdjD5UjRmu1gG+ETzxicA6A0pwLeO46sr+zlB2/PL67oqvVptrzOeVss18AS+p7YJ34Bb5bUDbZd4EbcCxy6RedP1LT74Y/khFCA/RPi3RZ2qAPu0OghPy6/M2bW2t0DA4uw2X7BHUg8uFKJOzpB5LzSCxRT751FvHh+sJETfY7cg1Cv2dX2OKjBrQl6dXrhN9ogNApGKkHfWzdjq3wUcQxulmsvYwn8sL9dmoftr3c1w5hb0Gw6C/ZvgyN2ZzFHcrs6IAjEQqyP262VAuf8+DHrhP/CEvScgXT33ZR4k8r8og5EjrI0PlxUQDa735DiVMuQieUi7TSWZAUg3PccPlag4RLQ20sag4yVWOLFa144NSXyRmKqFvidh5XQKykTo4bUAOMTWcC6+Tf8E+KQ+mHZndHj4lwBaX0vvVL2AmDsIk6q88jdm6Q+4/wOvDRp3k+UEUsqhNUCaK8TJzyeFgnteL15P3hx6hbOaDekzGpK2fashj/QM16OtKga/Q1JU5aMJ87iyB6qeTwxmDG/zBrYNRM2gqi3ltJq2a3MlyMjEFOvghhVPXitohfXfTeXa60hZCRBDJlD8Pm1PnLUrOlcMX6ViHIUuOaB28Q5SUz4f9TD0VrmoC8ikfuX/cpqrlWKQxSeoxm84yMbue3/JbqPrmFJ7neNYzV4clwrtSwvff9kf2teL8oGOQTxxEeqKXHjC744xOIXOPC4S2FGvyeypWe71Glm9j89cpIsI41+T+v5d7PXrVabczX93R/RZ6YN/M5H+ZLnnQuv9IFtgfGAP5xAgmdTVVxQ5+p5yYGh4/tdnwLc/z56TxvyiUT3ABS5PgAkbCAxs94L5J+sDiHNmuPgY4Ok1QzRhIm9EPl1JR/tEBXVdPvL8l/nkUPLq4ZnuyslekJEUNbcrCSpDGSnUMyoYUBhhbCf0JOwD953zjaqMo2nKntVMT6pcSxNmRsQ43y6HJ21qHVrZtYGKJB3N5Tx25dTXfFLaQ3gHu5MnBlOsBjm+8rQYlvdtZDALe2+EE7xf6Rxoq7va1/B7q0q544CABcLBXLryBbkPVPJLWP7+Auvk/NjDVPTCKHHYxTI20TeRmMj2F5ZHJVJ+6iJ2koN0OvcWsjVlLvWz3KbsCpC+50I7kRDF+pVa+/41gexWjVfD/sgq1n3Mo9dKBTZ7CeE4iCPfhMQrKTXa/flAB12uhS8reOPcuaO3uOYVJfyvbA14EhKnYl07LJH0lxOPiqqBoCDAUq2GLe1xxN7dIxt7XbhL0TptkgYbI5BNrWEsZ7zrLnlQZzjda9zIicZebigMyiHkAhhxd0miCkEpHKe0kzIAoIAw8/vTg1AWRUJ/y/mxyF/PXQxcYbkyk1Uphg1CRmU2q0Szbw7G5aqY5WXlN/EeTQTWxhs853eamI9+U8RX0R2w6ZWNPiC56GVqqeOmZ3SDbeYD/Zcl8Z0uqiwUzpPgPqKDdL741QUKBzMCsj+mIALt/2jcZ7OGdhIiriPLxDrDECyaOpBpgzZlP9HTz/2mIQYfZ8Qst0Gj6ng1a4gF/a8AIcOuy7XVd6Q9wajWCgQqICllaV88gmCf3cFWjiV1wJeic04A0+R6xzOIOW+ZR+S8ZRqTP0HdKJBqSuCZ8rITqhuV1YSwuF8TWCxbSauUIsZDVkxk81fXaul6/UV/n1CytYpmaXkzmlLDnbuPecpY4aWaJ6lkBC6noPthkEMKj0oPfXcrRHRaDjU+xHxrRC9o5P4e1UmPo3tPP8b6SQ9X6E50+qrQrGMy06FGbAC05cbEj7hVZcb2KO0+Z220AoYG272PmlAH7xuoLro6ndUsAqpNBC/czm0hwUw1ylfJWWTTX4Ga7nIpimvTMtMUR9ojJ9EqrmCMxEQsHsoB233Xt1o5Z4R8FOshqNj0iSkNo0iuwVw2clBfxRKm+amJISCOoLyx+rECC62jxE0h+aUNv02qwl/EkoyLPU5i4GPI/VbEr4mEGALRwkGfImLOUV8KmVAaDaKLVYTJQ+xR+FVkTLnlaIbeaZUFA3IPclNu//aMQ0FwPBByZroFbHNB90oAu/MNF4/CFTkuCNyf673oFEShTJc05yaAGyjJDkR6dQBNfK0iAUGnBX4dDbXlrdKPXOIsRxGBH7oBrex43Qg2rXQ7FrAu/zv+AuZNgXDka0eEe5rCbBGqnV7e3cVETMkUvgMqb3B7L1BGTgc64rB47gm39V352NjqrIWRnQ3nozNIz0lbI9jXwduDIkB1MUdIloGhIToqg9gk1oucRboqo4KqFZVNm7NZGGDGV2VoewLasKi6ZY4VdX2JlhiyyKI2VHD0Vj8dvm06b2RQsXoPdJsed5gdQQGNj8smwFHwENOUqMz2CfccujSN3rzR2RG0kUws6ftpkXY9mOmFCsKAzKvNNXvdkNLPKorMqB9s7cad9IjqkBtGjuX7VFobR6d+IP1PJPCo7C2TwwrX4cUYVhTSm0rv0Us5qYBKQGIXMcpUEg93GaKQcmnJgBrMdpicOFrx/jZEOTa4pZ8S71yP83eUJaSWNXUqFrTajCWa5ZuTNCJFb3S1DVkqjTMNOJ8InPizXA5C76lcN9WKR63KsQXrJctpH37hvvdEM+lSoRjX+GeJJ8LeQ3Q7d5PkU9NpvQmM6ldD5GJ5h+HNnspFO/RTt9n2ZijKgXGc81HoOM2PmbgtU4NEHL66Lljt+brIGjdQ8lmyJ+hEhnjUSGjcv7tpXI/SIES2Iy/6UPv76JjpPups4sxoWHmLyb7eTHY2uPJQhFvflpGTKRfYD9hXRQPEW3CY+8yGlD2wr6QJaFaGMl76y4PoC9igENljZbcp4fbVKjf70jHEttD3taQAs6wYS5JnK/d7E6P3l9dBHgDQnya7nfLYJuvPnIsIv4j9y//xtD4n+LXnFxiBnOou7sVu1cmVR3HIf/ranmvm2YwDCz6AIS3D3NfYxxtsthBjhBaMjBprHGQiwzF0rFNz7RRrojS/WWbE+siJzCs8dr2+JJ98AHireAlzurEcLAUiXcnrr7ajQXehCbFDE2OONf7XrCV++kj860Yb7G2XOoRcq5HWkQ7xJwRpNid5iPBq1PTeaYiuyLwLeF+gy6Szpwz82xrNdQyObTOWexLIL4Qw4GFpTxS/7N/iE05lrFkBEDmCByULwNYOOnMVAUIHC3tTxaSBrl6HdQejBwup75NIJLSNmScayMZLgdPe1LGkGwqAPxGJF0HAXO+E9Lb4hmnBkr3kRk2A5i0L/RMzhoSIsXUuAFU2hVbu5NEIBoKpFrG73EFqfFhmD/Vo+gWRzwoj69c6eVJp4/Hda69fQcgIxfIYH6fGmRc/j97yxRuqMrpuWFKXivXnKrGUCHoOqiqaZkQ1T7Qt1pkZ7fnoQNc3N709XS53tJDSPPi+rzWscnxFqiNIaqosBLimlYU5In9nuoJPjBxo8MDXrXjpFLy2gQHncRq5RYdKiZQD8Z33enZqsHAofzL79DQx6vEWMo9CVHLHbRqj8LcQMY3WV3pOB0e3eXLKG1T+I8qDolRi1Tg7iPuQjz0RHEvkKC+gPsmUUojFOkerBs9VPuO5tIW9Qpaf1i8dRIym7uglqRvCjL1zk8z0fLncdF03BinGx9SxnE3nBtu15jYbUOjtpqwiRJJ/SHU4xY+y265TMYHi5pXAy8QSgijzsBnH1f/s3uIRBxWkVp7AmCcZMA3kuGl2XS72Bbq6ehroWcIzEZRXT+YbxiOy97dZQTK02ZMDGk7LDFqD4RswXogxrRRv6R9AcMIvUnpahaebF5yEGXw8Donqy3OSmyHfdfCQSl8DYUUkWxLbv4gWq9aBhpc6OqkJYZzT2Uz5HmSho7V2oKxpXpLV/ImhYxm3Q1qObYSN06pr7ZclP/kzLkruMPleHPa55IgCQxh5jKyrkO89NrycQ6jN1cwRAzFHQ+Hm8XVk8CNWCMNMhwD8PVOc6RJkcpvxZKuHvdu+G/H9nUFHxBh8BWcgAZKP8WN59b8ZZsRkNj7psLf/ni3ieiGba/oIDp13N+m/ZWzt7NaVXno4gt7ixAFkzmI8WeaUoPg1AvmHW1lnmmQSJhWho3BifdgX0oowrNmYmP4dY8JOgHkKHbDqe43mqrPQPQtV74QWH5iPG4jcx3xgBhjHl4x8U2zCMWhqYkewIPcIpuhy2r7/0rdZ5T+mV+ag5ilH3IMQSzp5Ef5tBnQVCmPIceHwluY765Mj22Cfgf6OT28BCGjJSVvUwjvWkeBVfivqpFLp7ujdla6otphKU1/wQ72mFMB5d4ni/9gNA6TvZ6yaIhPxMkFgaahNaZZC9QqN6QZsIwQcWHK/5rWfe8otkkc6vgSSQdVMjW9aoeT/35T2wlTyA92nL2/rhejpYMZJcCj9B8rr1Y1uIIFqXoDH31//QqZJRdnVqOw5TLMiPVDTolB5k5rtF69ZkUogQERYwEQGu/Rfrms5pe4fbqT7+vkjpvhubhvQ9s6uKj2bXm7DiDNn8G+p7TdzSI9bX1ABMjcvMvNWSMjabPkkHjUAGFDCoDVKopyP3m/iMgMWyrVwY5eDY1mt560+IhQPOReHutMAy/5QGgieI2MhRiNd4I8JszItAVRsx4w7EJhAH6no3yqjReahPtlnDHr+Bmq5wXEHue/K22ThHwAfDDZrA++79hr+eZRsXFulaKadyoBh4Epvajul0ZYyDfVbTG87LupPH4T+E13wWmXMH7SH0W/d/UqHLNP02ScWYTTfpRkcFhCVN/IjPxlQRuB90oz5P8/P2jfWHWdMdUWmgcWHvd32X4pWgKCtJbUXHh2dchq4gByS/Y8jtdIn100lfWP5wjoqa0J+juabYn9f6Dy38aelPPipERK6ddrEKei8jQ5aEUugwCGFf37n2jERja8N42RI1sLBKPiKMbFXUTQiXtYLMcooKi7nkBEjKjTxZjc4LXcZqiPZRUQtRE1UOuVvh0yw76ZEONXPPBJjBYp5QKVKTxDnoDj/rmn2P/jTul3TeQ2yVcRbOcp1T7F9M5hiTeltNv1krWVqyIZvRdqBorywkj7jIZfiSmGydP2KslKsNcqPfP6gYCnZSPRE0jB4a6Yv8nbSsUQ8GLJl+AOCA0J+rzwtQ1ba+iTCQsPIJikYIWynG/YFzAZYqd2bmCg8yn8l9U0wiJoWtUIo7VjJAmR0tqrhvydZ9kH8miVyn/Allq8K4iNWxx+V9dYallKFSj55zhZrDNUzAo22I0v2Vl3PZnmUfVSNp+80Vz4yj1h9I9G6RdubuLT+MRCaqCMneLRVnGrTaPOW7dtYkGV3UpBRGuv3p/w6lGhdMikgrHiD5Hynp4nl15iDp7hPUxttnBBIfLOYTeC/dLRo5LRnlPYBK89780hR3LJxJ/NUVidoWLu1QDAAPoeH//EDa2UoN3rIVHSl4Yxh1Du2kI6nx1xEl6pMife89CP2cie9edxWqggmoXWfCk5o5TaA81JgR2751nLrvzGacADLl5AyEUMM+qaK8y1hlziSGPMUwrKEQPuLYapRPdHndkrMBFqDYpTdw50gy/H3p4o96YAIoLseQxrVrr/b/cm9bcXZIyqxTjYlrKC3hJBxxd5PlH/tbp+SLcJHQEvIw9R0J67V9fCaBk0aU9Ty46JCBOsD+kSyWJ6yQ9+h0r5YPKghrutx0EBURx5UA4FLJUKBccdtl2k70Pr/qk491cNJ1QsHO3wpIhu83C7YULCafYm2BJ0JGHI5XwjOlUGPNuapQ2f/83riRDf02+3YHEeU8zfli/TZWo3DeAWAXcCBi8I5y0SXd9zB0FUF8wX8RGuZvdP/P3+6jUfrzvhaoltFjPUe8wnRGMlw7cn2OmWaEjSI90rXW/3sqsMHnWjqSjlE2AmEIXCsUcniSEwN5t0mzQWXblNLmEJVoXwpKeId4K/f4tNbCDvaSJtUwLMJGzSVtLgUqz2VFe4YPS8/uO3HXtb7ZIjT4hIyYKK1gB92H+iehJ1H0WSDSosQJ/rfvGfPbKtOyd/GCr0iKBkV+CBhq3M6IFZVx24sXmH9NAfsGoOpzbBq5GnE96gUMc0BBh5ADZY5SHYcc4ecAeZ5iD8tnPLm+viGCOJeRNB9FuQSEtpZqSk2ulzFdo1y8u1LJEq8QxetElJ5s73WtypA21LIZWi+Fm+MyxRTQTx+dmRc2sZ+5IqTPPMAvxSNJdTyXxe31ybzDKMdNvD5LBlZb+8pVR8L1agxkBWDLXq3BeCS058hJTFNyvh/F7/OQKK6//A9TMlRydB1TtlCVYLF5sQMtyG5eFYptGzkpsYTn6musMYO6NpRDjVvN2pCfmBmRGWpTpoqNn2OZ+SfbagJGAukmISQqS3svhLWfL8eqRCrpTl7sqs38EQWrzmWpoycRMfpQv+IknEH0ujVqXuvrELl6s4/cCTskGLTQLdhbJSv+kiJ1PpbSw1+W9gmd0DrI48RKIJvR43G9ngHpMLHVEJ0JSjhCXfDRlxi1DTrSXAuiUBse/O0Twmrqx7aUAn0OrWklBcE2/5/HBgNNVV7L73x2fpUsLAsAUayRz7T20J0Da5X8pJ/9PFL9LslGWlwhMDcYvqmLV57Qdxhno9pkKWUNzy8R6h9WfR6f274uQQaiyWPyMova+F3wq4x7+1qpvY+7/kLLKuG3EP3PKBStN4YnnmTEOcLy91MAINW0HeoTL2eHDSJ2QO4DtHx6yHwPdLPsyk15PsvSXaYEJUJNmIQx4Hhp7MoARFSPmqyrwgVrEnSo9NvtknlgjNba+EslFhSnfywLacbId+dZ09h6DT10iCQFRgZZK3E7R5Rnyrb7caSfpeI7btFfeiOsPPr"
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
enciphered_blob | BASE64 | Для прошивок 399+: 6144 URL-encoded байтов base64;Для прошивок 500+: 15360 байтов бинарных данных (размер base64, требуемый для их кодировки, не регламентирован) | часть зашифрованных данных для CMS | |
retcode | ENUM | 2 байта | код возврата ф-ии |
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/6LbqY8D4zqDqTMIzeqoBTSto5rS6Ehq3ay/?id=GET_ENCIPHER_CMS_ID&ctx_handle=xXrKOSKc
Получить части для CMS
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | GET_ENCIPHER_CMS_ID | id функции | |
ctx_handle | HANDLE | 8 байт | хендл контекста операции |
Example responses
200 Response
{
"head": "MIIvQwYJKoZIhvcNAQcDoIIvNDCCLzACAQAxggJW",
"suffix": "MIIszwYJKoZIhvcNAQcBMB0GBiqFAwICFTATBAimJbSBo3saywYHKoUDAgIfAYCCLKE="
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
head | BASE64 | 2048 байт | данные начала CMS в base64 | |
suffix | BASE64 | 2048 байт | данные суффикса CMS в base64 | |
retcode | ENUM | 2 байта | код возврата ф-ии |
4). Формируем CMS с использованием зашифрованных данных в соответствии со схемой: Шифрованныеданныев_формате_CMS = head +[Recipient_info] + suffix + зашифрованные данные
Recipient_info – это ответ на запрос id=ADD_RECIPIENT_Y_ID.
5). Полученные шифрованные значения JWE Protected Header и JWE Ciphertext
Пример Protected Header | Пример Ciphertext | Пример JWE Compact Serialization |
---|---|---|
eyJ0eXAiOiAiSk9TRSIsICJlbmMiIDogImdvc3QyODE0Ny04OSIsICJhbGciIDogImRpciJ9 | MIIvQwYJKoZIhvcNAQcDoIIvNDCCLzACAQAxggJWMIICUgIBADCCAXswggFrMRswGQYDVQQIDBI3NyDQsy7QnNC+0YHQutCy0LAxGDAWBgNVBAcMD9CzLtCc0L7RgdC60LLQsDEaMBgGCCqFAwOBAwEBEgwwMDc3MDcwODM4OTMxJjAkBgNVBAkMHdGD0LsuINCS0LDQstC40LvQvtCy0LAsINC0LjE5MRgwFgYFKoUDZAESDTEwMjc3MDAxMzIxOTUxCzAJBgNVBAYTAlJVMSswKQYDVQQKDCLQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiAo0KLQldCh0KIpMUMwQQYDVQQLDDrQlNC10L/QsNGA0YLQsNC80LXQvdGCINCx0LXQt9C+0L/QsNGB0L3QvtGB0YLQuCAo0KLQldCh0KIpMTIwMAYDVQQDDCnQn9CQ0J4g0KHQsdC10YDQsdCw0L3QuiDQo9CmICjQotCV0KHQoiBRKTEhMB8GCSqGSIb3DQEJARYSY2FzYnJmQHNiZXJiYW5rLnJ1Agp4mysXZybjyvhIMB8GCCqFAwcBAQEBMBMGByqFAwICIwIGCCqFAwcBAQICBIGsMIGpMCgEIIxzsG0Af4ShXKB+aCQPQDaEJS4gEWnaeatPMi/t4ChSBASSfJgYoH0GCSqFAwcBAgUBAaBmMB8GCCqFAwcBAQEBMBMGByqFAwICIwIGCCqFAwcBAQICA0MABECBkzEtLzyUEh91WlL4yxG2+zEok4tNgPobBfzAXMoLFE3tjo0ZiNEjFVIJQSVzumK6ROBzpvvoREmjDKkmWh5sBAhSNQI2lmQKCjCCLM8GCSqGSIb3DQEHATAdBgYqhQMCAhUwEwQIpiW0gaN7GssGByqFAwICHwGAgiyhM3m0JDtJbNNzBrOnEX16UIf9rWdF8/K5tK7LFHJGGBrRFsTrBxw9HhmJTnI9Q1f0jmG/T9u0mmAuAnuOZmZwcYm3uDVW5Mgi5TIHIuDUuigP9Y+SvHgGmIyqqA19ZYUKSTtPuFRkErxOOCp1MEr2WV4Ff7H9PW1Vt/UJhm6j0qP/hqZWeGCuaDZmtswmEeEfh/Rrvk4SqReVz+az6PwvaxClbUIYH4l+o/1zuGERHgk3UYkNg6WGfuIS91JJ8xxXRqOu5SESeV2YAoraX7hD5Z+W0KIPdXu/+ftboRBJEnaLT2nD8Uy/1QL7SmNEd1j70txv0eH4ZTMXi70CJCo5ANpY4yLos/hpNblUQF288ogdSgNpdxieibOrep+vxx3nV4NBPV0qvOVzHU+b0ic6fwR83bvHFClpoLaWsiT4XFjwEaQBHeH868bRox7H8v+4O4x/B6eNbcsa89yNPnmXml0S8bEbEsos53hHwTHuGzaIsm9FEZSzr43T41Ml/WeICoAoyIEjSfigNtXO9UegnYz1CjuKNliCXNbRCvbMnhayUSEnq5/f5WKiQgxX6w6QBHimQ1FBoszmC9jYaN264uA6d7qgMjly6qrhysVYMCvyMpHfKpFniEaQSxUhmwzICVq5d8r3kSLkLy4Ut8BQ0sLu3KCtC3QksLyQRxUKsMPE1NSUyB4bLCQ5G7j2FE/bWPtCmpgTbhcSon1keJGmsGxUwdhTZYV7ky+Tfmhv85FfQwAHpJIa1ZzoA9nQ1ssQcCEGp0ZBo0aGbgpWSgB84I1i4SzmAiY7OSFohQV0mkbSfBoxKSQGXJ8QxpJFfqXgwOLNE8GyMh1Ysu8eVsE8kYVHUq2mNjbZoZZLSmNNpeRUgRYbHD8J9GcSs2ClM/KjhcKylbkgie/8bBwTb9tHLe+gHJUB05w6d7VipOtHRky+IVuT8FheafEru//Fp4A7y34hhj34dShXU3h4HgpIHb5j47q6/pd+LfrWA4VXYaehKrCo/6Wi6+QVNXX0yw8SmKLjftpzD2nwEKET3rPXONdHJnI8oFBrifiQcZnjz9mnY8JeRRbVbn4EOkBBHriyf7svVVjs4TXnPpwNbibFiA+hvYkw94cx1rAMbBTP0N1Zun8xNESfnR727qLCy7a8s2ENLNlwoONig+YVEvWm+dM7S3vjHYr/VZtHSxBh/q08ulKO/6FPMubGOdCqRauqfxB00eUDYn2NRc9b6lP5t+QX9SYDWoTdcTPPgYgKXxnzLGVRjF0AMDa3uyIyYL4vvQ42+87PjXnKKi9KG6VUORamrYAtfAM+gOOSR2gC/2FADuBAbNngeXoNuCKyaRkHfX5eZ01S358uHs4eoO73ZFVa76eybNFGvSq6+qF/TFi2R41xqGlCL0/ldoWuk0EkxOlCStCA/ph4+BpP9FPggtagilx5c5MRAijTuk46uuPDGg/ejn+U2Hg0TLVY+MwpiwxYPpVX5VdPPmBY0Rrk1KFyq3oOPJm5olF1EZ13AQfYPAQqwWYMkynIPk65M3UtKsPqPgd6UnYEhzPmu4dHwZx6BR7Hi1uynxGgGQEzrYf67t+LtepIZHhgBoO761872f3W36y9YbHw+ZEdXXd13O3dXLCIg9dhLwhdLhyzrJXpswmOQYiess4tHppu4tFBekDYtUy24TT0iO6cYrMrymvXoWypX4mG5LUMkTZVrE34A4dkisE4rxPNW+UDHjqddYbHLbqJ/+phlm16fyOhZ2G2Hd7Mo4GXswSzHg9fieuYBjjISiK9p4VVHwhxOX+K8Uzs6R7zJlXKkeRS72S1PpmbVKMG7byvYfO+U6uo8dK5Q0fvNqFu40m63R6xhR89vVdd44f6o29NO0/vHqyljGhvFl+3X9QxyIHnAIJtpwgpgSvG4sg03wLV4OSVhURqDtvW5mOlvK7j0O5QQ/TbZO8d8V01r3RJvbPeq7jOHiLRXgLAqUeDGWxtJbhSZvGFuwArYnx8hUmLF3iFVUkdLpy2wpzLaHeD+WD7ygJSfO7YTnukzSYMBoUv+sdG6ELK6KjOIy7143WwwiiN+2zxa8t4GeC1m952+GXaszFYcmMOD0os9HpniK6dOAgKgM1wbdAuMNzwhUF4SnDCCqjFDNfqIZsq6XaSp9xkmqT6TjuNuSTj5N2sd7wZr9eeD1MlUUoCnxwX4Avhr1jk1p0lcUq4LdjiuRd2YCgRCesbqwgeo5bR8krB9vQK68yAsZV5EEc9sFkVQFTdFe257lzKufT+Zfe/LeyjXcNxtRqFCCgnVwum4PEmH0sXzYxxxf3wv+BA89TiYMNSIeIPJQkteJBdTvv17Wau+HBNMzwQOJP9Rq/sdn383danE2gxKZuDyRwKGXc5Yo3ll4oIw/i/N1wHK3z9yUaAtl0hN/H712JIe4Dnmq/vujHFR8d9Ktzdhb9V5NMPcoOtLtkz0BJ+slVqTglpWFwoJzBukaGNs+JOF6Rd9DXY6kWXdpbFH8kDpUF87m89mDXCsZERzWxtpjIwpT10JxdlDqe306WdT90aPokz2h5NrMbHkyPgOHrlNMfA3MKuqKUVp0S04nq/t8nfTioboxUx5Hd19+OjQaMV36rWttDvs/6UOBCGnKKnumn10LhMbIPkHCwjNKG4j/l/jVcSfNvQHPfueCnZsVfPnlmUFhXSkmG8Ry91aHKDIgL5+bSltmEWuOPv1ucnqoLyoDEcEKB8si8weLCpL8/iw5INvvKEVkJuKfEKDXQ+7yhGBNLSTfT/XuH8APRzPRrsOnxKtTHsoRo83MeffQ2td19DQSe8U0rS5t05CnrcCPbsoUDSIhyAcXWPAr2lWlxNp4TYgsZHyHMKEtalgs2Sa8J6ofSV2499rpZmxncXAwZtqBSL4tayQPmlBt5V/IFceJNyiYx11N2CnnBDW4Ew0Bm4uRjHgANPTqwz2WTOJPfK/MIDPH+uu1z/NcgLT8J1/mh+ow8lMgZCtLRJ4uIWrBOTsyKMSxSGstGuaTtq7rnk/rkWoKSK9XLm+0v9bFHAv2wIDeSom2xw0bKdmp5xYCZREphlSj4hweVWbsUHMITpWyvIjj07OO2kuFTRvityarGMEhA00nSdiWxsaG0XBOe9jmXd3FUaIJNsLKpCAylRkc1TZW9tFpRdqHEr7owWiPr3w3xjSlaYFXsEgH2/eAnscggcj5BXM1M+6f17hDubIDnGMh4JG+EnEblDvbzj/DNQoL7cPG7N033emMaAuLtWlMnmfB06NgX26Ajh6yK/pGcovzKsWpb0TWJLdS8j3lmmh8JwCBCrO4NPGpE0lnNLmLLWrIcweEHCtvujXE0hxOEvBCCFsAa8gAg5NypD8zS6KNH4wJTeq4EePLABjh6EyL9DSyOJb5Qetnkt+dLQd2FBiqflfGZTLCHQPgXthtJE6eqwy1xdbUSy+v1tvi/ezVBMaascwChJBTuP2c+P1rNjiSmZR2g8N6L1dwmZfaJUOx7nXy4T65ZJ8C1LkiQohFJhZx13SLS2TgPtsfhgG7p6ugYTlP6Ibnu2YsuExcmVtOSx2RtfCYoDYONpB3foX1+o5haGCBvbCwTWeRXYrsBv5wdEg1E7NxrQCaGCTx8TnkvA+XKZ3PNDdvVSXVlPWrsZKv3brefGgNjcNl++eUmMtN9d9Vd/ypT8StWE9kkJ9VHEk3wkdbp9XNnsu4B/wwzbttKQwlVWM6HW7AyUk1A6/u8FQYIqQEj3l5DwmLH3uJgz78pGVL4lCeXc0NxxyyhcFFEoDIChYE7ozpCj14deDbHcMDO1zJeEK5/UjzoJJBghFkpKKuW76YTuCBPTPi1DmOde+Q05AO+grxUrzQMRlVo38NyrCCFWHTKxMMygea25lf4LDOMUVe1zhBa/HauFIyDfNg0u/G+TsxPkDbaZIRnlrSNrjjFumXiRZKD7dG3AvJwC6+sN3gdlYwOms+yv6wCAlAYNsjzjtkb+h8MccowO81Gcrx5NlFY6aJj5tWiJQgb10cTANG4pvahec81RUvznlSYqz1rXnG37oLN/hFo/OrCLCKypHWqn98VVBiyICWpcC0vE1dgZK/inOStYQT2xxKgjGEeVCZfH8yPCzzvrwO+QLPtS//q3FtBLbtJy6M6Uzkbdplf6tkOEg53xh9Dpvbl08qQA4rcfT5P/Kl42/0O8WwoR9V8JWoGemf4ynAJUJ2PNe6NtelsGsIS0FE7Wxjkl2FXxD6dykod2EYQ8vw9sJ+DbSmPZ1BCkoIfDIgpBjOOMvSzmzkLhbCv40pPhNSA4rQvJlI1PyXYD9tUT7I2R5hL+aJX6MEPLn57zblEiAX+Lrysfsd2EV5egKMdL0QRI0HZPHu9kyvVn78Rdu7QuG38vMfDQ+UdXLH663hy8MktT/jrgfxYLUUJZ9D0e5r2eVIOzgCQa4+og6I1v8il/P0JVvVCA7XUVdW5PvL31wqK+ok4xF1jjlQQWGU2C8sktxPSs+20QxLEAeT4lKh52LQkVxDB3Mn159aCEoYsmLvIJbW8vdf0MVbrQRsp6ot9HgvNdgsh6lipKMqVyBj6WWHC0AhMkgtQdcq6FFJb+RDjIYiWRqLP5qIPIIBfSgl9DRw9EPY27ViVoityYK3XkCMwzNbHv6NiznIrd1hbHXxhFXkmszF5GME1doNafjRxOCW0D6VCuAxkSsolZd7EqPjy9fRofTILXEqdl9MyvRwk+3fZzzRAClx0bt7ahWx+rYIuq3flbNGWwnJwrMojcrq1SGzwP0+4HJxDBnp//wjFnVW9U9qvuSowHeTpu2fv0k1g5JQ87NMiI6mgTlBL32VguMcr8Kdd5Zade2xyzChENvT7ojFZczu/bKkDaWQ6D0BLV70UxPOjqpfrxLS/gwPVAMvxcwK4Ojg1jQF/rw4cOVsCL9DlpDPSRJJoabrVbd5/QKPJxKu4n0K6Zp1vGwKCf+XonsOOqsalzVOJqD9PE9hfQQBZVlLv+isdUNiPYdgFTGRawqcI3BDoS7+ZOc2SNDYMZ3Rn0dvl90dMc3gtnKqSAvexO3QB6V5m70VSXIGAHWD7LqS3prOW3Hg3rcbgR8psEUDzvmkDIUj1DRhUF0bMyOyxuJreKrNos/hWnjJMuYLXc+lCzTrgdUXK18DT4/83eYz2NWM7B0j1kUAjfmtDVeyuPUgGkDU7vTXnJQygvHPNStLmGGlSVqbyEb1POOyG1h4FuujecOTrrgmMyw9m5ltmy1KLxXVAhNIc3e76lQC5aiOSPOxDqPTcJ+o6uR75k0Z3s7IEU2Bm5aPljeHmKpLDArn8a2L7VAQwFjCKQmgUru3188W3MUjHQ20HseBBzztMezYGvhgJ5MOdKb68THHrH1O7TL4xlzxY86XbJyKKS/EDGB/xO8myDcBig2iwrTyO9IgXqhf5TWXfsceUqPm0Qsd9BAGzaPlOft6pRpXeTDODPw1/YrLKgJSwY55/0K+FfaMk5hudr5n65jTafxh4wAUrfZfwMmc1hHxedGejXbmRM2TjldhZzngouK/uP2V7XOHVwV5tQeF+cVqD0gFU+HkH6O+NfNPpCFCYN/inftIxuPD8FEsQyjYHcKpdCguh6e4mNl6SpqHPBTkQo/7F8Slxe3tOuNAqW2gPA1aiFsyKJx4azJoHxQAX1AEIpL37xs2hPqTszxkjqxeY/sws7QfuCfkZ9Z6lUKxC7jsyKXHKmlmUWNLlcNfM/nOT4momrFsLD1FA8d6KWzMPTluxQKAlDkD/VYYjpuAiPqw5cH7lJKecu8h2nnsOy7GaZCExcXJYMnBXLrre0JdyUoIlROFtEcz3grPltEhvaN5/aOXDHwCRgg6vNXJGh+AjtxgKq9LRq+Bwz7k64ucL68QqX6DmyPAVxkgvnJGO8psfRQlP03vzqxG8PQLJKMmXzo+dpReC1o0R3SqSYTnuyoYBe1BLRTX+MjTKRxRO6B1cXrvnfYtC0mSUifKf7KvDznReNsUd+AkZ38E8rp8Itvmbh8AsuDkXZHxpICN+jdruU+2I20uH7++BBCRHi4k6qo/3LI7ZEu2XQmZYdLvygR30DnvpDw1ynK1m+K3gvvTW0FUaWcJMiSn0/QB59+1CoR5CMiNSqkLEbsn5t60bW7wMUmETvJ6c7ug/sfTgzadr/zHniyTpkYBm7kPwHT7OlxUDU7C4h+3PQ9o3s/StEcsBfw/FjqnJVL8kznUKmVhMy0hmpcFEwr0eEslXEPtgixGIbg6elBNX6J7bj1hfrb2oozL4bXjtX94SAG84mmvObz4q2yXXmnh21rvf0ngOO9oMZgfN6tD0rlnNF+MV8HPftAmnlhoUySbjmeOJdDnAgAtntBv+K5df7dOFI1ncEqBKGazK6gTaaCsCw9dZRgekRqWZmPCxp3YMR8mbciIcmK1C6L4ar0tpUvWU8ExJXT8HTn/HX2zn8RUvgWXAjeHobBdNXc0dDk05Sy9CbDeLZbrCT84RXvn1Lj8ZGtr9E3i0u6zf09hFZVcSAePIULCkMLTG8BSugTZazMHYXEgGW4QGtlsDBaaX8I94qhEONHJ6TVBRJp+TDILQJonRpZYOEYoP0f6OAGqobaay5FNvQ9kCaovaTdliUanr0IGxxVLEVDLkPgZL94QGEOA3iTnXRd49ex3sxH/6AlIlyIA9otfba2XJEOpQy1e/V2mA2WNfcTf54vj14M3XtVkq41BcpNptUagYb+v0Bsav1vxQhf3zSmxM0S9tXAPbKm8bl77NFr9kDpguCtCv5Rsiv1sKtsFtDbjF74uyBGpjRrq1MEwsoXiv+RrQORBd27nq8IMJJQ+zDrK2pWoNtPsz4P02tm8vVUajkExxy5VAcyzlmFOuVrouu+DcKg+Bvc4Enqcsm4+rV92mplRNyoueumn41753cNlbVbQ10JEnVeKma8gVgPjeZE6QKsDkV+X0B3+Rmr8FOiF6wAfeUIUSKZyEAwTSSByg2miDjRnqAMVKzz6WsZRmQhBI1SZoHCa40lpSuzCVGdX0+KkuHm4a0YT/8GO68ZUUhNfmY2jw90cGeC5WxhCiOKUlaGJa8fCA1VONrIlOvryzgBVozVlrCDHysdCeEsLRHBX0a0oQ5+96V3Ewe8UBteCCXPUXc/ZWbFWX0ZtWmf6X7EUh1Lu1CtTGwi7gWcQObOE6F0mRZSXu9VzRLmRez5HvMpb5t/h7R5AXFMMl29fr/EjsnzmevGiFbzKyR7lip6nZUE26vYgZXJDzRd3Tn0kKLnPaSTXeOT1CZdY66cPS9o/Mvwf6gIvS92r/xYqvKKdlU5k0+bQ7Yn/B85Sd8ko/mW25YR/7DxYueiwdkBJW01amkUzJc4nF8fNF5IQRASebnzYHZ4cPGBnpqTHStBCurZnQujwHWvD8FxTd++Tk6C6WH56tQ/Cf+boFfi3tSEVIyWBPXJxyBpX33fo/SVQoJRK0S3Vno+EXzdNLY+bZjMeMaSDkM8uIqf5IrBvTXylFq3/58mHZB1SX9KuiqGFB3Mnq8DXIrPUyToun+sEn9u0fz/9MhXQVh3tIsU8AsQgDHUXaYWaOLBi42NZpg4wMM6B4YkdrC1M97fL7zFvvA8OhRDUFezhAWybaOh+sbrEq/+OPgJbtSGj+QrT5RbsusqYYrgl75abPtPS/RsRf/gvW2bbrawxgbJWjir5fno+sokRt9dJ2CzFIFmJNIPnTeBG6C5I61xuADtdDMWLab3liAKG684ZNvBkyljlv/59+mSnL0esceNVEzf57DPHzw1GKmKgS2YwmNJJO9x1N1uaLMsfUNPocHFKJPuQxMpgqjKVxM/8NtGNNUQdgzr5/HisFBZ7AIhKskxlWvRlQUPlkOosavEnLQyAhGdHzDUD5d6GDDdWWW8LJSx6vf+BM5v73xMO12AbeXS8YCl7Y2YVdWVSXLMoyC4MIO1THCWdPWhLSduBsYKtXA4y1CUSfVh7YQ5dPBQuZl+xNRG0BMPKIHNgkVnERNY8J4GLPPuOHWGf/RKOIKCbQQ3UnlbjS9zGH1yTOM6lnuGIXg1nCT2/i6Fie4+WC0E5zGT7o+ObUi/QjX/1eYPELSJni22ykVR1ls9pN3pkieWtU+c+X8/jiLlNyVAwG/MwzBhgH6JY/ThOBlTguydMk2dKbb4xLkE86LhBxOxdBZLj9uiR6YsUFA4G/Bw+vBGwIYodEvpt4z7Q7X+41P55PFO5gTawtTYUCStzcJoPyhgMIUgs0oMx+YLfLr8q/LxZAtyQWYg86sXjPlVHJYU1p4/xy0gI1k6h07yIszob43JvwflBcskLW6XNHomyWyeLdqTZCb1hJ70y9vQGtH1kyZ/pLhLLA95mVlEC0A490zgtMqTnqwl8/iOBUiBcFKAWeCXbUI4pZIjd7R0IHxLAcqxYMoa5OVbF0e6mpHMsuVdjD5UjRmu1gG+ETzxicA6A0pwLeO46sr+zlB2/PL67oqvVptrzOeVss18AS+p7YJ34Bb5bUDbZd4EbcCxy6RedP1LT74Y/khFCA/RPi3RZ2qAPu0OghPy6/M2bW2t0DA4uw2X7BHUg8uFKJOzpB5LzSCxRT751FvHh+sJETfY7cg1Cv2dX2OKjBrQl6dXrhN9ogNApGKkHfWzdjq3wUcQxulmsvYwn8sL9dmoftr3c1w5hb0Gw6C/ZvgyN2ZzFHcrs6IAjEQqyP262VAuf8+DHrhP/CEvScgXT33ZR4k8r8og5EjrI0PlxUQDa735DiVMuQieUi7TSWZAUg3PccPlag4RLQ20sag4yVWOLFa144NSXyRmKqFvidh5XQKykTo4bUAOMTWcC6+Tf8E+KQ+mHZndHj4lwBaX0vvVL2AmDsIk6q88jdm6Q+4/wOvDRp3k+UEUsqhNUCaK8TJzyeFgnteL15P3hx6hbOaDekzGpK2fashj/QM16OtKga/Q1JU5aMJ87iyB6qeTwxmDG/zBrYNRM2gqi3ltJq2a3MlyMjEFOvghhVPXitohfXfTeXa60hZCRBDJlD8Pm1PnLUrOlcMX6ViHIUuOaB28Q5SUz4f9TD0VrmoC8ikfuX/cpqrlWKQxSeoxm84yMbue3/JbqPrmFJ7neNYzV4clwrtSwvff9kf2teL8oGOQTxxEeqKXHjC744xOIXOPC4S2FGvyeypWe71Glm9j89cpIsI41+T+v5d7PXrVabczX93R/RZ6YN/M5H+ZLnnQuv9IFtgfGAP5xAgmdTVVxQ5+p5yYGh4/tdnwLc/z56TxvyiUT3ABS5PgAkbCAxs94L5J+sDiHNmuPgY4Ok1QzRhIm9EPl1JR/tEBXVdPvL8l/nkUPLq4ZnuyslekJEUNbcrCSpDGSnUMyoYUBhhbCf0JOwD953zjaqMo2nKntVMT6pcSxNmRsQ43y6HJ21qHVrZtYGKJB3N5Tx25dTXfFLaQ3gHu5MnBlOsBjm+8rQYlvdtZDALe2+EE7xf6Rxoq7va1/B7q0q544CABcLBXLryBbkPVPJLWP7+Auvk/NjDVPTCKHHYxTI20TeRmMj2F5ZHJVJ+6iJ2koN0OvcWsjVlLvWz3KbsCpC+50I7kRDF+pVa+/41gexWjVfD/sgq1n3Mo9dKBTZ7CeE4iCPfhMQrKTXa/flAB12uhS8reOPcuaO3uOYVJfyvbA14EhKnYl07LJH0lxOPiqqBoCDAUq2GLe1xxN7dIxt7XbhL0TptkgYbI5BNrWEsZ7zrLnlQZzjda9zIicZebigMyiHkAhhxd0miCkEpHKe0kzIAoIAw8/vTg1AWRUJ/y/mxyF/PXQxcYbkyk1Uphg1CRmU2q0Szbw7G5aqY5WXlN/EeTQTWxhs853eamI9+U8RX0R2w6ZWNPiC56GVqqeOmZ3SDbeYD/Zcl8Z0uqiwUzpPgPqKDdL741QUKBzMCsj+mIALt/2jcZ7OGdhIiriPLxDrDECyaOpBpgzZlP9HTz/2mIQYfZ8Qst0Gj6ng1a4gF/a8AIcOuy7XVd6Q9wajWCgQqICllaV88gmCf3cFWjiV1wJeic04A0+R6xzOIOW+ZR+S8ZRqTP0HdKJBqSuCZ8rITqhuV1YSwuF8TWCxbSauUIsZDVkxk81fXaul6/UV/n1CytYpmaXkzmlLDnbuPecpY4aWaJ6lkBC6noPthkEMKj0oPfXcrRHRaDjU+xHxrRC9o5P4e1UmPo3tPP8b6SQ9X6E50+qrQrGMy06FGbAC05cbEj7hVZcb2KO0+Z220AoYG272PmlAH7xuoLro6ndUsAqpNBC/czm0hwUw1ylfJWWTTX4Ga7nIpimvTMtMUR9ojJ9EqrmCMxEQsHsoB233Xt1o5Z4R8FOshqNj0iSkNo0iuwVw2clBfxRKm+amJISCOoLyx+rECC62jxE0h+aUNv02qwl/EkoyLPU5i4GPI/VbEr4mEGALRwkGfImLOUV8KmVAaDaKLVYTJQ+xR+FVkTLnlaIbeaZUFA3IPclNu//aMQ0FwPBByZroFbHNB90oAu/MNF4/CFTkuCNyf673oFEShTJc05yaAGyjJDkR6dQBNfK0iAUGnBX4dDbXlrdKPXOIsRxGBH7oBrex43Qg2rXQ7FrAu/zv+AuZNgXDka0eEe5rCbBGqnV7e3cVETMkUvgMqb3B7L1BGTgc64rB47gm39V352NjqrIWRnQ3nozNIz0lbI9jXwduDIkB1MUdIloGhIToqg9gk1oucRboqo4KqFZVNm7NZGGDGV2VoewLasKi6ZY4VdX2JlhiyyKI2VHD0Vj8dvm06b2RQsXoPdJsed5gdQQGNj8smwFHwENOUqMz2CfccujSN3rzR2RG0kUws6ftpkXY9mOmFCsKAzKvNNXvdkNLPKorMqB9s7cad9IjqkBtGjuX7VFobR6d+IP1PJPCo7C2TwwrX4cUYVhTSm0rv0Us5qYBKQGIXMcpUEg93GaKQcmnJgBrMdpicOFrx/jZEOTa4pZ8S71yP83eUJaSWNXUqFrTajCWa5ZuTNCJFb3S1DVkqjTMNOJ8InPizXA5C76lcN9WKR63KsQXrJctpH37hvvdEM+lSoRjX+GeJJ8LeQ3Q7d5PkU9NpvQmM6ldD5GJ5h+HNnspFO/RTt9n2ZijKgXGc81HoOM2PmbgtU4NEHL66Lljt+brIGjdQ8lmyJ+hEhnjUSGjcv7tpXI/SIES2Iy/6UPv76JjpPups4sxoWHmLyb7eTHY2uPJQhFvflpGTKRfYD9hXRQPEW3CY+8yGlD2wr6QJaFaGMl76y4PoC9igENljZbcp4fbVKjf70jHEttD3taQAs6wYS5JnK/d7E6P3l9dBHgDQnya7nfLYJuvPnIsIv4j9y//xtD4n+LXnFxiBnOou7sVu1cmVR3HIf/ranmvm2YwDCz6AIS3D3NfYxxtsthBjhBaMjBprHGQiwzF0rFNz7RRrojS/WWbE+siJzCs8dr2+JJ98AHireAlzurEcLAUiXcnrr7ajQXehCbFDE2OONf7XrCV++kj860Yb7G2XOoRcq5HWkQ7xJwRpNid5iPBq1PTeaYiuyLwLeF+gy6Szpwz82xrNdQyObTOWexLIL4Qw4GFpTxS/7N/iE05lrFkBEDmCByULwNYOOnMVAUIHC3tTxaSBrl6HdQejBwup75NIJLSNmScayMZLgdPe1LGkGwqAPxGJF0HAXO+E9Lb4hmnBkr3kRk2A5i0L/RMzhoSIsXUuAFU2hVbu5NEIBoKpFrG73EFqfFhmD/Vo+gWRzwoj69c6eVJp4/Hda69fQcgIxfIYH6fGmRc/j97yxRuqMrpuWFKXivXnKrGUCHoOqiqaZkQ1T7Qt1pkZ7fnoQNc3N709XS53tJDSPPi+rzWscnxFqiNIaqosBLimlYU5In9nuoJPjBxo8MDXrXjpFLy2gQHncRq5RYdKiZQD8Z33enZqsHAofzL79DQx6vEWMo9CVHLHbRqj8LcQMY3WV3pOB0e3eXLKG1T+I8qDolRi1Tg7iPuQjz0RHEvkKC+gPsmUUojFOkerBs9VPuO5tIW9Qpaf1i8dRIym7uglqRvCjL1zk8z0fLncdF03BinGx9SxnE3nBtu15jYbUOjtpqwiRJJ/SHU4xY+y265TMYHi5pXAy8QSgijzsBnH1f/s3uIRBxWkVp7AmCcZMA3kuGl2XS72Bbq6ehroWcIzEZRXT+YbxiOy97dZQTK02ZMDGk7LDFqD4RswXogxrRRv6R9AcMIvUnpahaebF5yEGXw8Donqy3OSmyHfdfCQSl8DYUUkWxLbv4gWq9aBhpc6OqkJYZzT2Uz5HmSho7V2oKxpXpLV/ImhYxm3Q1qObYSN06pr7ZclP/kzLkruMPleHPa55IgCQxh5jKyrkO89NrycQ6jN1cwRAzFHQ+Hm8XVk8CNWCMNMhwD8PVOc6RJkcpvxZKuHvdu+G/H9nUFHxBh8BWcgAZKP8WN59b8ZZsRkNj7psLf/ni3ieiGba/oIDp13N+m/ZWzt7NaVXno4gt7ixAFkzmI8WeaUoPg1AvmHW1lnmmQSJhWho3BifdgX0oowrNmYmP4dY8JOgHkKHbDqe43mqrPQPQtV74QWH5iPG4jcx3xgBhjHl4x8U2zCMWhqYkewIPcIpuhy2r7/0rdZ5T+mV+ag5ilH3IMQSzp5Ef5tBnQVCmPIceHwluY765Mj22Cfgf6OT28BCGjJSVvUwjvWkeBVfivqpFLp7ujdla6otphKU1/wQ72mFMB5d4ni/9gNA6TvZ6yaIhPxMkFgaahNaZZC9QqN6QZsIwQcWHK/5rWfe8otkkc6vgSSQdVMjW9aoeT/35T2wlTyA92nL2/rhejpYMZJcCj9B8rr1Y1uIIFqXoDH31//QqZJRdnVqOw5TLMiPVDTolB5k5rtF69ZkUogQERYwEQGu/Rfrms5pe4fbqT7+vkjpvhubhvQ9s6uKj2bXm7DiDNn8G+p7TdzSI9bX1ABMjcvMvNWSMjabPkkHjUAGFDCoDVKopyP3m/iMgMWyrVwY5eDY1mt560+IhQPOReHutMAy/5QGgieI2MhRiNd4I8JszItAVRsx4w7EJhAH6no3yqjReahPtlnDHr+Bmq5wXEHue/K22ThHwAfDDZrA++79hr+eZRsXFulaKadyoBh4Epvajul0ZYyDfVbTG87LupPH4T+E13wWmXMH7SH0W/d/UqHLNP02ScWYTTfpRkcFhCVN/IjPxlQRuB90oz5P8/P2jfWHWdMdUWmgcWHvd32X4pWgKCtJbUXHh2dchq4gByS/Y8jtdIn100lfWP5wjoqa0J+juabYn9f6Dy38aelPPipERK6ddrEKei8jQ5aEUugwCGFf37n2jERja8N42RI1sLBKPiKMbFXUTQiXtYLMcooKi7nkBEjKjTxZjc4LXcZqiPZRUQtRE1UOuVvh0yw76ZEONXPPBJjBYp5QKVKTxDnoDj/rmn2P/jTul3TeQ2yVcRbOcp1T7F9M5hiTeltNv1krWVqyIZvRdqBorywkj7jIZfiSmGydP2KslKsNcqPfP6gYCnZSPRE0jB4a6Yv8nbSsUQ8GLJl+AOCA0J+rzwtQ1ba+iTCQsPIJikYIWynG/YFzAZYqd2bmCg8yn8l9U0wiJoWtUIo7VjJAmR0tqrhvydZ9kH8miVyn/Allq8K4iNWxx+V9dYallKFSj55zhZrDNUzAo22I0v2Vl3PZnmUfVSNp+80Vz4yj1h9I9G6RdubuLT+MRCaqCMneLRVnGrTaPOW7dtYkGV3UpBRGuv3p/w6lGhdMikgrHiD5Hynp4nl15iDp7hPUxttnBBIfLOYTeC/dLRo5LRnlPYBK89780hR3LJxJ/NUVidoWLu1QDAAPoeH//EDa2UoN3rIVHSl4Yxh1Du2kI6nx1xEl6pMife89CP2cie9edxWqggmoXWfCk5o5TaA81JgR2751nLrvzGacADLl5AyEUMM+qaK8y1hlziSGPMUwrKEQPuLYapRPdHndkrMBFqDYpTdw50gy/H3p4o96YAIoLseQxrVrr/b/cm9bcXZIyqxTjYlrKC3hJBxxd5PlH/tbp+SLcJHQEvIw9R0J67V9fCaBk0aU9Ty46JCBOsD+kSyWJ6yQ9+h0r5YPKghrutx0EBURx5UA4FLJUKBccdtl2k70Pr/qk491cNJ1QsHO3wpIhu83C7YULCafYm2BJ0JGHI5XwjOlUGPNuapQ2f/83riRDf02+3YHEeU8zfli/TZWo3DeAWAXcCBi8I5y0SXd9zB0FUF8wX8RGuZvdP/P3+6jUfrzvhaoltFjPUe8wnRGMlw7cn2OmWaEjSI90rXW/3sqsMHnWjqSjlE2AmEIXCsUcniSEwN5t0mzQWXblNLmEJVoXwpKeId4K/f4tNbCDvaSJtUwLMJGzSVtLgUqz2VFe4YPS8/uO3HXtb7ZIjT4hIyYKK1gB92H+iehJ1H0WSDSosQJ/rfvGfPbKtOyd/GCr0iKBkV+CBhq3M6IFZVx24sXmH9NAfsGoOpzbBq5GnE96gUMc0BBh5ADZY5SHYcc4ecAeZ5iD8tnPLm+viGCOJeRNB9FuQSEtpZqSk2ulzFdo1y8u1LJEq8QxetElJ5s73WtypA21LIZWi+Fm+MyxRTQTx+dmRc2sZ+5IqTPPMAvxSNJdTyXxe31ybzDKMdNvD5LBlZb+8pVR8L1agxkBWDLXq3BeCS058hJTFNyvh/F7/OQKK6//A9TMlRydB1TtlCVYLF5sQMtyG5eFYptGzkpsYTn6musMYO6NpRDjVvN2pCfmBmRGWpTpoqNn2OZ+SfbagJGAukmISQqS3svhLWfL8eqRCrpTl7sqs38EQWrzmWpoycRMfpQv+IknEH0ujVqXuvrELl6s4/cCTskGLTQLdhbJSv+kiJ1PpbSw1+W9gmd0DrI48RKIJvR43G9ngHpMLHVEJ0JSjhCXfDRlxi1DTrSXAuiUBse/O0Twmrqx7aUAn0OrWklBcE2/5/HBgNNVV7L73x2fpUsLAsAUayRz7T20J0Da5X8pJ/9PFL9LslGWlwhMDcYvqmLV57Qdxhno9pkKWUNzy8R6h9WfR6f274uQQaiyWPyMova+F3wq4x7+1qpvY+7/kLLKuG3EP3PKBStN4YnnmTEOcLy91MAINW0HeoTL2eHDSJ2QO4DtHx6yHwPdLPsyk15PsvSXaYEJUJNmIQx4Hhp7MoARFSPmqyrwgVrEnSo9NvtknlgjNba+EslFhSnfywLacbId+dZ09h6DT10iCQFRgZZK3E7R5Rnyrb7caSfpeI7btFfeiOsPPr | BASE64URL(JWE Protected Header)... BASE64URL(JWE Ciphertext). |
Тип содержимого JOSE в представлении JWE Compact Serialization RFC 7516: JSON Web Encryption (JWE)
Тип содержимого JOSE в представлении JWS Compact Serialization RFC 7515: JSON Web Signature (JWS).
Расшифрование ответа
Для того, чтобы получить ответ в зашифрованном виде необходимо в запросе передать http-заголовок Accept со значением application/jose, тогда сформированный не ошибочный ответ (код ответа 200) будет представлен в JOSE в представлении JWE Compact Serialization. При этом в ответе также будет содержаться http-заголовок Content-Type со значением application/jose.
JWE Compact Serialization состоит из 5 частей, разделитель между частями - символ '.'
В нашем случае структура JWE Compact Serialization будет иметь следующий вид: BASE64URL(UTF8(JWE Protected Header)) || '.' '.' '.' || BASE64URL(JWE Ciphertext) || '.'
Защищенный заголовок (Protected Header) будет иметь следующий вид:
{
"enc": "gost28147-89",
"alg":"dir"
}
Параметр enc содержит алгоритм, по которому был зашифрован ответ, в нашем случае gost28147-89.
Пример JWE Compact Serialization
eyJlbmMiOiJnb3N0MjgxNDctODkiLCJhbGciOiJkaXIifQ...MIIIWAYJKoZIhvcNAQcDoIIISTCCCEUCAQCgggSfoII
EmzCCBJcwggRGoAMCAQICCneGpLu1iLaqSBEwCAYGKoUDAgIDMIIBEzELMAkGA1UEBhMCUlUxLzAtBgNVBAoMJtCe0JDQniAi0KHQsdC10YDQsdCw0L3Q
продолжение Ciphertext
bgaMxFrlN8CSJ65TgoTwh442bxjC2mDmEdVvjirq76gC6D6SLmWfvuUf0wP06twKI1bFodSWHJlvpfgPqnRu-LN-rOZQBGuyMKO5dXFIg.
Пример декодированного из (BASE64URL) Protected Header
{
"enc": "gost28147-89",
"alg": "dir"
}
Описание алгоритма расшифрования
Для того, чтобы расшифровать JWE Ciphertext необходимо выполнить следующие действия на VPNKeyTLS:
- Проинициализировать устройство (INIT_DECIPHER_ID) путем передачи части с заголовком.
- Внести данные для расшифрования (DECIPHER_ID – 1 или более вызовов) и получить в ответ расшифрованные данные
Запросы необходимо отправлять на http://localhost:28016/vpnkeylocal/
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/iJbnPrTXFHOd85ZxdKQyrqGV9cOe11WmCY/?id=INIT_DECIPHER_ID&head=Полученное значение&mode=1
Инициализация расшифрования
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | INIT_DECIPHER_ID | id функции | |
data | BASE64 | Для прошивок 399+: 2048 URL-encoded байтов base64;Для прошивок 500+: 2048 байт бинарных данных (размер base64, требуемый для их кодировки, не регламентирован) | данные начала CMS в base64 | |
obj_id | HANDLE | 8 байт | id сертификата для расшифрования | с версии 500 игнорируется |
mode | ENUM | 1,2 | Стандарт крипто операции: КС1 - токен только генерирует ключевую пару, данные шифруются "стартом.ехе"; КС2 - токен генерирует ключевую пару и шифрует данные. | Только нечётные версии 500+; Опционально; по умолчанию: 2. |
Example responses
200 Response
{
"ctx_handle": "AU6BTBjL",
"body_displ": "0",
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
retcode | ENUM | 2 байта | код возврата ф-ии | |
ctx_handle | HANDLE | 8 байт | хендл контекста операции | |
body_displ | NUMBER | 2^32-1 | размер (смещение) начала CMS в чистом виде (до кодирования base64) |
Code samples
# You can also use wget
curl -X POST http://localhost:28016/vpnkeylocal/iJbnPrTXFHOd85ZxdKQyrqGV9cOe11WmCY/?id=DECIPHER_ID&data=Полученное значение&ctx_handle=AU6BTBjL
Расшифрование данных
Параметры запроса
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
id | ID_FORMAT | DECIPHER_ID | id функции | |
data | BASE64 | Для прошивок 399+: 6144 URL-encoded байтов base64;Для прошивок 500+ чётных версий и нечётных ранее 507:для режима КС1: 15360 байтов бинарных данных; для режима КС2: 16777216 байтов бинарных данных;для нечётных 507 и выше: 2^64 - 1 байтов бинарных данных; (размер base64, требуемый для их кодировки, не ограничен) | данные для расшифрования в base64; размер декодированных данных должен быть кратным 8, начиная с размера (смещения) начала CMS в чистом виде (до кодирования base64) | |
ctx_handle | HANDLE | 8 байт | хендл контекста операции |
Example responses
200 Response
{
"deciphered_blob": "Полученное значение",
"retcode": "1",
}
Параметры ответа
Имя | Тип | Ограничение | Назначение | Дополнительно |
---|---|---|---|---|
retcode | ENUM | 2 байта | код возврата ф-ии | |
deciphered_blob | BASE64 | Соответствует размеру поданного на вход поля "data" | часть расшифрованных данных |
После декодирования из BASE64URL параметра ответа deciphered_blob получаем ответ в виде JWS.
Responses
Status | Meaning | Description | Reason |
---|---|---|---|
400 | DESERIALIZATION_FAULT | Неверный формат запроса | Неверный формат запроса |
400 | VALIDATION_FAULT | Ошибка валидации | Ошибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определённым в модели. |
400 | WORKFLOW_FAULT | Не указан идентификатор сертификата подписи | Не указан идентификатор сертификата подписи(параметр kid заголовка JWS) |
400 | WORKFLOW_FAULT | Некорректный формат параметра kid заголовка JWS | Некорректный формат параметра kid заголовка JWS(ожидается UUID) |
400 | SIGN_CHECK_EXCEPTION | Подлинность подписи не установлена/Сертификат не обнаружен или не является активным | Ошибка возникает, если не удалось установить подлинность подписи |
500 | UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | |
503 | UNAVAILABLE_RESOURCE_EXCEPTION | Сервис временно недоступен | Проводятся технические работы |
2.7 Получение справочной информации
GET /v1/dicts?name={name} - Получение справочной информации
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/dicts?name={name}
Ресурс позволяет получить справочники, необходимые для отправки документов.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения справочника, необходимо отправить GET-запрос /v1/dicts?name={name}, где в качестве {name} нужно передать соответствующее значение параметра.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис DICT.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/dicts?name=string \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/dicts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
name | query | string | true | Идентификатор справочника |
Example responses
200 Response
{
"archive": "string",
"name": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DictArchive |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
В ответ вернется JSON, содержащий ZIP архив, закодированный в Base64. Архив нужно декодировать из Base64, после чего разархивировать. Результатом разархивирования ZIP будет JSON справочника, соответствующего указанному {name}.
ВАЖНО: необходимо учитывать, что в JSON справочников будет применяться экранирование спецсимволов(unicode символы тоже экранируются), в приведенных примерах экранирование уже снято.
Перечень справочников
№ | Наименование справочника | Значение параметра |
---|---|---|
1 | Справочник БИК | BIC |
2 | Справочник структур национальных клиринговых кодов | ClearingStructure |
3 | Справочник стран | Country |
4 | Справочник валют | CurDict |
5 | Справочник типов списания | DirType |
6 | Справочник кодов инструкций поля 23Е | Instruction23 |
7 | Справочник Кодовые слова поля 70 | KeyWord70 |
8 | Справочник Кодовые слова поля 72 | KeyWord72 |
9 | Справочник Кодовые слова поля 77В | KeyWord77B |
10 | Справочник типов пластиковых карт ЗП проект | MzpCardType |
11 | Справочник Признак резидента оформившего ПС | ResidDict |
12 | Справочник цифровых значений видов зачислений | SalType |
13 | Международный справочник банков | SwiftBic |
14 | Справочник Шаблоны для поля 70 | Templ70 |
15 | Справочник Коды видов валютных операций | VOCodes |
16 | Справочник типов ПСФ | GenericLetterType |
2.8 Реестр задолженности
POST /v1/debt-registries - Реестр задолженности
GET /v1/debt-registries/{externalId}/state - Получение статуса
POST /v1/files/upload - Запрос ссылки на загрузку файла
GET /v1/files/upload/{fileId}/state - Получение статуса загрузки файла
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/debt-registries
Ресурс позволяет отправить реестр задолженности в банк.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для отправки документа необходимо отправить POST-запрос (/v1/debt-registries), в котором передать авторизационный токен (Access Token) и реквизитный состав документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис DEBT_REGISTRY.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/debt-registries \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/debt-registries
Body parameter
{
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Клиент\"",
"orgTaxNumber": "7707083893",
"recordNum": "100"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | DebtRegistry | true | Реестр начислений |
Example responses
201 Response
{
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Клиент\"",
"orgTaxNumber": "7707083893",
"recordNum": "100"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | DebtRegistry |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/debt-registries/{externalId}/state
Ресурс позволяет получить статус ранее отправленного реестра задолженности.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса, необходимо отправить GET-запрос (/v1/debt-registries/{externalId}/state), в котором передать авторизационный токен (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис DEBT_REGISTRY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/debt-registries/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/debt-registries/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID реестра начислений |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/files/upload
С помощью ресурса можно загружать файлы на ресурс Банка для дальнейшей привязки к документу.
Сценарий:
- Получение ссылки с помощью ресурса /v1/files/upload.
- Загрузка файла по полученной ссылке (В АС пользователю необходимо выбрать файл для загрузки (см. https://www.php.net/manual/ru/features.file-upload.post-method.php), далее АС отправляет POST-запрос на адрес, полученный в /v1/files/upload).
- Проверка статуса загрузки файла с помощью ресурса /v1/files/upload/{fileId}/state.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для получения ссылки на загрузку файла необходимо отправить POST-запрос (/v1/files/upload), в заголовке запроса необходимо передать авторизационный токен (Access Token).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/files/upload \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/files/upload
Body parameter
{
"digestSignature": {
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
},
"subType": "DebtRegistry",
"type": "DOC"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | FileUploadRequest | true | Параметры запроса на создание задачи на выгрузку файла |
Example responses
200 Response
{
"bankComment": "string",
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"status": "ATTACHING",
"url": "https://bf.sberbank.ru:9443/sbns-app/upload/020b7237-f874-42ce-89bb-02d39d400bcd"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | FileUploadState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/files/upload/{fileId}/state
Ресурс позволяет получить статус загрузки файла. После успешной загрузки возможна дальнейшая отправка документа с вложенным файлом.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса загрузки файла необходимо отправить GET-запрос (/v1/files/upload/{fileId}/state), в заголовке запроса необходимо передать авторизационный токен (Access Token).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/files/upload/{fileId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/files/upload/{fileId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
fileId | path | string | true | Идентификатор файла |
Example responses
200 Response
{
"bankComment": "string",
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"status": "ATTACHING",
"url": "https://bf.sberbank.ru:9443/sbns-app/upload/020b7237-f874-42ce-89bb-02d39d400bcd"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | FileUploadState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.9 Реестр платежей
POST /v1/files/download - Запрос ссылки на скачивание файла
GET /v1/files/downloadState - Получение статуса
GET /v1/payments-registry - Получение реестра платежей
GET /v1/payments-registry/{externalId}/change-state - Изменение статуса реестра платежей
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/files/download
Ресурс позволяет получить ссылку для скачивания файла. Скачать файл после получения ссылки возможно только после получения положительного статуса о готовности файла для скачивания. Проверка статуса осуществляется с помощью ресурса /v1/files/downloadState.
Шаги
- Получить AccessToken
- Отправить запрос
- Получить статус
Для создания запроса ссылки на скачивание файла необходимо отправить POST-запрос (/v1/files/download), в заголовке запроса необходимо передать авторизационный токен собственной организации (Access Token).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/files/download \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/files/download
Body parameter
{
"fileIds": [
"string"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | FileDownloadRequest | true | Параметры запроса на создание задач на загрузку файлов |
Example responses
400 Response
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | None |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/files/downloadState
Ресурс позволяет получить статус о готовности файла для скачивания.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/payments/{externalId}/state), в котором передать авторизационный токен к данным собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис FILES.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/files/downloadState \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/files/downloadState
Body parameter
{
"fileIds": [
"string"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | FileDownloadStateRequest | true | Параметры запроса на получение статусов загрузки файлов |
Example responses
200 Response
[
{
"bankComment": "string",
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"status": "PREPARING_FOR_DOWNLOAD",
"url": "https://bf.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb-02d39d400bcd"
}
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Response Schema
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | FileDownloadState | false | none | Модель статуса загрузки файла |
bankComment | string | false | none | Банковский комментарий к статусу загрузки файла |
fileId | string | false | none | Идентификатор файла |
status | string | false | none | Статус загрузки файла |
url | string | false | none | Ссылка для загрузки файла |
Enumerated Values
Property | Value |
---|---|
status | PREPARING_FOR_DOWNLOAD |
status | READY_FOR_DOWNLOAD |
status | ERROR |
status | OUTDATED |
status | SPOILED |
status | UNKNOWN_STATUS |
Ресурс/v1/payments-registry
Ресурс позволяет получить реестр платежей, с целью выявления контрагентов имеющих задолженность.
Шаги
- Получить AccessToken
- Отправить запрос
Для создания запроса реестра платежей необходимо отправить GET-запрос (/v1/payments-registry), в заголовке запроса необходимо передать авторизационный токен пользователя (Access Token).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYMENTS_REGISTRY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments-registry \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payments-registry
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
datetimeLastRequest | query | string(date-time) | false | Дата и время последнего запроса реестров платежей (yyyy-MM-dd'T'HH:mm:ss) |
dateSince | query | string(date-time) | false | Дата начала периода (yyyy-MM-dd) |
dateUntil | query | string(date-time) | false | Дата окончания периода (yyyy-MM-dd) |
state | query | string | false | Статус документа |
page | query | integer(int32) | false | Номер запрашиваемой страницы (начиная с 1) |
Enumerated Values
Parameter | Value |
---|---|
state | ACCEPTED |
state | PROCESSED |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"paymentsRegistry": [
{
"account": "40802810600000200000",
"bankComment": "string",
"bankStatus": "ACCEPTED",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "5",
"paymentsRegistry": [
{
"amount": 2000.15,
"amountBring": 2100.35,
"dateBegin": "2018-12-31",
"dateEnd": "2018-12-31",
"dateLoad": "2018-12-31",
"registryName": "EPS39291510642_5018141474.txt",
"uploadedRecords": 10
}
]
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PaymentsRegistryInfo |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/payments-registry/{externalId}/change-state
Ресурс позволяет изменить статус реестра платежей.
Шаги
- Получить AccessToken
- Отправить запрос
Для изменения статуса реестра платежей необходимо отправить PUT-запрос (/v1/payments-registry/{externalId}/change-state), в заголовке запроса необходимо передать авторизационный токен пользователя (Access Token).
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYMENTS_REGISTRY.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payments-registry/{externalId}/change-state \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/payments-registry/{externalId}/change-state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID реестра платежей |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
204 | No Content | Нет содержимого | None |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
2.10 Письма свободного формата
POST /v1/generic-letters/to-bank - Создание письма свободного формата в банк
GET /v1/generic-letters/to-bank/{externalId}/state - Получение статуса документа письмо в банк
GET /v1/generic-letters/from-bank - Получение письма из банка
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/generic-letters/to-bank
Ресурс позволяет создавать документ Письмо в Банк по собственной/дочерней организации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания документа необходимо отправить POST-запрос (/v1/generic-letters/to-bank), в котором передать авторизационный токен к данным (Access Token) и реквизиты данного документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GENERIC_LETTER_TO_BANK.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/generic-letters/to-bank \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/generic-letters/to-bank
Body parameter
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | GenericLetter | true | Письмо свободного формата (в банк) |
Example responses
201 Response
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"crmNumber": "190410-0033-142400",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall",
"typeName": "Направить запрос по 115-ФЗ"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | GenericLetter |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/generic-letters/to-bank/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного документа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса документа необходимо отправить GET-запрос (/v1/generic-letters/to-bank/{externalId}/state),в котором передать авторизационный токен к данным (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GENERIC_LETTER_TO_BANK.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/generic-letters/to-bank/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/generic-letters/to-bank/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID письма свободного формата (в банк) |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/generic-letters/to-bank/{externalId}
Ресурс позволяет получить, по ранее отправленному электронному документу, информацию о номере обращения в CRM и идентификатор цепочки.
Данные реквизиты возвращаются для писем имеющие наименование группы письма из справочника "GenericLetterType" поле "groupName".
- Номер обращения в CRM - данный номер можно сообщить службе поддержки в случае возникновения спорных ситуаций.
- Идентификатор цепочки - позволяет связать исходящее письмо в Банк с входящим письмом из Банка.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения реквизитов документа необходимо отправить GET-запрос (/v1/generic-letters/to-bank/{externalId}), в котором передать авторизационный токен (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GENERIC_LETTER_TO_BANK.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/generic-letters/to-bank/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/generic-letters/to-bank/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID письма свободного формата (в банк) |
Example responses
200 Response
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"crmNumber": "190410-0033-142400",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall",
"typeName": "Направить запрос по 115-ФЗ"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GenericLetter |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/generic-letters/from-bank
Ресурс позволяет получить документ из банка по собственной/дочерней организации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/generic-letters/from-bank), в котором передать ключ доступа (Access Token), дату за которую необходимо получить письмо (messageDate) и номер запрашиваемой страницы (page=1).
Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GENERIC_LETTER_FROM_BANK.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/generic-letters/from-bank?messageDate=2019-08-24T14%3A15%3A22Z&page=1 \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/generic-letters/from-bank
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
messageDate | query | string(date-time) | true | Дата письма (yyyy-MM-dd) |
page | query | integer(int32) | true | Номер страницы (начиная с 1) |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"letters": [
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"crmNumber": "190410-0033-142400",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall",
"typeName": "Направить запрос по 115-ФЗ"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GenericLetters |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Необходимо запрашивать постранично входящие данные, начиная с первой страницы и опрашивать следующую до того момента, как в полученном ответе перестанет приходить href c признаком "rel": "next", что будет означать, что следующей страницы нет. На запрос первой страницы в ответе вернётся письмо (Если существуют входящее письмо за выбранную дату) и контейнер links с параметром (href) на следующую страницу и признаком "rel": "next". На запрос второй страницы в ответе вернётся письмо из банка и контейнер links с параметром (href) на следующую и предыдущую страницы и признаками: "rel": "prev", "rel": "next". Получение последующих страниц производится по аналогии.
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.11 Валютный контракт
2.11.1 Справка о подтверждающих документах
POST /v1/confirmatory-documents-inquiries - Справка о подтверждающих документах
GET /v1/confirmatory-documents-inquiries/{externalId}/state - Получение статуса
GET /v1/confirmatory-documents-inquiries/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/confirmatory-documents-inquiries
Ресурс позволяет создавать документ Справка о подтверждающих документах (далее СПД).
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания СПД необходимо отправить POST-запрос (/v1/confirmatory-documents-inquiries), в котором передать авторизационный токен организации(Access Token) и реквизиты СПД. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CONFIRMATORY_DOCUMENTS_INQUIRY.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/confirmatory-documents-inquiries \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/confirmatory-documents-inquiries
Body parameter
{
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"customerBankBIC": "044525225",
"customerINN": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOKPO": "222221001",
"date": "2018-12-31",
"dealDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docs": [
{
"addInfo": "Дополнительная информация",
"confDocDate": "2018-12-31",
"confDocNumber": "123",
"contractSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractSumDel": 1.01,
"correctionDate": "2018-12-31",
"correctionNumber": 1,
"countryCode": "643",
"countryName": "РОССИЯ",
"docCode": "03_3",
"docName": "03_3 О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции",
"docSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docSumDel": 1.01,
"expectedLife": "2018-12-31",
"hasConfDocNumber": false,
"ordinalNumber": 1,
"supplyFeature": "1"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"psNumber": "120123A0/1234/GU23/1/2"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | ConfirmatoryDocumentsInquiry | true | Справка о подтверждающих документах |
Example responses
201 Response
{
"acceptDate": "2018-12-31",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"customerBankBIC": "044525225",
"customerINN": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOKPO": "222221001",
"date": "2018-12-31",
"dealDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docs": [
{
"addInfo": "Дополнительная информация",
"confDocDate": "2018-12-31",
"confDocNumber": "123",
"contractSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractSumDel": 1.01,
"correctionDate": "2018-12-31",
"correctionNumber": 1,
"countryCode": "643",
"countryName": "РОССИЯ",
"docCode": "03_3",
"docName": "03_3 О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции",
"docSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docSumDel": 1.01,
"expectedLife": "2018-12-31",
"hasConfDocNumber": false,
"ordinalNumber": 1,
"supplyFeature": "1"
}
],
"executorEmployeeName": "Ответственный исполнитель банка",
"executorName": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"number": "1",
"psNumber": "120123A0/1234/GU23/1/2",
"returnReason1": false,
"returnReason1Comment": "Ошибка",
"returnReason2": false,
"returnReason2Comment": "Ошибка",
"returnReason3": false,
"returnReason3Comment": "Ошибка",
"returnReason4": false,
"returnReason4Comment": "Ошибка",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | ConfirmatoryDocumentsInquiry |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Сортировка дайджеста
- Теги дайджеста должны быть отсортированы по алфавиту, в формировании дайджеста не участвует поле number
- В таблице BfAttachments строки сортируются во возрастанию поля fileId.
В таблице Docs строки сортируются по возрастанию поля ordinalNumber
Подписание запроса транспортной подписью
Ресурс /v1/confirmatory-documents-inquiries/{externalId}/state
Ресурс позволяет создавать документ Справка о подтверждающих документах (далее СПД).
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/confirmatory-documents-inquiries/{externalId}/state),в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CONFIRMATORY_DOCUMENTS_INQUIRY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/confirmatory-documents-inquiries/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID справки о подтверждающих документах |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/confirmatory-documents-inquiries/{externalId}
Ресурс позволяет получить ранее отправленный электронный документ СПД с информацией о причинах возврата\отказа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/confirmatory-documents-inquiries/{externalId}), в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CONFIRMATORY_DOCUMENTS_INQUIRY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/confirmatory-documents-inquiries/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/confirmatory-documents-inquiries/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID справки о подтверждающих документах |
Example responses
200 Response
{
"acceptDate": "2018-12-31",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"customerBankBIC": "044525225",
"customerINN": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOKPO": "222221001",
"date": "2018-12-31",
"dealDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docs": [
{
"addInfo": "Дополнительная информация",
"confDocDate": "2018-12-31",
"confDocNumber": "123",
"contractSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractSumDel": 1.01,
"correctionDate": "2018-12-31",
"correctionNumber": 1,
"countryCode": "643",
"countryName": "РОССИЯ",
"docCode": "03_3",
"docName": "03_3 О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции",
"docSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docSumDel": 1.01,
"expectedLife": "2018-12-31",
"hasConfDocNumber": false,
"ordinalNumber": 1,
"supplyFeature": "1"
}
],
"executorEmployeeName": "Ответственный исполнитель банка",
"executorName": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"number": "1",
"psNumber": "120123A0/1234/GU23/1/2",
"returnReason1": false,
"returnReason1Comment": "Ошибка",
"returnReason2": false,
"returnReason2Comment": "Ошибка",
"returnReason3": false,
"returnReason3Comment": "Ошибка",
"returnReason4": false,
"returnReason4Comment": "Ошибка",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ConfirmatoryDocumentsInquiry |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/bank-control-statements/{externalId}/linked-docs-list
Ресурс позволяет получить, связанные с валютным контрактом (кредитным контрактом), СПД по собственной/дочерней организации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/bank-control-statements/{externalId}/linked-docs-list), в котором необходимо передать авторизационный токен к данным собственной/дочерней организации (Access Token) и внешний идентификатор документа (externalId) и тип возвращаемых документов docType (СПД). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис BANK_CONTROL_STATEMENT.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/bank-control-statements/{externalId}/linked-docs-list?docType=string \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/bank-control-statements/{externalId}/linked-docs-list
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID ведомости банковского контроля |
docType | query | string | true | Тип документа |
Example responses
200 Response
[
"string"
]
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.12 Валютные операции
2.12.1 Валютное платежное поручение
POST /v1/pay-doc-cur - Создание документа валютное платежное поручение
GET /v1/pay-doc-cur/{externalId}/state - Получение статуса
GET /v1/pay-doc-cur/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/pay-doc-cur
Ресурс позволяет создавать валютное платежное поручение по собственной организации и по дочерней компании, при наличии согласия дочерней организации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для создания документа необходимо отправить POST-запрос (/v1 /pay-doc-cur), в котором необходимо передать авторизационный токен для доступа к данным собственной/дочерней организации (Access Token) и реквизитный состав документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_CUR.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/pay-doc-cur \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/pay-doc-cur
Body parameter
{
"addInfo": "Примечание",
"additionalInfo": "/CCTFDR/",
"amountTransfer": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"b77info": "/BENEFRES/",
"beneficiaryAccount": "40802840600000200000",
"beneficiaryAddress": "UL.KUTUZOVSKAYA,D.2",
"beneficiaryBankAccount": "40802840600000200000",
"beneficiaryBankAddress": "3, AVENUE HOCHE",
"beneficiaryBankBranchName": "(TREASURY DEPARTMENT)",
"beneficiaryBankClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"beneficiaryBankCountryDigital": "643",
"beneficiaryBankCountryIso2": "RU",
"beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
"beneficiaryBankPlace": "ФИНЛЯНДИЯ",
"beneficiaryBankSwift": "AABAFI22TMS",
"beneficiaryBeiCode": "UBSWUS33CHI",
"beneficiaryCountryDigital": "643",
"beneficiaryCountryIso2": "RU",
"beneficiaryCountryName": "РОССИЯ",
"beneficiaryInn": "7707083893",
"beneficiaryName": "EMIRP",
"beneficiaryPlace": "MOSCOW",
"chargesType": "BEN",
"codes23e": [
{
"code": "SDVA",
"description": "Средства должны быть зачислены бенефициару той же датой валютирования",
"info": "DOPOLNITEL INFO 8747483893"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"iMediaBankAddress": "ACCIONES Y VALORES, PISO 12:CALLE 72 7 64",
"iMediaBankCountryDigital": "643",
"iMediaBankCountryIso2": "RU",
"iMediaBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"iMediaBankPlace": "LUANDA",
"iMediaBankSwift": "BDAAAOLU",
"iMediaClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"iMediaFilialBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"inn": "7707083893",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"number": "1",
"option50a": "K",
"option56a": "A",
"option57a": "A",
"option59a": "A",
"orgName": "ООО \"Организация\"",
"payerAccount": "40802840600000200000",
"payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III",
"payerBankBic": "044525225",
"payerBankPlace": "MOSCOW",
"payerCountryDigital": "643",
"payerCountryIso2": "RU",
"payerCountryName": "РОССИЯ",
"payerName": "LLC COMPANY",
"payerPlace": "MOSKVA",
"paymentDetails": "CONTRACT 123",
"paymentDirection": "0",
"rateAgree": false,
"urgent": false
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | PayDocCur | true | Валютное платёжное поручение |
Example responses
201 Response
{
"acceptDate": "2018-12-31",
"addInfo": "Примечание",
"additionalInfo": "/CCTFDR/",
"amountDebitTotal": 1.01,
"amountTransfer": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"amountTransferTotal": 1.01,
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"b77info": "/BENEFRES/",
"bankComment": "string",
"bankStatus": "string",
"beneficiaryAccount": "40802840600000200000",
"beneficiaryAddress": "UL.KUTUZOVSKAYA,D.2",
"beneficiaryBankAccount": "40802840600000200000",
"beneficiaryBankAddress": "3, AVENUE HOCHE",
"beneficiaryBankBranchName": "(TREASURY DEPARTMENT)",
"beneficiaryBankClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"beneficiaryBankCountryDigital": "643",
"beneficiaryBankCountryIso2": "RU",
"beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
"beneficiaryBankPlace": "ФИНЛЯНДИЯ",
"beneficiaryBankSwift": "AABAFI22TMS",
"beneficiaryBeiCode": "UBSWUS33CHI",
"beneficiaryCountryDigital": "643",
"beneficiaryCountryIso2": "RU",
"beneficiaryCountryName": "РОССИЯ",
"beneficiaryInn": "7707083893",
"beneficiaryName": "EMIRP",
"beneficiaryPlace": "MOSCOW",
"chargesType": "BEN",
"codes23e": [
{
"code": "SDVA",
"description": "Средства должны быть зачислены бенефициару той же датой валютирования",
"info": "DOPOLNITEL INFO 8747483893"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factRate": 1.0001,
"iMediaBankAddress": "ACCIONES Y VALORES, PISO 12:CALLE 72 7 64",
"iMediaBankCountryDigital": "643",
"iMediaBankCountryIso2": "RU",
"iMediaBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"iMediaBankPlace": "LUANDA",
"iMediaBankSwift": "BDAAAOLU",
"iMediaClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"iMediaFilialBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"inn": "7707083893",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"number": "1",
"option50a": "K",
"option56a": "A",
"option57a": "A",
"option59a": "A",
"orgName": "ООО \"Организация\"",
"payerAccount": "40802840600000200000",
"payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III",
"payerBankBic": "044525225",
"payerBankPlace": "MOSCOW",
"payerCountryDigital": "643",
"payerCountryIso2": "RU",
"payerCountryName": "РОССИЯ",
"payerName": "LLC COMPANY",
"payerPlace": "MOSKVA",
"paymentDetails": "CONTRACT 123",
"paymentDirection": "0",
"rateAgree": false,
"urgent": false,
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PayDocCur |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Заполнение клиринговых кодов
Для задания клиринговых кодов банка бенефициара и банка-посредника, описываемых в виде JSON-объекта ClearingStructure, можно использовать данные справочников:
- Справочник структур национальных клиринговых кодов (ClearingStructure) для заполнения countryCode, shortName и symbol;
- Международный справочник банков (SwiftBic) для заполнения clearingCode и countryCode.
Чтобы их получить, необходимо отправить соответствующие GET-запросы с указанием имени нужного справочника.
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для документов, создаваемых по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Алгоритм сортировки дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. В дайджесте не указываются значения number и блок linkedDocs.
- Подписание запроса транспортной подписью
Ресурс /v1/pay-doc-cur/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного документа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса документа необходимо отправить GET-запрос (/v1/pay-doc-cur/{externalId}/state), в котором передать авторизационный токен к данным собственной/дочерней организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_CUR.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/pay-doc-cur/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/pay-doc-cur/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID валютного платёжного поручения |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/pay-doc-cur/{externalId}
Ресурс позволяет получить ранее отправленный электронный документа с информацией о причинах возврата/отказа электронного документа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/pay-doc-cur/{externalId}), в котором передать авторизационный токен к данным собственной/дочерней организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAY_DOC_CUR.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/pay-doc-cur/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/pay-doc-cur/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID валютного платёжного поручения |
Example responses
200 Response
{
"acceptDate": "2018-12-31",
"addInfo": "Примечание",
"additionalInfo": "/CCTFDR/",
"amountDebitTotal": 1.01,
"amountTransfer": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"amountTransferTotal": 1.01,
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"b77info": "/BENEFRES/",
"bankComment": "string",
"bankStatus": "string",
"beneficiaryAccount": "40802840600000200000",
"beneficiaryAddress": "UL.KUTUZOVSKAYA,D.2",
"beneficiaryBankAccount": "40802840600000200000",
"beneficiaryBankAddress": "3, AVENUE HOCHE",
"beneficiaryBankBranchName": "(TREASURY DEPARTMENT)",
"beneficiaryBankClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"beneficiaryBankCountryDigital": "643",
"beneficiaryBankCountryIso2": "RU",
"beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
"beneficiaryBankPlace": "ФИНЛЯНДИЯ",
"beneficiaryBankSwift": "AABAFI22TMS",
"beneficiaryBeiCode": "UBSWUS33CHI",
"beneficiaryCountryDigital": "643",
"beneficiaryCountryIso2": "RU",
"beneficiaryCountryName": "РОССИЯ",
"beneficiaryInn": "7707083893",
"beneficiaryName": "EMIRP",
"beneficiaryPlace": "MOSCOW",
"chargesType": "BEN",
"codes23e": [
{
"code": "SDVA",
"description": "Средства должны быть зачислены бенефициару той же датой валютирования",
"info": "DOPOLNITEL INFO 8747483893"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factRate": 1.0001,
"iMediaBankAddress": "ACCIONES Y VALORES, PISO 12:CALLE 72 7 64",
"iMediaBankCountryDigital": "643",
"iMediaBankCountryIso2": "RU",
"iMediaBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"iMediaBankPlace": "LUANDA",
"iMediaBankSwift": "BDAAAOLU",
"iMediaClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"iMediaFilialBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"inn": "7707083893",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"number": "1",
"option50a": "K",
"option56a": "A",
"option57a": "A",
"option59a": "A",
"orgName": "ООО \"Организация\"",
"payerAccount": "40802840600000200000",
"payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III",
"payerBankBic": "044525225",
"payerBankPlace": "MOSCOW",
"payerCountryDigital": "643",
"payerCountryIso2": "RU",
"payerCountryName": "РОССИЯ",
"payerName": "LLC COMPANY",
"payerPlace": "MOSKVA",
"paymentDetails": "CONTRACT 123",
"paymentDirection": "0",
"rateAgree": false,
"urgent": false,
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PayDocCur |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Подписание запроса транспортной подписью
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.12.2 Покупка и конверсия валюты
POST /v1/curr-buy - Создание документа Покупка и конверсия валюты
GET /v1/curr-buy/{externalId}/state - Получение статуса
GET /v1/curr-buy/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/curr-buy
Ресурс позволяет создавать документ Покупка и конверсия валюты.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания документа необходимо отправить POST-запрос (/v1/curr-buy), в котором передать авторизационный токен организации(Access Token) и реквизиты документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_BUY.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-buy \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/curr-buy
Body parameter
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankSwiftCode": "SABRRUMM",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | CurrBuy | true | Поручение на покупку/конверсию валюты |
Example responses
201 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankSwiftCode": "SABRRUMM",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | CurrBuy |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для документов, создаваемых по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Алгоритм сортировки дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. В дайджесте не указываются значения number и блок linkedDocs.
- Подписание запроса транспортной подписью
Ресурс /v1/curr-buy/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного документа Покупка и конверсия валюты.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса документа необходимо отправить GET-запрос (/v1/curr-buy/{externalId}/state),в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_BUY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-buy/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/curr-buy/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID поручения на покупку/конверсию валюты |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/curr-buy/{externalId}
Ресурс позволяет получить документ Покупка и конверсия валюты информацию о комиссии, купленной валюте, проданной валюте, дате валютирования, фактическом курсе сделки.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения реквизитов по отправленному документу Покупка и конверсия валюты необходимо отправить GET-запрос (/v1/curr-buy/{externalId}), в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_BUY.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-buy/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/curr-buy/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID поручения на покупку/конверсию валюты |
Example responses
200 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankSwiftCode": "SABRRUMM",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CurrBuy |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Подписание запроса транспортной подписью
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.12.3 Продажа валюты
POST /v1/curr-sell - Продажа валюты
GET /v1/curr-sell/{externalId}/state - Получение статуса
GET /v1/curr-sell/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/curr-sell
Ресурс позволяет создавать документ Продажа валюты.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания документа необходимо отправить POST-запрос (/v1/curr-sell), в котором передать авторизационный токен организации(Access Token) и реквизиты документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_SELL.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-sell \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/curr-sell
Body parameter
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | CurrSell | true | Поручение на продажу валюты |
Example responses
201 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | CurrSell |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для документов, создаваемых по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Алгоритм сортировки дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. В дайджесте не указываются значения number и блок linkedDocs.
- Подписание запроса транспортной подписью
Ресурс /v1/curr-sell/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного документа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса документа необходимо отправить GET-запрос (/v1/curr-sell/{externalId}/state),в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_SELL.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-sell/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/curr-sell/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID поручения на продажу валюты |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/curr-sell/{externalId}
Ресурс позволяет получить по ранее отправленному электронному документу Продажа валюты информацию о комиссии, проданной валюте, дате валютирования, фактическом курсе сделки.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения реквизитов по отправленному документу Покупка и конверсия валюты необходимо отправить GET-запрос (/v1/curr-sell/{externalId}), в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CURR_SELL.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/curr-sell/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/curr-sell/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID поручения на продажу валюты |
Example responses
200 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CurrSell |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Подписание запроса транспортной подписью
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.12.4 Распоряжение на перевод с транзитного счета
POST /v1/orders-mandatory-sale - Создание распоряжения на перевод с транзитного счета
GET /v1/orders-mandatory-sale/{externalId}/state - Получение статуса
GET /v1/orders-mandatory-sale/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/curr-sell
Ресурс позволяет создать распоряжения на перевод с транзитного счёта по собственной/дочерней организации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для создания документа необходимо отправить POST-запрос (/v1/orders-mandatory-sale), в котором передать авторизационный токен организации(Access Token) и реквизиты документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ORDER_MANDATORY_SALE.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/orders-mandatory-sale \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/orders-mandatory-sale
Body parameter
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankBic": "044525225",
"bankName": "ПАО СБЕРБАНК",
"customerInn": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOkpo": "222221001",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docAccount": "40802840600000200000",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"noticeDocDate": "2018-12-31",
"noticeDocNum": "12344",
"noticeDocSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"number": "1",
"transferCurrency": {
"accountNum": "40802810600000200000",
"bankSwiftCode": "SABRRUMM",
"bankSwiftName": "SBERBANK",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"transferAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"transferTo": "orgAccount"
},
"voluntarySale": {
"accountNum": "40802810600000200000",
"accountType": "orgAccount",
"bankBic": "044525225",
"bankName": "ПАО СБЕРБАНК",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"comissionAccount": "40802810600000200000",
"comissionBankBic": "044525225",
"comissionBankName": "ПАО СБЕРБАНК",
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"dealType": "sberbankRateConditions",
"sellAmount": {
"amount": 1.01,
"currencyName": "USD"
}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | OrderMandatorySale | true | РПТС |
Example responses
201 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankBic": "044525225",
"bankComment": "string",
"bankName": "ПАО СБЕРБАНК",
"bankStatus": "string",
"comment": "Комментарий",
"customerInn": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOkpo": "222221001",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docAccount": "40802840600000200000",
"employee": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"noticeDocDate": "2018-12-31",
"noticeDocNum": "12344",
"noticeDocSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"number": "1",
"receiptDate": "2018-12-31",
"transferCurrency": {
"accountNum": "40802810600000200000",
"bankSwiftCode": "SABRRUMM",
"bankSwiftName": "SBERBANK",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"transferAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"transferTo": "orgAccount",
"valueDate": "2018-12-31"
},
"voluntarySale": {
"accountNum": "40802810600000200000",
"accountType": "orgAccount",
"bankBic": "044525225",
"bankCorrAccount": "30101810400000000225",
"bankName": "ПАО СБЕРБАНК",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"comissionAccount": "40802810600000200000",
"comissionBankBic": "044525225",
"comissionBankName": "ПАО СБЕРБАНК",
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"dealType": "sberbankRateConditions",
"enrolledRub": 1.01,
"rate": 1.01,
"sellAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"valueDate": "2018-12-31"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | OrderMandatorySale |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для документов, создаваемых по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа. Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Алгоритм сортировки дайджеста
- Если какой-либо из необязательных параметров не передается, то в формировании дайджеста он также не участвует.
Теги дайджеста должны быть отсортированы по алфавиту, в формировании дайджеста не участвуют поля таблицы linkedDocs и поле number.
Подписание запроса транспортной подписью
Ресурс /v1/orders-mandatory-sale/{externalId}/state
Ресурс позволяет получить статус ранее отправленного электронного документа.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса документа необходимо отправить GET-запрос (/v1/orders_mandatory_sale/{externalId}/state),в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ORDER_MANDATORY_SALE.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/orders-mandatory-sale/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/orders-mandatory-sale/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID РПТС |
Example responses
200 Response
{
"bankComment": "Документ в обработке",
"bankStatus": "PROCESSING",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/orders-mandatory-sale/{externalId}
Ресурс позволяет получить ранее отправленный документ.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения реквизитов по отправленному документу Покупка и конверсия валюты необходимо отправить GET-запрос (/v1/orders-mandatory-sale/{externalId}), в котором передать авторизационный токен организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ORDER_MANDATORY_SALE.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/orders-mandatory-sale/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/orders-mandatory-sale/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID РПТС |
Example responses
200 Response
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankBic": "044525225",
"bankComment": "string",
"bankName": "ПАО СБЕРБАНК",
"bankStatus": "string",
"comment": "Комментарий",
"customerInn": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOkpo": "222221001",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docAccount": "40802840600000200000",
"employee": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"noticeDocDate": "2018-12-31",
"noticeDocNum": "12344",
"noticeDocSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"number": "1",
"receiptDate": "2018-12-31",
"transferCurrency": {
"accountNum": "40802810600000200000",
"bankSwiftCode": "SABRRUMM",
"bankSwiftName": "SBERBANK",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"transferAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"transferTo": "orgAccount",
"valueDate": "2018-12-31"
},
"voluntarySale": {
"accountNum": "40802810600000200000",
"accountType": "orgAccount",
"bankBic": "044525225",
"bankCorrAccount": "30101810400000000225",
"bankName": "ПАО СБЕРБАНК",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"comissionAccount": "40802810600000200000",
"comissionBankBic": "044525225",
"comissionBankName": "ПАО СБЕРБАНК",
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"dealType": "sberbankRateConditions",
"enrolledRub": 1.01,
"rate": 1.01,
"sellAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"valueDate": "2018-12-31"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | OrderMandatorySale |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Подписание запроса транспортной подписью
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.13 Сервис инкассации
GET /v1/encash/encash-contracts - Получение списка договоров инкассации
POST /v1/encash/encash-add-requests - Создание заявки на добавление объектов в договор инкассации
GET /v1/encash/encash-add-requests/{externalId}/state - Получение статуса заявки
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/encash/encash-contracts
Ресурс позволяет получить список договоров инкассации. Информация необходима для формирования заявки на добавление объекта инкассации к одному из полученных договоров.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения список договоров необходимо отправить GET-запрос (/v1/encash/encash-contracts), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор платежного поручения. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/encash/encash-contracts \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/encash/encash-contracts
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
page | query | integer(int32) | false | Номер запрашиваемой страницы (начиная с 1) |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"encashmentContracts": [
{
"createDate": "2018-12-31",
"endDate": "2018-12-31",
"feeChargeTypes": "FACT_SCHET_GRP,IPT_SEND",
"number": "38/943/04",
"objects": [
{
"address": "г.Москва, ул.Тамбовская, д.5",
"encashContractAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"encashDebitAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"name": "АО \"Тандер\" Многоцветница 773460",
"objectStatus": "ARHIV"
}
],
"servicesInfo": [
{
"serviceName": "ENCASH",
"serviceType": 0
}
],
"startDate": "2018-12-31"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | EncashmentContracts |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | None |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/encash/encash-add-requests
Ресурс позволяет создавать заявку на добавление объектов инкассации, что позволяет передать в Банк информацию о новых объектах инкассации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для создания заявки необходимо отправить POST-запрос (/v1/encash/encash-add-requests), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор платежного поручения. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/encash/encash-add-requests \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/encash/encash-add-requests
Body parameter
{
"bankComment": "string",
"bankStatus": "string",
"contactName": "Иванов Иван Иванович",
"contactRemarks": "Новый комментарий",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"email": "address@email.ru",
"encashObjects": [
{
"contractModifyDate": "2018-12-31",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectContactName": "Иванов Иван Иванович",
"objectContactPhone": "89269999999",
"objectName": "АО \"Киберлинк\" технологии 555100",
"objectRegion": "Москва",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-И",
"serviceType": 3,
"visitInfo": {
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
}
],
"workSchedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
],
"externalId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"phoneNumber": "4955005550"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | EncashAddRequest | true | Заявка на добавление объектов в договор инкассации |
Example responses
201 Response
{
"bankComment": "string",
"bankStatus": "string",
"contactName": "Иванов Иван Иванович",
"contactRemarks": "Новый комментарий",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"email": "address@email.ru",
"encashObjects": [
{
"contractModifyDate": "2018-12-31",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectContactName": "Иванов Иван Иванович",
"objectContactPhone": "89269999999",
"objectName": "АО \"Киберлинк\" технологии 555100",
"objectRegion": "Москва",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-И",
"serviceType": 3,
"visitInfo": {
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
}
],
"workSchedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
],
"externalId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"phoneNumber": "4955005550"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | EncashAddRequest |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/encash/encash-add-requests/{externalId}/state
Ресурс позволяет получить статус заявки на добавление объекта инкассации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/encash/encash-add-requests/{externalId}/state), в котором передать авторизационный токен к данным собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/encash/encash-add-requests/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/encash/encash-add-requests/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Идентификатор документа в организации-партнёре |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/encash/encashment-offers/{requestId}
Ресурс позволяет получить актуальное коммерческое предложение, связанное с заявкой на добавление объекта.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения актуального коммерческого предложения необходимо отправить GET-запрос (/v1/encash/encashment-offers ), в котором необходимо передать авторизационный токен к данным собственной организации/организации клиента (Access Token) и Идентификатор заявки. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/encash/encashment-offers/{requestId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/encash/encashment-offers/{requestId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
requestId | path | string | true | Внешний идентификатор заявки на добавление объекта в договор инкассации в организации-партнёре (UUID) |
Example responses
200 Response
{
"bankComment": "Новый",
"bankStatus": "RECEIVED",
"contractModifyDate": "2018-12-31",
"date": "2018-12-31",
"encashObjects": [
{
"examResult": "Enrolled",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectName": "АО \"Киберлинк\" технологии 555100",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-П",
"serviceType": 3,
"tariffs": [
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
],
"visitInfo": {
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
}
]
}
],
"encashOfferId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "96"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | EncashmentOffer |
204 | No Content | Коммерческое предложение отсутствует или находится в обработке | EncashmentOffer |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | None |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/encash/encashment-object-centers
Ресурс позволяет получить информацию о доступных кассово-инкассаторских центрах (КИЦ)
Шаги
- Получить AccessToken
- Отправить запрос
Для получения информацию о доступных кассово-инкассаторских центров необходимо отправить GET-запрос (/v1/encash/encashment-object-centers), в котором нужно передать авторизационный токен к данным собственной организации (Access Token) и номер запрашиваемой страницы (Page=1). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/v1/encash/encashment-object-centers?{page=1}\
-H 'Accept: application/json' \
-H 'Authorization: string'
GET /v1/encash/encashment-object-centers
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
pages | path | string | true | Номер запрашиваемой страницы (начиная с 1) |
Example responses
200 Response
{
"_links": [{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}],
"encashmentObjectCenters": [{
"eocAddress": "217146, г. Москва, ул. Красногвардейская, д.5",
"eocName": "ОО №9013/0199 КИЦ Воронежский",
"eocId": "667254"
}]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | EncashmentOffer |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/encash/encashment-offers/{externalId}/acceptance
Ресурс позволяет согласовать коммерческое предложение с передачей дополнительных данных для заключения договора на услуги инкассации или отклонить с передачей причины отказа (изменение статуса коммерческого предложения).
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
Для согласования коммерческого предложения необходимо отправить POST-запрос (/v1/encash/encashment-offers/{externalId}/acceptance), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор платежного поручения. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ENCASH_DOCUMENTS.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/encash/encashment-offers/{externalId}/acceptance \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/encash/encashment-offers/{externalId}/acceptance
Body parameter
{
"birthDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"firstName": "Иван",
"identNum": "111111",
"identSeries": "0000",
"identType": "07",
"lastName": "Иванов",
"middleName": "Иванович",
"offerStatus": "Accept",
"post": "Бухгалтер",
"remarks": "Красивый комментарий",
"warrantDate": "2018-12-31",
"warrantNum": "1111"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Идентификатор коммерческого предложения |
body | body | EncashmentOfferAddAttributes | true | Дополнительные атрибуты коммерческого предложения |
Example responses
200 Response
{
"bankComment": "Новый",
"bankStatus": "RECEIVED",
"contractModifyDate": "2018-12-31",
"date": "2018-12-31",
"encashObjects": [
{
"examResult": "Enrolled",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectName": "АО \"Киберлинк\" технологии 555100",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-П",
"serviceType": 3,
"tariffs": [
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
],
"visitInfo": {
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
}
]
}
],
"encashOfferId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "96"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | EncashmentOffer |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose – запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.14 Инкассовые поручения
POST /v1/collection-orders - Создание рублевого инкассового поручения
GET /v1/collection-orders/{externalId}/state - Получение статуса
GET /v1/collection-orders/{externalId} - Получение документа
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/collection-orders
Ресурс позволяет отправить запрос на создание рублевого инкассового поручения для расчетно-кассового обслуживания.
Шаги
- Получить AccessToken
- Отправить запрос
- Получить статус
Для создания рублевого инкассового поручения необходимо отправить POST-запрос (/v1/collection-orders), в котором передать авторизационный токен собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис COLLECTION_ORDERS.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/collection-orders \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/collection-orders
Body parameter
{
"amount": 1.01,
"date": "2018-12-31",
"deliveryKind": "электронно",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | CollectionOrder | true | Рублёвое инкассовое поручение |
Example responses
201 Response
{
"amount": 1.01,
"balancePayment": 0,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileDate": "2019-08-24T14:15:22Z",
"numPartPayment": "string",
"numPayOrder": "string",
"number": "1",
"operationCode": "01",
"orderDate": "2019-08-24T14:15:22Z",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"sumPartPayment": 0,
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | CollectionOrder |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/collection-orders/{externalId}/state
Ресурс позволяет получить статус отправленного запроса на создание рублевого инкассового поручения.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/collection-orders/{externalId}/state), в котором передать авторизационный токен собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис COLLECTION_ORDERS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/collection-orders/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/collection-orders/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID рублёвого инкассового поручения |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/collection-orders/{externalId}
Ресурс позволяет получить ранее отправленное рублевое инкассовое поручение.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения документа необходимо отправить GET-запрос (/v1/collection-orders/{externalId}), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор документа. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис COLLECTION_ORDERS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/collection-orders/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/collection-orders/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID рублёвого инкассового поручения |
Example responses
200 Response
{
"amount": 1.01,
"balancePayment": 0,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileDate": "2019-08-24T14:15:22Z",
"numPartPayment": "string",
"numPayOrder": "string",
"number": "1",
"operationCode": "01",
"orderDate": "2019-08-24T14:15:22Z",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"sumPartPayment": 0,
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CollectionOrder |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose– запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.15 Входящие платежные требования
POST /v1/acceptance-letters - Создание заявления об акцепте/отказе от акцепта
GET /v1/acceptance-letters/{externalId}/state - Получение статуса
GET /v1/payment-requests/incoming - Получение входящих платежных требований
GET /v1/payment-requests/incoming/{externalId}/state - Получение статуса
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/acceptance-letters
Ресурс позволяет создать заявление об акцепте/отказе от акцепта входящего платежного требования.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
Для создания заявления необходимо отправить POST-запрос (/v1/acceptance-letters ), в котором передать авторизационный токен собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ACCEPTANCE_LETTERS.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/acceptance-letters \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/acceptance-letters
Body parameter
{
"amount": 1.01,
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"nonAcceptReason": "string",
"number": "1",
"payReqAmount": 1.01,
"payReqDate": "2018-12-31",
"payReqExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"payReqLastDate": "2018-12-31",
"payReqNumber": "2",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"type": "accept"
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | AcceptanceLetter | true | Заявка на удаленное подключение «Зарплатного проекта» |
Example responses
201 Response
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"nonAcceptReason": "string",
"number": "1",
"payReqAmount": 1.01,
"payReqDate": "2018-12-31",
"payReqExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"payReqLastDate": "2018-12-31",
"payReqNumber": "2",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"type": "accept"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | AcceptanceLetter |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП (можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Для платёжных поручений, создаваемым по собственным счетам можно передать одну или две электронных подписей (или не передавать при отсутствии ЭП) вместе с реквизитами создаваемого документа . Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе Интернет-банк СберБизнес.
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Формат дайджеста
Теги дайджеста должны быть отсортированы по алфавиту. Если значение поля не определено, то тег в дайджесте не используется.
- Подписание запроса транспортной подписью
Ресурс /v1/acceptance-letters/{externalId}/state
Ресурс позволяет получить статус отправленного запроса на создание заявления об акцепте/отказе от акцепта входящего платежного требования.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/acceptance-letters/{externalId}/state ), в котором передать авторизационный токен собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис ACCEPTANCE_LETTERS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/acceptance-letters/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/acceptance-letters/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Идентификатор документа |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/payment-requests/incoming
Ресурс позволяет получить входящие платежные поручения за указанную дату.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения входящих платежных поручений необходимо отправить GET-запрос (/v1/payment-requests/incoming ), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token), дату и номер страницы . Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYMENTS_REQUEST_IN.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payment-requests/incoming?date=2019-08-24T14%3A15%3A22Z \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payment-requests/incoming
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
date | query | string(date-time) | true | Дата (yyyy-MM-dd) |
page | query | integer(int32) | false | Номер запрашиваемой страницы (начиная с 1) |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"paymentsRequestIn": [
{
"acceptLastDate": "2018-12-31",
"acceptanceTerm": "20",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PaymentRequestsInInfo |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/payment-requests/incoming/{externalId}/state
Ресурс позволяет получить статус входящего платежного требования.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/payment-requests/incoming/{externalId}/state), в котором передать авторизационный токен собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис PAYMENTS_REQUEST_IN.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/payment-requests/incoming/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/payment-requests/incoming/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID входящего платёжного требования |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose –запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.16 Сервис самоинкассации
POST /v1/self-encashers-requests - Заявление на добавление вносителя самоинкассации
GET /v1/self-encashers-requests/{externalId}/state - Получение статуса документа
GET /v1/self-encashers-requests/{externalId} - Получение заявления
POST /v1/self-encashers/block - Блокировка вносителя самоинкассации
POST /v1/self-encashers/new-password - Генерация нового пароля вносителя самоинкассации
Для обращения к ресурсам необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/self-encashers-requests
Ресурс позволяет создавать заявления на добавление нового вносителя самоинкассации.
Шаги
- Получить AccessToken
- Сформировать ЭП
- Отправить запрос
- Получить статус
- Получить документ
Для создания заявления на добавление вносителя необходимо отправить POST-запрос (/v1/self-encashers-requests), в котором передать авторизационный токен к данным собственной организации (Access Token) и реквизиты заявления. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SELF_ENCASHER_REQUEST.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/self-encashers-requests \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/self-encashers-requests
Body parameter
{
"agreedAdmOperation": false,
"attorneyNumber": "51 А А 0001904",
"birthDate": "2018-12-31",
"birthPlace": "Москва",
"byAttorney": false,
"citizenshipCountryCode": "643",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"empowermentEnd": "2018-12-31",
"empowermentStart": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"gender": "F",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г. Москвы",
"issuerCode": "222-222",
"number": "111222",
"serial": "1111",
"typeCode": "21"
},
"insuranceNumber": "11111111111",
"login": "username",
"name": "Дмитрий",
"number": "1",
"patronymic": "Сергеевич",
"persInfoConsent": false,
"phone": "79269999999",
"regAddress": {
"building": "1",
"city": "Александров",
"countryCode": "643",
"district": "Александровский",
"flat": "1",
"house": "1",
"postalCode": "601650",
"settlement": "село Андреевское",
"state": "Владимирская область",
"street": "Институтская"
},
"surname": "Петров",
"taxNumber": "7707083893",
"templates": [
"string"
]
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
body | body | SelfEncasherRequest | true | Информация о новом вносителе |
Example responses
201 Response
{
"agreedAdmOperation": false,
"attorneyNumber": "51 А А 0001904",
"bankComment": "string",
"bankStatus": "string",
"birthDate": "2018-12-31",
"birthPlace": "Москва",
"byAttorney": false,
"citizenshipCountryCode": "643",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"empowermentEnd": "2018-12-31",
"empowermentStart": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"gender": "F",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г. Москвы",
"issuerCode": "222-222",
"number": "111222",
"serial": "1111",
"typeCode": "21"
},
"insuranceNumber": "11111111111",
"login": "username",
"name": "Дмитрий",
"number": "1",
"patronymic": "Сергеевич",
"persInfoConsent": false,
"phone": "79269999999",
"regAddress": {
"building": "1",
"city": "Александров",
"countryCode": "643",
"district": "Александровский",
"flat": "1",
"house": "1",
"postalCode": "601650",
"settlement": "село Андреевское",
"state": "Владимирская область",
"street": "Институтская"
},
"surname": "Петров",
"taxNumber": "7707083893",
"templates": [
"string"
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | SelfEncasherRequest |
202 | Accepted | Операция не завершена полностью | WorkflowFault |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Передача электронной подписи вместе с документом
Заявление должно быть подписано электронной подписью (ЭП). Для передачи ЭП в теле запроса используется массив digestSignatures, в котором передаются элементы типа Signature:
Наименование поля | Тип данных | Описание поля | О | Пример |
---|---|---|---|---|
base64Encoded | String | Значение ЭП документа | √ | HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep 6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71 TBS7w== |
certificateUuid | String | Идентификатор сертификата, использованного при создании ЭП ( можно узнать, обратившись к ресурсу /v1/crypto) | √ | 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6 |
Документ может быть подписан следующими наборами подписей:
- одна (единственная) подпись,
- первая и вторая подписи.
При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.
Очерёдность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля пользователя при заведении в Банке.
Формирование электронной подписи (ГОСТ 2012)
Ресурс /v1/self-encashers-requests/{externalId}/state
Ресурс позволяет получить статус заявления на добавление вносителя самоинкассации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статуса необходимо отправить GET-запрос (/v1/self-encashers-requests/{externalId}/state), в котором передать авторизационный токен к данным собственной организации (Access Token) и идентификатор документа (externalId). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SELF_ENCASHER_REQUEST.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/self-encashers-requests/{externalId}/state \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/self-encashers-requests/{externalId}/state
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID заявления на создание нового вносителя самоинкассации |
Example responses
200 Response
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DocState |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/self-encashers-requests/{externalId}
Ресурс позволяет получить атрибуты ранее отправленного заявления на добавление вносителя самоинкассации.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения заявления на добавление вносителя необходимо отправить GET-запрос (/v1/self-encashers-requests/{externalId}), в котором необходимо передать авторизационный токен к данным собственной организации (Access Token) и внешний идентификатор заявления. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SELF_ENCASHER_REQUEST.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/self-encashers-requests/{externalId} \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/self-encashers-requests/{externalId}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Внешний UUID заявления на создание нового вносителя самоинкассации |
Example responses
200 Response
{
"attorneyNumber": "51 А А 0001904",
"bankComment": "string",
"bankStatus": "string",
"byAttorney": false,
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"empowermentEnd": "2018-12-31",
"empowermentStart": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"login": "username",
"number": "1"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | SelfEncasherRequestInfo |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
404 | Not Found | Не найдено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/self-encashers/block
Ресурс позволяет блокировать вносителя самоинкассации.
Шаги
- Получить AccessToken
- Отправить запрос
Для блокирования вносителя самоинкассации необходимо отправить POST-запрос (/v1/self-encashers/block), в котором передать авторизационный токен к данным собственной организации (Access Token) и login блокируемого вносителя. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SELF_ENCASHER_BLOCK.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/self-encashers/block \
-H 'Content-Type: application/jose' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/self-encashers/block
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
Example responses
400 Response
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | None |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
- Подписание запроса транспортной подписью
Ресурс /v1/self-encashers/new-password
Ресурс позволяет создать новый пароль вносителя самоинкассации.
Шаги
- Получить AccessToken
- Отправить запрос
Для создания нового пароля вносителя самоинкассации необходимо отправить POST-запрос (/v1/self-encashers/new-password), в котором передать авторизационный токен к данным собственной организации (Access Token) и login вносителя. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SELF_ENCASHER_NEW_PASSWORD.
Code samples
# You can also use wget
curl -X POST https://edupirfintech.sberbank.ru:9443/fintech/api/v1/self-encashers/new-password \
-H 'Content-Type: application/jose' \
-H 'Accept: */*' \
-H 'Authorization: string'
POST /v1/self-encashers/new-password
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
Example responses
400 Response
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | None |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
- Подписание запроса транспортной подписью
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose –запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары пользователя (используется приватный ключ парный сертификату пользователя с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
2.17 Формирование электронной подписи (ГОСТ 2012)
- Запросы необходимо отправлять на http://localhost:28016/vpnkeylocal/
/, где SID2-идентификатор сессии, получаемый после перехода в бизнес-систему. - Подробнее о форматах запроса смотрите "VPNKeyTLS505b20_API.doc".
Для того чтобы получить ЭП VPNKeyTLS в формате CMS необходимо:
- Cформировать строковую последовательность (ключевой буфер или дайджест), включающий все значимые данные документа.
- Определить список сертификатов, находящихся на VPNKeyTLS, методом GET_OBJ_LIST_ID.
- Определить handle сертификата методом INIT_SIGN_H_ID. Для работы по ГОСТ 2011 и выше необходимо указать хендл сертификата на этапе вызова команды "INIT_SIGN_H_ID", т.к. параметры криптооперации берутся из сертификата. Если сертификат не будет указан при вызове INIT_SIGN_H_ID, то его будет необходимо указать в конце, однако, в этом случае подписание будет произведено по ГОСТ-3411_1994_256, и если указанный в конце сертификат содержит другие параметры подписания, то операция будет завершена с ошибкой.
- Передать методу SET_SIGN_DATA_H_ID дайджест в формате base64 и handle сертификата.
- Вычислить подпись методом CALC_SIGN_H_ID. Поле "obj_id" не рекомендуется использовать с командой "CALC_SIGN_H_ID", т.к. рекомендуется использовать его на этапе вызова команды "INIT_SIGN_H_ID". Подробнее смотрите примечание к "INIT_SIGN_H_ID"
- Получить ЭП в формате CMS методом GET_SIGN_CMS_H_ID. Необходимо объединить head + suffix, полученные на текущем шаге, и полученное значение передать в параметре base64Encoded параметра запроса.
2.18 Получение статистики по количеству запросов к API
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/partner-info/request-statistics
Ресурс позволяет получить статистику по количеству запросов к API.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения статистики необходимо отправить GET-запрос (/v1/partner-info/request-statistics), в котором передать авторизационный токен собственной организации (Access Token). Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис GET_REQUEST_STATISTICS.
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/partner-info/request-statistics?dateSince=2019-08-24T14%3A15%3A22Z&dateUntil=2019-08-24T14%3A15%3A22Z \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/partner-info/request-statistics
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
dateSince | query | string(date-time) | true | Дата начала периода (yyyy-MM-dd) |
dateUntil | query | string(date-time) | true | Дата окончания периода (yyyy-MM-dd) |
clientId | query | integer(int64) | false | Идентификатор сервиса |
Example responses
200 Response
{
"billingObjects": [
{
"numberRequests": 1000,
"serviceName": "Код авторизации",
"serviceSystemName": "sso-authorize"
}
],
"nonBillingObjects": [
{
"numberRequests": 1000,
"serviceName": "Код авторизации",
"serviceSystemName": "sso-authorize"
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | RequestStatistics |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
2.19 Обновление справочника ценовых предложений по международной логистике
GET /v1/shipping-tariffs - Получение списка тарифных планов
PUT /v1/shipping-tariffs/{externalId} - Добавление/обновление тарифов по международной логистике
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур https://edupirfintech.sberbank.ru:9443
- Промышленный контур https://fintech.sberbank.ru:9443
Ресурс /v1/shipping-tariffs
Ресурс позволяет получить список всех когда-либо загруженных тарифов, также получить список тарифов на необходимую дату.
Шаги
- Получить AccessToken
- Отправить запрос
Для получения списка тарифов необходимо отправить GET-запрос (/v1/shipping-tariffs), в котором нужно передать авторизационный токен к данным собственной организации (Access Token). Также, при необходимости, указать дату tariffDate, по которую необходимо получить весь список действующих тарифных планов. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SHIPPING_TARIFF
Code samples
# You can also use wget
curl -X GET https://edupirfintech.sberbank.ru:9443/fintech/api/v1/shipping-tariffs \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
GET /v1/shipping-tariffs
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
page | query | string | true | Номер запрашиваемой страницы (начиная с 1) |
tariffDate | query | Date | false | Дата, по которой необходимо получить весь список действующих тарифных планов |
body | body | ShippingTariffs | true | Список тарифов по международной логистике |
Example responses
200 Response
{
"_links": [
{
"href": "?tariffDate=2018-03-15&page=3",
"rel": "next"
}
],
"shippingTariff": [
{
"beginDate": "2018-12-31",
"cancelDate": "2018-12-31",
"currency": "840",
"currencyIn": "string",
"deliveryTimeMax": 16,
"deliveryTimeMin": 14,
"deliveryType": "RW",
"departmentCode": "JPYOK",
"destinationCode": "RUMOW",
"endDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fclContainerType": "20",
"lclMaxWeight": 0,
"lclMinWeight": 0,
"loadingType": "FCL",
"payType": "AFTER",
"portCode": "string",
"routeCode": "string",
"routeComment": "string",
"tariffValue": 0,
"tariffValueIn": 0
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ShippingTariff |
400 | Bad Request | Неверный формат запроса | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Доступ к ресурсу запрещён | Notice |
404 | Not Found | Тариф по данному партнёру не найден | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
Ресурс /v1/shipping-tariffs/{externalId}
Ресурс позволяет д обавить/обновить тариф , для того, чтобы иметь возможность работы с тарифами по международной логистике.
Шаги
- Получить AccessToken
- Отправить запрос
Для добавления тарифа необходимо отправить PUT-запрос (/v1/shipping-tariffs/{externalId} ), в котором передать авторизационный токен к данным собственной организации (Access Token), идентификатор тарифа в организации-партнёра (externalId) и информацию о тарифе по международной логистике. Авторизационный токен передается в параметре Authorization заголовка запроса.
Чтобы получить доступ к ресурсу, необходимо передать в scope сервис SHIPPING_TARIFF
Code samples
# You can also use wget
curl -X PUT https://edupirfintech.sberbank.ru:9443/fintech/api/v1/shipping-tariffs/{externalId} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Authorization: string'
PUT /v1/shipping-tariffs/{externalId}
Body parameter
{
"beginDate": "2018-12-31",
"cancelDate": "2018-12-31",
"currency": "840",
"currencyIn": "string",
"deliveryTimeMax": 16,
"deliveryTimeMin": 14,
"deliveryType": "RW",
"departmentCode": "JPYOK",
"destinationCode": "RUMOW",
"endDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fclContainerType": "20",
"lclMaxWeight": 0,
"lclMinWeight": 0,
"loadingType": "FCL",
"payType": "AFTER",
"portCode": "string",
"routeCode": "string",
"routeComment": "string",
"tariffValue": 0,
"tariffValueIn": 0
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
Authorization | header | string | true | Access token организации-клиента, полученный через SSO |
externalId | path | string | true | Идентификатор тарифа в организации-партнёре |
body | body | ShippingTariff | true | Информация о тарифе по международной логистике |
Example responses
200 Response
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"shippingTariffs": [
{
"beginDate": "2018-12-31",
"cancelDate": "2018-12-31",
"currency": "840",
"currencyIn": "string",
"deliveryTimeMax": 16,
"deliveryTimeMin": 14,
"deliveryType": "RW",
"departmentCode": "JPYOK",
"destinationCode": "RUMOW",
"endDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fclContainerType": "20",
"lclMaxWeight": 0,
"lclMinWeight": 0,
"loadingType": "FCL",
"payType": "AFTER",
"portCode": "string",
"routeCode": "string",
"tariffValue": 0,
"tariffValueIn": 0
}
]
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ShippingTariff |
400 | Bad Request | Ошибка в запросе или его жизненном цикле | ResourceFault |
401 | Unauthorized | Не авторизован | Notice |
403 | Forbidden | Запрещено | Notice |
500 | Internal Server Error | Внутренняя ошибка сервера | Notice |
503 | Service Unavailable | Сервис временно недоступен | Notice |
- Подписание запроса транспортной подписью
Дополнительная информация
Content-Type может содержать одно из двух значений:
1) application/json – запрос без подписи
2) application/jose– запрос, подписанный транспортной подписью
Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).
JWS состоит из:
- Заголовка (Header)
- JSON-документа с реквизитным составом платежного поручения (Payload)
- Подписи запроса (Signature)
Формирование компактной сериализации JWS
JWS формируется из трех составляющих:
Base64Url(Header) || ’.’ || Base64Url(Payload) || ’.’ || Base64Url(Signature)
Signature - это подпись данных приватной частью ключевой пары клиента (используется приватный ключ парный сертификату клиента с UUID, указанному в Заголовке (Header) в параметре kid). Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных: Base64Url(Header) || ‘.’ || Base64Url(Payload).
Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).
Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования. Условно это преобразование можно представить следующим образом:
Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)
здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.
Преобразование BASE64URL, отличается от BASE64 преобразования:
- Используются другие вспомогательные символы Base 64 Encoding with URL and Filename Safe Alphabet.
BASE64URL | BASE64 |
---|---|
- (minus) | + |
_ (underline) | / |
- В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data
В ответе на запрос сервер возвращает JSON-документ, который содержит реквизитный состав подготовленного черновика рублевого платежного поручения в статусе Создан.
Обратная связь
Вы можете задать вопросы нашим разработчикам, оставить отзыв и предложить улучшения по SberBusinessAPI:
- в репозитории на github;
- в письме на адрес электронной почты fintech_API@sberbank.ru.
Schemas
Error
{
"ex": "string",
"url": "string"
}
Информационное сообщение об ошибке
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
ex | string | false | none | Сообщение об ошибке |
url | string | false | none | Адрес запроса |
SSOTokenResponseSuccess
{
"access_token": "93b1afbd-a9ce-446e-88ce-14f652320001-1",
"expires_in": 3600,
"id_token": "eyJhbGciOiJub0.ICAgImlzcyI6Mjg5NzYxMDAxIiwNCiAgICJhdWQiO.",
"refresh_token": "771e239f-e30d-404f-825a-004314b56011-1",
"scope": "openid exampleservice exampleclaim",
"token_type": "Bearer"
}
Успешный ответ на запрос Access Token
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
access_token | string | false | none | Значение Access Token |
expires_in | integer(int32) | false | none | Срок истечения действия Access Token в секундах |
id_token | string | false | none | Значение Id Token |
refresh_token | string | false | none | Значение Refresh Token |
scope | string | false | none | Область сведения |
token_type | string | false | none | Тип токена |
ActivatedTariffPlan
{
"bankStatus": "ACTIVE",
"freePeriod": 2,
"freePeriodType": "М",
"freezeDate": "2018-12-31T23:59:59",
"freezed": true,
"paymentEndDate": "2018-12-31",
"paymentStartDate": "2018-12-31",
"paymentType": "UNPAID",
"tariffActivationDate": "2018-12-31",
"tariffDescription": "Продукт позволяет избежать ограничений по 115-ФЗ",
"tariffDisconnectionDate": "2018-12-31",
"tariffName": "Безопасный бизнес Базовый",
"tariffSystemName": "SECURE_BUSINESS_BASIC"
}
Тарифный план, подключенный пользователю организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankStatus | string | true | none | Статус подписки |
freePeriod | integer(int64) | true | none | Бесплатный период |
freePeriodType | string | true | none | Размерность бесплатного периода (Y - год, Q - квартал, M - месяц) |
freezeDate | string(date-time) | true | none | Дата и время приостановки тарифа |
freezed | boolean | true | none | Показатель приостановки тарифа |
paymentEndDate | string(date-time) | true | none | Дата, до которой оплачен тариф |
paymentStartDate | string(date-time) | true | none | Дата начала тарификации |
paymentType | string | true | none | Тип оплаты тарифа |
tariffActivationDate | string(date-time) | true | none | Дата подключения тарифа |
tariffDescription | string | true | none | Описание тарифного плана |
tariffDisconnectionDate | string(date-time) | true | none | Дата окончания тарификации |
tariffName | string | true | none | Наименование тарифного плана |
tariffSystemName | string | true | none | Системное наименование тарифного плана |
Enumerated Values
Property | Value |
---|---|
paymentType | PREPAID |
paymentType | POSTPAID |
paymentType | UNPAID |
Owner
{
"age": 40
}
Бенефициарный владелец
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
age | integer(int32) | true | none | Возраст бенефициарного владельца |
Customer
{
"accounts": [
{
"accountBic": "044525225",
"accountId": 11,
"accountNumber": "40802810600000200000",
"accountState": "OPEN",
"accountType": "STANDART",
"businessNewType": false,
"businessOldType": false,
"gosContractNum": "1920187408202412245023026",
"gosContractorType": "NORM"
}
],
"orgActive": false,
"orgBusinessSegment": "05",
"orgFinanceBlock": false,
"orgFullName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgGuid": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"orgInn": "7707083893",
"orgKpp": "222201001",
"orgOgrn": "380123456789012",
"orgOkpo": "222221001",
"orgShortName": "\"Клиент\"",
"services": [
{
"clientID": 1234,
"enabledDate": "2018-12-31"
}
],
"terBank": "Территориальный банк",
"terBankLevel2": "Удмуртское ОСБ",
"terBankLevel3": "Удмуртское ОСБ №444",
"usersInfo": [
{
"sbbol3": false,
"servicesEnabled": [
{
"clientID": 1234,
"enabledDate": "2018-12-31"
}
],
"sub": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"userActive": false,
"userCryptoType": "SMS",
"userEmail": "address@email.ru",
"userGroups": "Руководитель",
"userId": 11,
"userIdentified": false,
"userLogin": "User",
"userName": "Иванов Иван Иванович",
"userPhoneNumber": "4955005550"
}
]
}
Информация по клиентам для КОРУС
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accounts | [CustomerAccount] | false | none | Информация о счетах |
orgActive | boolean | false | none | Признак активности организации |
orgBusinessSegment | string | false | none | Бизнес-сегмент |
orgFinanceBlock | boolean | false | none | Признак финансовой блокировки |
orgFullName | string | false | none | Полное наименование организации |
orgGuid | string | false | none | Глобальный идентификатор организации |
orgInn | string | false | none | ИНН / КИО |
orgKpp | string | false | none | KPP |
orgOgrn | string | false | none | ОГРН |
orgOkpo | string | false | none | ОКПО |
orgShortName | string | false | none | Сокращённое наименование организации |
services | [CustomerEnabledService] | false | none | Подключенные в ВСП платные сервисы |
terBank | string | false | none | Наименование территориального банка |
terBankLevel2 | string | false | none | Наименование нижестоящего подразделения (1-го по иерархии после ТБ) |
terBankLevel3 | string | false | none | Наименование нижестоящего подразделения (2-го по иерархии после ТБ) |
usersInfo | [CustomerUser] | false | none | Информация о пользователях |
AccountsInfo
{
"accounts": [
{
"absId": "string",
"amount": 1.01,
"amountDate": "2018-12-31T23:59:59",
"amountRub": 1.01,
"bic": "044525225",
"blockedQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSumQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSums": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"business": false,
"businessNewType": false,
"cdiAcptDocQnt": 0,
"cdiAcptDocSum": 1.01,
"cdiCart2DocQnt": 0,
"cdiCart2DocSum": 1.01,
"cdiPermDocQnt": 0,
"cdiPermDocSum": 1.01,
"closeDate": "2018-12-31",
"comment": "string",
"credCard": false,
"creditBlocked": false,
"creditBlockedBeginDate": "2018-12-31",
"creditBlockedCause": "string",
"creditBlockedEndDate": "2018-12-31",
"creditBlockedInitiator": "string",
"creditBlockedTaxAuthorityCode": "string",
"currencyCode": "810",
"dbo": false,
"debitBlocked": false,
"debitBlockedBeginDate": "2018-12-31",
"debitBlockedCause": "string",
"debitBlockedEndDate": "2018-12-31",
"debitBlockedInitiator": "string",
"debitBlockedTaxAuthorityCode": "string",
"eksId": "string",
"minBalance": 1.01,
"mode": "STANDART",
"name": "string",
"notDelay": false,
"number": "40802810600000200000",
"openDate": "2018-12-31",
"overdraft": 1.01,
"passive": false,
"state": "OPEN",
"type": "assuranceRegistration",
"urgent": false
}
]
}
Информация о счетах клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accounts | [AccountInfo] | false | none | Информация о счетах |
ResourceFault
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Описание ошибки ресурса (ошибка в запросе или его жизненном цикле)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
referenceId | string | false | none | Уникальный идентификатор ошибки (UUID) |
message | string | false | none | Сообщение |
checks | [Check] | false | none | Список проверок, приведших к ошибке |
fieldNames | [string] | false | none | Названия полей с некорректным значением (только для VALIDATION_FAULT) |
BfAttachment
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
Данные о вложении документа (большой файл)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fileId | string | false | none | Уникальный идентификатор файла |
fileName | string | false | read-only | Имя файла |
CurrControlMessagesFromBank
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"messages": [
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"refDocument": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"rootMessage": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"subject": "Досыл документа.",
"text": "Добрый день. Документ отправлен."
}
]
}
Письма для целей ВК (из банка)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
messages | [CurrControlMessageFromBank] | false | none | Письма для целей ВК (из банка) |
CreditAttraction
{
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD",
"hasPercentType": false,
"interestCredit": 1.01,
"nonResidentCountryCode": "643",
"nonResidentCountryName": "РОССИЯ",
"nonResidentName": "Kazan"
}
Привлечение кредита на синдицированной (консорциональной) основе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма привлечения резидентом кредита, предоставленного нерезидентами |
currencyCode | string | false | none | Цифровой код валюты привлечения резидентом кредита, предоставленного нерезидентами |
currencyName | string | false | none | Буквенный ISO-код валюты привлечения резидентом кредита, предоставленного нерезидентами |
hasPercentType | boolean | true | none | Доля или сумма (false - сумма, true - доля) |
interestCredit | number | false | none | Доля в общей сумме кредита, % |
nonResidentCountryCode | string | false | none | Цифровой код страны нерезидента |
nonResidentCountryName | string | false | none | Наименование страны нерезидента |
nonResidentName | string | false | none | Наименование нерезидента |
ShippingTariff
{
"beginDate": "2018-12-31",
"cancelDate": "2018-12-31",
"currency": "840",
"currencyIn": "string",
"deliveryTimeMax": 16,
"deliveryTimeMin": 14,
"deliveryType": "RW",
"departmentCode": "JPYOK",
"destinationCode": "RUMOW",
"endDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fclContainerType": "20",
"lclMaxWeight": 0,
"lclMinWeight": 0,
"loadingType": "FCL",
"payType": "AFTER",
"portCode": "string",
"routeCode": "string",
"routeComment": "string",
"tariffValue": 0,
"tariffValueIn": 0
}
Тариф по международной логистике
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
beginDate | string(date-time) | true | none | Дата начала действия тарифа |
cancelDate | string(date-time) | false | none | Дата отмены действия тарифа |
currency | string | true | none | Трёхзначный код валюты |
currencyIn | string | false | none | Трехзначный код валюты (внутренние перевозки) |
deliveryTimeMax | integer(int32) | false | none | Максимальное транзитное время в днях |
deliveryTimeMin | integer(int32) | false | none | Минимальное транзитное время в днях |
deliveryType | string | true | none | Тип доставки |
departmentCode | string | true | none | Код города отправки |
destinationCode | string | true | none | Код города получения |
endDate | string(date-time) | true | none | Дата окончания действия тарифа |
externalId | string | false | none | Идентификатор тарифа в организации-партнёре (UUID) |
fclContainerType | string | false | none | Тип контейнера |
lclMaxWeight | number | false | none | Максимальный вес диапазона (для LCL) |
lclMinWeight | number | false | none | Минимальный вес диапазона (для LCL) |
loadingType | string | true | none | Тип загрузки |
payType | string | true | none | Тип оплаты |
portCode | string | false | none | Код города – порта для доставки морем или транзитного населенного пункта |
routeCode | string | false | none | Код маршрута |
routeComment | string | false | none | Комментарий к маршруту |
tariffValue | number | true | none | Тариф на доставку |
tariffValueIn | number | false | none | Тариф на доставку (внутренние перевозки) |
Enumerated Values
Property | Value |
---|---|
deliveryType | AIR |
deliveryType | SEA |
deliveryType | RW |
fclContainerType | 20 |
fclContainerType | 40 |
fclContainerType | 40H |
fclContainerType | 40R |
fclContainerType | 40RH |
loadingType | LCL |
loadingType | FCL |
payType | AFTER |
payType | BEFORE |
DepositCondition
{
"currency": "RUB",
"depositName": "Депозит Классический Онлайн",
"depositSubtype": "Нет",
"depositSubtypeCode": "1",
"depositSubtypeFullDescription": "string",
"instrumentDescription": "string",
"isIndividualRate": false,
"maxDepositSum": 1000000,
"maxDepositTerm": 1096,
"minDepositSum": 1,
"minDepositTerm": 7,
"productType": "DEPOSIT",
"rateType": "UL",
"rates": {
"amountRanges": [
{
"from": 0,
"to": 0
}
],
"daysRanges": [
[
{
"from": 0,
"to": 0
}
]
],
"rates": [
[
0
]
]
},
"refund": false,
"revocation": false
}
Условие размещения депозита
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
currency | string | false | none | Валюта |
depositName | string | false | none | Наименование депозита / нсо |
depositSubtype | string | false | none | Спецусловие, стандартные - 'Нет', повторное размещение - '+ 5%', повт. разм. с увел. срока или суммы в два раза - '+ 10%' |
depositSubtypeCode | string | false | none | Код спецусловия, 1 - 'Нет', 2 - '+ 5%', 3 - '+ 10%' |
depositSubtypeFullDescription | string | false | none | Полное описание спецусловия |
instrumentDescription | string | false | none | Полное описание инструмента |
isIndividualRate | boolean | false | none | Признак вклада по индивидуальной ставке |
maxDepositSum | number | false | none | Максимальная сумма депозита |
maxDepositTerm | integer(int32) | false | none | Максимальный срок депозита |
minDepositSum | number | false | none | Минимальная сумма депозита |
minDepositTerm | integer(int32) | false | none | Минимальный срок депозита |
productType | string | false | none | Тип продукта |
rateType | string | false | none | Категоря клиентов, для которой действует инструмент |
rates | DepositConditionRate | false | none | Условие размещения депозита (ставка) |
refund | boolean | false | none | Возможность пополнения |
revocation | boolean | false | none | Возможность досрочного отзыва |
EncashmentOfferServiceTariff
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
Тарифы/платы по услуге
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isNds | boolean | false | none | Признак расчета с НДС |
tariffKind | string | false | none | Вид комиссии |
tariffMax | number | false | none | Максимум |
tariffMin | number | false | none | Минимум |
tariffRate | number | false | none | % от суммы денежной наличности |
tariffSum | number | false | none | Сумма |
CertRequestEio
{
"bankComment": "string",
"bankStatus": "string",
"email": "address@email.ru",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"login": "L1",
"number": "1",
"orgName": "ООО \"Организация\"",
"pkcs10": {
"bicryptId": "A001NVA3",
"cms": "-----BEGIN CMS-----\n ... MIIIj ... \n-----END CMS-----"
},
"userName": "Иванов Иван Иванович",
"userPosition": "Операционист"
}
Запрос на новый сертификат от ЕИО
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
string | true | none | Адрес электронной почты | |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
login | string | true | none | Логин пользователя, для которого создаётся запрос на сертификат |
number | string | false | none | Номер документа |
orgName | string | false | none | Краткое наименование организации |
pkcs10 | Pkcs10 | true | none | Информация о запросе |
userName | string | true | none | Фамилия, имя и отчество |
userPosition | string | true | none | Должность |
CurrControlMessageToBank
{
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"ТЕСТ\"",
"refDocument": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"rootMessage": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"subject": "Досыл документа.",
"text": "Добрый день. Документ отправлен."
}
Письмо для целей ВК (в банк)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Данные о файлах, связанных с письмом для целей ВК |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
number | string | false | none | Номер документа |
orgName | string | true | none | Наименование организации клиента |
refDocument | LinkedDoc | false | none | Связанный документ |
rootMessage | LinkedDoc | false | none | Связанный документ |
subject | string | true | none | Тема письма |
text | string | true | none | Текст письма |
SetEInvoicingDocsCountAndRefreshDateRequest
{
"docCountActualDate": "2019-08-24T14:15:22Z",
"noticeType": "USERDOCCOUNT",
"noticeValue": 0,
"sub": "string"
}
Модель параметров запроса на уведомление об актуальном количестве документов в сервисе документооборота
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
docCountActualDate | string(date-time) | true | none | Дата и время подсчета кол-ва документов (yyyy-MM-dd'T'HH:mm:ss) |
noticeType | string | true | none | Тип документа |
noticeValue | integer(int64) | true | none | Значение |
sub | string | true | none | Хэш идентификатора пользователя |
Enumerated Values
Property | Value |
---|---|
noticeType | USERDOCCOUNT |
noticeType | ORGDOCCOUNT |
AsupResponse
{
"channel": "FINTECH",
"datetime": "2018-12-31T23:59:59",
"offerId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"placement": "MAIN[MAIN_FEED]",
"type": "OR"
}
Отклик на персональное предложение АСУП
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
channel | string | true | none | Канал получения отклика |
datetime | string(date-time) | false | none | Дата и время создания отклика |
offerId | string | true | none | Идентификатор предложения |
placement | string | false | none | Страница размещения предложения (плейсмента) |
type | string | true | none | Тип отклика |
Enumerated Values
Property | Value |
---|---|
channel | SBBOL |
channel | DCB |
channel | MP |
channel | SBB |
channel | SBBOL3 |
channel | FINTECH |
type | SHM |
type | STA |
type | STL |
type | HDC |
type | UHC |
type | SCT |
type | STR |
type | NPC |
type | THL |
type | ORC |
type | ORL |
type | HIM |
type | OCS |
type | SHW |
type | HDF |
type | SLL |
type | SLR |
type | SLS |
type | OC |
type | BAD |
type | LGN |
type | OR |
type | TXL |
type | TXW |
type | TXN |
type | OCB |
type | WEL |
type | MCC |
type | MCS |
BankControlStatementInfo
{
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"creationMode": "ICS_CONTRACT_INFORMATION",
"currencyName": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"isActual": false,
"unk": "string"
}
Информация о ведомости банковского контроля
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankCommentAuthor | string | false | read-only | Автор комментария |
bfAttachments | [BfAttachment] | false | none | Прикреплённые большие файлы |
chainId | string | false | read-only | Id цепочки |
creationMode | string | true | none | Режим создания ВБК |
currencyName | string | false | none | Буквенный ISO-код валюты контракта |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
failReasons | [FailReason] | false | read-only | Причины отказа |
isActual | boolean | false | read-only | Признак актуальности ВБК |
unk | string | false | none | none |
Enumerated Values
Property | Value |
---|---|
creationMode | ICS_CONTRACT_INFORMATION |
creationMode | ICS_CONTRACT_REGISTRATION |
creationMode | ICS_CREDIT_REGISTRATION |
CardIssue
{
"accept": false,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeCardIssue": [
{
"accountNumber": "40802810600000200000",
"bankMessage": "Счет успешно открыт",
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"issCard": false,
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"result": "Счет открыт",
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Электронный реестр на открытие счетов и выпуск карт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accept | boolean | true | none | Флаг Согласие физ. лиц получено |
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
contractDate | string(date-time) | true | none | Дата зарплатного договора |
contractNumber | string | true | none | Номер зарплатного договора |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
employeeCardIssue | [CardIssueEmployee] | true | none | Реквизиты сотрудников в реестре |
employeesNumber | integer(int32) | true | none | Итоговое количество сотрудников |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
orgName | string | true | none | Наименование организации клиента |
orgTaxNumber | string | true | none | ИНН организации клиента |
ConfirmatoryDocumentsInquiry
{
"acceptDate": "2018-12-31",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"customerBankBIC": "044525225",
"customerINN": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOKPO": "222221001",
"date": "2018-12-31",
"dealDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docs": [
{
"addInfo": "Дополнительная информация",
"confDocDate": "2018-12-31",
"confDocNumber": "123",
"contractSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractSumDel": 1.01,
"correctionDate": "2018-12-31",
"correctionNumber": 1,
"countryCode": "643",
"countryName": "РОССИЯ",
"docCode": "03_3",
"docName": "03_3 О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции",
"docSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docSumDel": 1.01,
"expectedLife": "2018-12-31",
"hasConfDocNumber": false,
"ordinalNumber": 1,
"supplyFeature": "1"
}
],
"executorEmployeeName": "Ответственный исполнитель банка",
"executorName": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"number": "1",
"psNumber": "120123A0/1234/GU23/1/2",
"returnReason1": false,
"returnReason1Comment": "Ошибка",
"returnReason2": false,
"returnReason2Comment": "Ошибка",
"returnReason3": false,
"returnReason3Comment": "Ошибка",
"returnReason4": false,
"returnReason4Comment": "Ошибка",
"valueDate": "2018-12-31"
}
Сведения о подтверждающих документах
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptDate | string(date-time) | false | read-only | Дата представления в банк |
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Приложенные к документу: отсканированные образы-вложения - для АС БФ |
customerBankBIC | string | false | none | БИК банка клиента |
customerINN | string | true | none | ИНН резидента |
customerName | string | true | none | Наименование резидента |
customerOKPO | string | true | none | ОКПО резидента |
date | string(date-time) | true | none | Дата составления документа |
dealDate | string(date-time) | true | none | Дата справки |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
docs | [ConfirmatoryDocumentsInquiryDoc] | false | none | Документы, включённые в справку |
executorEmployeeName | string | false | read-only | Должность ответственного лица |
executorName | string | false | read-only | Подпись ответственного лица |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
failReasons | [FailReason] | false | read-only | Причины отказа |
number | string | false | none | Номер документа |
psNumber | string | false | none | Уникальный номер контракта (кредитного договора) |
returnReason1 | boolean | false | read-only | Флаг причины возврата 16.1.1 |
returnReason1Comment | string | false | read-only | Комментарий причины возврата 16.1.1 |
returnReason2 | boolean | false | read-only | Флаг причины возврата 16.1.3 |
returnReason2Comment | string | false | read-only | Комментарий причины возврата 16.1.3 |
returnReason3 | boolean | false | read-only | Флаг причины возврата 16.1.4 |
returnReason3Comment | string | false | read-only | Комментарий причины возврата 16.1.4 |
returnReason4 | boolean | false | read-only | Флаг причины возврата 16.1.5 |
returnReason4Comment | string | false | read-only | Комментарий причины возврата 16.1.5 |
valueDate | string(date-time) | false | read-only | Дата принятия/возврата |
StatementSummary
{
"closingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"closingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"composedDateTime": "2018-12-31T23:59:59",
"creditTransactionsNumber": 1,
"creditTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"creditTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTransactionsNumber": 1,
"debitTurnover": {
"amount": 1.01,
"currencyName": "USD"
},
"debitTurnoverRub": {
"amount": 1.01,
"currencyName": "USD"
},
"lastMovementDate": "2018-12-31",
"openingBalance": {
"amount": 1.01,
"currencyName": "USD"
},
"openingBalanceRub": {
"amount": 1.01,
"currencyName": "USD"
},
"openingRate": 1.01
}
Сводная информация по выписке
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
closingBalance | Amount | false | none | Сумма |
closingBalanceRub | Amount | false | none | Сумма |
composedDateTime | string(date-time) | false | none | Дата и время составления сводки |
creditTransactionsNumber | integer(int32) | false | none | Количество кредитовых операций по счёту |
creditTurnover | Amount | false | none | Сумма |
creditTurnoverRub | Amount | false | none | Сумма |
debitTransactionsNumber | integer(int32) | false | none | Количество дебетовых операций по счёту |
debitTurnover | Amount | false | none | Сумма |
debitTurnoverRub | Amount | false | none | Сумма |
lastMovementDate | string(date-time) | false | none | Дата последней операции по счёту за запрошенный период |
openingBalance | Amount | false | none | Сумма |
openingBalanceRub | Amount | false | none | Сумма |
openingRate | number | false | none | Курс ЦБ за единицу валюты на начало периода |
BankInfo
{
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "RUS",
"bankCountryIsoCode": "643",
"bankName": "SBERBANK",
"bankPlace": "BELGRAD",
"branch": "REGIONAL BRANCH",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
}
Информация о банке контрагента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankAddress | string | false | none | Адрес банка |
bankCorrAccount | string | false | none | Корреспонденсткий счёт банка |
bankCountry | string | false | none | Страна банка |
bankCountryCode | string | false | none | Цифоровой код страны банка |
bankCountryIsoCode | string | false | none | Буквенный код страны банка |
bankName | string | false | none | Наименование банка |
bankPlace | string | false | none | Населённый пункт банка |
branch | string | false | none | Филиал банка |
clirCode | string | false | none | Клиринговый код банка |
clirCountry | string | false | none | Страна клирингового кода банка |
clirCountryCode | string | false | none | Код страны клирингового кода банка |
swiftCode | string | false | none | SWIFT-код банка |
symbolClirCode | string | false | none | Символьный клиринговый код банка |
AcceptanceLetter
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"nonAcceptReason": "string",
"number": "1",
"payReqAmount": 1.01,
"payReqDate": "2018-12-31",
"payReqExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"payReqLastDate": "2018-12-31",
"payReqNumber": "2",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"type": "accept"
}
Заявление об акцепте/отказе от акцепта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма акцепта |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа в организации-партнёре (UUID) |
nonAcceptReason | string | true | none | Причина отказа |
number | string | false | none | Номер документа |
payReqAmount | number | true | none | Сумма платежного требования |
payReqDate | string(date-time) | true | none | Дата платежного требования |
payReqExternalId | string | true | none | Идентификатор платежного требования |
payReqLastDate | string(date-time) | true | none | Дата окончания акцепта |
payReqNumber | string | true | none | Номер платежного требования |
payeeAccount | string | true | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК получателя платежа |
payeeBankCorrAccount | string | true | none | Корсчёт банка получателя платежа |
payeeInn | string | true | none | ИНН получателя платежа |
payeeName | string | true | none | Полное наименование получателя платежа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerInn | string | true | none | ИНН плательщика |
payerName | string | true | none | Полное наименование плательщика |
type | string | true | none | Тип заявления |
Enumerated Values
Property | Value |
---|---|
type | accept |
type | nonAccept |
CurTransfer
{
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
}
Данные валютной операции
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankOperationCode | string | false | none | Код банковской операции (формат MT103) |
beneficiaryBankAccount | string | false | none | Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103 |
beneficiaryBankName | string | false | none | Код BIC, расположение или название и адрес банка бенефициара. Содержимое поля 57 (за исключением номера счета, с разделителями) в формате MT103 |
beneficiaryBankOption | string | false | none | Признак вида поля банка бенефициара (поле 57 в формате MT103). Возможные значения: A, B, С, D |
beneficiaryCustomerAccount | string | false | none | Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103 |
beneficiaryCustomerName | string | false | none | Код BIC/BEI или название и адрес бенефициара. Содержимое поля 59 (за исключением номера счета, с разделителями) в формате MT103 |
detailsOfCharges | string | false | none | Сведения о расходах (формат MT103) |
exchangeRate | string | false | none | Курс конвертации (формат MT103) |
instructedAmount | string | false | none | Валюта/сумма по инструкции (формат MT103) |
instructionCode | string | false | none | Код инструкции (формат MT103) |
intermediaryBankAccount | string | false | none | Номер счета банка-посредника. 1-я часть значения поля 56 в формате MT103 |
intermediaryBankName | string | false | none | Код BIC или название банка-посредника. Содержимое поля 56 (за исключением номера счета, с разделителями) в формате MT103 |
intermediaryBankOption | string | false | none | Признак вида поля банка-посредника (поле 56 в формате MT103). Возможные значения: A, С, D |
messageDestinator | string | false | none | Получатель сообщения SWIFT (формат MT103) |
messageIdentifier | string | false | none | Уникальный системный номер сообщения SWIFT (формат MT103) |
messageOriginator | string | false | none | Отправитель сообщения SWIFT (формат MT103) |
messageReceiveTime | string | false | none | Дата и время получения сообщения SWIFT (формат MT103) |
messageSendTime | string | false | none | Дата и время отправки сообщения SWIFT (формат MT103) |
messageType | string | false | none | Тип сообщения SWIFT |
orderingCustomerAccount | string | false | none | Номер счета плательщика в формате IBAN или BBAN (для внутренних платежей). 1-я часть значения поля 50 в формате MT103 |
orderingCustomerName | string | false | none | Код BIC/BEI или название и адрес плательщика. Содержимое поля 50 (за исключением номера счета, с разделителями) в формате MT103 |
orderingCustomerOption | string | false | none | Признак вида поля плательщика (поле 50 в формате MT103). Возможные значения: A, F, K |
orderingInstitutionAccount | string | false | none | Номер счета банка плательщика. 1-я часть значения поля 52 в формате MT103 |
orderingInstitutionName | string | false | none | Код BIC или название и адрес банка плательщика. Содержимое поля 52 (за исключением номера счета, с разделителями) в формате MT103 |
orderingInstitutionOption | string | false | none | Признак вида поля банка плательщика (поле 52 в формате MT-103). Возможные значения: A, D |
payeeAccount | string | false | none | Номер счёта получателя |
payeeBankBic | string | false | none | БИК банка получателя |
payeeBankName | string | false | none | Наименование банка получателя |
payeeInn | string | false | none | ИНН получателя |
payeeName | string | false | none | Наименование получателя |
payerAccount | string | false | none | Номер счёта плательщика |
payerBankBic | string | false | none | БИК банка плательщика |
payerBankName | string | false | none | Наименование банка плательщика |
payerInn | string | false | none | ИНН плательщика |
payerName | string | false | none | Наименование плательщика |
receiverCharges | string | false | none | Расходы получателя (формат MT103) |
receiverCorrespondentAccount | string | false | none | Номер счета корреспондента получателя. 1-я часть значения поля 54 в формате MT103 |
receiverCorrespondentName | string | false | none | Код BIC, расположение или название и адрес корреспондента получателя. Содержимое поля 54 (за исключением номера счета, с разделителями) в формате MT103 |
receiverCorrespondentOption | string | false | none | Признак вида поля корреспондента получателя (поле 54 в формате MT103). Возможные значения: A, B, D |
regulatoryReporting | string | false | none | Контрольная отчетность (формат MT103) |
remittanceInformation | string | false | none | Сведения о переводе (формат MT103) |
senderCharges | string | false | none | Расходы отправителя (формат MT103) |
senderCorrespondentAccount | string | false | none | Номер счета корреспондента отправителя. 1-я часть значения поля 53 в формате MT103 |
senderCorrespondentName | string | false | none | Код BIC, расположение или название и адрес корреспондента отправителя. Содержимое поля 53 (за исключением номера счета, с разделителями) в формате MT103 |
senderCorrespondentOption | string | false | none | Признак вида поля корреспондента отправителя (поле 53 в формате MT103). Возможные значения: A, B, D |
senderToReceiverInformation | string | false | none | Информация отправителя получателю (формат MT103) |
transactionReferenceNumber | string | false | none | Референс операции (формат MT103) |
transactionRelatedReference | string | false | none | Связанный референс (формат MT103) |
transactionTypeCode | string | false | none | Код типа операции (формат MT103) |
urgent | string | false | none | Признак срочности операции (формат MT103). Возможные значения: URGENT, NORMAL |
valueDateCurrencyInterbankSettledAmount | string | false | none | Дата валютирования, код валюты, сумма межбанковского расчета (формат MT103) |
DepositsInfo
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"deposits": [
{
"account": "40702810500000006109",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"benefBankSwift": "SABRRUMM",
"contractDate": "2018-12-31",
"contractNumber": "10000001.ПУ00",
"endDate": "2018-12-31",
"imediaBankSwift": "SABRRUMM",
"interestRate": 5.49,
"paymentPeriod": "В конце срока",
"refund": true,
"returnAccount": "40802810600000200000",
"returnBankBic": "044525225",
"revocation": true,
"startDate": "2018-12-31",
"statusCode": "CONCLUDED",
"term": 31,
"type": "Депозит Классический Онлайн"
}
]
}
Информация по депозитным договорам
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
deposits | [Deposit] | false | none | Депозитные договоры |
StatementTransaction
{
"amount": {
"amount": 1.01,
"currencyName": "USD"
},
"amountRub": {
"amount": 1.01,
"currencyName": "USD"
},
"correspondingAccount": "30101810400000000225",
"curTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"direction": "CREDIT",
"documentDate": "2018-12-31",
"filial": "ОСБ 3",
"number": "4",
"operationCode": "01",
"operationDate": "2018-12-31T23:59:59",
"paymentPurpose": "Оплата заказа №123. НДС нет.",
"priority": "5",
"revaln": "ПК",
"rurTransfer": {
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
},
"swiftTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"transactionId": 11111,
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
Данные операции по выписке
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | Amount | false | none | Сумма |
amountRub | Amount | false | none | Сумма |
correspondingAccount | string | false | none | Корреспондирующий счёт |
curTransfer | CurTransfer | false | none | Данные валютной операции |
direction | string | false | none | Направление транзакции DEBIT/CREDIT |
documentDate | string(date-time) | false | none | Дата документа |
filial | string | false | none | Наименование филиала |
number | string | false | none | Номер операции |
operationCode | string | false | none | Тип операции |
operationDate | string(date-time) | false | none | Дата и время операции |
paymentPurpose | string | false | none | Назначение платежа |
priority | string | false | none | Очередность платежа |
revaln | string | false | none | Признак операции переоценки (ПК - пересчет курса, ДП - дооценка руб. покрытия) |
rurTransfer | RURTransfer | false | none | Данные рублевой операции |
swiftTransfer | SWIFTTransfer | false | none | Данные перевода SWIFT MT103 |
transactionId | integer(int64) | false | none | Идентификатор операции |
uuid | string | false | none | Уникальный идентификатор операции (UUID) |
Enumerated Values
Property | Value |
---|---|
direction | DEBIT |
direction | CREDIT |
CartInfo
{
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
}
Дополнительная информация о документе (картотека)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
documentCode | string | false | none | Шифр документа (картотека) (для 16) |
documentContent | string | false | none | Содержание операции (для 16) |
documentDate | string(date-time) | false | none | Дата документа (картотека) (для 16) |
documentNumber | string | false | none | Номер документа (картотека) (для 16) |
paymentNumber | string | false | none | Номер платежа (картотека) (для 16) |
restAmount | number | false | none | Сумма остатка платежа (картотека) (для 16) |
MediaBankinfo
{
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "643",
"bankCountryIsoCode": "RUS",
"bankName": "SBERBANK",
"bankPlace": "Moscow",
"branch": "ДО №1654 Московского банка ПАО Сбербанк",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
}
Информация о банке-посреднике
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankAddress | string | false | none | Адрес банка |
bankCorrAccount | string | false | none | Корреспонденсткий счёт банка |
bankCountry | string | false | none | Страна банка |
bankCountryCode | string | false | none | Цифоровой код страны банка |
bankCountryIsoCode | string | false | none | Буквенный код страны банка |
bankName | string | false | none | Наименование банка |
bankPlace | string | false | none | Населённый пункт банка |
branch | string | false | none | Филиал банка |
clirCode | string | false | none | Клиринговый код банка |
clirCountry | string | false | none | Страна клирингового кода банка |
clirCountryCode | string | false | none | Код страны клирингового кода банка |
swiftCode | string | false | none | SWIFT-код банка |
symbolClirCode | string | false | none | Символьный клиринговый код банка |
SalaryAgreementCardType
{
"bonusProgramCode": "11",
"depositSubtypeCode": "11",
"depositTypeCode": "11",
"endDate": "2018-12-31",
"peopleGroupCode": "111",
"peopleGroupName": "Зарплатная",
"typeCode": "11",
"typeName": "Visa Classic"
}
Тип пластиковой карты
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bonusProgramCode | string | false | none | Код бонусной программы |
depositSubtypeCode | string | false | none | Код подвида вклада |
depositTypeCode | string | false | none | Код вида вклада |
endDate | string(date-time) | false | none | Дата закрытия возможности выпуска карт |
peopleGroupCode | string | false | none | Код категории населения |
peopleGroupName | string | false | none | Название категории населения |
typeCode | string | false | none | Код вида карты |
typeName | string | false | none | Вид карты |
SalaryAgreementCommissionInfo
{
"actualDateTime": "2018-12-31T23:59:59",
"currentRate": 1.01,
"diffTariffs": [
{
"admissionTypeCode": "Other",
"endAmount": 1.01,
"fromAmount": 1.01,
"tariffRate": 1.01
}
],
"invoiceDate": "2018-12-31",
"otherRate": 1.01,
"periodInfo": {
"commissionAmount": 1.01,
"endDate": "2018-12-31",
"payAmount": 1.01,
"startDate": "2018-12-31"
},
"salaryRate": 1.01,
"totalDebitAmount": 1.01
}
Информация о комиссии за зачисление
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualDateTime | string(date-time) | false | none | Дата и время последнего обновления информации банком о неоплаченной комиссии |
currentRate | number | false | none | Текущая ставка тарифа за реестровые зачисления (%) |
diffTariffs | [SalaryAgreementDiffTariff] | false | none | Дифференцированные тарифы для зарплатных реестров |
invoiceDate | string(date-time) | false | none | Дата выставления счета и направления детализации |
otherRate | number | false | none | Фиксированная ставка по прочим зачислениям (%) |
periodInfo | SalaryAgreementPeriodInfo | false | none | Информация за расчетный период |
salaryRate | number | false | none | Фиксированная ставка комиссии по зарплатным зачислениям (%) |
totalDebitAmount | number | false | none | Общая сумма неоплаченной комиссии |
Link
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
Ссылка на связанный ресурс
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
href | string | true | none | Абсолютный или относительный адрес |
rel | string | true | none | Отношение ссылки к текущей сущности (next, prev) |
GenericLetter
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"crmNumber": "190410-0033-142400",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall",
"typeName": "Направить запрос по 115-ФЗ"
}
Письма свободного формата
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
attachments | [Attachment] | false | none | Вложенные документы |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | true | none | Идентификатор (-ы) больших файлов |
crmNumber | string | false | read-only | Номер ПСФ в CRM |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
integrationId | string | false | read-only | Идентификатор цепочки |
number | string | false | none | Номер документа |
text | string | true | none | Текст сообщения |
typeCode | string | true | none | Системное имя темы письма |
typeName | string | false | read-only | Тип письма |
TariffPlanOverBillingRequest
{
"billingObjectCode": "ft-payments",
"countServiceFact": 1000,
"dateUntil": "2018-12-31",
"tariffSystemName": "SECURE_BUSINESS_BASIC"
}
Запрос на отправку сведений о потреблении клиентом услуг сверх лимита тарифного плана
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
billingObjectCode | string | true | none | Код платного сервиса |
countServiceFact | integer(int64) | true | none | Количество фактов потребления услуги за период (состояние на конец периода) |
dateUntil | string(date-time) | false | none | Дата окончания актуальности списания |
tariffSystemName | string | true | none | Системное наименование тарифного плана услуги |
PaymentImplementedInfo
{
"amount": 1.01,
"createDate": "2018-12-31T23:59:59",
"lastModifyDate": "2018-12-31T23:59:59",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"purpose": "Оплата заказа №123. НДС нет.",
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
Информация об исполненных рублевых платежных поручениях клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма документа |
createDate | string(date-time) | false | none | Дата и время создания документа |
lastModifyDate | string(date-time) | false | none | Дата и время последней модификации документа |
number | string | false | none | Номер документа |
payeeAccount | string | false | none | Счёт получателя |
payeeBankBic | string | false | none | БИК банка получателя |
payeeInn | string | false | none | ИНН получателя |
payeeName | string | false | none | Наименование организации получателя |
purpose | string | false | none | Назначение платежа |
uuid | string | false | none | UUID документа |
CryptoUserInfo
{
"cryptoProfileInfos": [
{
"alias": "Profile alias",
"certificateInfos": [
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"typeName": "Инфокрипт"
}
],
"sub": "string"
}
Информация о пользователе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cryptoProfileInfos | [CryptoProfileInfo] | false | none | Идентификаторы криптопрофилей |
sub | string | false | none | Хэш идентификатора пользователя |
PayDocCur
{
"acceptDate": "2018-12-31",
"addInfo": "Примечание",
"additionalInfo": "/CCTFDR/",
"amountDebitTotal": 1.01,
"amountTransfer": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"amountTransferTotal": 1.01,
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"b77info": "/BENEFRES/",
"bankComment": "string",
"bankStatus": "string",
"beneficiaryAccount": "40802840600000200000",
"beneficiaryAddress": "UL.KUTUZOVSKAYA,D.2",
"beneficiaryBankAccount": "40802840600000200000",
"beneficiaryBankAddress": "3, AVENUE HOCHE",
"beneficiaryBankBranchName": "(TREASURY DEPARTMENT)",
"beneficiaryBankClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"beneficiaryBankCountryDigital": "643",
"beneficiaryBankCountryIso2": "RU",
"beneficiaryBankName": "ALANDSBANKEN ABP (FINLAND),SVENSK FILIAL",
"beneficiaryBankPlace": "ФИНЛЯНДИЯ",
"beneficiaryBankSwift": "AABAFI22TMS",
"beneficiaryBeiCode": "UBSWUS33CHI",
"beneficiaryCountryDigital": "643",
"beneficiaryCountryIso2": "RU",
"beneficiaryCountryName": "РОССИЯ",
"beneficiaryInn": "7707083893",
"beneficiaryName": "EMIRP",
"beneficiaryPlace": "MOSCOW",
"chargesType": "BEN",
"codes23e": [
{
"code": "SDVA",
"description": "Средства должны быть зачислены бенефициару той же датой валютирования",
"info": "DOPOLNITEL INFO 8747483893"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factRate": 1.0001,
"iMediaBankAddress": "ACCIONES Y VALORES, PISO 12:CALLE 72 7 64",
"iMediaBankCountryDigital": "643",
"iMediaBankCountryIso2": "RU",
"iMediaBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"iMediaBankPlace": "LUANDA",
"iMediaBankSwift": "BDAAAOLU",
"iMediaClearingCode": {
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
},
"iMediaFilialBankName": "BANCO DE DESENVOLVIMENTO DE ANGOLA",
"inn": "7707083893",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"number": "1",
"option50a": "K",
"option56a": "A",
"option57a": "A",
"option59a": "A",
"orgName": "ООО \"Организация\"",
"payerAccount": "40802840600000200000",
"payerAddress": "UL.DOBROLIUBOVA,D.18,OF.III",
"payerBankBic": "044525225",
"payerBankPlace": "MOSCOW",
"payerCountryDigital": "643",
"payerCountryIso2": "RU",
"payerCountryName": "РОССИЯ",
"payerName": "LLC COMPANY",
"payerPlace": "MOSKVA",
"paymentDetails": "CONTRACT 123",
"paymentDirection": "0",
"rateAgree": false,
"urgent": false,
"valueDate": "2018-12-31"
}
Валютное платёжное поручение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptDate | string(date-time) | false | read-only | Дата представления в банк |
addInfo | string | false | none | Примечание |
additionalInfo | string | false | none | Информация получателю платежа (дополнительная информация), поле 72 |
amountDebitTotal | number | false | read-only | Фактическая сумма списанной валюты |
amountTransfer | AmountCurrency | true | none | Сумма и валюта |
amountTransferTotal | number | false | read-only | Фактическая сумма переведенной валюты |
authPersonName | string | false | none | ФИО уполномоченного сотрудника организации клиента |
authPersonTelfax | string | false | none | Номер телефона, факса уполномоченного сотрудника организации клиента |
b77info | string | false | none | Информация для регулирующих органов |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
beneficiaryAccount | string | false | none | Счет бенефициара |
beneficiaryAddress | string | false | none | Адрес бенефициара |
beneficiaryBankAccount | string | false | none | Корреспондентский счёт банка бенефициара |
beneficiaryBankAddress | string | false | none | Адрес банка бенефициара |
beneficiaryBankBranchName | string | false | none | Наименование филиала банка бенефициара |
beneficiaryBankClearingCode | ClearingCode | false | none | Клиринговый код |
beneficiaryBankCountryDigital | string | true | none | Цифровой код страны банка бенефициара |
beneficiaryBankCountryIso2 | string | true | none | 2х буквенный ISO-код страны банка бенефициара |
beneficiaryBankName | string | true | none | Наименование банка бенефициара |
beneficiaryBankPlace | string | true | none | Местонахождение банка бенефициара |
beneficiaryBankSwift | string | false | none | SWIFT-код банка бенефициара |
beneficiaryBeiCode | string | false | none | BEI-код (SWIFT-код) банка бенефициара |
beneficiaryCountryDigital | string | true | none | Цифровой код страны бенефициара |
beneficiaryCountryIso2 | string | true | none | 2х буквенный ISO-код страны бенефициара |
beneficiaryCountryName | string | false | none | Наименование страны бенефициара на русском языке (краткое наименование) |
beneficiaryInn | string | false | none | ИНН бенефициара |
beneficiaryName | string | true | none | Наименование бенефициара |
beneficiaryPlace | string | true | none | Город (месторасположение) бенефициара |
chargesType | string | true | none | Тип комиссии за перевод: BEN, SHA или OUR |
codes23e | [Code23e] | false | none | 23E: Код инструкции |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа в организации-партнёре (UUID) |
factRate | number | false | read-only | Фактический курс конверсии |
iMediaBankAddress | string | false | none | Адрес банка-посредника |
iMediaBankCountryDigital | string | false | none | Цифровой код страны банка-посредника |
iMediaBankCountryIso2 | string | false | none | 2х буквенный ISO-код страны банка-посредника |
iMediaBankName | string | false | none | Наименование банка-посредника |
iMediaBankPlace | string | false | none | Город банка-посредника |
iMediaBankSwift | string | false | none | SWIFT-код банка-посредника |
iMediaClearingCode | ClearingCode | false | none | Клиринговый код |
iMediaFilialBankName | string | false | none | Наименование филиала банка-посредника |
inn | string | true | none | ИНН клиента |
linkedDocs | [LinkedDoc] | false | none | Связанные документы |
number | string | false | none | Номер документа |
option50a | string | true | none | Опция 50а |
option56a | string | false | none | Опция 56a |
option57a | string | true | none | Опция 57а |
option59a | string | false | none | Опция 59а |
orgName | string | true | none | Сокращенное наименование организации клиента |
payerAccount | string | true | none | Счёт плательщика |
payerAddress | string | true | none | Адрес плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerBankPlace | string | false | none | Местонахождение банка плательщика |
payerCountryDigital | string | true | none | Цифровой код страны перевододателя |
payerCountryIso2 | string | true | none | 2х буквенный ISO-код страны перевододателя |
payerCountryName | string | false | none | Наименование страны перевододателя на русском языке (краткое наименование) |
payerName | string | true | none | Международное наименование плательщика |
payerPlace | string | true | none | Город (местонахождение) плательщика |
paymentDetails | string | true | none | Назначение платежа |
paymentDirection | string | true | none | Направление платежа (Платёж внутри или вне СБРФ): 1-внутри, 0-вне |
rateAgree | boolean | true | none | С курсом проведения конверсионной операции согласны |
urgent | boolean | true | none | Срочность |
valueDate | string(date-time) | false | read-only | Дата валютирования/возврата |
Enumerated Values
Property | Value |
---|---|
chargesType | BEN |
chargesType | SHA |
chargesType | OUR |
option50a | K |
option50a | F |
option56a | A |
option56a | D |
option57a | A |
option57a | D |
option59a | A |
option59a | F |
Code23e
{
"code": "SDVA",
"description": "Средства должны быть зачислены бенефициару той же датой валютирования",
"info": "DOPOLNITEL INFO 8747483893"
}
Код инструкций 23е
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | true | none | Код инструкции |
description | string | false | none | Описание |
info | string | false | none | Дополнительная информация |
Notification
{
"attributes": {
"property1": {},
"property2": {}
},
"codeMessageKind": 8705,
"datetimeSince": "2018-12-31T23:59:59",
"datetimeUntil": "2018-12-31T23:59:59",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Уведомление
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
attributes | object | false | none | Значения атрибутов сообщений для шаблонов |
» additionalProperties | object | false | none | none |
codeMessageKind | integer(int32) | true | none | Код вида сообщения |
datetimeSince | string(date-time) | true | none | Дата и время, начиная с которой должно быть отправлено сообщение |
datetimeUntil | string(date-time) | false | none | Дата и время, до которого должно быть отправлено сообщение |
externalId | string | true | none | Идентификатор уведомления, присвоенный партнёром (UUID) |
CashUnholdRequest
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"cashHoldExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Запрос на разблокировку денежных средств на расчетном счете (без перевода)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма разблокировки |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
cashHoldExternalId | string | true | none | Идентификатор связанного запроса на блокировку, присвоенный партнёром (UUID) |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
BankControlStatementChangeApplicationInfo
{
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"basisDocs": [
{
"date": "2018-12-31",
"number": "2222222222"
}
],
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"contentInfo": "Текстовая информация об изменениях",
"contractExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inUSRLE": false,
"prolongation": false
}
Информация о заявлении о внесении изменений в I раздел ВБК
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
authPersonName | string | true | none | ФИО ответственного лица |
authPersonTelfax | string | true | none | Телефон ответственного лица |
basisDocs | [BankControlStatementChangeBasisDoc] | false | none | Документы-основания для внесения изменений |
bfAttachments | [BfAttachment] | false | none | Прикреплённые большие файлы |
contentInfo | string | false | none | Информация об изменениях |
contractExternalId | string | true | none | Идентификатор изменяемого контракта в организации-партнёре |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
inUSRLE | boolean | true | none | Изменения в ЕГРЮЛ/ЕГРИП |
prolongation | boolean | true | none | Пролонгация |
BillingObjectStatistics
{
"numberRequests": 1000,
"serviceName": "Код авторизации",
"serviceSystemName": "sso-authorize"
}
Cтатистика о потреблении в API запроса
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
numberRequests | integer(int32) | false | none | Количество запросов за период |
serviceName | string | false | none | Наименование запроса |
serviceSystemName | string | false | none | Системное наименование запроса |
Beneficiaries
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"beneficiaries": [
{
"accountNumber": "40802840600000200000",
"address": "Moscow,Novoslobodskaya,11",
"bankInfo": {
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "RUS",
"bankCountryIsoCode": "643",
"bankName": "SBERBANK",
"bankPlace": "BELGRAD",
"branch": "REGIONAL BRANCH",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
},
"country": "РОССИЯ",
"countryCode": "643",
"countryIsoCode": "RUS",
"currCode": "840",
"currIsoCode": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inn": "7707083893",
"mediaBankInfo": {
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "643",
"bankCountryIsoCode": "RUS",
"bankName": "SBERBANK",
"bankPlace": "Moscow",
"branch": "ДО №1654 Московского банка ПАО Сбербанк",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
},
"name": "Общество с ограниченной ответственностью \"Клиент\"",
"operCode": "01",
"operName": "Покупка резидентом иностранной валюты за валюту Российской Федерации",
"payDirection": "Оплата заказа №123. НДС нет.",
"paymentType": "sbrfOut",
"place": "Moscow",
"remark": "Комментарий"
}
]
}
Контрагенты по валютным операциям
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
beneficiaries | [Beneficiar] | false | none | Список"Контрагенты по валютным операциям" |
PaymentsRegistryInfo
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"paymentsRegistry": [
{
"account": "40802810600000200000",
"bankComment": "string",
"bankStatus": "ACCEPTED",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "5",
"paymentsRegistry": [
{
"amount": 2000.15,
"amountBring": 2100.35,
"dateBegin": "2018-12-31",
"dateEnd": "2018-12-31",
"dateLoad": "2018-12-31",
"registryName": "EPS39291510642_5018141474.txt",
"uploadedRecords": 10
}
]
}
]
}
Информация о реестре платежей
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
paymentsRegistry | [PaymentsRegistry] | false | none | Документы "Реестр платежей" |
EncashmentContracts
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"encashmentContracts": [
{
"createDate": "2018-12-31",
"endDate": "2018-12-31",
"feeChargeTypes": "FACT_SCHET_GRP,IPT_SEND",
"number": "38/943/04",
"objects": [
{
"address": "г.Москва, ул.Тамбовская, д.5",
"encashContractAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"encashDebitAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"name": "АО \"Тандер\" Многоцветница 773460",
"objectStatus": "ARHIV"
}
],
"servicesInfo": [
{
"serviceName": "ENCASH",
"serviceType": 0
}
],
"startDate": "2018-12-31"
}
]
}
Договоры инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
encashmentContracts | [EncashmentContract] | false | none | Документы "Договор инкассации" |
AdvanceAcceptance
{
"active": false,
"bundles": [
{
"code": "MIN+1M",
"sinceDate": "2018-12-31",
"untilDate": "2018-12-31"
}
],
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "40802810600000200000",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerOrgIdHash": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"purpose": "Оплата заказа №123. НДС нет.",
"sinceDate": "2018-12-31",
"untilDate": "2018-12-31"
}
Информация о заранее данном акцепте
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
active | boolean | false | none | Признак активности ЗДА |
bundles | [AdvanceAcceptanceBundle] | false | none | Пакеты услуг |
payerAccount | string | false | none | Счёт плательщика |
payerBankBic | string | false | none | БИК банка плательщика |
payerBankCorrAccount | string | false | none | Корсчёт банка плательщика |
payerInn | string | false | none | ИНН плательщика |
payerName | string | false | none | Наименование плательщика |
payerOrgIdHash | string | false | none | Идентификатор организации плательщика |
purpose | string | false | none | Назначение платежа |
sinceDate | string(date-time) | false | none | Дата начала действия заранее данного акцепта |
untilDate | string(date-time) | false | none | Дата окончания действия заранее данного акцепта |
SelfEncasherRequest
{
"agreedAdmOperation": false,
"attorneyNumber": "51 А А 0001904",
"bankComment": "string",
"bankStatus": "string",
"birthDate": "2018-12-31",
"birthPlace": "Москва",
"byAttorney": false,
"citizenshipCountryCode": "643",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"empowermentEnd": "2018-12-31",
"empowermentStart": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"gender": "F",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г. Москвы",
"issuerCode": "222-222",
"number": "111222",
"serial": "1111",
"typeCode": "21"
},
"insuranceNumber": "11111111111",
"login": "username",
"name": "Дмитрий",
"number": "1",
"patronymic": "Сергеевич",
"persInfoConsent": false,
"phone": "79269999999",
"regAddress": {
"building": "1",
"city": "Александров",
"countryCode": "643",
"district": "Александровский",
"flat": "1",
"house": "1",
"postalCode": "601650",
"settlement": "село Андреевское",
"state": "Владимирская область",
"street": "Институтская"
},
"surname": "Петров",
"taxNumber": "7707083893",
"templates": [
"string"
]
}
Информация о новом вносителе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
agreedAdmOperation | boolean | true | none | Признак подтверждения клиентом согласия с условиями |
attorneyNumber | string | false | none | Номер доверенности |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
birthDate | string(date-time) | true | none | Дата рождения |
birthPlace | string | true | none | Место рождения |
byAttorney | boolean | false | none | По доверенности |
citizenshipCountryCode | string | true | none | Цифровой код страны |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
empowermentEnd | string(date-time) | true | none | Дата окончания наделения полномочий |
empowermentStart | string(date-time) | true | none | Дата начала наделения полномочий |
externalId | string | true | none | Идентификатор документа у клиента (UUID) |
gender | string | false | none | Пол |
identityDoc | SelfEncasherRequestIdentityDoc | true | none | Документ удостоверяющий личность |
insuranceNumber | string | false | none | СНИЛС |
login | string | false | none | Имя пользователя |
name | string | true | none | Имя |
number | string | false | none | Номер документа |
patronymic | string | false | none | Отчество |
persInfoConsent | boolean | true | none | Признак подтверждения клиентом согласия вносителя на обработку его персональных данных банком |
phone | string | true | none | Номер мобильного телефона |
regAddress | SelfEncasherRequestRegAddress | true | none | Адрес регистрации |
surname | string | true | none | Фамилия |
taxNumber | string | false | none | ИНН |
templates | [string] | true | none | Массив наименований шаблонов внесения денежных средств |
ExportType
{
"isExportRusGoodsNoReimport": true,
"isGrantIntellectualActivity": true,
"isImplRusOutServices": false,
"isImplRusOutServicesToResult": false
}
Виды экспорта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
isExportRusGoodsNoReimport | boolean | false | none | none |
isGrantIntellectualActivity | boolean | true | none | Предоставление иностранному юридическому лицу прав использования российских результатов интеллектуальной деятельности |
isImplRusOutServices | boolean | true | none | Осуществление российских работ (услуг) для иностранных юридических лиц за пределами РФ |
isImplRusOutServicesToResult | boolean | true | none | Осуществление российских работ (услуг) для использования результата выполнения работ или оказания услуг за пределами РФ |
QuestionForm
{
"answer": "Подайте заявку онлайн.",
"question": "Как мне оплатить счёт кредитными деньгами?"
}
Вопрос и ответ по созданию кредитной заявки
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
answer | string | false | none | Ответ на вопрос по соданию кредитной заявки |
question | string | false | none | Вопрос по созданию кредитной заявки |
PaymentDocState
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string",
"crucialFieldsHash": "string"
}
Статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
channelInfo | string | false | read-only | Комментарий, специфичный для документа, полученного по данному каналу |
crucialFieldsHash | string | false | none | Hash от ключевых полей документа |
EncashAddRequestObject
{
"contractModifyDate": "2018-12-31",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectContactName": "Иванов Иван Иванович",
"objectContactPhone": "89269999999",
"objectName": "АО \"Киберлинк\" технологии 555100",
"objectRegion": "Москва",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-И",
"serviceType": 3,
"visitInfo": {
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
}
],
"workSchedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
Объекты инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
contractModifyDate | string(date-time) | true | none | Желаемая дата внесения изменений в договор инкассации |
objectAddress | string | true | none | Адрес объекта |
objectContactName | string | true | none | Контактное лицо на объекте |
objectContactPhone | string | true | none | Контактный номер телефона на объекте |
objectName | string | true | none | Наименование объекта |
objectRegion | string | true | none | Регион объекта |
services | [EncashAddRequestService] | true | none | Подключаемые услуги |
workSchedule | [EncashAddRequestSchedule] | true | none | Объекты инкассации |
CertRequest
{
"bankComment": "string",
"bankStatus": "string",
"email": "address@email.ru",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Организация\"",
"pkcs10": {
"bicryptId": "A001NVA3",
"cms": "-----BEGIN CMS-----\n ... MIIIj ... \n-----END CMS-----"
},
"userName": "Иванов Иван Иванович",
"userPosition": "Операционист"
}
Запрос на новый сертификат
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
string | true | none | Адрес электронной почты | |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
orgName | string | false | none | Краткое наименование организации |
pkcs10 | Pkcs10 | true | none | Информация о запросе |
userName | string | true | none | Фамилия, имя и отчество |
userPosition | string | true | none | Должность |
CardIssueContactInfo
{
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
}
Контактная информация
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
string | false | none | Электронная почта | |
homePhone | string | false | none | Домашний телефон |
mobileOperatorType | string | false | none | Наименование оператора мобильной связи |
mobilePhone | string | false | none | Мобильный телефон |
officePhone | string | false | none | Рабочий телефон |
ClientBankProduct
{
"category": "Бухгалтерия и финансовый учёт",
"fullDesc": "Сервис позволяет выполнять сдачу необходимой бухгалтерской, налоговой и финансовой отчетности в электронном виде в государственные органы",
"name": "Бухгалтерия для ИП",
"productId": "korpkarta",
"shortDesc": "Облачная бухгалтерия"
}
Подключённый банковский продукт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
category | string | false | none | Категория продукта |
fullDesc | string | false | none | Полное описание продукта |
name | string | false | none | Наименование внешнего сервиса |
productId | string | false | none | Идентификатор продукта |
shortDesc | string | false | none | Краткое описание продукта |
Correspondent
{
"accountNumber": "40802810600000200000",
"bankBic": "044525225",
"bankCorrAcct": "30101810400000000225",
"bankName": "ПАО СБЕРБАНК",
"inn": "7707083893",
"kpp": "222201001",
"name": "Общество с ограниченной ответственностью \"Клиент\"",
"remark": "Комментарий",
"signed": false
}
Контрагент по рублёвым операциям
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountNumber | string | false | none | Номер счёта контрагента |
bankBic | string | false | none | БИК банка, где открыт счёт |
bankCorrAcct | string | false | none | Корр. счёт банка |
bankName | string | false | none | Наименование банка |
inn | string | false | none | ИНН контрагента |
kpp | string | false | none | КПП контрагента |
name | string | false | none | Наименование организации контрагента |
remark | string | false | none | Комментарий |
signed | boolean | false | none | Признак 'подписан' |
EncashmentOfferServiceVisitInfo
{
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
Информация о заездах
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cashAmount | integer(int64) | false | none | Сумма сдаваемой наличности за заезд |
cashCoins | integer(int64) | false | none | Сумма монет в объеме сдаваемой наличности |
countInMonth | integer(int64) | false | none | Количество заездов в месяц |
isByRequest | boolean | false | none | Тип обслуживания |
schedule | [EncashmentOfferServiceVisitSchedule] | false | none | График заездов |
Webhook
{
"event": "payment.implemented",
"formatVersion": 1,
"requestContentType": "application/json",
"url": "https://www.partner.ru/webhooks",
"webhookId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Заявка на получение уведомлений о событии
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
event | string | true | none | Событие |
formatVersion | integer(int64) | true | none | Версия формата ответа |
requestContentType | string | true | none | Тип содержимого запроса |
url | string | true | none | URL отправки уведомления о событии |
webhookId | string | false | none | Идентификатор заявки, присвоенный партнёром (UUID) |
Enumerated Values
Property | Value |
---|---|
event | payment.implemented |
event | paymentrequest.implemented |
event | statement.transactions |
event | statement.transactions.ids |
event | userlogin.web |
requestContentType | application/json |
requestContentType | application/jose |
DocStateShort
{
"bankComment": "string",
"bankStatus": "string"
}
Сокращенный статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
VoluntarySale
{
"accountNum": "40802810600000200000",
"accountType": "orgAccount",
"bankBic": "044525225",
"bankName": "ПАО СБЕРБАНК",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"comissionAccount": "40802810600000200000",
"comissionBankBic": "044525225",
"comissionBankName": "ПАО СБЕРБАНК",
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"dealType": "sberbankRateConditions",
"enrolledRub": 1.01,
"rate": 1.01,
"sellAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"valueDate": "2018-12-31"
}
Блок необязательной продажи
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountNum | string | true | none | Счёт для зачисления рублей |
accountType | string | true | none | Тип зачисления |
bankBic | string | true | none | БИК банка |
bankName | string | true | none | Наименование банка счёта, куда перечисляются рублёвые средства от необязательной продажи валюты |
chargedCur | Amount | false | none | Сумма |
comissionAccount | string | false | none | Счёт списания комиссии (рублёвый) |
comissionBankBic | string | false | none | БИК банка, в котором открыт счёт для списания комиссий |
comissionBankName | string | false | none | Наименование банка, в котором открыт счёт для списания комиссий |
commission | Amount | false | none | Сумма |
dealType | string | true | none | Выбор курса продажи |
enrolledRub | number | false | read-only | Зачислено рублей при необязательной продаже |
rate | number | false | read-only | Курс необязательной продажи |
sellAmount | Amount | true | none | Сумма |
valueDate | string(date-time) | false | read-only | Дата валютирования необязательной продажи |
Enumerated Values
Property | Value |
---|---|
accountType | orgAccount |
accountType | bankAccount |
dealType | sberbankRateConditions |
dealType | centralBankRateConditions |
PersonalOffer
{
"activatedUrl": "string",
"adviseMediaLink": "https://21.21.21.21/redesign/share/stories/sovet.svg",
"buttonAction": 1,
"buttonLink": "credits/products?targetCode=40",
"buttonName": "Подключить",
"campaignName": "Кредит",
"category": "Кредит",
"channel": "SBBOL",
"contextAdvise": "Деньги заказывали?",
"creditProduct": "Одобренный SMART-кредит",
"crmProductId": "1-27RUCY00",
"currency": "USD",
"currencyCode": "840",
"dateSince": "2018-12-31",
"dateUntil": "2018-12-31",
"depositType": "Депозит Классический Онлайн",
"fmLink": "string",
"fmMsg": "string",
"fullDesc": "Сервис позволит вам направить заявку на получение банковского кредита без посещения отделения банка",
"iconDocLink": "https://21.21.21.21/redesign/share/stories/mini_main_credit.jpg",
"iconImageLink": "https://21.21.21.21/redesign/share/stories/mini_shop.jpg",
"iconLink": "string",
"imgLink": "string",
"imgLinkDcb": "https://www.sberbank.ru/img/files/file.jpg",
"isApproved": "1",
"maxOfferAmount": 10000,
"needPledge": false,
"offerAmount": 30000,
"offerGuid": "12345678-1234-1234-1234-123456789012",
"offerLink": "string",
"offerRate": 17,
"offerSetLimit": "10000|20000|30000|40000",
"offerSetRate": "15|16|17|18",
"offerSetTerm": "12|24|36|48",
"offerTerm": 36,
"priority": 100,
"productCode": "kredit",
"productName": "Бухгалтерия для ИП",
"productSystemName": "SMART_SBOFF",
"serviceName": "Бухгалтерия для ИП",
"shortDesc": "Кредит на любые цели",
"specialCondition": "2",
"telInText": "89269999999",
"textBandCard": "Кредит [br] для бизнеса",
"textDocCard": "Как приобрести [br] транспорт",
"type": "38/943/04"
}
Персональное предложение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
activatedUrl | string | false | none | Ссылка для перенаправления пользователя, если продукт подключен |
adviseMediaLink | string | false | none | Ссылка на картинку для контекстного совета |
buttonAction | integer(int32) | false | none | Действие по кнопке персонального предложения |
buttonLink | string | false | none | Ссылка для перехода по кнопке персонального предложения |
buttonName | string | false | none | Наименование кнопки целевого действия для персонального предложения |
campaignName | string | false | none | Наименование кампании |
category | string | false | none | Категория продукта |
channel | string | false | none | Канал |
contextAdvise | string | false | none | Контекстный совет |
creditProduct | string | false | none | Наименование кредитного продукта |
crmProductId | string | false | none | Идентификатор продукта персонального предложения в CRM |
currency | string | false | none | Валюта |
currencyCode | string | false | none | Цифровой код валюты |
dateSince | string(date-time) | false | none | Дата начала действия предложения |
dateUntil | string(date-time) | false | none | Дата окончания действия предложения |
depositType | string | false | none | Тип депозита |
fmLink | string | false | none | Ссылка на внешний сайт при нажатии «Узнать больше» |
fmMsg | string | false | none | Текст при переходе на внешний сайт при нажатии «Узнать больше» |
fullDesc | string | false | none | Полное описание продукта |
iconDocLink | string | false | none | Ссылка на картинку в документарных разделах |
iconImageLink | string | false | none | Ссылка на картинку для ленты |
iconLink | string | false | none | Иконка маркетингового исследования или новостей |
imgLink | string | false | none | Ссылка на картинку на развороте предложения |
imgLinkDcb | string | false | none | Ссылка на картинку для DCB |
isApproved | string | false | none | Признак одобренного / предодобренного продукта |
maxOfferAmount | number | false | none | Максимальная сумма предложения. Целое число, в тысячах рублей |
needPledge | boolean | false | none | Признак необоходимости залога при получении кредита на сумму свыше 5 млн. |
offerAmount | integer(int64) | false | none | Сумма |
offerGuid | string | false | none | Идентификатор предложения |
offerLink | string | false | none | Персональная ссылка в тексте предложения |
offerRate | number | false | none | Процентная ставка |
offerSetLimit | string | false | none | Набор сумм с символом " |
offerSetRate | string | false | none | Набор ставок с символом " |
offerSetTerm | string | false | none | Набор сроков с символом " |
offerTerm | integer(int32) | false | none | Срок |
priority | integer(int32) | false | none | Приоритет показа предложения |
productCode | string | false | none | Код продукта персонального предложения |
productName | string | false | none | Наименование карточки продукта |
productSystemName | string | false | none | Наименование продукта персонального предложения |
serviceName | string | false | none | Наименование внешнего сервиса в системе |
shortDesc | string | false | none | Краткое описание продукта |
specialCondition | string | false | none | Условия специального предложения |
telInText | string | false | none | Телефон в тексте персонального предложения |
textBandCard | string | false | none | Текст на карточке в ленте |
textDocCard | string | false | none | Текст на карточке в документарных разделах |
type | string | false | none | Тип предложения |
RequestStatistics
{
"billingObjects": [
{
"numberRequests": 1000,
"serviceName": "Код авторизации",
"serviceSystemName": "sso-authorize"
}
],
"nonBillingObjects": [
{
"numberRequests": 1000,
"serviceName": "Код авторизации",
"serviceSystemName": "sso-authorize"
}
]
}
Cтатистика о потреблении в API
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
billingObjects | [BillingObjectStatistics] | false | none | Статистика тарифицируемых запросов |
nonBillingObjects | [BillingObjectStatistics] | false | none | Статистика нетарифицируемых запросов |
Attachment
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
Вложенный документ
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
content | [string] | false | none | Вложение закодированное в Base64 |
mimeType | string | false | none | Тип формат файла |
name | string | false | none | Имя файла |
InkotermsCondition
{
"conditionId": "EXW"
}
Условия Инкотермс
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
conditionId | string | true | none | Идентификатор условия Инкотермс |
ExternalSystemAuthProfile
{
"accessToken": "bb9fb25d004182bc00417502000000090000033d6100d08fdffcadf26b643bd74c195f",
"accessTokenExpiresIn": "2018-12-31T23:59:59",
"commentary": "Произвольный текст",
"extSystemId": 12345,
"extSystemUserId": "12345dfff",
"extSystemUserLogin": "qwerty",
"refreshToken": "ab1edс5d004189bc0041750200000009000003fa1d9de836e47b531a635b8a0dc8f385",
"refreshTokenExpiresIn": "2018-12-31T23:59:59",
"tokenType": "Bearer"
}
Авторизационные данные пользователя во внешней системе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accessToken | string | false | none | Access токен |
accessTokenExpiresIn | string(date-time) | false | none | Дата и время окончания действия accessToken'а |
commentary | string | false | none | Произвольный комментарий |
extSystemId | integer(int64) | true | none | Идентификатор внешней системы |
extSystemUserId | string | false | none | Идентификатор пользователя во внешней системе |
extSystemUserLogin | string | false | none | Логин пользователя во внешней системе |
refreshToken | string | false | none | Refresh токен |
refreshTokenExpiresIn | string(date-time) | false | none | Дата и время окончания действия refreshToken'а |
tokenType | string | false | none | Тип токена |
DepositConditionInfo
{
"chargeDates": "[\"2020-04-14\",\"2020-04-15\"]",
"depositConditions": [
{
"currency": "RUB",
"depositName": "Депозит Классический Онлайн",
"depositSubtype": "Нет",
"depositSubtypeCode": "1",
"depositSubtypeFullDescription": "string",
"instrumentDescription": "string",
"isIndividualRate": false,
"maxDepositSum": 1000000,
"maxDepositTerm": 1096,
"minDepositSum": 1,
"minDepositTerm": 7,
"productType": "DEPOSIT",
"rateType": "UL",
"rates": {
"amountRanges": [
{
"from": 0,
"to": 0
}
],
"daysRanges": [
[
{
"from": 0,
"to": 0
}
]
],
"rates": [
[
0
]
]
},
"refund": false,
"revocation": false
}
]
}
Информация об условиях размещения депозита
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
chargeDates | [string] | false | none | Возможные даты списания |
depositConditions | [DepositCondition] | false | none | Условия размещения средств |
DepositConditionRate
{
"amountRanges": [
{
"from": 0,
"to": 0
}
],
"daysRanges": [
[
{
"from": 0,
"to": 0
}
]
],
"rates": [
[
0
]
]
}
Условие размещения депозита (ставка)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amountRanges | [FromTo_bigdecimal_] | false | none | Диапазон сумм |
daysRanges | [array] | false | none | Диапазон дней |
rates | [array] | false | none | Ставки |
serviceRatingData
{
"enableBroadcast": true,
"priority": true,
"rating": "green",
"tariffName": "Мой тариф"
}
Параметры Сберрейтинга
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
enableBroadcast | boolean | true | none | Признак согласия на трансляцию данных по себе в рамках услуги |
priority | boolean | false | none | Признак максимального приоритета цвета |
rating | string | true | none | Значение рейтинга по услуге Внутренние источники для определения цвета "светофора" |
tariffName | string | false | none | Название тарифа |
Enumerated Values
Property | Value |
---|---|
rating | Yellow |
rating | Green |
rating | Red |
rating | Blank |
PaymentRequestsInInfo
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"paymentsRequestIn": [
{
"acceptLastDate": "2018-12-31",
"acceptanceTerm": "20",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
]
}
Список входящих платёжных требований
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
paymentsRequestIn | [PaymentRequestsIn] | false | none | Входящие платежные требования |
PaymentRequestsIn
{
"acceptLastDate": "2018-12-31",
"acceptanceTerm": "20",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Входящее платёжное требование
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptLastDate | string(date-time) | false | none | Дата окончания акцепта |
acceptanceTerm | string | false | none | Срок для акцепта (поле 36) |
amount | number | false | none | Сумма платежа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
externalId | string | false | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
operationCode | string | false | none | Код операции |
payeeAccount | string | false | none | Счёт получателя платежа |
payeeBankBic | string | false | none | БИК получателя платежа |
payeeBankCorrAccount | string | false | none | Корсчёт банка получателя платежа |
payeeInn | string | false | none | ИНН получателя платежа |
payeeName | string | false | none | Полное наименование получателя платежа |
payerAccount | string | false | none | Счёт плательщика |
payerBankBic | string | false | none | БИК банка плательщика |
payerBankCorrAccount | string | false | none | Корсчёт банка плательщика |
payerInn | string | false | none | ИНН плательщика |
payerName | string | false | none | Полное наименование плательщика |
paymentCondition | string | false | none | Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика. |
priority | string | false | none | Очерёдность платежа |
purpose | string | false | none | Назначение платежа |
vat | Vat | false | none | Данные НДС |
BankControlStatementNonResident
{
"countryCode": "643",
"countryName": "РОССИЯ",
"name": "Kazan"
}
Нерезидент
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
countryCode | string | true | none | Цифровой код страны |
countryName | string | true | none | Наименование страны |
name | string | true | none | Наименование иностранного контрагента |
EncashmentContractObject
{
"address": "г.Москва, ул.Тамбовская, д.5",
"encashContractAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"encashDebitAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"name": "АО \"Тандер\" Многоцветница 773460",
"objectStatus": "ARHIV"
}
Объект инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
address | string | false | none | Адрес объекта инкассации |
encashContractAccounts | [EncashmentContractAcc] | false | none | Счета списания |
encashDebitAccounts | [EncashmentContractAcc] | false | none | Счета зачисления наличности |
name | string | false | none | Наименование объекта инкассации |
objectStatus | string | false | none | Статус объекта инкассации |
FileDownloadStateRequest
{
"fileIds": [
"string"
]
}
Модель параметров запроса на получение статусов загрузки файлов
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fileIds | [string] | true | none | Список идентификаторов файлов |
Periodicity
{
"daysOfMonth": "5,10,25,28",
"daysOfWeek": "MON,TUE,WED,THU,FRI,SAT,SUN",
"mode": "DAILY",
"offset": "BACKWARD",
"time": "14:00"
}
Определение периодичности исполнения
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
daysOfMonth | string | false | none | Дни месяца, через запятую |
daysOfWeek | string | false | none | Дни недели, через запятую |
mode | string | true | none | Режим определения периодичности |
offset | string | false | none | Режим смещения платежа в связи с нерабочими днями |
time | string | true | none | Время совершения платежа |
Enumerated Values
Property | Value |
---|---|
mode | DAILY |
mode | MONTHLY_FIRST_WORKDAY |
mode | MONTHLY_LAST_WORKDAY |
mode | WORKDAYS_ODD |
mode | WORKDAYS_EVEN |
mode | WEEKLY |
mode | MONTHLY_SELECTED |
offset | BACKWARD |
offset | FORWARD |
offset | NONE |
CustomerAccount
{
"accountBic": "044525225",
"accountId": 11,
"accountNumber": "40802810600000200000",
"accountState": "OPEN",
"accountType": "STANDART",
"businessNewType": false,
"businessOldType": false,
"gosContractNum": "1920187408202412245023026",
"gosContractorType": "NORM"
}
Информация о счёте
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountBic | string | false | none | БИК |
accountId | integer(int64) | false | none | Идентификатор счёта |
accountNumber | string | false | none | Номер счёта |
accountState | string | false | none | Статус |
accountType | string | false | none | Тип счёта |
businessNewType | boolean | false | none | Признак бизнес-счёта нового типа |
businessOldType | boolean | false | none | Признак бизнес-счёта старого типа |
gosContractNum | string | false | none | Номер госконтракта |
gosContractorType | string | false | none | Тип госконтракта |
CreditOffer
{
"checkSum": 1.01,
"clientId": 1005,
"delayRepayment": 30,
"individual": true,
"orgLawForms": [
{
"name": "Индивидуальный предприниматель",
"shortName": "ИП"
}
],
"productCode": "MB-F-ip-19",
"productName": "СМАРТ-кредит",
"questions": [
{
"answer": "Подайте заявку онлайн.",
"question": "Как мне оплатить счёт кредитными деньгами?"
}
],
"rate": 1.01,
"sumMax": 1.01,
"sumMin": 1.01,
"termMax": 36,
"termMin": 12
}
Кредитное предложение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
checkSum | number | false | none | Сумма займа, после которой потребуется выездная проверка по месту ведения бизнеса |
clientId | integer(int64) | true | none | Идентификатор внешнего сервиса |
delayRepayment | integer(int32) | false | none | Льготный период |
individual | boolean | false | none | none |
orgLawForms | [OrgLawForm] | false | none | Перечень организационно-правовых форм организаций, для которых доступен кредитный продукт |
productCode | string | true | none | Код кредитного продукта |
productName | string | false | none | Наименование кредитного продукта |
questions | [QuestionForm] | false | none | Список топ вопросов с ответами по созданию кредитной заявки |
rate | number | false | none | Ставка по кредитному предложению (%) |
sumMax | number | false | none | Максимальная сумма доступная для покупки в кредит |
sumMin | number | false | none | Минимальная сумма доступная для покупки в кредит |
termMax | integer(int32) | false | none | Максимальный срок кредита (в месяцах) |
termMin | integer(int32) | false | none | Минимальный срок кредита (в месяцах) |
SelfEncasherRequestIdentityDoc
{
"issueDate": "2018-12-31",
"issuer": "ОВД г. Москвы",
"issuerCode": "222-222",
"number": "111222",
"serial": "1111",
"typeCode": "21"
}
Документ удостоверяющий личность
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
issueDate | string(date-time) | true | none | Дата выдачи |
issuer | string | true | none | Кем выдан |
issuerCode | string | false | none | Код подразделения, выдавшего ДУЛ |
number | string | false | none | Номер |
serial | string | false | none | Серия |
typeCode | string | true | none | Код типа |
CashUnholdRequestState
{
"actualHoldAmount": 1.01,
"bankComment": "string",
"bankStatus": "string"
}
Статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualHoldAmount | number | false | none | Cумма блокированных денежных средств (рассчитывается с учетом разблокированных денежных средств в рамках блокировки) |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
ClientAdded
{
"hashOrgId": "string",
"usersInfo": [
{
"servicesInfo": [
{
"clientId": 0,
"refreshToken": "string"
}
],
"sub": "string"
}
]
}
Информация о клиенте
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
hashOrgId | string | false | none | Хэш идентификатора организации |
usersInfo | [ClientAddedUserInfo] | false | none | Информация о пользователях |
CurrBuy
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payeeBankSwiftCode": "SABRRUMM",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Поручение на покупка/конверсию валюты
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
addInfo | string | false | none | Дополнительная информация |
authPersonName | string | true | none | ФИО ответственного лица |
authPersonTelfax | string | true | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
chargeAmount | Amount | false | none | Сумма |
commissionAccount | string | false | none | Счёт списания комиссионного вознаграждения |
commissionBankBic | string | false | none | БИК банка списания комиссии |
course | string | true | none | Курс сделки |
creditAmount | number | false | none | Сумма зачисления |
date | string(date-time) | true | none | Дата составления документа |
debitAmount | number | false | none | Сумма списания |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
factCreditAmount | Amount | false | none | Сумма |
factDebitAmount | Amount | false | none | Сумма |
factRate | number | false | none | Фактический курс сделки |
individualRate | number | false | none | Значение индивидуального курса |
number | string | false | none | Номер документа |
payeeAccount | string | true | none | Счёт зачисления валюты |
payeeBankBic | string | false | none | БИК банка зачисления |
payeeBankSwiftCode | string | false | none | SWIFT-код банка зачисления валюты |
payerAccount | string | true | none | Счёт списания валюты |
payerBankBic | string | true | none | БИК банка списания |
valueDate | string(date-time) | false | none | Дата валютирования |
Enumerated Values
Property | Value |
---|---|
course | sberbankRateConditions |
course | centralBankRateConditions |
course | individualRateConditions |
RURTransfer
{
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
}
Данные рублевой операции
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cartInfo | CartInfo | false | none | Дополнительная информация о документе (картотека) |
deliveryKind | string | false | none | Способ отправки документа |
departmentalInfo | DepartmentalInfo | false | none | Реквизиты налогового, таможенного или иного бюджетного платежа |
payeeAccount | string | false | none | Номер счёта получателя |
payeeBankBic | string | false | none | БИК банка получателя |
payeeBankCorrAccount | string | false | none | Корсчёт банка получателя |
payeeBankName | string | false | none | Наименование банка получателя |
payeeInn | string | false | none | ИНН получателя |
payeeKpp | string | false | none | КПП получателя |
payeeName | string | false | none | Наименование получателя |
payerAccount | string | false | none | Номер счёта плательщика |
payerBankBic | string | false | none | БИК банка плательщика |
payerBankCorrAccount | string | false | none | Корсчёт банка плательщика |
payerBankName | string | false | none | Наименование банка плательщика |
payerInn | string | false | none | ИНН плательщика |
payerKpp | string | false | none | КПП плательщика |
payerName | string | false | none | Наименование плательщика |
payingCondition | string | false | none | Условие оплаты (для 02) |
purposeCode | string | false | none | Код вида дохода получателей выплаты по 229-ФЗ |
receiptDate | string(date-time) | false | none | Дата поступления в банк плательщика |
valueDate | string(date-time) | false | none | Дата валютирования |
CardIssueAddress
{
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
}
Адрес
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
building | string | false | none | Номер корпуса |
city | string | false | none | Город |
country | string | true | none | Наименование страны |
countryCode | string | true | none | Трехбуквенный код страны |
countryNumericCode | string | true | none | Цифровой код страны |
district | string | false | none | Район |
flat | string | false | none | Номер офиса/квартиры |
fullAddress | string | false | none | Полный адрес |
house | string | true | none | Номер дома |
postalCode | string | true | none | Индекс |
settlementName | string | false | none | Наименование нас. пункта |
state | string | true | none | Субъект/Регион |
street | string | true | none | Улица |
CredRepayPayment
{
"condition": "АБВ123",
"currencyCode": "840",
"currencyName": "USD",
"interestAmount": 1.01,
"interestDate": "2018-12-31",
"principalAmount": 1.01,
"principalDate": "2018-12-31"
}
Платёж по кредитному договору
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
condition | string | false | none | Особые условия |
currencyCode | string | true | none | Цифровой код валюты платежа |
currencyName | string | false | none | Буквенный ISO-код валюты платежа |
interestAmount | number | false | none | Сумма платежа по процентам |
interestDate | string(date-time) | false | none | Дата платежа (процентный) |
principalAmount | number | false | none | Сумма платежа по основному долгу |
principalDate | string(date-time) | false | none | Дата платежа (основной долг) |
SalaryAgreementRequest
{
"account": "40802810600000200000",
"admissionType": "2",
"amount": 1.01,
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTel": "8(495)1234567",
"bankComment": "string",
"bankStatus": "string",
"bic": "044525225",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"identityDoc": {
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"firstName": "Иван",
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"lastName": "Иванов",
"middleName": "Иванович",
"number": "123456",
"serial": "1234",
"typeCode": "21",
"typeName": "Паспорт гражданина Российской Федерации"
},
"number": "1",
"offerAgree": false,
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}
Заявка на удаленное подключение «Зарплатного проекта»
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | true | none | Номер счёта клиента |
admissionType | string | true | none | Тип зачисления |
amount | number | true | none | Месячный фонд оплаты труда |
authPersonName | string | true | none | ФИО уполномоченного сотрудника организации клиента |
authPersonTel | string | true | none | Номер телефона уполномоченного сотрудника организации клиента |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bic | string | true | none | БИК банка клиента |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
employeesNumber | integer(int32) | true | none | Количество сотрудников |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
identityDoc | SalaryAgreementRequestIdentityDoc | true | none | Сведения ДУЛ |
number | string | false | none | Номер документа |
offerAgree | boolean | false | none | Согласие с Условиями предоставления услуг и Тарифами |
orgName | string | true | none | Наименование организации клиента |
orgTaxNumber | string | true | none | ИНН клиента |
SetEInvoicingFlagToUserRequest
{
"sub": "string"
}
Модель параметров запроса на изменение признака регистрации пользователя в сервисе документооборота
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
sub | string | true | none | Хэш идентификатора пользователя |
EncashmentOffer
{
"bankComment": "Новый",
"bankStatus": "RECEIVED",
"contractModifyDate": "2018-12-31",
"date": "2018-12-31",
"encashObjects": [
{
"examResult": "Enrolled",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectName": "АО \"Киберлинк\" технологии 555100",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-П",
"serviceType": 3,
"tariffs": [
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
],
"visitInfo": {
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
}
]
}
],
"encashOfferId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "96"
}
Коммерческое предложение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | none | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
contractModifyDate | string(date-time) | false | none | Желаемая дата внесения изменений в договор инкассации |
date | string(date-time) | false | none | Дата составления документа |
encashObjects | [EncashmentOfferObject] | false | none | Объекты инкассации |
encashOfferId | string | false | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
CurrContract
{
"amount": 1.01,
"balance": 1.01,
"bankComment": "string",
"bankControlStatementInfo": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"creationMode": "ICS_CONTRACT_INFORMATION",
"currencyName": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"isActual": false,
"unk": "string"
},
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractEndDate": "2018-12-31",
"contractNumber": "123АБВ",
"contractType": "MULTI_CONTRACT",
"currencyCode": "840",
"date": "2018-12-31",
"decNonresToResidentLiabSum": 1.01,
"decResidentToNonresLiabSum": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"finalTransCurrencyCode": "643",
"finalTransCurrencyName": "USD",
"incNonresidLiabilitySum": 1.01,
"incResidentLiabilitySum": 1.01,
"nonResidents": [
{
"countryCode": "643",
"countryName": "РОССИЯ",
"name": "Kazan"
}
],
"number": "1",
"totalCredit": 1.01,
"totalDebit": 1.01,
"transDate": "2018-12-31"
}
Валютный контракт с нерезидентом
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма контракта |
balance | number | false | read-only | Сальдо расчётов |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementInfo | BankControlStatementInfo | true | none | Информация о ведомости банковского контроля |
bankStatus | string | false | read-only | Статус документа |
contractDate | string(date-time) | true | none | Дата контракта |
contractEndDate | string(date-time) | false | none | Дата окончания обязательств по контракту |
contractNumber | string | false | none | Номер контракта |
contractType | string | false | none | Код вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта (Режим создания ВБК) |
currencyCode | string | false | none | Цифровой код валюты контракта |
date | string(date-time) | true | none | Дата составления документа |
decNonresToResidentLiabSum | number | false | read-only | Сумма по подтверждающим документам, уменьшающим обязательства нерезидента перед резидентом |
decResidentToNonresLiabSum | number | false | read-only | Сумма по подтверждающим документам, уменьшающим обязательства резидента перед нерезидентом |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
finalTransCurrencyCode | string | false | read-only | Цифровой код страны |
finalTransCurrencyName | string | false | read-only | Буквенный ISO-код валюты |
incNonresidLiabilitySum | number | false | read-only | Сумма по подтверждающим документам, увеличивающим обязательства нерезидента |
incResidentLiabilitySum | number | false | read-only | Сумма по подтверждающим документам, увеличивающим обязательства резидента |
nonResidents | [BankControlStatementNonResident] | false | none | Информация о нерезидентах |
number | string | false | none | Номер документа |
totalCredit | number | false | read-only | Сумма денежных средств, поступивших по контракту в пользу резидента (всего зачислено) |
totalDebit | number | false | read-only | Сумма денежных средств, переведенных по контракту в пользу нерезидента (всего списано) |
transDate | string(date-time) | false | read-only | Дата расчёта |
Enumerated Values
Property | Value |
---|---|
contractType | PRODUCT_EXPORT |
contractType | SERVICE_EXPORT |
contractType | MULTI_CONTRACT |
CardIssueEmployee
{
"accountNumber": "40802810600000200000",
"bankMessage": "Счет успешно открыт",
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"issCard": false,
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"result": "Счет открыт",
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
Реквизиты сотрудников в реестре
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountNumber | string | false | read-only | Номер открытого счета |
bankMessage | string | false | read-only | Банковский комментарий к статусу карты |
birthDate | string(date-time) | true | none | Дата рождения |
birthPlace | string | true | none | Место рождения |
cardInfo | CardIssueCardInfo | true | none | Зарплатная карта |
cardUniqueDesignCode | string | false | none | Код индивидуального дизайна карты |
categoryCode | string | true | none | Код категории населения |
citizenship | CardIssueCitizenship | true | none | Гражданство сотрудника |
contactInfo | CardIssueContactInfo | false | none | Контактная информация |
firstName | string | true | none | Имя |
identityDoc | CardIssueIdentityDoc | false | none | Документ удостоверяющий личность |
inn | string | false | none | ИНН |
issCard | boolean | false | read-only | Признак того что карта выпущена |
lastName | string | true | none | Фамилия |
middleName | string | false | none | Отчество |
personnelNumber | string | false | none | Табельный номер |
placeOfService | CardIssuePlaceOfService | true | none | Места обслуживания физических лиц |
position | string | false | none | Должность |
registrationAddress | CardIssueAddress | true | none | Адрес |
resident | boolean | false | none | Резидент РФ |
residentalAddress | CardIssueAddress | false | none | Адрес |
result | string | false | read-only | Результат открытия счетов / выпуска карт |
sameAddress | boolean | false | none | Адреса регистрации и проживания совпадают |
sendReport | boolean | false | none | Признак рассылки отчета по Internet |
serNumber | integer(int32) | true | none | № п/п |
sex | boolean | true | none | Пол |
LinkedDoc
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
Связанный документ
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
docExtId | string | true | none | Идентификатор документа во внешней системе (UUID) |
type | string | true | none | Тип связанного документа |
Branch
{
"address": "г.Москва, Кутузовский проспект, 34",
"code": "138592",
"name": "Доп офис 1654"
}
Подразделение банка
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
address | string | false | none | Адрес подразделения |
code | string | false | none | Номер подразделения |
name | string | false | none | Наименование подразделения |
CurrSell
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"chargeAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"commissionAccount": "40802810600000200000",
"commissionBankBic": "044525225",
"course": "sberbankRateConditions",
"creditAmount": 1.01,
"date": "2018-12-31",
"debitAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"factCreditAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factDebitAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"factRate": 1.0001,
"individualRate": 5.5678,
"number": "1",
"payeeAccount": "40802840600000200000",
"payeeBankBic": "044525225",
"payerAccount": "40802840600000200000",
"payerBankBic": "044525225",
"valueDate": "2018-12-31"
}
Поручение на продажу валюты
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
addInfo | string | false | none | Дополнительная информация |
authPersonName | string | true | none | ФИО ответственного лица |
authPersonTelfax | string | true | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
chargeAmount | Amount | false | none | Сумма |
commissionAccount | string | false | none | Счёт списания комиссионного вознаграждения |
commissionBankBic | string | false | none | БИК банка списания комиссии |
course | string | true | none | Курс сделки |
creditAmount | number | false | none | Сумма зачисления |
date | string(date-time) | true | none | Дата составления документа |
debitAmount | number | false | none | Сумма списания |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
factCreditAmount | Amount | false | none | Сумма |
factDebitAmount | Amount | false | none | Сумма |
factRate | number | false | none | Фактический курс сделки |
individualRate | number | false | none | Значение индивидуального курса |
number | string | false | none | Номер документа |
payeeAccount | string | true | none | Счёт зачисления валюты |
payeeBankBic | string | true | none | БИК банка зачисления |
payerAccount | string | true | none | Счёт списания валюты |
payerBankBic | string | true | none | БИК банка списания |
valueDate | string(date-time) | false | none | Дата валютирования |
Enumerated Values
Property | Value |
---|---|
course | sberbankRateConditions |
course | centralBankRateConditions |
course | individualRateConditions |
PaymentFromContragentInfo
{
"amount": 1.01,
"createDate": "2018-12-31T23:59:59",
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerOgrn": "380123456789012",
"purpose": "Оплата заказа №123. НДС нет.",
"valueDate": "2018-12-31T23:59:59"
}
Информация о планируемых входящих платежах от контрагентов
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма документа |
createDate | string(date-time) | true | none | Дата и время создания документа |
date | string(date-time) | true | none | Дата составления документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | true | none | Номер документа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerInn | string | true | none | ИНН плательщика |
payerName | string | true | none | Наименование организации плательщика |
payerOgrn | string | false | none | ОГРН плательщика |
purpose | string | true | none | Назначение платежа |
valueDate | string(date-time) | false | none | Дата и время исполнения документа |
CurrCredTrancheChangeable
{
"amount": 1.01,
"currencyCode": "840",
"entryDate": "2018-12-31",
"periodCode": "1"
}
Транш по валютному кредитному договору - изменяемые поля
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма |
currencyCode | string | false | none | Цифровой код валюты |
entryDate | string(date-time) | false | none | Ожидаемая дата поступления |
periodCode | string | false | none | Код срока привлечения |
ExportContractInsureState
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"statusComment": "Комментарий",
"statusName": "WAITING_FOR_PAY"
}
Бенефициарный владелец
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fileId | string | false | none | Идентификатор файла, который необходимо прилинковать к заявлению на страхование |
statusComment | string | false | none | Текстовый комментарий к статусу/Причина отказа |
statusName | string | true | none | Наименование статуса |
Enumerated Values
Property | Value |
---|---|
statusName | RECEIVED_EKSAR |
statusName | REFUSED |
statusName | WAITING_FOR_PAY |
statusName | POLICE_ACTIVATED |
EncashAddRequestService
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-И",
"serviceType": 3,
"visitInfo": {
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
}
Подключаемые услуги
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
encashContractDate | string(date-time) | true | none | Дата создания договора инкассации |
encashContractNum | string | true | none | Номер договора инкассации |
serviceType | integer(int32) | true | none | Тип услуги |
visitInfo | EncashAddRequestVisitInfo | true | none | Информация о заездах |
CryptoProfileInfo
{
"alias": "Profile alias",
"certificateInfos": [
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"typeName": "Инфокрипт"
}
Информация о криптопрофиле
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
alias | string | false | none | Псевдоним |
certificateInfos | [CertificateInfo] | false | none | Информация о сертификатах |
typeName | string | false | none | Наименование типа |
OrderInfo
{
"numOfPosition": 1,
"position": "string",
"price": 1.01,
"totalPrice": 1.01
}
Информация о составе заказа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
numOfPosition | integer(int64) | false | none | Количество позиций/товаров |
position | string | false | none | Позиция/Наименование товара |
price | number | false | none | Стоимость позиции |
totalPrice | number | false | none | Итоговая стоимость |
PaymentRequestOut
{
"acceptanceTerm": "string",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"crucialFieldsHash": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"paymentCondition": "string",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Исходящее платёжное требование
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptanceTerm | string | false | none | Срок для акцепта (поле 36). Указывается количество дней для получения акцепта плательщика. |
amount | number | true | none | Сумма платежа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
crucialFieldsHash | string | false | none | Hash от ключевых полей документа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
operationCode | string | true | none | Код операции |
payeeAccount | string | false | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК получателя платежа |
payeeBankCorrAccount | string | false | none | Корсчёт банка получателя платежа |
payeeInn | string | false | none | ИНН получателя платежа |
payeeName | string | true | none | Полное наименование получателя платежа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerBankCorrAccount | string | true | none | Корсчёт банка плательщика |
payerInn | string | true | none | ИНН плательщика |
payerName | string | true | none | Полное наименование плательщика |
paymentCondition | string | true | none | Условие оплаты (поле 35). Указывается цифра "1" - заранее данный акцепт плательщика или цифра "2" - требуется получение акцепта плательщика. |
priority | string | true | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
vat | Vat | false | none | Данные НДС |
voCode | string | false | none | Код вида валютной операции |
CorrespondentCurAdditional
{
"easyIcon": "999",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"lastBalanceDate": "2018-12-31",
"legalForm": "GmbH",
"ratingCompany": "Высокий уровень",
"registerAddress": "ZURICH PARADEPLATZ 8",
"registerCountry": "ШВЕЙЦАРИЯ",
"registerDate": "2018-12-31",
"registerNumber": "1",
"sourceName": "PARTNER_NAME",
"updateRegistryDate": "2018-12-31T23:59:59"
}
Дополнительная информация по валютному контрагенту (бенефициару)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
easyIcon | string | false | none | EASY / ICON номер |
externalId | string | true | none | Идентификатор валютного контрагента (бенефициара) (UUID) |
lastBalanceDate | string(date-time) | false | none | Дата составления последнего балансового отчета |
legalForm | string | false | none | Организационно-правовая форма компании |
ratingCompany | string | false | none | Рейтинг компании |
registerAddress | string | false | none | Адрес регистрации |
registerCountry | string | false | none | Страна регистрации |
registerDate | string(date-time) | false | none | Дата регистрации |
registerNumber | string | false | none | Регистрационный номер |
sourceName | string | false | none | Источник информации (имя партнера) |
updateRegistryDate | string(date-time) | false | none | Дата и время обновления сведений в реестре |
CardIssueCitizenship
{
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
}
Гражданство сотрудника
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
country | string | true | none | Гражданство сотрудника: наименование страны |
countryCode | string | true | none | Гражданство сотрудника: трехбуквенный код страны |
countryNumericCode | string | true | none | Гражданство сотрудника: цифровой код страны |
CurrControlMessageFromBank
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"refDocument": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"rootMessage": {
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
},
"subject": "Досыл документа.",
"text": "Добрый день. Документ отправлен."
}
Письмо для целей ВК (из банка)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
attachments | [Attachment] | false | none | Вложенные документы |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Данные о файлах, связанных с письмом для целей ВК |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
number | string | false | none | Номер документа |
refDocument | LinkedDoc | false | none | Связанный документ |
rootMessage | LinkedDoc | false | none | Связанный документ |
subject | string | true | none | Тема письма |
text | string | true | none | Текст письма |
AmountCurrency
{
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
}
Сумма и валюта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма |
currencyCode | string | true | none | Цифровой код валюты |
currencyName | string | true | none | Буквенный ISO-код валюты |
OrderMandatorySale
{
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankBic": "044525225",
"bankComment": "string",
"bankName": "ПАО СБЕРБАНК",
"bankStatus": "string",
"comment": "Комментарий",
"customerInn": "7707083893",
"customerName": "Общество с ограниченной ответственностью \"Клиент\"",
"customerOkpo": "222221001",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docAccount": "40802840600000200000",
"employee": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"noticeDocDate": "2018-12-31",
"noticeDocNum": "12344",
"noticeDocSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"number": "1",
"receiptDate": "2018-12-31",
"transferCurrency": {
"accountNum": "40802810600000200000",
"bankSwiftCode": "SABRRUMM",
"bankSwiftName": "SBERBANK",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"transferAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"transferTo": "orgAccount",
"valueDate": "2018-12-31"
},
"voluntarySale": {
"accountNum": "40802810600000200000",
"accountType": "orgAccount",
"bankBic": "044525225",
"bankName": "ПАО СБЕРБАНК",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"comissionAccount": "40802810600000200000",
"comissionBankBic": "044525225",
"comissionBankName": "ПАО СБЕРБАНК",
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"dealType": "sberbankRateConditions",
"enrolledRub": 1.01,
"rate": 1.01,
"sellAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"valueDate": "2018-12-31"
}
}
Распоряжение на перевод с транзитного счёта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
addInfo | string | false | none | Примечание |
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankBic | string | true | none | БИК банка |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankName | string | true | none | Наименование банка |
bankStatus | string | false | read-only | Статус документа |
comment | string | false | read-only | Комментарий |
customerInn | string | true | none | ИНН клиента |
customerName | string | true | none | Полное наименование организации клиента |
customerOkpo | string | false | none | ОКПО клиента |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
docAccount | string | true | none | Транзитный валютный счёт |
employee | string | false | read-only | Исполнитель |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
linkedDocs | [LinkedDoc] | false | none | Связанные документы |
noticeDocDate | string(date-time) | false | none | Дата уведомления о поступлении денежных средств на транзитный счёт |
noticeDocNum | string | false | none | Номер уведомления о поступлении денежных средств на транзитный счёт |
noticeDocSum | AmountCurrency | false | none | Сумма и валюта |
number | string | false | none | Номер документа |
receiptDate | string(date-time) | false | read-only | Дата поступления документа в банк |
transferCurrency | MandatorySaleTransf | false | none | Блок валютного перевода |
voluntarySale | VoluntarySale | false | none | Блок необязательной продажи |
PaymentsRegistryItem
{
"amount": 2000.15,
"amountBring": 2100.35,
"dateBegin": "2018-12-31",
"dateEnd": "2018-12-31",
"dateLoad": "2018-12-31",
"registryName": "EPS39291510642_5018141474.txt",
"uploadedRecords": 10
}
Реестр платежей
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма |
amountBring | number | false | none | Сумма с комиссией |
dateBegin | string(date-time) | false | none | Дата начала периода |
dateEnd | string(date-time) | false | none | Дата окончания периода |
dateLoad | string(date-time) | false | none | Дата выгрузки реестра |
registryName | string | false | none | Наименование реестра |
uploadedRecords | integer(int32) | false | none | Количество платежей |
OrgIndustry
{
"code": 0,
"name": "string"
}
Информация об отрасли организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer(int32) | false | none | Код отрасли |
name | string | false | none | Наименование отрасли |
CurrencyNotice
{
"bankName": "ПАО СБЕРБАНК",
"bic": "044525225",
"branchName": "ДО №1654 Московского банка ПАО Сбербанк",
"currencyName": "USD",
"date": "2018-12-31",
"dateReceipt": "2018-12-31",
"docSum": 1.01,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "21053520",
"transferDate": "2018-12-31",
"transitAccountNumber": "40802840600000200000"
}
Уведомления о поступлении денежных средств на транзитный валютный счёт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankName | string | false | read-only | Наименование банка |
bic | string | false | none | БИК |
branchName | string | false | none | Подразделение банка |
currencyName | string | false | none | Буквенный ISO-код валюты |
date | string(date-time) | false | none | Дата документа |
dateReceipt | string(date-time) | false | none | Срок предоставления СВО и подтверждающих документов |
docSum | number | false | none | Сумма |
externalId | string | false | none | Идентификатор документа |
number | string | false | none | Номер документа |
transferDate | string(date-time) | false | none | Дата зачисления |
transitAccountNumber | string | false | none | Номер транзитного счёта |
Account
{
"bic": "string",
"blockedQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSumQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSums": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"business": false,
"businessNewType": false,
"cdiAcptDocQnt": 0,
"cdiAcptDocSum": 0,
"cdiCart2DocQnt": 0,
"cdiCart2DocSum": 0,
"cdiPermDocQnt": 0,
"cdiPermDocSum": 0,
"closeDate": "2019-08-24T14:15:22Z",
"comment": "string",
"creditBlocked": false,
"creditBlockedBeginDate": "2019-08-24T14:15:22Z",
"creditBlockedCause": "string",
"creditBlockedEndDate": "2019-08-24T14:15:22Z",
"creditBlockedInitiator": "string",
"creditBlockedTaxAuthorityCode": "string",
"currencyCode": "string",
"dbo": false,
"debitBlocked": false,
"debitBlockedBeginDate": "2019-08-24T14:15:22Z",
"debitBlockedCause": "string",
"debitBlockedEndDate": "2019-08-24T14:15:22Z",
"debitBlockedInitiator": "string",
"debitBlockedTaxAuthorityCode": "string",
"minBalance": 0,
"mode": "STANDART",
"name": "string",
"notDelay": false,
"number": "string",
"openDate": "2019-08-24T14:15:22Z",
"overdraft": 0,
"passive": false,
"state": "OPEN",
"type": "assuranceRegistration",
"urgent": false
}
Счет клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bic | string | false | none | БИК банка, где открыт счет |
blockedQueuesInfo | [AccountBlockInfo] | false | none | Приостановления операций по счету выше очередности (блокировки по очередности) |
blockedSumQueuesInfo | [AccountBlockInfo] | false | none | Приостановления операций по счету выше очередности на сумму |
blockedSums | [AccountBlockInfo] | false | none | Заблокированные (арестованные) суммы на счёте |
business | boolean | false | none | Признак бизнес-счёта |
businessNewType | boolean | false | none | Признак бизнес-счёта 'нового' типа |
cdiAcptDocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, ожидающих акцепта. Количество документов |
cdiAcptDocSum | number | false | none | Содержит информацию о расчетных документах, ожидающих акцепта. Сумма документов |
cdiCart2DocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, помещённых в картотеку к счету 90902 (картотека 2). Количество документов |
cdiCart2DocSum | number | false | none | Содержит информацию о расчетных документах, помещённых в картотеку к счету 90902 (картотека 2). Сумма документов |
cdiPermDocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Количество документов |
cdiPermDocSum | number | false | none | Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Сумма документов |
closeDate | string(date-time) | false | none | Дата закрытия счета |
comment | string | false | none | Примечание |
creditBlocked | boolean | false | none | Признак полной блокировки счета по кредиту |
creditBlockedBeginDate | string(date-time) | false | none | Дата начала действия ограничения |
creditBlockedCause | string | false | none | Основание ареста |
creditBlockedEndDate | string(date-time) | false | none | Дата снятия ограничения |
creditBlockedInitiator | string | false | none | Наименование органа, наложившего арест |
creditBlockedTaxAuthorityCode | string | false | none | Код налогового органа, наложившего арест |
currencyCode | string | false | none | Цифровой код валюты счета |
dbo | boolean | false | none | Признак обслуживания в ДБО |
debitBlocked | boolean | false | none | Признак полной блокировки счета по дебету |
debitBlockedBeginDate | string(date-time) | false | none | Дата начала действия ограничения |
debitBlockedCause | string | false | none | Основание ареста |
debitBlockedEndDate | string(date-time) | false | none | Дата снятия ограничения |
debitBlockedInitiator | string | false | none | Наименование органа, наложившего арест |
debitBlockedTaxAuthorityCode | string | false | none | Код налогового органа, наложившего арест |
minBalance | number | false | none | Минимальный поддерживаемый (неснижаемый) остаток на счете |
mode | string | false | none | Режим работы счёта |
name | string | false | none | Наименование счета |
notDelay | boolean | false | none | Признак возможности проведения неотложных платежей |
number | string | false | none | Номер счета (20 сиволов) |
openDate | string(date-time) | false | none | Дата открытия счета |
overdraft | number | false | none | Сумма общего лимита овердрафта в валюте счёта |
passive | boolean | false | none | Признак пассивности счета |
state | string | false | none | Состояние счета |
type | string | false | none | Тип счёта |
urgent | boolean | false | none | Признак возможности проведения срочных платежей |
Enumerated Values
Property | Value |
---|---|
mode | STANDART |
mode | FORBIDDEN_RECEIVING |
mode | ONLY_RECEIVING |
state | OPEN |
state | BLOCKED |
state | CLOSED |
type | assuranceRegistration |
type | calculated |
type | transit |
type | specialTransit |
type | budget |
type | loan |
type | deposit |
DocState
{
"bankComment": "string",
"bankStatus": "string",
"channelInfo": "string"
}
Статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
channelInfo | string | false | read-only | Комментарий, специфичный для документа, полученного по данному каналу |
Invoice
{
"amount": 1.01,
"date": "2018-12-31",
"deliveryKind": "электронно",
"expirationDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"operationCode": "01",
"orderNumber": "123",
"payeeAccount": "40802810600000200000",
"payeeOrgIdHash": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"paymentNumber": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Счёт на оплату по фиксированным реквизитам
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма платежа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
expirationDate | string(date-time) | false | none | Дата истечения заказа (платёж должен быть подтверждён клиентом) |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
linkedDocs | [LinkedDoc] | false | none | Связанные документы |
operationCode | string | false | none | Код операции |
orderNumber | string | false | none | Номер заказа |
payeeAccount | string | true | none | Счёт получателя платежа |
payeeOrgIdHash | string | false | none | Идентификатор получателя платежа |
paymentNumber | string | false | none | Номер платёжного документа |
priority | string | false | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
urgencyCode | string | false | none | Код срочности |
vat | Vat | false | none | Данные НДС |
Enumerated Values
Property | Value |
---|---|
urgencyCode | INTERNAL |
urgencyCode | INTERNAL_NOTIF |
urgencyCode | OFFHOURS |
urgencyCode | BESP |
urgencyCode | NORMAL |
Address
{
"area": "string",
"building": "string",
"city": "string",
"comment": "string",
"country": "string",
"flat": "string",
"fullAddress": "string",
"house": "string",
"region": "string",
"settlement": "string",
"settlementType": "string",
"street": "string",
"type": "string",
"zip": "string"
}
Адрес клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
area | string | false | none | Район |
building | string | false | none | Строение, корпус |
city | string | false | none | Город |
comment | string | false | none | Примечание |
country | string | false | none | Цифровой код страны |
flat | string | false | none | Квартира |
fullAddress | string | false | none | Адрес |
house | string | false | none | Дом |
region | string | false | none | Субъект или регион |
settlement | string | false | none | Населенный пункт |
settlementType | string | false | none | Тип населенного пункта |
street | string | false | none | Улица |
type | string | false | none | Наименование типа адреса |
zip | string | false | none | Индекс |
Check
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
Результат проверки
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
level | string | false | none | Уровень результата |
message | string | false | none | Сообщение |
fields | [string] | false | none | Названия полей (при наличии связи с моделью) |
Enumerated Values
Property | Value |
---|---|
level | ERROR |
level | WARNING |
Vat
{
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
Данные НДС
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма НДС |
rate | string | false | none | Ставка НДС |
type | string | true | none | Способ расчета НДС |
Enumerated Values
Property | Value |
---|---|
type | INCLUDED |
type | ONTOP |
type | NO_VAT |
type | MANUAL |
SelfEncasherRequestRegAddress
{
"building": "1",
"city": "Александров",
"countryCode": "643",
"district": "Александровский",
"flat": "1",
"house": "1",
"postalCode": "601650",
"settlement": "село Андреевское",
"state": "Владимирская область",
"street": "Институтская"
}
Адрес регистрации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
building | string | false | none | Корпус |
city | string | false | none | Город |
countryCode | string | true | none | Цифровой код страны |
district | string | false | none | Район |
flat | string | false | none | Квартира |
house | string | true | none | Дом |
postalCode | string | false | none | Индекс |
settlement | string | false | none | Населенный пункт |
state | string | true | none | Регион |
street | string | true | none | Улица |
AcceptanceAdvance
{
"acceptLastDate": "2018-12-31",
"acceptStartDate": "2018-12-31",
"bankComment": "string",
"bankStatus": "CREATED",
"contractDate": "2018-12-31",
"contractNumber": "3344",
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "667",
"obligation": "Оплата телефонных услуг",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\""
}
Документ Заявление на заранее данный акцепт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptLastDate | string(date-time) | false | none | Дата окончания периода действия ЗДА |
acceptStartDate | string(date-time) | true | none | Дата начала периода действия ЗДА |
bankComment | string | false | none | Расшифровка статуса обработки |
bankStatus | string | false | none | Статус обработки |
contractDate | string(date-time) | true | none | Дата договора |
contractNumber | string | true | none | Номер договора |
date | string(date-time) | true | none | Дата документа |
externalId | string | true | none | Идентификатор запроса, присвоенный партнером |
number | string | true | none | Номер документа |
obligation | string | false | none | Предмет договора |
payeeAccount | string | true | none | Счёт получателя |
payeeBankBic | string | false | none | БИК получателя платежа |
payeeInn | string | false | none | ИНН получателя |
payeeName | string | false | none | Наименование получателя |
payerAccount | string | false | none | Счёт плательщика |
payerBic | string | false | none | БИК плательщика |
payerInn | string | false | none | ИНН плательщика |
payerName | string | false | none | Наименование плательщика |
FailReason
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
Причина отказа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
docField | string | false | none | Поле документа |
reasonComment | string | false | none | Правило заполнения/замечания |
reasonId | string | false | none | Код причины отказа |
returnComment | string | false | none | Комментарий |
ContractCloseApplication
{
"additionalInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankControlStatementType": "ON_CONTRACT",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"closeReasonCode": "6.1.1",
"contractBankNumber": "120123A0/1234/GU23/1/2",
"contractDate": "2018-12-31",
"contractNumber": "123123",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"number": "1",
"otherBankInfo": "Другой банк",
"reasonDocDate": "2018-12-31",
"reasonDocNumber": "1",
"residentBuilding": "1",
"residentCity": "Воронеж",
"residentDistrict": "Воронежский",
"residentFlat": "1",
"residentHouse": "2",
"residentKpp": "222201001",
"residentName": "Общество с ограниченной ответственностью \"Клиент\"",
"residentOgrn": "380123456789012",
"residentRegDate": "2018-12-31",
"residentSettlementName": "Воронеж",
"residentState": "Воронежская область",
"residentStreet": "Воронежская",
"residentTaxNumber": "7707083893"
}
Заявление о снятии с учёта контракта (кредитного договора)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
additionalInfo | string | false | none | Дополнительная информация (комментарий) пользователя |
authPersonName | string | true | none | ФИО ответственного лица |
authPersonTelfax | string | true | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementType | string | true | none | Тип ВБК |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Прикреплённые большие файлы |
closeReasonCode | string | true | none | Код основания для снятия контракта с учёта |
contractBankNumber | string | true | none | Номер контракта (кредитного договора), установленный Банком |
contractDate | string(date-time) | false | none | Дата контракта (кредитного договора) |
contractNumber | string | false | none | Номер контракта (кредитного договора) |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
failReasons | [FailReason] | false | read-only | Причины отказа в части данных контратка (кредитного договора) |
number | string | false | none | Номер документа |
otherBankInfo | string | false | none | Наименование банка, в который переводится контракт |
reasonDocDate | string(date-time) | false | none | Дата документа, подтверждающего уступку |
reasonDocNumber | string | false | none | Номер документа, подтверждающего уступку |
residentBuilding | string | false | none | Корпус/строение организации-резидента |
residentCity | string | false | none | Город организации-резидента |
residentDistrict | string | false | none | Район организации-резидента |
residentFlat | string | false | none | Номер офиса организации-резидента |
residentHouse | string | false | none | Номер дома организации-резидента |
residentKpp | string | false | none | КПП организации-резидента |
residentName | string | false | none | Наименование организации-резидента |
residentOgrn | string | false | none | ОГРН организации-резидента |
residentRegDate | string(date-time) | false | none | Дата внесения организации-резидента в государственный реестр |
residentSettlementName | string | false | none | Населённый пункт организации-резидента |
residentState | string | false | none | Субъект РФ организации-резидента |
residentStreet | string | false | none | Улица организации-резидента |
residentTaxNumber | string | false | none | ИНН организации-резидента |
Enumerated Values
Property | Value |
---|---|
bankControlStatementType | ON_CONTRACT |
bankControlStatementType | ON_CREDIT |
PartnerOfferInfo
{
"clientId": "1005",
"inn": "7707083893",
"orgName": "OrgName",
"users": [
{
"accountList": [
"string"
],
"sinceDate": "2018-12-31",
"status": "PUBLIC",
"sub": "026f8e459c8f89ef75fa7a78265a0025",
"untilDate": "2018-12-31",
"userName": "Name"
}
]
}
Информация по офертам организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clientId | string | false | none | Идентификатор сервиса |
inn | string | false | none | ИНН организации |
orgName | string | false | none | Название организации |
users | [UserOffers] | false | none | Список пользователей с офертами |
CertificateInfo
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Информация о сертификате
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
active | boolean | false | none | Признак активности |
cert | string | false | none | Сертификат |
issuer | string | false | none | Издатель |
serialNumber | string | false | none | Серийный номер |
uuid | string | false | none | Уникальный идентификатор |
ConfirmatoryDocumentsInquiryDoc
{
"addInfo": "Дополнительная информация",
"confDocDate": "2018-12-31",
"confDocNumber": "123",
"contractSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractSumDel": 1.01,
"correctionDate": "2018-12-31",
"correctionNumber": 1,
"countryCode": "643",
"countryName": "РОССИЯ",
"docCode": "03_3",
"docName": "03_3 О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам, указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции",
"docSum": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docSumDel": 1.01,
"expectedLife": "2018-12-31",
"hasConfDocNumber": false,
"ordinalNumber": 1,
"supplyFeature": "1"
}
Документ, включённый в справку о подтверждающих документах
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
addInfo | string | false | none | Дополнительная информация |
confDocDate | string(date-time) | false | none | Дата подтверждающего документа |
confDocNumber | string | false | none | Номер подтверждающего документа |
contractSum | AmountCurrency | false | none | Сумма и валюта |
contractSumDel | number | false | none | Сумма, соответствующая признаку поставки 2 или 3, в валюте цены контракта (кредитного договора) |
correctionDate | string(date-time) | false | none | Дата корректировки |
correctionNumber | integer(int32) | false | none | Номер корректировки |
countryCode | string | false | none | Код страны грузополучателя (грузоотправителя) |
countryName | string | false | none | Наименование страны грузополучателя (грузоотправителя) |
docCode | string | true | none | Код вида документа |
docName | string | true | none | Наименование вида документа |
docSum | AmountCurrency | true | none | Сумма и валюта |
docSumDel | number | false | none | Сумма, соответствующая признаку поставки 2 или 3, в валюте документа |
expectedLife | string(date-time) | false | none | Ожидаемый срок |
hasConfDocNumber | boolean | true | none | Признак присутствия номера подтверждающего документа |
ordinalNumber | integer(int32) | true | none | Порядковый номер строки в справке |
supplyFeature | string | false | none | Признак поставки |
Enumerated Values
Property | Value |
---|---|
supplyFeature | 1 |
supplyFeature | 2 |
supplyFeature | 3 |
supplyFeature | 4 |
SberRatingValues
{
"enableBroadcast": true,
"enableService": true,
"inn": "7707083893",
"kpp": "222201001",
"rating": "green",
"serviceType": "inner_bank_sources",
"tariffName": "Мой тариф"
}
Параметры Сберрейтинга
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
enableBroadcast | boolean | true | none | Признак согласия на трансляцию данных по себе в рамках услуги |
enableService | boolean | true | none | Признак подключения услуги |
inn | string | true | none | ИНН |
kpp | string | false | none | КПП |
rating | string | true | none | Значение рейтинга по услуге Внутренние источники для определения цвета "светофора" |
serviceType | string | true | none | Наименование услуги в рамках продукта СберРейтинг |
tariffName | string | false | none | Название тарифа |
CryptoInfo
{
"certBank": "string",
"certBankUuid": "string",
"certCenterCode": "А000",
"certCenterNum": "02",
"certsCA": [
"string"
],
"cryptoProfileInfos": [
{
"alias": "Profile alias",
"certificateInfos": [
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"typeName": "Инфокрипт"
}
]
}
Информация о КУЦ и криптопрофилях
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
certBank | string | false | none | Сертификат технологического криптопрофиля банка |
certBankUuid | string | false | none | Уникальный идентификатор сертификата технологического криптопрофиля Банка |
certCenterCode | string | false | none | Код удостоверяющего центра |
certCenterNum | string | false | none | Текущий порядковый номер для генерации запроса на сертификат |
certsCA | [string] | false | none | Сертификаты удостоверяющих центров |
cryptoProfileInfos | [CryptoProfileInfo] | false | none | Идентификаторы криптопрофилей |
CashUnholdTransferRequestState
{
"actualHoldAmount": 1.01,
"bankComment": "string",
"bankStatus": "string"
}
Статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualHoldAmount | number | false | none | Cумма блокированных денежных средств (рассчитывается с учетом разблокированных денежных средств в рамках блокировки) |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
SetClosingDocumentsFlagToPaymentRequest
{
"id": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Модель параметров запроса на установку признака "Наличие закрывающих документов" у платёжного поручения
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | string | true | none | Идентификатор рублевой операции (UUID) |
EncashmentServicesInfo
{
"serviceName": "ENCASH",
"serviceType": 0
}
Информация об услугах по договору инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
serviceName | string | false | none | Наименование услуги |
serviceType | integer(int32) | false | none | Тип услуги |
SWIFTTransfer
{
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
}
Данные перевода SWIFT MT103
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankOperationCode | string | false | none | Код банковской операции (формат MT103) |
beneficiaryBankAccount | string | false | none | Номер счета банка бенефициара. 1-я часть значения поля 57 в формате MT103 |
beneficiaryBankName | string | false | none | Код BIC, расположение или название и адрес банка бенефициара. Содержимое поля 57 (за исключением номера счета, с разделителями) в формате MT103 |
beneficiaryBankOption | string | false | none | Признак вида поля банка бенефициара (поле 57 в формате MT103). Возможные значения: A, B, С, D |
beneficiaryCustomerAccount | string | false | none | Номер счета бенефициара. 1-я часть значения поля 59 в формате MT103 |
beneficiaryCustomerName | string | false | none | Код BIC/BEI или название и адрес бенефициара. Содержимое поля 59 (за исключением номера счета, с разделителями) в формате MT103 |
detailsOfCharges | string | false | none | Сведения о расходах (формат MT103) |
exchangeRate | string | false | none | Курс конвертации (формат MT103) |
instructedAmount | string | false | none | Валюта/сумма по инструкции (формат MT103) |
instructionCode | string | false | none | Код инструкции (формат MT103) |
intermediaryBankAccount | string | false | none | Номер счета банка-посредника. 1-я часть значения поля 56 в формате MT103 |
intermediaryBankName | string | false | none | Код BIC или название банка-посредника. Содержимое поля 56 (за исключением номера счета, с разделителями) в формате MT103 |
intermediaryBankOption | string | false | none | Признак вида поля банка-посредника (поле 56 в формате MT103). Возможные значения: A, С, D |
messageDestinator | string | false | none | Получатель сообщения SWIFT (формат MT103) |
messageIdentifier | string | false | none | Уникальный системный номер сообщения SWIFT (формат MT103) |
messageOriginator | string | false | none | Отправитель сообщения SWIFT (формат MT103) |
messageReceiveTime | string | false | none | Дата и время получения сообщения SWIFT (формат MT103) |
messageSendTime | string | false | none | Дата и время отправки сообщения SWIFT (формат MT103) |
messageType | string | false | none | Тип сообщения SWIFT |
orderingCustomerAccount | string | false | none | Номер счета плательщика в формате IBAN или BBAN (для внутренних платежей). 1-я часть значения поля 50 в формате MT103 |
orderingCustomerName | string | false | none | Код BIC/BEI или название и адрес плательщика. Содержимое поля 50 (за исключением номера счета, с разделителями) в формате MT103 |
orderingCustomerOption | string | false | none | Признак вида поля плательщика (поле 50 в формате MT103). Возможные значения: A, F, K |
orderingInstitutionAccount | string | false | none | Номер счета банка плательщика. 1-я часть значения поля 52 в формате MT103 |
orderingInstitutionName | string | false | none | Код BIC или название и адрес банка плательщика. Содержимое поля 52 (за исключением номера счета, с разделителями) в формате MT103 |
orderingInstitutionOption | string | false | none | Признак вида поля банка плательщика (поле 52 в формате MT-103). Возможные значения: A, D |
receiverCharges | string | false | none | Расходы получателя (формат MT103) |
receiverCorrespondentAccount | string | false | none | Номер счета корреспондента получателя. 1-я часть значения поля 54 в формате MT103 |
receiverCorrespondentName | string | false | none | Код BIC, расположение или название и адрес корреспондента получателя. Содержимое поля 54 (за исключением номера счета, с разделителями) в формате MT103 |
receiverCorrespondentOption | string | false | none | Признак вида поля корреспондента получателя (поле 54 в формате MT103). Возможные значения: A, B, D |
regulatoryReporting | string | false | none | Контрольная отчетность (формат MT103) |
remittanceInformation | string | false | none | Сведения о переводе (формат MT103) |
senderCharges | string | false | none | Расходы отправителя (формат MT103) |
senderCorrespondentAccount | string | false | none | Номер счета корреспондента отправителя. 1-я часть значения поля 53 в формате MT103 |
senderCorrespondentName | string | false | none | Код BIC, расположение или название и адрес корреспондента отправителя. Содержимое поля 53 (за исключением номера счета, с разделителями) в формате MT103 |
senderCorrespondentOption | string | false | none | Признак вида поля корреспондента отправителя (поле 53 в формате MT103). Возможные значения: A, B, D |
senderToReceiverInformation | string | false | none | Информация отправителя получателю (формат MT103) |
transactionReferenceNumber | string | false | none | Референс операции (формат MT103) |
transactionRelatedReference | string | false | none | Связанный референс (формат MT103) |
transactionTypeCode | string | false | none | Код типа операции (формат MT103) |
urgent | string | false | none | Признак срочности операции (формат MT103). Возможные значения: URGENT, NORMAL |
valueDateCurrencyInterbankSettledAmount | string | false | none | Дата валютирования, код валюты, сумма межбанковского расчета (формат MT103) |
ClearingCode
{
"clearingCode": "BLAAAOLU",
"countryCode": "DE",
"shortName": "German Bankleitzahl (BLZ)",
"symbol": "BL"
}
Клиринговый код
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clearingCode | string | false | none | Клиринговый код |
countryCode | string | false | none | 2-х символьный код страны |
shortName | string | false | none | Сокращенное наименование национального клирингового кода |
symbol | string | false | none | Обозначение национального клирингового кода |
CurrCredContractChangeApplication
{
"actualDebtAmount": 1.01,
"amount": 1.01,
"bankComment": "string",
"bankControlStatementChangeApplicationInfo": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"basisDocs": [
{
"date": "2018-12-31",
"number": "2222222222"
}
],
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"contentInfo": "Текстовая информация об изменениях",
"contractExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inUSRLE": false,
"prolongation": false
},
"bankStatus": "string",
"collateralAmount": 1.01,
"contractDate": "2018-12-31",
"contractEndDate": "2018-12-31",
"contractNumber": "123АБВ",
"credRepayPayments": [
{
"condition": "АБВ123",
"currencyCode": "840",
"interestAmount": 1.01,
"interestDate": "2018-12-31",
"principalAmount": 1.01,
"principalDate": "2018-12-31"
}
],
"creditAttractions": [
{
"amount": 1.01,
"interestCredit": 1.01,
"nonResidentCountryCode": "643",
"nonResidentName": "Kazan"
}
],
"creditPayPeriodCode": "1",
"currFixInterestRate": 1.01,
"currencyCode": "840",
"currencyEarningsAmount": 1.01,
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"hasDirectInvesting": false,
"increaseRate": 1.01,
"liborRate": "Л06",
"nonResidents": [
{
"countryCode": "643",
"countryName": "РОССИЯ",
"name": "Kazan"
}
],
"number": "1",
"otherPayments": "АБВ123",
"otherRateMethod": "АБВ123",
"tranches": [
{
"amount": 1.01,
"currencyCode": "840",
"entryDate": "2018-12-31",
"periodCode": "1"
}
],
"transferAmount": 1.01
}
Заявление о внесении изменений в I раздел ВБК (валютный кредитный договор)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualDebtAmount | number | false | none | Сумма фактической задолженности по основному долгу |
amount | number | false | none | Сумма контракта |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementChangeApplicationInfo | BankControlStatementChangeApplicationInfo | true | none | Информация о заявлении о внесении изменений в I раздел ВБК |
bankStatus | string | false | read-only | Статус документа |
collateralAmount | number | false | none | Сумма залогового или другого обеспечения |
contractDate | string(date-time) | true | none | Дата контракта |
contractEndDate | string(date-time) | false | none | Дата окончания обязательств по контракту |
contractNumber | string | false | none | Номер контракта |
credRepayPayments | [CredRepayPaymentChangeable] | false | none | График платежей по кредитному договору |
creditAttractions | [CreditAttractionChangeable] | false | none | Привлечение кредита на синдицированной (консорциональной) основе |
creditPayPeriodCode | string | false | none | Код срока привлечения (предоставления) |
currFixInterestRate | number | false | none | Фиксированный размер процентной ставки |
currencyCode | string | false | none | Цифровой код валюты контракта |
currencyEarningsAmount | number | false | none | Сумма, подлежащая погашению за счёт валютной выручки |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
hasDirectInvesting | boolean | false | none | Признак наличия отношений прямого инвестирования |
increaseRate | number | false | none | Размер процентной надбавки |
liborRate | string | false | none | Код ставки Libor |
nonResidents | [BankControlStatementNonResident] | false | none | Информация о нерезидентах |
number | string | false | none | Номер документа |
otherPayments | string | false | none | Иные платежи, предусмотренные кредитным договором |
otherRateMethod | string | false | none | Описание метода определения ставки |
tranches | [CurrCredTrancheChangeable] | false | none | Информация о траншах по кредиту |
transferAmount | number | false | none | Сумма, подлежащая зачислению на счета за рубежом |
PayrollPayDoc
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
Прикреплённое платежное поручение для зарплатной ведомости
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | AmountCurrency | true | none | Сумма и валюта |
docDate | string(date-time) | true | none | Дата расчетного документа |
number | string | true | none | Номер расчетного документа |
payeeAccount | string | true | none | Номер счета получателя |
payeeBic | string | true | none | БИК банка получателя |
payerAccount | string | true | none | Номер счета плательщика |
payerBic | string | true | none | БИК банка плательщика |
purpose | string | true | none | Назначение платежного документа |
BankControlStatementInfoSend
{
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
]
}
Досыл валютного контракта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankCommentAuthor | string | false | read-only | Автор комментария |
bfAttachments | [BfAttachment] | false | none | Прикреплённые большие файлы |
chainId | string | true | none | Id цепочки |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
failReasons | [FailReason] | false | read-only | Причины отказа |
EncashmentContract
{
"createDate": "2018-12-31",
"endDate": "2018-12-31",
"feeChargeTypes": "FACT_SCHET_GRP,IPT_SEND",
"number": "38/943/04",
"objects": [
{
"address": "г.Москва, ул.Тамбовская, д.5",
"encashContractAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"encashDebitAccounts": [
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
],
"name": "АО \"Тандер\" Многоцветница 773460",
"objectStatus": "ARHIV"
}
],
"servicesInfo": [
{
"serviceName": "ENCASH",
"serviceType": 0
}
],
"startDate": "2018-12-31"
}
Договор инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
createDate | string(date-time) | false | none | Дата заключения договора |
endDate | string(date-time) | false | none | Дата окончания действия договора |
feeChargeTypes | string | false | none | Способ взимания комиссии |
number | string | false | none | Номер договора |
objects | [EncashmentContractObject] | false | none | Объекты инкассации |
servicesInfo | [EncashmentServicesInfo] | false | none | Информация об услугах по договору инкассации |
startDate | string(date-time) | false | none | Дата начала действия договора |
CashHoldRequestState
{
"actualHoldAmount": 1.01,
"bankComment": "string",
"bankStatus": "string"
}
Статус документа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualHoldAmount | number | false | none | Cумма блокированных денежных средств (рассчитывается с учетом разблокированных денежных средств в рамках блокировки) |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | none | Статус документа |
ClientAddedUserServiceInfo
{
"clientId": 0,
"refreshToken": "string"
}
Подключенный в ВСП платный сервис
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clientId | integer(int64) | false | none | Идентификатор сервиса |
refreshToken | string | false | none | Токен обновления |
CurrencyNotices
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"notices": [
{
"bankName": "ПАО СБЕРБАНК",
"bic": "044525225",
"branchName": "ДО №1654 Московского банка ПАО Сбербанк",
"currencyName": "USD",
"date": "2018-12-31",
"dateReceipt": "2018-12-31",
"docSum": 1.01,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "21053520",
"transferDate": "2018-12-31",
"transitAccountNumber": "40802840600000200000"
}
]
}
Ссылки на "Уведомления о поступлении денежных средств на транзитный валютный счёт"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
notices | [CurrencyNotice] | false | none | Уведомления о поступлении денежных средств на транзитный валютный счёт |
Contract
{
"bankName": "ПАО СБЕРБАНК",
"contractDate": "2018-12-31",
"contractNumber": "8981272"
}
Контракт. Информация о действующих контрактах организации или контрактах, заявляющихся на страхование
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankName | string | false | none | Наименование банка |
contractDate | string(date-time) | false | none | Дата контракта |
contractNumber | string | true | none | Номер контракта |
TariffPlanActivationRequest
{
"bankStatus": "ACTIVE",
"enableTariff": true,
"tariffSystemName": "SECURE_BUSINESS_BASIC"
}
Запрос на подключение/отключение тарифного плана организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankStatus | string | false | none | Статус обработки |
enableTariff | boolean | true | none | Признак включения тарифного плана (true - включение тарифа, false - выключение тарифа) |
tariffSystemName | string | true | none | Системное наименование подключаемого/отключаемого тарифного плана |
FileUploadRequest
{
"digestSignature": {
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
},
"subType": "DebtRegistry",
"type": "DOC"
}
Модель параметров запроса на создание задачи на выгрузку файла
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
digestSignature | Signature | false | none | Электронная подпись |
subType | string | true | none | Тип передаваемого документа/справочника |
type | string | true | none | Тип задачи |
CashUnholdTransferRequest
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"cashHoldExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"purpose": "Оплата заказа №123. НДС нет."
}
Запрос на разблокировку и перевод денежных средств со счета клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма перевода |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
cashHoldExternalId | string | true | none | Идентификатор связанного запроса на блокировку, присвоенный партнёром (UUID) |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
purpose | string | true | none | Назначение платежа |
DebtRegistry
{
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "ООО \"Клиент\"",
"orgTaxNumber": "7707083893",
"recordNum": "100"
}
Реестр начислений
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Данные о файлах, связанных с реестром начислений |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
number | string | false | none | Номер документа |
orgName | string | true | none | Наименование организации клиента (сокращенное) |
orgTaxNumber | string | true | none | ИНН организации клиента |
recordNum | string | false | none | Количество записей |
PeriodicPayment
{
"amount": 1.01,
"amountMode": "AMOUNT",
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"minimumBalance": 1.01,
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"periodicity": {
"daysOfMonth": "5,10,25,28",
"daysOfWeek": "MON,TUE,WED,THU,FRI,SAT,SUN",
"mode": "DAILY",
"offset": "BACKWARD",
"time": "14:00"
},
"purpose": "Регулярное перечисление денежных средств",
"startDate": "2018-12-31",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Длительное платёжное поручение (ДПП)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма платежа для поручений с режимом AMOUNT |
amountMode | string | true | none | Режим определения суммы платежа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
minimumBalance | number | false | none | Неснижаемый остаток для поручений с режимом REMAINDER |
number | string | false | none | Номер документа |
payeeAccount | string | false | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК получателя платежа |
payeeInn | string | false | none | ИНН получателя платежа |
payeeKpp | string | false | none | КПП получателя платежа |
payeeName | string | true | none | Полное наименование получателя платежа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerName | string | true | none | Полное наименование плательщика |
periodicity | Periodicity | true | none | Определение периодичности исполнения |
purpose | string | true | none | Назначение платежа |
startDate | string(date-time) | false | none | Дата начала действия |
vat | Vat | false | none | Данные НДС |
Enumerated Values
Property | Value |
---|---|
amountMode | AMOUNT |
amountMode | REMAINDER |
AdvanceAcceptanceBundle
{
"code": "MIN+1M",
"sinceDate": "2018-12-31",
"untilDate": "2018-12-31"
}
Пакет услуг
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | Код пакета услуг |
sinceDate | string(date-time) | false | none | Дата подключения пакета услуг |
untilDate | string(date-time) | false | none | Дата отключения пакета услуг |
Payroll
{
"account": "40802810600000200000",
"admissionValue": "01",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "8(495)1234567",
"bankComment": "string",
"bankStatus": "string",
"bic": "044525225",
"commissionInfo": {
"actualRate": 1.01,
"actualSum": 1.01,
"estimatedRate": 1.01,
"estimatedSum": 1.01,
"invoiceDate": "2018-12-31"
},
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeSalaries": [
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"bankMessage": "string",
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"result": "string",
"withheldAmount": 1.01
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "1",
"loanAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"loanDate": "2018-12-31",
"loanNumber": "1234567890",
"month": "Январь",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893",
"payDocs": [
{
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"docDate": "2018-12-31",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBic": "044525225",
"payerAccount": "40802810600000200000",
"payerBic": "044525225",
"purpose": "Выплата заработной платы за январь. НДС не облагается."
}
],
"year": "2019"
}
Зарплатная ведомость
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | false | none | Номер счёта клиента |
admissionValue | string | false | none | Вид зачисления |
amount | AmountCurrency | true | none | Сумма и валюта |
authPersonName | string | false | none | ФИО уполномоченного сотрудника организации клиента |
authPersonTelfax | string | false | none | Номер телефона, факса уполномоченного сотрудника организации клиента |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
bic | string | true | none | БИК банка клиента |
commissionInfo | PayrollCommissionInfo | false | none | Тарифы и коммисия зарплатной ведомости |
contractDate | string(date-time) | true | none | Дата договора |
contractNumber | string | true | none | Номер договора |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
employeeSalaries | [PayrollEmpSalary] | false | none | Сотрудники, которым зачисляют зарплату |
employeesNumber | integer(int32) | true | none | Количество сотрудников |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
incomeTypeCode | string | false | none | Код вида дохода получателей выплаты по 229-ФЗ |
loanAmount | AmountCurrency | false | none | Сумма и валюта |
loanDate | string(date-time) | false | none | Дата кредитного договора |
loanNumber | string | false | none | Номер кредитного договора |
month | string | true | none | Месяц отчётного периода |
number | string | false | none | Номер документа |
orgName | string | true | none | Наименование организации клиента |
orgTaxNumber | string | true | none | ИНН организации клиента |
payDocs | [PayrollPayDoc] | false | none | Платежные документы перечисления зарплаты |
year | string | true | none | Год отчётного периода |
EncashAddRequestVisitInfo
{
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
Информация о заездах
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cashAmount | number | true | none | Сумма сдаваемой наличности за заезд |
cashCoins | number | true | none | Сумма монет в объеме сдаваемой наличности |
countInMonth | integer(int32) | true | none | Количество заездов в месяц |
isByRequest | boolean | true | none | Тип обслуживания |
schedule | [EncashAddRequestSchedule] | true | none | График заездов |
CurrCredContract
{
"actualDebtAmount": 1.01,
"actualDebtCurrencyCode": "840",
"actualDebtCurrencyName": "USD",
"amount": 1.01,
"bankComment": "string",
"bankControlStatementInfo": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"creationMode": "ICS_CONTRACT_INFORMATION",
"currencyName": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"isActual": false,
"unk": "string"
},
"bankStatus": "string",
"calcDate": "2018-12-31",
"collateralAmount": 1.01,
"contractDate": "2018-12-31",
"contractEndDate": "2018-12-31",
"contractNumber": "123АБВ",
"credRepayPayments": [
{
"condition": "АБВ123",
"currencyCode": "840",
"currencyName": "USD",
"interestAmount": 1.01,
"interestDate": "2018-12-31",
"principalAmount": 1.01,
"principalDate": "2018-12-31"
}
],
"creditAttractions": [
{
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD",
"hasPercentType": false,
"interestCredit": 1.01,
"nonResidentCountryCode": "643",
"nonResidentCountryName": "РОССИЯ",
"nonResidentName": "Kazan"
}
],
"creditPayPeriodCode": "1",
"currFixInterestRate": 1.01,
"currencyCode": "840",
"currencyEarningsAmount": 1.01,
"date": "2018-12-31",
"decAmount": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"enrollAmount": 1.01,
"finalDebtAmount": 1.01,
"finalDebtСurrencyCode": "643",
"finalDebtСurrencyName": "USD",
"hasDirectInvesting": false,
"hasSchedulePaymentsInCredit": false,
"incAmount": 1.01,
"increaseRate": 1.01,
"interestRateMethod": "1",
"liborRate": "Л06",
"loanAmount": 1.01,
"nonResidents": [
{
"countryCode": "643",
"countryName": "РОССИЯ",
"name": "Kazan"
}
],
"number": "1",
"otherPayments": "АБВ123",
"otherRateMethod": "АБВ123",
"tranches": [
{
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD",
"entryDate": "2018-12-31",
"periodCode": "1"
}
],
"transferAmount": 1.01
}
Валютный кредитный договор
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualDebtAmount | number | false | none | Сумма фактической задолженности по основному долгу |
actualDebtCurrencyCode | string | false | none | Цифровой код валюты фактической задолженности по основному долгу |
actualDebtCurrencyName | string | false | none | Буквенный ISO-код валюты фактической задолженности по основному долгу |
amount | number | false | none | Сумма контракта |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementInfo | BankControlStatementInfo | true | none | Информация о ведомости банковского контроля |
bankStatus | string | false | read-only | Статус документа |
calcDate | string(date-time) | false | read-only | Дата расчёта |
collateralAmount | number | false | none | Сумма залогового или другого обеспечения |
contractDate | string(date-time) | true | none | Дата контракта |
contractEndDate | string(date-time) | false | none | Дата окончания обязательств по контракту |
contractNumber | string | false | none | Номер контракта |
credRepayPayments | [CredRepayPayment] | false | none | График платежей по кредитному договору |
creditAttractions | [CreditAttraction] | false | none | Привлечение кредита на синдицированной (консорциональной) основе |
creditPayPeriodCode | string | false | none | Код срока привлечения (предоставления) |
currFixInterestRate | number | false | none | Фиксированный размер процентной ставки |
currencyCode | string | false | none | Цифровой код валюты контракта |
currencyEarningsAmount | number | false | none | Сумма, подлежащая погашению за счёт валютной выручки |
date | string(date-time) | true | none | Дата составления документа |
decAmount | number | false | read-only | Сумма уменьшения задолженности по основному долгу по иным основаниям |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
enrollAmount | number | false | read-only | Сумма денежных средств, переведённых (зачисленных) в счёт погашения основного долга |
finalDebtAmount | number | false | read-only | Задолженность по основному долгу на дату расчёта (на дату снятия с учета кредитного договора) |
finalDebtСurrencyCode | string | false | read-only | Цифровой код страны |
finalDebtСurrencyName | string | false | read-only | Буквенный ISO-код валюты |
hasDirectInvesting | boolean | false | none | Признак наличия отношений прямого инвестирования |
hasSchedulePaymentsInCredit | boolean | false | none | Основания для заполнения графика платежей (п. 8.2 181-И) |
incAmount | number | false | read-only | Сумма увеличения задолженности по основному долгу по иным основаниям |
increaseRate | number | false | none | Размер процентной надбавки |
interestRateMethod | string | false | none | Метод определения процентной ставки |
liborRate | string | false | none | Код ставки Libor |
loanAmount | number | false | read-only | Сумма денежных средств, полученных (предоставленных) по кредиту (займу) |
nonResidents | [BankControlStatementNonResident] | false | none | Информация о нерезидентах |
number | string | false | none | Номер документа |
otherPayments | string | false | none | Иные платежи, предусмотренные кредитным договором |
otherRateMethod | string | false | none | Описание метода определения ставки |
tranches | [CurrCredTranche] | false | none | Информация о траншах по кредиту |
transferAmount | number | false | none | Сумма, подлежащая зачислению на счета за рубежом |
EncashmentOfferServiceContract
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-П",
"serviceType": 3,
"tariffs": [
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
],
"visitInfo": {
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
}
Подключаемая услуга
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
encashContractDate | string(date-time) | false | none | Дата создания договора инкассации |
encashContractNum | string | false | none | Номер договора инкассации |
serviceType | integer(int64) | false | none | Тип услуги |
tariffs | [EncashmentOfferServiceTariff] | false | none | Тарифы/платы по услуге |
visitInfo | EncashmentOfferServiceVisitInfo | false | none | Информация о заездах |
InvoiceAny
{
"amount": 1.01,
"date": "2018-12-31",
"deliveryKind": "электронно",
"expirationDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"operationCode": "01",
"orderNumber": "123",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"paymentNumber": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Счёт на оплату по свободным реквизитам
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма платежа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
expirationDate | string(date-time) | false | none | Дата истечения заказа (платёж должен быть подтверждён клиентом) |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
linkedDocs | [LinkedDoc] | false | none | Связанные документы |
operationCode | string | false | none | Код операции |
orderNumber | string | false | none | Номер заказа |
payeeAccount | string | true | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК банка получателя платежа |
payeeBankCorrAccount | string | false | none | Кор. счёт банка получателя платежа |
payeeInn | string | true | none | ИНН получателя платежа |
payeeKpp | string | false | none | КПП получателя платежа |
payeeName | string | true | none | Наименование получателя платежа |
paymentNumber | string | false | none | Номер платёжного документа |
priority | string | false | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
urgencyCode | string | false | none | Код срочности |
vat | Vat | false | none | Данные НДС |
Enumerated Values
Property | Value |
---|---|
urgencyCode | INTERNAL |
urgencyCode | INTERNAL_NOTIF |
urgencyCode | OFFHOURS |
urgencyCode | BESP |
urgencyCode | NORMAL |
FileUploadState
{
"bankComment": "string",
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"status": "ATTACHING",
"url": "https://bf.sberbank.ru:9443/sbns-app/upload/020b7237-f874-42ce-89bb-02d39d400bcd"
}
Модель статуса выгрузки файла
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | none | Банковский комментарий к статусу выгрузки файла |
fileId | string | false | none | Идентификатор файла |
status | string | false | none | Статус выгрузки файла |
url | string | false | none | Ссылка для выгрузки файла |
Enumerated Values
Property | Value |
---|---|
status | ATTACHING |
status | ATTACH_FINISHED |
status | UPLOADING |
status | UPLOADED |
status | UPLOAD_ERROR |
status | ANTIVIRUS_ERROR |
status | FILE_TYPE_ERROR |
status | FILE_EXTENSION_ERROR |
status | MAX_SIZE_ERROR |
status | SIGN_ERROR |
status | SIGNING |
status | SIGNED |
status | PARTIALLY_UPLOADED |
status | UNKNOWN_STATUS |
DboContract
{
"date": "2018-12-31",
"financeBlock": true,
"number": "14/2/000001"
}
Договор обслуживания организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
date | string | false | none | Дата заключения договора ДБО |
financeBlock | boolean | false | none | Признак финансовой блокировки |
number | string | false | none | Номер заключенного договора ДБО |
ServicePackage
{
"additionalComments": "Текст комменатрия",
"averageBill": 1.01,
"averageSalary": 1.01,
"cashRegister": "ПАВ465",
"codeWord": "Слово",
"deliveryLocation": "Москва, ул. Ленина дом 16",
"digitalReporting": "Да/нет + доп.комменатрий",
"employeesNumber": 25,
"free": true,
"is2FR": true,
"mainLocation": "Казань",
"onlineStore": "Да/нет + доп.комменатрий",
"packageCount": 12,
"packageName": "Пакет 1",
"pointType": "Самообслуживание",
"pointsNumber": 3,
"productNumber": "123а34",
"receiveType": "Курьер",
"taxationSystem": "УСН"
}
Данные организации о подключенном пакете услуг внешнего сервиса
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
additionalComments | string | false | none | Дополнительные комментарии |
averageBill | number | false | none | Средний чек |
averageSalary | number | false | none | Среднемесячная заработная плата |
cashRegister | string | false | none | Название кассового ПО |
codeWord | string | false | none | Кодовое слово |
deliveryLocation | string | false | none | Место получения доставки |
digitalReporting | string | false | none | Электронная сдачи отчетности |
employeesNumber | integer(int64) | false | none | Штат сотрудников организации |
free | boolean | false | none | none |
is2FR | boolean | false | none | Наличие режима 2-ФР |
mainLocation | string | false | none | Местонахождение основного вида деятельности |
onlineStore | string | false | none | Наличие интернет-магазина |
packageCount | integer(int64) | false | none | Количество подключений |
packageName | string | false | none | Название подключенного пакета услуг |
pointType | string | false | none | Формат заведения |
pointsNumber | integer(int64) | false | none | Количество точек организации |
productNumber | string | false | none | Номер выдаваемой ценности (ICC SIM, карта, полис и т.п.) |
receiveType | string | false | none | Способ получения |
taxationSystem | string | false | none | Система налогообложения |
AccountInfo
{
"absId": "string",
"amount": 1.01,
"amountDate": "2018-12-31T23:59:59",
"amountRub": 1.01,
"bic": "044525225",
"blockedQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSumQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSums": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"business": false,
"businessNewType": false,
"cdiAcptDocQnt": 0,
"cdiAcptDocSum": 1.01,
"cdiCart2DocQnt": 0,
"cdiCart2DocSum": 1.01,
"cdiPermDocQnt": 0,
"cdiPermDocSum": 1.01,
"closeDate": "2018-12-31",
"comment": "string",
"credCard": false,
"creditBlocked": false,
"creditBlockedBeginDate": "2018-12-31",
"creditBlockedCause": "string",
"creditBlockedEndDate": "2018-12-31",
"creditBlockedInitiator": "string",
"creditBlockedTaxAuthorityCode": "string",
"currencyCode": "810",
"dbo": false,
"debitBlocked": false,
"debitBlockedBeginDate": "2018-12-31",
"debitBlockedCause": "string",
"debitBlockedEndDate": "2018-12-31",
"debitBlockedInitiator": "string",
"debitBlockedTaxAuthorityCode": "string",
"eksId": "string",
"minBalance": 1.01,
"mode": "STANDART",
"name": "string",
"notDelay": false,
"number": "40802810600000200000",
"openDate": "2018-12-31",
"overdraft": 1.01,
"passive": false,
"state": "OPEN",
"type": "assuranceRegistration",
"urgent": false
}
Информация по счету клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
absId | string | false | none | Идентификатор счета |
amount | number | true | none | Доступный остаток на счете |
amountDate | string(date-time) | false | none | Дата и время актуальности остатка на счете |
amountRub | number | false | none | Доступный остаток в национальной валюте |
bic | string | true | none | БИК банка, где открыт счет |
blockedQueuesInfo | [AccountBlockInfo] | false | none | Приостановления операций по счету выше очередности (блокировки по очередности) |
blockedSumQueuesInfo | [AccountBlockInfo] | false | none | Приостановления операций по счету выше очередности на сумму |
blockedSums | [AccountBlockInfo] | false | none | Заблокированные (арестованные) суммы на счёте |
business | boolean | true | none | Признак бизнес-счёта |
businessNewType | boolean | true | none | Признак бизнес-счёта 'нового' типа |
cdiAcptDocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, ожидающих акцепта. Количество документов |
cdiAcptDocSum | number | false | none | Содержит информацию о расчетных документах, ожидающих акцепта. Сумма документов |
cdiCart2DocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, помещённых в картотеку к счету 90902 (картотека 2). Количество документов |
cdiCart2DocSum | number | false | none | Содержит информацию о расчетных документах, помещённых в картотеку к счету 90902 (картотека 2). Сумма документов |
cdiPermDocQnt | integer(int32) | false | none | Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Количество документов |
cdiPermDocSum | number | false | none | Содержит информацию о расчетных документах, ожидающих разрешения на проведение операции. Сумма документов |
closeDate | string(date-time) | false | none | Дата закрытия счёта |
comment | string | false | none | Примечание |
credCard | boolean | true | none | Признак кредитной карты |
creditBlocked | boolean | false | none | Признак полной блокировки счета по кредиту |
creditBlockedBeginDate | string(date-time) | false | none | Дата начала действия ограничения |
creditBlockedCause | string | false | none | Основание ареста |
creditBlockedEndDate | string(date-time) | false | none | Дата снятия ограничения |
creditBlockedInitiator | string | false | none | Наименование органа, наложившего арест |
creditBlockedTaxAuthorityCode | string | false | none | Код налогового органа, наложившего арест |
currencyCode | string | true | none | Цифровой код валюты счета |
dbo | boolean | true | none | Признак обслуживания в ДБО |
debitBlocked | boolean | false | none | Признак полной блокировки счета по дебету |
debitBlockedBeginDate | string(date-time) | false | none | Дата начала действия ограничения |
debitBlockedCause | string | false | none | Основание ареста |
debitBlockedEndDate | string(date-time) | false | none | Дата снятия ограничения |
debitBlockedInitiator | string | false | none | Наименование органа, наложившего арест |
debitBlockedTaxAuthorityCode | string | false | none | Код налогового органа, наложившего арест |
eksId | string | false | none | Идентификатор счета в ЕКС |
minBalance | number | false | none | Минимальный поддерживаемый (неснижаемый) остаток на счете |
mode | string | true | none | Режим работы счёта |
name | string | true | none | Наименование счета |
notDelay | boolean | true | none | Признак возможности проведения неотложных платежей |
number | string | true | none | Номер счета (20 сиволов) |
openDate | string(date-time) | true | none | Дата открытия счета |
overdraft | number | false | none | Сумма общего лимита овердрафта в валюте счёта |
passive | boolean | true | none | Признак пассивности счета |
state | string | true | none | Состояние счета |
type | string | true | none | Тип счёта |
urgent | boolean | true | none | Признак возможности проведения срочных платежей |
Enumerated Values
Property | Value |
---|---|
mode | STANDART |
mode | FORBIDDEN_RECEIVING |
mode | ONLY_RECEIVING |
state | OPEN |
state | BLOCKED |
state | CLOSED |
type | assuranceRegistration |
type | calculated |
type | transit |
type | specialTransit |
type | budget |
type | loan |
type | deposit |
CredRepayPaymentChangeable
{
"condition": "АБВ123",
"currencyCode": "840",
"interestAmount": 1.01,
"interestDate": "2018-12-31",
"principalAmount": 1.01,
"principalDate": "2018-12-31"
}
Платёж по кредитному договору - изменяемые поля
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
condition | string | false | none | Особые условия |
currencyCode | string | true | none | Цифровой код валюты платежа |
interestAmount | number | false | none | Сумма платежа по процентам |
interestDate | string(date-time) | false | none | Дата платежа (процентный) |
principalAmount | number | false | none | Сумма платежа по основному долгу |
principalDate | string(date-time) | false | none | Дата платежа (основной долг) |
CardIssueCardInfo
{
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
}
Зарплатная карта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bonusId | string | false | none | Идентификатор бонус программы |
bonusNum | string | false | none | Номер участника в бонусной программе |
cardCurrName | string | true | none | Цифровой код валюты счета |
cardTypeCode | string | true | none | Код типа карты |
cardTypeName | string | true | none | Тип карты |
embossedTextFirstName | string | true | none | Текст эмбоссированный Имя |
embossedTextSurname | string | true | none | Текст эмбоссированный Фамилия |
Amount
{
"amount": 1.01,
"currencyName": "USD"
}
Сумма
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма |
currencyName | string | false | none | Буквенный ISO-код валюты |
OrgLawForm
{
"name": "Индивидуальный предприниматель",
"shortName": "ИП"
}
Организационно-правовая форма организаций, для которых доступен кредитный продукт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
name | string | true | none | Полное наименование организационно-правовой формы |
shortName | string | true | none | Общепринятое сокращение организационно-правовой формы |
ExportContractInsure
{
"annualRevenue": 1.01,
"bankComment": "Текст комментария",
"bankStatus": "REFUSED",
"buyerAddress": "Baker Street, London",
"buyerCompanySite": "https://example.com",
"buyerCooperationExperienceType": 1,
"buyerCountEmployeesType": 1,
"buyerCountry": "Англия",
"buyerIsLegalEntityMore2Y": true,
"buyerMainActivity": "Производство мебели",
"buyerName": "Example LTD",
"buyerRegNumber": "12348765",
"contactEmail": "address@email.ru",
"contactFullname": "Иванов Иван Иванович",
"contactPhoneNumber": "7916*****88",
"contactPosition": "Менеджер",
"contractDestinationCountry": "Австралия",
"contractEnsuringName": "Обеспечение",
"contractEnsuringType": 2,
"contractExportSubject": "Мебельные изделия",
"contractIsEqualBuyerCountryPlace": true,
"contractIsRussianGoods": true,
"contractNotDefinedInkoterms": true,
"contractNotProvidedInInkoterms": true,
"contractPeriodFrom": "2018-12-31",
"contractPeriodTo": "2018-12-31",
"contracts": [
{
"bankName": "ПАО СБЕРБАНК",
"contractDate": "2018-12-31",
"contractNumber": "8981272"
}
],
"deferredPayL90D": true,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"docDate": "2018-12-31",
"exportTypes": [
{
"isExportRusGoodsNoReimport": true,
"isGrantIntellectualActivity": true,
"isImplRusOutServices": false,
"isImplRusOutServicesToResult": false
}
],
"exporterAccount": "40802840600000200000",
"exporterChDelayCountType": 3,
"exporterCompanySite": "https://example.com",
"exporterExecutiveBirthdate": "2018-12-31",
"exporterExecutiveBirthplace": "Сейшеллы 1003/2",
"exporterExecutiveFullname": "Иванов Иван Иванович",
"exporterExecutiveStartDate": "2018-12-31",
"exporterFullname": "ООО \"Организация\"",
"exporterHasExpExperienceType": 1,
"exporterInn": "7707083893",
"exporterIsBeneficarOwnerFp": true,
"exporterMainActivity": "Производство мебели",
"exporterMainActivityClient": "Деятельность в области связи на базе проводных технологий",
"exporterOgrn": "380123456789012",
"exporterRegDate": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"hasBuyerDebtToTheInsure": true,
"inkotermsConditions": [
{
"conditionId": "EXW"
}
],
"insuranceCost": 1.01,
"insuranceCoverage": 1.01,
"offerConsent": true,
"owners": [
{
"age": 40
}
]
}
Документ Заявления на страхование экспортного контракта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
annualRevenue | number | true | none | Годовая выручка |
bankComment | string | false | none | Банковский комментарий к статусу заявления на страхование |
bankStatus | string | true | none | Статус заявления на страхование |
buyerAddress | string | false | none | Покупатель. Адрес местонахождения |
buyerCompanySite | string | false | none | Покупатель. Сайт компании |
buyerCooperationExperienceType | integer(int32) | false | none | Покупатель. Наличие совместного опыта сотрудничества. 1 - Да, контракты действуют, 2 - Да, контракты исполнены, 3 - Нет. |
buyerCountEmployeesType | integer(int32) | false | none | Покупатель. Количество сотрудников в штате: 1 - Менее 10, 2 - От 10 (включительно) до 50, 3 - От 50 (включительно) |
buyerCountry | string | false | none | Покупатель. Страна регистрации |
buyerIsLegalEntityMore2Y | boolean | false | none | Покупатель. Является юридическим лицом, деятельность которого осуществляется более 2х лет с даты регистрации |
buyerMainActivity | string | false | none | Покупатель. Основной вид деятельности |
buyerName | string | false | none | Покупатель. Наименование |
buyerRegNumber | string | false | none | Покупатель. Регистрационный номер |
contactEmail | string | false | none | Экспортёр. Контактная информация. Электронная почта |
contactFullname | string | false | none | Экспортёр. Контактная информация. ФИО контактного лица |
contactPhoneNumber | string | false | none | Экспортёр. Контактная информация. Номер телефона |
contactPosition | string | false | none | Экспортёр. Контактная информация. Должность |
contractDestinationCountry | string | false | none | Страна назначения экспорта |
contractEnsuringName | string | false | none | Наименование обеспечения, если выбран тип Иное. |
contractEnsuringType | integer(int32) | false | none | Вид обеспечения (1 - Поручительство, 2 - Залог, 3 - Банковская гарантия, 4 - Аккредитив, 5 - Иное, 6 - Без обеспечения) |
contractExportSubject | string | false | none | Предмет экспорта |
contractIsEqualBuyerCountryPlace | boolean | false | none | Страна назначения экспорта совпадает со страной местонахождения покупателя |
contractIsRussianGoods | boolean | false | none | Предмет экспорта - российские товары (работы, услуги, в т.ч. результаты интеллектуальной деятельности) |
contractNotDefinedInkoterms | boolean | false | none | Сделка. Базисные условия поставки еще не определены |
contractNotProvidedInInkoterms | boolean | false | none | Сделка. Инкотермс не предусмотрен в экспортном контракте |
contractPeriodFrom | string(date-time) | false | none | Период отгрузок. Дата начала |
contractPeriodTo | string(date-time) | false | none | Период отгрузок. Дата окончания |
contracts | [Contract] | false | none | Контракты |
deferredPayL90D | boolean | false | none | Отсрочка платежа по указанным экспортным контрактам менее (либо равна) 90 календарных дней |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
docDate | string(date-time) | true | none | Дата документа |
exportTypes | [ExportType] | false | none | Виды экспорта |
exporterAccount | string | false | none | Экспортёр. Расчетный счет |
exporterChDelayCountType | integer(int32) | false | none | Экспортёр. Кредитная история. Просрочки. 1 - Не имеется, 2 - Менее 5 календарных дней, 3 - От 5 (включительно) до 10 календарных дней, 4 - От 11 календарных дней |
exporterCompanySite | string | false | none | Экспортёр. Сайт компании |
exporterExecutiveBirthdate | string(date-time) | false | none | Экспортёр. Дата рождения ЕИО |
exporterExecutiveBirthplace | string | false | none | Экспортёр. Место рождения ЕИО |
exporterExecutiveFullname | string | false | none | Экспортёр. ФИО ЕИО |
exporterExecutiveStartDate | string(date-time) | false | none | Экспортёр. Дата вступления в должность ЕИО |
exporterFullname | string | false | none | Экспортёр. Полное наименование |
exporterHasExpExperienceType | integer(int32) | false | none | Экспортёр. Наличие опыта экспорта у компании. 0 - Не имеется, 1 - Имеется |
exporterInn | string | false | none | Экспортёр. ИНН |
exporterIsBeneficarOwnerFp | boolean | false | none | Экспортёр. Бенефициарный владелец является ФЛ |
exporterMainActivity | string | false | none | Экспортёр. Основной вид деятельности |
exporterMainActivityClient | string | false | none | Экспортёр. Основной вид деятельности, заполненный клиентом |
exporterOgrn | string | false | none | Экспортёр. ОГРН |
exporterRegDate | string(date-time) | false | none | Экспортёр. Дата регистрации юридического лица |
externalId | string | true | none | Идентификатор документа, присвоенный партнером |
hasBuyerDebtToTheInsure | boolean | false | none | На дату заявления на страхование у покупателя отсутствует задолженность перед страхователем |
inkotermsConditions | [InkotermsCondition] | false | none | Условия Инкотермс |
insuranceCost | number | true | none | Страховая стоимость |
insuranceCoverage | number | true | none | Сумма страхового покрытия |
offerConsent | boolean | false | none | Согласие с условиями оферты |
owners | [Owner] | false | none | Бенефициарные владельцы |
Enumerated Values
Property | Value |
---|---|
buyerCooperationExperienceType | 1 |
buyerCooperationExperienceType | 2 |
buyerCooperationExperienceType | 3 |
buyerCountEmployeesType | 1 |
buyerCountEmployeesType | 2 |
buyerCountEmployeesType | 3 |
contractEnsuringType | 1 |
contractEnsuringType | 2 |
contractEnsuringType | 3 |
contractEnsuringType | 4 |
contractEnsuringType | 5 |
contractEnsuringType | 6 |
exporterChDelayCountType | 1 |
exporterChDelayCountType | 2 |
exporterChDelayCountType | 3 |
exporterChDelayCountType | 4 |
exporterHasExpExperienceType | 0 |
exporterHasExpExperienceType | 1 |
StatementTransactions
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"transactions": [
{
"amount": {
"amount": 1.01,
"currencyName": "USD"
},
"amountRub": {
"amount": 1.01,
"currencyName": "USD"
},
"correspondingAccount": "30101810400000000225",
"curTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"direction": "CREDIT",
"documentDate": "2018-12-31",
"filial": "ОСБ 3",
"number": "4",
"operationCode": "01",
"operationDate": "2018-12-31T23:59:59",
"paymentPurpose": "Оплата заказа №123. НДС нет.",
"priority": "5",
"revaln": "ПК",
"rurTransfer": {
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
},
"swiftTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"transactionId": 11111,
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
]
}
Операции по выписке
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
transactions | [StatementTransaction] | false | none | Данные по операциям выписки |
UserOffers
{
"accountList": [
"string"
],
"sinceDate": "2018-12-31",
"status": "PUBLIC",
"sub": "026f8e459c8f89ef75fa7a78265a0025",
"untilDate": "2018-12-31",
"userName": "Name"
}
Информация по офертам клиентов организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountList | [string] | false | none | Список счетов |
sinceDate | string(date-time) | false | none | Дата начала действия оферты |
status | string | false | none | Статус оферты |
sub | string | false | none | Хэш идентификатора пользователя |
untilDate | string(date-time) | false | none | Дата завершения действия оферты |
userName | string | false | none | Наименование пользователя |
CashHoldRequest
{
"account": "40802810600000200000",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"clientId": 1005,
"datetimeUnhold": "2018-12-31T23:59:59",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"hashOrgId": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"reasonId": "Бронирование QWRTN"
}
Запрос на блокировку денежных средств на расчетном счете
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | true | none | Счет агента, на котором будет осуществляться блокировка |
amount | number | true | none | Сумма начисления без НДС |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
clientId | integer(int32) | true | none | Идентификатор сервиса, используемый для взаимодействия с агентом |
datetimeUnhold | string(date-time) | true | none | Дата и время автоматической разблокировки денежных средств (yyyy-MM-dd'T'HH:mm:ss) |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
hashOrgId | string | true | none | Хэш идентификатора организации агента |
reasonId | string | false | none | Идентификатор блокировки (используется при формировании основания блокировки денежных средств) |
TaskForDownload
{
"filename": "СББОЛ. Выписка за 2020.05.08 счёт 40802810600000200000.zip",
"id": 1,
"state": "CREATED",
"url": "https://bf.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb-02d39d400bcd"
}
Задание на загрузку файла
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
filename | string | false | none | Имя файла |
id | integer(int64) | false | none | Идентификатор |
state | string | false | none | Состояние |
url | string | false | none | Ссылка для загрузки файла |
Enumerated Values
Property | Value |
---|---|
state | CREATED |
state | PROCESSING |
state | ERROR |
state | EXECUTED |
state | EXPIRED |
CreditAttractionChangeable
{
"amount": 1.01,
"interestCredit": 1.01,
"nonResidentCountryCode": "643",
"nonResidentName": "Kazan"
}
Привлечение кредита на синдицированной (консорциональной) основе - изменяемые поля
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма привлечения резидентом кредита, предоставленного нерезидентами |
interestCredit | number | false | none | Доля в общей сумме кредита, % |
nonResidentCountryCode | string | false | none | Цифровой код страны нерезидента |
nonResidentName | string | false | none | Наименование нерезидента |
PaymentImplementedInfos
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"payments": [
{
"amount": 1.01,
"createDate": "2018-12-31T23:59:59",
"lastModifyDate": "2018-12-31T23:59:59",
"number": "1",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"purpose": "Оплата заказа №123. НДС нет.",
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
]
}
Список информаций об исполненных рублевых платежных поручениях клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
payments | [PaymentImplementedInfo] | false | none | Список информаций об исполненных рублевых платежных поручениях клиента |
FintechCurrContractsUUID
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"externalId": [
"string"
]
}
Ссылки "ВБК"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
externalId | [string] | false | none | ВБК |
CardIssueIdentityDoc
{
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
}
Документ удостоверяющий личность
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
issueDate | string(date-time) | true | none | Дата выдачи |
issuer | string | true | none | Кем выдан |
issuerCode | string | true | none | Код органа, выдавшего документ |
number | string | true | none | Номер |
serial | string | true | none | Серия |
type | string | true | none | Наименование ДУЛ |
typeCode | string | true | none | Код вида документа |
Notice
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Информационное сообщение об ошибке, сбое или предупреждение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
cause | string | false | none | Причина или основание сообщения |
referenceId | string | false | none | Уникальный идентификатор (UUID) |
message | string | false | none | Сообщение |
Correspondents
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"correspondents": [
{
"accountNumber": "40802810600000200000",
"bankBic": "044525225",
"bankCorrAcct": "30101810400000000225",
"bankName": "ПАО СБЕРБАНК",
"inn": "7707083893",
"kpp": "222201001",
"name": "Общество с ограниченной ответственностью \"Клиент\"",
"remark": "Комментарий",
"signed": false
}
]
}
Контрагенты по рублёвым операциям
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
correspondents | [Correspondent] | false | none | Список "Контрагенты по рублёвым операциям" |
EncashmentOfferObject
{
"examResult": "Enrolled",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectName": "АО \"Киберлинк\" технологии 555100",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-П",
"serviceType": 3,
"tariffs": [
{
"isNds": false,
"tariffKind": "RevisitExchange",
"tariffMax": 1.01,
"tariffMin": 1.01,
"tariffRate": 1.01,
"tariffSum": 1.01
}
],
"visitInfo": {
"cashAmount": 2323220,
"cashCoins": 2323,
"countInMonth": 30,
"isByRequest": false,
"schedule": [
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
]
}
}
]
}
Объект инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
examResult | string | false | none | Результат обследования объекта |
objectAddress | string | false | none | Адрес объекта |
objectName | string | false | none | Наименование объекта |
services | [EncashmentOfferServiceContract] | false | none | Подключаемые услуги |
BankControlStatementChangeBasisDoc
{
"date": "2018-12-31",
"number": "2222222222"
}
Документ-основание для изменения контракта
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
date | string(date-time) | true | none | Дата документа-основания |
number | string | false | none | Номер документа-основания |
EncashmentOfferServiceVisitSchedule
{
"day": "Mon",
"timeFrom": "10:00",
"timeTo": "19:00"
}
График заездов
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
day | string | false | none | День заезда |
timeFrom | string | false | none | Время заезда с |
timeTo | string | false | none | Время заезда по |
SalaryAgreementPeriodInfo
{
"commissionAmount": 1.01,
"endDate": "2018-12-31",
"payAmount": 1.01,
"startDate": "2018-12-31"
}
Информация за расчетный период
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
commissionAmount | number | true | none | Сумма начисленной комиссии за расчетный период |
endDate | string(date-time) | true | none | Дата окончания расчетного периода |
payAmount | number | true | none | Сумма выплат за расчетный период |
startDate | string(date-time) | true | none | Дата начала расчетного периода |
FileDownloadState
{
"bankComment": "string",
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"status": "PREPARING_FOR_DOWNLOAD",
"url": "https://bf.sberbank.ru:9443/sbns-app/download/020b7237-f874-42ce-89bb-02d39d400bcd"
}
Модель статуса загрузки файла
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | none | Банковский комментарий к статусу загрузки файла |
fileId | string | false | none | Идентификатор файла |
status | string | false | none | Статус загрузки файла |
url | string | false | none | Ссылка для загрузки файла |
Enumerated Values
Property | Value |
---|---|
status | PREPARING_FOR_DOWNLOAD |
status | READY_FOR_DOWNLOAD |
status | ERROR |
status | OUTDATED |
status | SPOILED |
status | UNKNOWN_STATUS |
InvoiceBudget
{
"amount": 1.01,
"date": "2018-12-31",
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerKpp": "222201001",
"paymentNumber": "1",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Счёт на оплату в бюджет
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма платежа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
departmentalInfo | DepartmentalInfo | true | none | Реквизиты налогового, таможенного или иного бюджетного платежа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
linkedDocs | [LinkedDoc] | false | none | Связанные документы |
operationCode | string | false | none | Код операции |
payeeAccount | string | true | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК банка получателя платежа |
payeeBankCorrAccount | string | false | none | Кор. счёт банка получателя платежа |
payeeInn | string | true | none | ИНН получателя платежа |
payeeKpp | string | false | none | КПП получателя платежа |
payeeName | string | true | none | Наименование получателя платежа |
payerKpp | string | false | none | КПП плательщика |
paymentNumber | string | false | none | Номер платёжного документа |
priority | string | false | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
urgencyCode | string | false | none | Код срочности |
vat | Vat | false | none | Данные НДС |
Enumerated Values
Property | Value |
---|---|
urgencyCode | INTERNAL |
urgencyCode | INTERNAL_NOTIF |
urgencyCode | OFFHOURS |
urgencyCode | BESP |
urgencyCode | NORMAL |
CustomerUser
{
"sbbol3": false,
"servicesEnabled": [
{
"clientID": 1234,
"enabledDate": "2018-12-31"
}
],
"sub": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"userActive": false,
"userCryptoType": "SMS",
"userEmail": "address@email.ru",
"userGroups": "Руководитель",
"userId": 11,
"userIdentified": false,
"userLogin": "User",
"userName": "Иванов Иван Иванович",
"userPhoneNumber": "4955005550"
}
Информация о пользователе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
sbbol3 | boolean | false | none | Признак наличия дизайна СББОЛ 3.0 |
servicesEnabled | [CustomerEnabledService] | false | none | Подключенные сервисы |
sub | string | false | none | Хэш идентификатора пользователя |
userActive | boolean | false | none | Признак активности пользователя |
userCryptoType | string | false | none | Тип криптографии |
userEmail | string | false | none | Адрес электронной почты |
userGroups | string | false | none | Группы пользователя |
userId | integer(int64) | false | none | Идентификатор пользователя |
userIdentified | boolean | false | none | Признак идентификации пользователя |
userLogin | string | false | none | Логин пользователя |
userName | string | false | none | ФИО пользователя |
userPhoneNumber | string | false | none | Номер телефона |
Deposit
{
"account": "40702810500000006109",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"benefBankSwift": "SABRRUMM",
"contractDate": "2018-12-31",
"contractNumber": "10000001.ПУ00",
"endDate": "2018-12-31",
"imediaBankSwift": "SABRRUMM",
"interestRate": 5.49,
"paymentPeriod": "В конце срока",
"refund": true,
"returnAccount": "40802810600000200000",
"returnBankBic": "044525225",
"revocation": true,
"startDate": "2018-12-31",
"statusCode": "CONCLUDED",
"term": 31,
"type": "Депозит Классический Онлайн"
}
Депозитный договор
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | false | none | Номер счёта |
amount | AmountCurrency | false | none | Сумма и валюта |
benefBankSwift | string | false | none | Международный БИК банка бенефициара |
contractDate | string(date-time) | false | none | Дата договора |
contractNumber | string | false | none | Номер договора |
endDate | string(date-time) | false | none | Дата окончания срока вклада (депозита) |
imediaBankSwift | string | false | none | Международный БИК банка-посредника |
interestRate | number | false | none | Процентная ставка |
paymentPeriod | string | false | none | Периодичность выплаты процентов |
refund | boolean | false | none | Возможность пополнения |
returnAccount | string | false | none | Счёт выплаты процентов и возврата вклада |
returnBankBic | string | false | none | БИК банка выплаты процентов и возврата вклада |
revocation | boolean | false | none | Возможность досрочного отзыва |
startDate | string(date-time) | false | none | Дата открытия вклада (депозита) |
statusCode | string | false | none | Статус договора |
term | integer(int32) | false | none | Срок вклада (депозита) |
type | string | false | none | Тип вклада (депозита) |
Enumerated Values
Property | Value |
---|---|
statusCode | ACCOUNT_CREATED |
statusCode | REFUSEDBYABS |
statusCode | REJECTED_BY_ABS |
statusCode | CONCLUDED |
statusCode | PROLONGED |
statusCode | TERMINATED |
statusCode | CLOSED |
statusCode | ANNULLED |
RurStatementTransaction
{
"amount": {
"amount": 1.01,
"currencyName": "USD"
},
"amountRub": {
"amount": 1.01,
"currencyName": "USD"
},
"correspondingAccount": "30101810400000000225",
"curTransfer": {
"bankOperationCode": "CRED",
"beneficiaryBankAccount": "LOYDGB21321",
"beneficiaryBankName": "BANCO DE SABADELL, S.A. 1, PLAZA CATALUNYA SABADELL ES ",
"beneficiaryBankOption": "D",
"beneficiaryCustomerAccount": "/FI8850000120266333",
"beneficiaryCustomerName": "SUN-KING KNITTED BELT PRODUCT LTD. N.39,DONGMEN ROAD FUQING CITY,FUJIAN,CHINA",
"detailsOfCharges": "OUR",
"exchangeRate": "67,74",
"instructedAmount": "USD70,",
"instructionCode": "URGP",
"intermediaryBankAccount": "COBADEFF",
"intermediaryBankName": "BANCA POPOLARE DELL'ETRURIA E DEL LAZIO (SEDE DI MILANO) MILANO ",
"intermediaryBankOption": "D",
"messageDestinator": "LAPBLV2X",
"messageIdentifier": "S000013082900014",
"messageOriginator": "SABRRU2P",
"messageReceiveTime": "15-05-27 14:01",
"messageSendTime": "15-05-27 13:21",
"messageType": "103",
"orderingCustomerAccount": "/08251801040004813",
"orderingCustomerName": "DONGNING JIXIN INDUSTRY AND TRADE(GROUP) CO.,LTD. NO.98 FANRONG STREET DONGNING COUNTY",
"orderingCustomerOption": "K",
"orderingInstitutionAccount": "ABOCBNBJ080",
"orderingInstitutionName": "AGRICULTURAL BANK OF CHINA, THE(HEILONGJIANG BRANCH) HARBIN",
"orderingInstitutionOption": "A",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"receiverCharges": "EUR13,19",
"receiverCorrespondentAccount": "CHASDEFX",
"receiverCorrespondentName": "THE BANK OF NEW YORK MELLON NEW YORK,NY ",
"receiverCorrespondentOption": "D",
"regulatoryReporting": "/N10/NS/N4/12345678901234567890/N5/12345678901/N6/TP/N7/МS.05.2003/N8/123456789012345/N9/12.05.2003",
"remittanceInformation": "CONTRACT NO SE/00233 DATED 06.03.2012, INVOICE NO 4783",
"senderCharges": "USD7,03",
"senderCorrespondentAccount": "BOTKGB2L",
"senderCorrespondentName": "CITIBANK N.A. NEW YORK,NY ",
"senderCorrespondentOption": "D",
"senderToReceiverInformation": "/NZP/OT 15.03.2009. NDS NE OBLAGAETSYA",
"transactionReferenceNumber": "S380609091426498",
"transactionRelatedReference": "S380609091426498",
"transactionTypeCode": "N1",
"urgent": "NORMAL",
"valueDateCurrencyInterbankSettledAmount": "130824EUR5447,34"
},
"direction": "CREDIT",
"documentDate": "2018-12-31",
"filial": "ОСБ 3",
"number": "4",
"operationCode": "01",
"operationDate": "2018-12-31T23:59:59",
"paymentPurpose": "Оплата заказа №123. НДС нет.",
"priority": "5",
"revaln": "ПК",
"rurTransfer": {
"cartInfo": {
"documentCode": "string",
"documentContent": "string",
"documentDate": "2019-08-24T14:15:22Z",
"documentNumber": "string",
"paymentNumber": "string",
"restAmount": 0
},
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeBankName": "ПАО СБЕРБАНК",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerBankName": "ПАО СБЕРБАНК",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"payingCondition": "string",
"purposeCode": "1",
"receiptDate": "2018-12-31",
"valueDate": "2018-12-31"
},
"transactionId": 11111,
"uuid": "55daccdf-de87-3879-976c-8b8415c8caf9"
}
Данные операции по рублевой выписке
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | Amount | false | none | Сумма |
amountRub | Amount | false | none | Сумма |
correspondingAccount | string | false | none | Корреспондирующий счёт |
curTransfer | CurTransfer | false | none | Данные валютной операции |
direction | string | false | none | Направление транзакции DEBIT/CREDIT |
documentDate | string(date-time) | false | none | Дата документа |
filial | string | false | none | Наименование филиала |
number | string | false | none | Номер операции |
operationCode | string | false | none | Тип операции |
operationDate | string(date-time) | false | none | Дата и время операции |
paymentPurpose | string | false | none | Назначение платежа |
priority | string | false | none | Очередность платежа |
revaln | string | false | none | Признак операции переоценки (ПК - пересчет курса, ДП - дооценка руб. покрытия) |
rurTransfer | RURTransfer | false | none | Данные рублевой операции |
transactionId | integer(int64) | false | none | Идентификатор операции |
uuid | string | false | none | Уникальный идентификатор операции (UUID) |
Enumerated Values
Property | Value |
---|---|
direction | DEBIT |
direction | CREDIT |
CurrContractChangeApplication
{
"amount": 1.01,
"bankComment": "string",
"bankControlStatementChangeApplicationInfo": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"basisDocs": [
{
"date": "2018-12-31",
"number": "2222222222"
}
],
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"contentInfo": "Текстовая информация об изменениях",
"contractExternalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inUSRLE": false,
"prolongation": false
},
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractEndDate": "2018-12-31",
"contractNumber": "123АБВ",
"currencyCode": "840",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"nonResidents": [
{
"countryCode": "643",
"countryName": "РОССИЯ",
"name": "Kazan"
}
],
"number": "1"
}
Заявление о внесении изменений в I раздел ВБК (валютный контракт с нерезидентом)
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма контракта |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementChangeApplicationInfo | BankControlStatementChangeApplicationInfo | true | none | Информация о заявлении о внесении изменений в I раздел ВБК |
bankStatus | string | false | read-only | Статус документа |
contractDate | string(date-time) | true | none | Дата контракта |
contractEndDate | string(date-time) | false | none | Дата окончания обязательств по контракту |
contractNumber | string | false | none | Номер контракта |
currencyCode | string | false | none | Цифровой код валюты контракта |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
nonResidents | [BankControlStatementNonResident] | false | none | Информация о нерезидентах |
number | string | false | none | Номер документа |
BankControlStatementInfoSendDoc
{
"bankComment": "string",
"bankControlStatementInfoSend": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
]
},
"bankStatus": "string",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"number": "1"
}
Досыл валютного контракта DTO
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankControlStatementInfoSend | BankControlStatementInfoSend | true | none | Досыл валютного контракта |
bankStatus | string | false | read-only | Статус документа |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
number | string | false | none | Номер документа |
SalaryAgreement
{
"admissionValueTypes": [
{
"admissionCode": "01",
"admissionName": "Заработная плата",
"admissionType": "Зарплатный"
}
],
"branchBic": "044525225",
"branchName": "ПАО СБЕРБАНК",
"cardTypes": [
{
"bonusProgramCode": "11",
"depositSubtypeCode": "11",
"depositTypeCode": "11",
"endDate": "2018-12-31",
"peopleGroupCode": "111",
"peopleGroupName": "Зарплатная",
"typeCode": "11",
"typeName": "Visa Classic"
}
],
"commissionInfo": {
"actualDateTime": "2018-12-31T23:59:59",
"currentRate": 1.01,
"diffTariffs": [
{
"admissionTypeCode": "Other",
"endAmount": 1.01,
"fromAmount": 1.01,
"tariffRate": 1.01
}
],
"invoiceDate": "2018-12-31",
"otherRate": 1.01,
"periodInfo": {
"commissionAmount": 1.01,
"endDate": "2018-12-31",
"payAmount": 1.01,
"startDate": "2018-12-31"
},
"salaryRate": 1.01,
"totalDebitAmount": 1.01
},
"contractEndDate": "2018-12-31",
"contractNumber": "10000001",
"contractStartDate": "2018-12-31",
"isReserve": false,
"orgTaxNumber": "7707083893",
"osb": "1111",
"placesOfService": [
{
"osb": "1111",
"placeAddress": "г.Москва, Кутузовский проспект, 34",
"placeCode": "1111111111",
"placeName": "Доп офис 1111",
"tb": "11",
"vsp": "1111"
}
],
"tb": "11"
}
Зарплатный договор
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
admissionValueTypes | [SalaryAgreementAdmissionValueType] | false | none | Виды зачислений |
branchBic | string | false | none | БИК подразделения |
branchName | string | false | none | Наименование подразделения |
cardTypes | [SalaryAgreementCardType] | false | none | Типы пластиковых карт |
commissionInfo | SalaryAgreementCommissionInfo | false | none | Информация о комиссии за зачисление |
contractEndDate | string(date-time) | false | none | Дата окончания действия договора |
contractNumber | string | false | none | Номер договора |
contractStartDate | string(date-time) | false | none | Дата начала действия договора |
isReserve | boolean | false | none | Признак резервирования |
orgTaxNumber | string | false | none | ИНН организации клиента |
osb | string | false | none | Номер отделения сберегательного банка |
placesOfService | [SalaryAgreementPlaceOfService] | false | none | Места обслуживания |
tb | string | false | none | Номер территориального банка |
SalaryAgreementPlaceOfService
{
"osb": "1111",
"placeAddress": "г.Москва, Кутузовский проспект, 34",
"placeCode": "1111111111",
"placeName": "Доп офис 1111",
"tb": "11",
"vsp": "1111"
}
Место обслуживания
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
osb | string | false | none | Номер отделения сберегательного банка |
placeAddress | string | false | none | Адрес подразделения |
placeCode | string | false | none | Код подразделения |
placeName | string | false | none | Наименование подразделения |
tb | string | false | none | Номер территориального банка |
vsp | string | false | none | Номер внутреннего структурного подразделения |
Payment
{
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"crucialFieldsHash": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"departmentalInfo": {
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
},
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"incomeTypeCode": "2",
"number": "1",
"operationCode": "01",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"urgencyCode": "INTERNAL",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Рублёвое платёжное поручение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма платежа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
crucialFieldsHash | string | false | none | Hash от ключевых полей документа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
departmentalInfo | DepartmentalInfo | false | none | Реквизиты налогового, таможенного или иного бюджетного платежа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
incomeTypeCode | string | false | none | Код вида дохода получателей выплаты по 229-ФЗ |
number | string | false | none | Номер документа |
operationCode | string | true | none | Код операции |
payeeAccount | string | false | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК получателя платежа |
payeeBankCorrAccount | string | false | none | Корсчёт банка получателя платежа |
payeeInn | string | false | none | ИНН получателя платежа |
payeeKpp | string | false | none | КПП получателя платежа |
payeeName | string | true | none | Полное наименование получателя платежа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerBankCorrAccount | string | true | none | Корсчёт банка плательщика |
payerInn | string | true | none | ИНН плательщика |
payerKpp | string | false | none | КПП плательщика |
payerName | string | true | none | Полное наименование плательщика |
priority | string | true | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
urgencyCode | string | false | none | Код срочности |
vat | Vat | false | none | Данные НДС |
voCode | string | false | none | Код вида валютной операции |
Enumerated Values
Property | Value |
---|---|
urgencyCode | INTERNAL |
urgencyCode | INTERNAL_NOTIF |
urgencyCode | OFFHOURS |
urgencyCode | BESP |
urgencyCode | NORMAL |
PayrollEmpSalary
{
"account": "40802810600000200000",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"bankMessage": "string",
"firstName": "Дмитрий",
"lastName": "Петров",
"middleName": "Сергеевич",
"result": "string",
"withheldAmount": 1.01
}
Сотрудник, которому зачисляют зарплату
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | true | none | Номер счёта сотрудника |
amount | AmountCurrency | true | none | Сумма и валюта |
bankMessage | string | false | read-only | Сообщение из банка по сотруднику |
firstName | string | true | none | Имя |
lastName | string | true | none | Фамилия |
middleName | string | false | none | Отчество |
result | string | false | read-only | Результат начисления |
withheldAmount | number | false | none | Сумма удержанных средств по исполнительному документу |
ClientInfo
{
"accounts": [
{
"bic": "string",
"blockedQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSumQueuesInfo": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"blockedSums": [
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
],
"business": false,
"businessNewType": false,
"cdiAcptDocQnt": 0,
"cdiAcptDocSum": 0,
"cdiCart2DocQnt": 0,
"cdiCart2DocSum": 0,
"cdiPermDocQnt": 0,
"cdiPermDocSum": 0,
"closeDate": "2019-08-24T14:15:22Z",
"comment": "string",
"creditBlocked": false,
"creditBlockedBeginDate": "2019-08-24T14:15:22Z",
"creditBlockedCause": "string",
"creditBlockedEndDate": "2019-08-24T14:15:22Z",
"creditBlockedInitiator": "string",
"creditBlockedTaxAuthorityCode": "string",
"currencyCode": "string",
"dbo": false,
"debitBlocked": false,
"debitBlockedBeginDate": "2019-08-24T14:15:22Z",
"debitBlockedCause": "string",
"debitBlockedEndDate": "2019-08-24T14:15:22Z",
"debitBlockedInitiator": "string",
"debitBlockedTaxAuthorityCode": "string",
"minBalance": 0,
"mode": "STANDART",
"name": "string",
"notDelay": false,
"number": "string",
"openDate": "2019-08-24T14:15:22Z",
"overdraft": 0,
"passive": false,
"state": "OPEN",
"type": "assuranceRegistration",
"urgent": false
}
],
"addresses": [
{
"area": "string",
"building": "string",
"city": "string",
"comment": "string",
"country": "string",
"flat": "string",
"fullAddress": "string",
"house": "string",
"region": "string",
"settlement": "string",
"settlementType": "string",
"street": "string",
"type": "string",
"zip": "string"
}
],
"branch": {
"address": "г.Москва, Кутузовский проспект, 34",
"code": "138592",
"name": "Доп офис 1654"
},
"cardNum": "string",
"dboContracts": [
{
"date": "2018-12-31",
"financeBlock": true,
"number": "14/2/000001"
}
],
"fullName": "string",
"inn": "string",
"kpps": [
"string"
],
"offerSmartCredit": false,
"ogrn": "string",
"okato": "string",
"okpo": "string",
"orgBusinessSegment": "string",
"orgBusinessSegmentName": "string",
"orgCrmId": "string",
"orgForm": "string",
"orgGuid": "string",
"orgId": 0,
"orgIndustryInfo": {
"code": 0,
"name": "string"
},
"orgKindActivityInfo": {
"code": 0,
"name": "string"
},
"orgPprbId": 0,
"orgRegDateINN": "string",
"orgRegDateOGRN": "string",
"resident": false,
"shortName": "string",
"summOfferSmartCredit": 0,
"territorialBank": "string"
}
Информация о клиенте
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accounts | [Account] | false | none | Счета организации клиента, доступные партнёру |
addresses | [Address] | false | none | Адреса (все заведённые для клиента) |
branch | Branch | false | none | Подразделение банка |
cardNum | string | false | none | Номер таможенной карты |
dboContracts | [DboContract] | false | none | Договоры обслуживания организации |
fullName | string | false | none | Полное наименование организации |
inn | string | false | none | ИНН / КИО |
kpps | [string] | false | none | КПП (все заведенные для организации клиента) |
offerSmartCredit | boolean | false | none | Предодобренные предложения по смарт-кредитам |
ogrn | string | false | none | ОГРН |
okato | string | false | none | ОКАТО |
okpo | string | false | none | ОКПО |
orgBusinessSegment | string | false | none | Бизнес-сегмент |
orgBusinessSegmentName | string | false | none | Наименование бизнес-сегмента |
orgCrmId | string | false | none | Идентификатор организации в CRM |
orgForm | string | false | none | Организационно-правовая форма организации клиента |
orgGuid | string | false | none | Глобальный идентификатор организации |
orgId | integer(int64) | false | none | Идентификатор организации в СББОЛ |
orgIndustryInfo | OrgIndustry | false | none | Информация об отрасли организации |
orgKindActivityInfo | OrgKindActivity | false | none | Информация о виде деятельности организации |
orgPprbId | integer(int64) | false | none | Идентификатор организации в ППРБ |
orgRegDateINN | string | false | none | Дата регистрации ИНН |
orgRegDateOGRN | string | false | none | Дата регистрации ОГРН |
resident | boolean | false | none | Признак 'резидент / нерезидент' |
shortName | string | false | none | Сокращённое наименование организации |
summOfferSmartCredit | integer(int64) | false | none | Сумма предодобренного предложения по смарт-кредитам |
territorialBank | string | false | none | Территориальный банк клиента |
FileDownloadRequest
{
"fileIds": [
"string"
]
}
Модель параметров запроса на создание задач на загрузку файлов
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
fileIds | [string] | true | none | Список идентификаторов файлов |
Pkcs10
{
"bicryptId": "A001NVA3",
"cms": "-----BEGIN CMS-----\n ... MIIIj ... \n-----END CMS-----"
}
Информация о запросе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bicryptId | string | true | none | Идентификатор bicryptId |
cms | string | true | none | Данные запроса на сертификат ЭП в формате CMS (PKCS #10) |
GenericLetters
{
"_links": [
{
"href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
"rel": "next"
}
],
"letters": [
{
"attachments": [
{
"content": "dGVzdA==",
"mimeType": "image/jpeg",
"name": "тест.jpg"
}
],
"bankComment": "string",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"crmNumber": "190410-0033-142400",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"text": "У меня все хорошо",
"typeCode": "payment_recall",
"typeName": "Направить запрос по 115-ФЗ"
}
]
}
Ссылки на "Письма из Банка"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
_links | [Link] | false | none | Ссылки на связанные ресурсы |
letters | [GenericLetter] | false | none | Письма из Банка |
Beneficiar
{
"accountNumber": "40802840600000200000",
"address": "Moscow,Novoslobodskaya,11",
"bankInfo": {
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "RUS",
"bankCountryIsoCode": "643",
"bankName": "SBERBANK",
"bankPlace": "BELGRAD",
"branch": "REGIONAL BRANCH",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
},
"country": "РОССИЯ",
"countryCode": "643",
"countryIsoCode": "RUS",
"currCode": "840",
"currIsoCode": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"inn": "7707083893",
"mediaBankInfo": {
"bankAddress": "65 B, POZESKA",
"bankCorrAccount": "30101810400000000225",
"bankCountry": "РОССИЯ",
"bankCountryCode": "643",
"bankCountryIsoCode": "RUS",
"bankName": "SBERBANK",
"bankPlace": "Moscow",
"branch": "ДО №1654 Московского банка ПАО Сбербанк",
"clirCode": "77876576856",
"clirCountry": "Canadian Payment Association",
"clirCountryCode": "CA",
"swiftCode": "SABRRUMM",
"symbolClirCode": "СС"
},
"name": "Общество с ограниченной ответственностью \"Клиент\"",
"operCode": "01",
"operName": "Покупка резидентом иностранной валюты за валюту Российской Федерации",
"payDirection": "Оплата заказа №123. НДС нет.",
"paymentType": "sbrfOut",
"place": "Moscow",
"remark": "Комментарий"
}
Контрагент по валютным операциям
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountNumber | string | false | none | Номер счёта контрагента |
address | string | false | none | Адрес контрагента |
bankInfo | BankInfo | false | none | Информация о банке контрагента |
country | string | false | none | Страна контрагента |
countryCode | string | false | none | Цифровой код страны контрагента |
countryIsoCode | string | false | none | Буквенный код страны контрагента |
currCode | string | false | none | Цифровой код валюты |
currIsoCode | string | false | none | Буквенный код валюты |
externalId | string | true | none | Уникальный индентификатор бенефициара |
inn | string | false | none | ИНН контрагента |
mediaBankInfo | MediaBankinfo | false | none | Информация о банке-посреднике |
name | string | false | none | Наименование организации контрагента |
operCode | string | false | none | Код валютной операции |
operName | string | false | none | Наименование валютной операции |
payDirection | string | false | none | Назначение платежа |
paymentType | string | false | none | Тип перевода |
place | string | false | none | Город контрагента |
remark | string | false | none | Комментарий |
CurrencyOperationDetails
{
"acceptDate": "2018-12-31",
"accountNumber": "40802840600000200000",
"addInfo": "Дополнительная информация",
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankNonResidentCountryName": "РОССИЯ",
"bankNonResidentCountryNumericCode": "643",
"bankStatus": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"correction": false,
"correctionNumber": 0,
"currencyDocDate": "2018-12-31",
"currencyDocNumber": "123",
"currencyDocType": "PayDocCur",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"executorEmployeeName": "Ответственный исполнитель банка",
"executorName": "Иванов Иван Иванович",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"isAccountInOtherBank": false,
"isNumberAbsent": false,
"linkedDocs": [
{
"docExtId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"type": "PayDocCur"
}
],
"number": "1",
"numberAbsent": true,
"operationDate": "2018-12-31",
"operations": [
{
"additionalInfo": "Дополнительная информация",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractDate": "2018-12-31",
"contractNumber": "123",
"contractNumberType": "0",
"creditAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"dataComposition": "1",
"expectedDate": "2018-12-31",
"operationCode": "20300",
"operationCodeDescription": "Оплата нерезидента резиденту по договору аренды движимого или недвижимого имущества",
"operationReason": "1",
"passportNumber": "120123A0/1234/GU23/1/2",
"paymentConditions": "0",
"serialNumber": 1
}
],
"paymentAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"paymentDirection": "1",
"senderInn": "7707083893",
"senderName": "Общество с ограниченной ответственностью \"Клиент\"",
"senderOkpo": "222221001",
"valueDate": "2018-12-31"
}
Сведения о валютной операции
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
acceptDate | string(date-time) | false | read-only | Дата представления в банк |
accountNumber | string | false | none | Номер счета |
addInfo | string | false | none | Дополнительная информация |
authPersonName | string | false | none | ФИО ответственного лица |
authPersonTelfax | string | false | none | Телефон ответственного лица |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankNonResidentCountryName | string | false | none | Наименование страны |
bankNonResidentCountryNumericCode | string | false | none | Код страны, 3 цифры |
bankStatus | string | false | read-only | Статус документа |
bfAttachments | [BfAttachment] | false | none | Приложенные к документу: отсканированные образы-вложения - для АС БФ |
correction | boolean | true | none | Признак корректировки |
correctionNumber | integer(int32) | false | none | Порядковый номер корректировки |
currencyDocDate | string(date-time) | false | none | Дата валютного документа |
currencyDocNumber | string | false | none | Номер документа по валютной операций |
currencyDocType | string | false | none | Тип валютного документа |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
executorEmployeeName | string | false | read-only | Должность ответственного лица |
executorName | string | false | read-only | Подпись отвественного лица |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
failReasons | [FailReason] | false | read-only | Причины отказа |
isAccountInOtherBank | boolean | true | none | Признак счёта в другом банке |
isNumberAbsent | boolean | true | none | Признак отсутствия номера валютного документа |
linkedDocs | [LinkedDoc] | false | none | Cвязанные документы |
number | string | false | none | Номер документа |
numberAbsent | boolean | false | none | none |
operationDate | string(date-time) | false | none | Дата операции |
operations | [CurrencyOperationDetailsDoc] | true | none | Документы валютного контроля |
paymentAmount | AmountCurrency | true | none | Сумма и валюта |
paymentDirection | string | true | none | Направление платежа: 1-зачисление, 2-списание |
senderInn | string | true | none | ИНН резидента, указываемый в документе |
senderName | string | true | none | Полное наименование организации, указываемое в документе |
senderOkpo | string | true | none | ОКПО клиента, указываемый в документе |
valueDate | string(date-time) | false | read-only | Дата принятия/возврата |
Enumerated Values
Property | Value |
---|---|
currencyDocType | MandatorySale |
currencyDocType | PayDocCur |
currencyDocType | PayDocRu |
currencyDocType | CurrencyNotices |
paymentDirection | 1 |
paymentDirection | 2 |
WorkflowFault
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Описание ошибки, возникшей в жизненном цикле ресурса
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
referenceId | string | false | none | Уникальный идентификатор ошибки (UUID) |
message | string | false | none | Сообщение |
checks | [Check] | false | none | Список проверок, приведших к ошибке |
fieldNames | [string] | false | none | Названия полей с некорректным значением (только для VALIDATION_FAULT) |
ClientAccrual
{
"account": "40802810600000200000",
"amount": 1.01,
"amountDebt": 1.01,
"amountVat": 1.01,
"bankComment": "string",
"bankStatus": "ANNULLED",
"client": "ee0fb56b01a9d9b9648a2c60549b77702eb2a6de8f2189c4349447e43b250da5",
"clientId": 1005,
"countServiceFact": 20,
"dateExpiration": "2018-12-31",
"dateSince": "2018-12-31",
"dateUntil": "2018-12-31",
"datetimeStatusChange": "2018-12-31T23:59:59",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"purpose": "Оплата заказа №123. НДС нет."
}
Запрос на списание платы за пользование клиентом сервиса партнёра
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | false | none | Счёт клиента для списания комиссии |
amount | number | false | none | Сумма начисления без НДС |
amountDebt | number | false | none | Остаток задолженности |
amountVat | number | false | none | Сумма НДС |
bankComment | string | false | read-only | Банковский комментарий к статусу |
bankStatus | string | false | read-only | Статус списания денежных средств за начисление |
client | string | true | none | Идентификатор организации |
clientId | integer(int64) | true | none | Идентификатор сервиса |
countServiceFact | integer(int64) | false | none | Количество фактов потребления услуги за период |
dateExpiration | string(date-time) | false | none | Дата начала взимания пени при просрочке платежа |
dateSince | string(date-time) | true | none | Дата начала периода списания |
dateUntil | string(date-time) | true | none | Дата окончания периода списания |
datetimeStatusChange | string(date-time) | false | read-only | Дата и время исполнения документа |
digestSignatures | [Signature] | true | none | Подписи начисления |
externalId | string | true | none | Идентификатор начисления, присвоенный партнёром (UUID) |
purpose | string | false | none | Назначение платежа |
Enumerated Values
Property | Value |
---|---|
bankStatus | ANNULLED |
bankStatus | CANCELED |
bankStatus | CHECKERROR |
bankStatus | CHECKERRORABS |
bankStatus | CREATED |
bankStatus | DELIVERED |
bankStatus | NOT_PROCESSED |
bankStatus | NOTPAID |
bankStatus | PAID |
bankStatus | PARTPAID |
bankStatus | REFUSED_BY_LIMIT |
bankStatus | REQUISITEERROR |
bankStatus | EXPORTED |
bankStatus | SENDED |
bankStatus | UPLOADERROR |
bankStatus | WAITING |
bankStatus | DECLINED |
CreditRequest
{
"account": "40802810600000200000",
"amount": 1.01,
"bankComment": "string",
"bankStatus": "string",
"creditAmount": 1.01,
"creditProductCode": "MB-F-ip-150",
"creditTerm": 48,
"deliveryAmount": 1.01,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"orderId": "2128506",
"orderInfo": [
{
"numOfPosition": 1,
"position": "string",
"price": 1.01,
"totalPrice": 1.01
}
],
"orderUrl": "https://example.ru/order?uid=2128506",
"purpose": "Оплата заказа №2128506 от 23.12.2019. НДС 20% - 1,01 рублей",
"vatAmount": 1.01
}
Заявка на кредит
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | true | none | Расчётный счет для зачисления денежных средств за заказ |
amount | number | true | none | Сумма заказа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
creditAmount | number | false | none | Запрошенная сумма кредита |
creditProductCode | string | false | none | Код продукта для кредитного предложения, в рамках которого для клиента оформляется заявка |
creditTerm | integer(int32) | false | none | Срок кредита (в месяцах) |
deliveryAmount | number | false | none | Сумма доставки |
externalId | string | true | none | Идентификатор запроса, присвоенный партнёром |
orderId | string | true | none | Идентификатор заказа клиента (номер) |
orderInfo | [OrderInfo] | false | none | Информация о составе заказа |
orderUrl | string | true | none | Ссылка на заказ |
purpose | string | true | none | Назначение платежа |
vatAmount | number | false | none | Сумма НДС |
EncashmentContractAcc
{
"bankCode": "044525225",
"bankName": "ПАО СБЕРБАНК",
"number": "40802810600000200000"
}
Счёт списания/зачисления
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankCode | string | false | none | БИК |
bankName | string | false | none | Наименование банка |
number | string | false | none | Номер счёта |
DepartmentalInfo
{
"uip": "0",
"drawerStatus101": "01",
"kbk": "18210102010011000110",
"oktmo": "01701000",
"reasonCode106": "ТП",
"taxPeriod107": "ГД.00.2018",
"docNumber108": "123",
"docDate109": "0",
"paymentKind110": "1"
}
Реквизиты налогового, таможенного или иного бюджетного платежа
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
uip | string | true | none | Уникальный идентификатор платежа |
drawerStatus101 | string | true | none | Показатель статуса налогоплательщика (реквизит - 101) |
kbk | string | true | none | Код бюджетной классификации (реквизит - 104) |
oktmo | string | true | none | Код OKTMO (реквизит - 105) |
reasonCode106 | string | true | none | Показатель основания платежа (реквизит - 106) |
taxPeriod107 | string | true | none | Налоговый период / код таможенного органа (реквизит - 107) |
docNumber108 | string | true | none | Номер налогового документа (реквизит - 108) |
docDate109 | string | true | none | Дата налогового документа (реквизит - 109) |
paymentKind110 | string | false | none | Тип налогового платежа (реквизит - 110) |
SalaryAgreementDiffTariff
{
"admissionTypeCode": "Other",
"endAmount": 1.01,
"fromAmount": 1.01,
"tariffRate": 1.01
}
Дифференцированный тариф для зарплатных реестров
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
admissionTypeCode | string | true | none | Тип зачисления |
endAmount | number | true | none | Конечная сумма диапазона выплат |
fromAmount | number | true | none | Начальная сумма диапазона выплат |
tariffRate | number | true | none | Тарифная ставка (%) |
Enumerated Values
Property | Value |
---|---|
admissionTypeCode | Other |
admissionTypeCode | Salary |
CardIssuePlaceOfService
{
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
}
Места обслуживания физических лиц
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
branchCode | string | true | none | Код подразделения |
branchName | string | true | none | Наименование подразделения |
osb | string | true | none | Номер отделения сберегательного банка |
tb | string | true | none | Номер территориального банка |
vsp | string | true | none | Номер внутреннего структурного подразделения |
ClientAddedUserInfo
{
"servicesInfo": [
{
"clientId": 0,
"refreshToken": "string"
}
],
"sub": "string"
}
Информация о пользователе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
servicesInfo | [ClientAddedUserServiceInfo] | false | none | Подключенные в ВСП платные сервисы |
sub | string | false | none | Хэш идентификатора пользователя |
PaymentsRegistry
{
"account": "40802810600000200000",
"bankComment": "string",
"bankStatus": "ACCEPTED",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "5",
"paymentsRegistry": [
{
"amount": 2000.15,
"amountBring": 2100.35,
"dateBegin": "2018-12-31",
"dateEnd": "2018-12-31",
"dateLoad": "2018-12-31",
"registryName": "EPS39291510642_5018141474.txt",
"uploadedRecords": 10
}
]
}
Документ "Реестр платежей"
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
account | string | false | none | Расчетный счет |
bankComment | string | false | none | Атрибуты реестра |
bankStatus | string | false | none | Статус документа |
bfAttachments | [BfAttachment] | false | none | Данные о файлах, связанных с реестром платежей |
date | string(date-time) | false | none | Дата создания документа |
externalId | string | false | none | Идентификатор документа |
number | string | false | none | Номер документа |
paymentsRegistry | [PaymentsRegistryItem] | false | none | Реестры платежей |
CustomerEnabledService
{
"clientID": 1234,
"enabledDate": "2018-12-31"
}
Подключенный сервис
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clientID | integer(int64) | false | none | Идентификатор сервиса |
enabledDate | string(date-time) | false | none | Дата подключения сервиса |
PayrollCommissionInfo
{
"actualRate": 1.01,
"actualSum": 1.01,
"estimatedRate": 1.01,
"estimatedSum": 1.01,
"invoiceDate": "2018-12-31"
}
Тарифы и коммисия зарплатной ведомости
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
actualRate | number | false | read-only | Фактическая тарифная ставка комиссии (%) |
actualSum | number | false | read-only | Фактическая сумма комиссии |
estimatedRate | number | false | read-only | Предварительная тарифная ставка комиссии (%) |
estimatedSum | number | false | read-only | Предварительная сумма комиссии |
invoiceDate | string(date-time) | false | read-only | Дата выставления счета и направления детализации |
CurrCredTranche
{
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD",
"entryDate": "2018-12-31",
"periodCode": "1"
}
Транш по валютному кредитному договору
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма |
currencyCode | string | false | none | Цифровой код валюты |
currencyName | string | false | none | Буквенный ISO-код валюты |
entryDate | string(date-time) | false | none | Ожидаемая дата поступления |
periodCode | string | false | none | Код срока привлечения |
ClientsAdded
{
"clientsAdded": [
{
"hashOrgId": "string",
"usersInfo": [
{
"servicesInfo": [
{
"clientId": 0,
"refreshToken": "string"
}
],
"sub": "string"
}
]
}
]
}
Список клиентов, подключенных через БЧ за период
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
clientsAdded | [ClientAdded] | false | none | Информация о клиентах |
CollectionOrder
{
"amount": 1.01,
"balancePayment": 0,
"bankComment": "string",
"bankStatus": "string",
"date": "2018-12-31",
"deliveryKind": "электронно",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileDate": "2019-08-24T14:15:22Z",
"numPartPayment": "string",
"numPayOrder": "string",
"number": "1",
"operationCode": "01",
"orderDate": "2019-08-24T14:15:22Z",
"payeeAccount": "40802810600000200000",
"payeeBankBic": "044525225",
"payeeBankCorrAccount": "30101810400000000225",
"payeeInn": "7707083893",
"payeeKpp": "222201001",
"payeeName": "Общество с ограниченной ответственностью \"Клиент\"",
"payerAccount": "40802810600000200000",
"payerBankBic": "044525225",
"payerBankCorrAccount": "30101810400000000225",
"payerInn": "7707083893",
"payerKpp": "222201001",
"payerName": "Общество с ограниченной ответственностью \"Клиент\"",
"priority": "5",
"purpose": "Оплата заказа №123. НДС нет.",
"sumPartPayment": 0,
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
},
"voCode": "61150"
}
Рублёвое инкассовое поручение
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | true | none | Сумма платежа |
balancePayment | number | false | read-only | Сумма остатка платежа |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
date | string(date-time) | true | none | Дата составления документа |
deliveryKind | string | false | none | Вид платежа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
fileDate | string(date-time) | false | read-only | Дата помещения в картотеку |
numPartPayment | string | false | read-only | Номер частичного платежа |
numPayOrder | string | false | read-only | Номер платёжного ордера |
number | string | false | none | Номер документа |
operationCode | string | true | none | Код операции |
orderDate | string(date-time) | false | read-only | Дата платёжного ордера |
payeeAccount | string | true | none | Счёт получателя платежа |
payeeBankBic | string | true | none | БИК получателя платежа |
payeeBankCorrAccount | string | true | none | Корсчёт банка получателя платежа |
payeeInn | string | true | none | ИНН получателя платежа |
payeeKpp | string | true | none | КПП получателя платежа |
payeeName | string | true | none | Полное наименование получателя платежа |
payerAccount | string | true | none | Счёт плательщика |
payerBankBic | string | true | none | БИК банка плательщика |
payerBankCorrAccount | string | true | none | Корсчёт банка плательщика |
payerInn | string | true | none | ИНН плательщика |
payerKpp | string | false | none | КПП плательщика |
payerName | string | true | none | Полное наименование плательщика |
priority | string | true | none | Очерёдность платежа |
purpose | string | true | none | Назначение платежа |
sumPartPayment | number | false | read-only | Сумма частичного платежа |
vat | Vat | false | none | Данные НДС |
voCode | string | false | none | Код вида валютной операции |
AvailableTariffPlan
{
"freePeriod": 2,
"freePeriodType": "М",
"paymentType": "UNPAID",
"tariffDescription": "Продукт позволяет избежать ограничений по 115-ФЗ",
"tariffName": "Безопасный бизнес Базовый",
"tariffPlansDetails": [
{
"billingObjectCode": "ft-payment",
"billingObjectName": "Создание рублевого платежного поручения",
"billingObjectStrategy": "MAX",
"tariffPackCount": 1000,
"tariffPackFree": 500
}
],
"tariffSystemName": "SECURE_BUSINESS_BASIC"
}
Тарифный план, доступный партнёрскому сервису для подключения
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
freePeriod | integer(int64) | true | none | Бесплатный период |
freePeriodType | string | true | none | Размерность бесплатного периода (Y - год, Q - квартал, M - месяц) |
paymentType | string | true | none | Тип оплаты тарифа |
tariffDescription | string | true | none | Описание тарифного плана |
tariffName | string | true | none | Наименование тарифного плана |
tariffPlansDetails | [TariffPlansDetails] | false | none | Тарифицируемые объекты тарифного плана |
tariffSystemName | string | true | none | Системное наименование тарифного плана |
Enumerated Values
Property | Value |
---|---|
paymentType | PREPAID |
paymentType | POSTPAID |
paymentType | UNPAID |
EncashmentOfferAddAttributes
{
"birthDate": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"firstName": "Иван",
"identNum": "111111",
"identSeries": "0000",
"identType": "07",
"lastName": "Иванов",
"middleName": "Иванович",
"offerStatus": "Accept",
"post": "Бухгалтер",
"remarks": "Красивый комментарий",
"warrantDate": "2018-12-31",
"warrantNum": "1111"
}
Дополнительные аттрибуты коммерческого предложения
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
birthDate | string(date-time) | false | none | Дата рождения |
digestSignatures | [Signature] | false | none | Электронные подписи |
firstName | string | false | none | Имя подписанта |
identNum | string | false | none | Номер документа |
identSeries | string | false | none | Серия документа |
identType | string | false | none | Тип документа, удостоверяющего личность |
lastName | string | false | none | Фамилия подписанта |
middleName | string | false | none | Отчество подписанта |
offerStatus | string | true | none | Результат ознакомления (Accept - согласие, Decline - отказ) |
post | string | false | none | Должность клиента |
remarks | string | false | none | Комментарий клиента |
warrantDate | string(date-time) | false | none | Дата доверенности |
warrantNum | string | false | none | Номер доверенности |
Enumerated Values
Property | Value |
---|---|
identType | 07 |
identType | 8 |
identType | 21 |
identType | 24 |
identType | 26 |
identType | 27 |
offerStatus | Accept |
offerStatus | Decline |
EncashAddRequest
{
"bankComment": "string",
"bankStatus": "string",
"contactName": "Иванов Иван Иванович",
"contactRemarks": "Новый комментарий",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"email": "address@email.ru",
"encashObjects": [
{
"contractModifyDate": "2018-12-31",
"objectAddress": "г. Москва, Кутузовский проспект, д 32",
"objectContactName": "Иванов Иван Иванович",
"objectContactPhone": "89269999999",
"objectName": "АО \"Киберлинк\" технологии 555100",
"objectRegion": "Москва",
"services": [
{
"encashContractDate": "2018-12-31",
"encashContractNum": "76-И",
"serviceType": 3,
"visitInfo": {
"cashAmount": 15000,
"cashCoins": 25000,
"countInMonth": 10,
"isByRequest": true,
"schedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
}
],
"workSchedule": [
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
]
}
],
"externalId": "55daccdf-de87-3879-976c-8b8415c8caf9",
"number": "1",
"phoneNumber": "4955005550"
}
Заявка на добавление объектов в договор инкассации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
contactName | string | true | none | ФИО контактного лица |
contactRemarks | string | false | none | Комментарий |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
string | true | none | Адрес электронной почты | |
encashObjects | [EncashAddRequestObject] | false | none | Объекты инкассации |
externalId | string | true | none | Идентификатор документа в организации-партнёре |
number | string | false | none | Номер документа |
phoneNumber | string | true | none | Контактный телефон |
OrgKindActivity
{
"code": 0,
"name": "string"
}
Информация о виде деятельности организации
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | integer(int32) | false | none | Код вида деятельности |
name | string | false | none | Наименование вида деятельности |
SelfEncasherRequestInfo
{
"attorneyNumber": "51 А А 0001904",
"bankComment": "string",
"bankStatus": "string",
"byAttorney": false,
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"empowermentEnd": "2018-12-31",
"empowermentStart": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"login": "username",
"number": "1"
}
Информация о новом вносителе
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
attorneyNumber | string | false | none | Номер доверенности |
bankComment | string | false | read-only | Банковский комментарий к статусу документа |
bankStatus | string | false | read-only | Статус документа |
byAttorney | boolean | false | none | По доверенности |
date | string(date-time) | true | none | Дата составления документа |
digestSignatures | [Signature] | false | none | Электронные подписи по дайджесту документа |
empowermentEnd | string(date-time) | true | none | Дата окончания наделения полномочий |
empowermentStart | string(date-time) | true | none | Дата начала наделения полномочий |
externalId | string | true | none | Идентификатор документа у клиента (UUID) |
login | string | false | none | Имя пользователя |
number | string | false | none | Номер документа |
ClientExtserviceProduct
{
"category": "Бухгалтерия и финансовый учёт",
"fullDesc": "Сервис позволяет выполнять сдачу необходимой бухгалтерской, налоговой и финансовой отчетности в электронном виде в государственные органы",
"name": "Бухгалтерия для ИП",
"productId": "Бухгалтерия для ИП",
"shortDesc": "Облачная бухгалтерия",
"sinceDate": "2018-12-31"
}
Небанковский продукт
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
category | string | false | none | Категория продукта |
fullDesc | string | false | none | Полное описание продукта |
name | string | false | none | Наименование внешнего сервиса |
productId | string | false | none | Идентификатор продукта |
shortDesc | string | false | none | Краткое описание продукта |
sinceDate | string(date-time) | false | none | Дата подключения |
ClientsChanges
{
"hashOrgIds": [
"string"
]
}
Список клиентов, по которым произошли изменения за дату
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
hashOrgIds | [string] | false | none | Хэши идентификаторов организаций |
PeriodicPaymentToPartner
{
"amount": 1.01,
"amountMode": "AMOUNT",
"clientAccount": "40802810600000200000",
"date": "2018-12-31",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"minimumBalance": 1.01,
"number": "1",
"partnerAccount": "40802810600000200000",
"periodicity": {
"daysOfMonth": "5,10,25,28",
"daysOfWeek": "MON,TUE,WED,THU,FRI,SAT,SUN",
"mode": "DAILY",
"offset": "BACKWARD",
"time": "14:00"
},
"purpose": "Регулярное перечисление денежных средств",
"startDate": "2018-12-31",
"vat": {
"amount": 1.01,
"rate": "10",
"type": "NO_VAT"
}
}
Длительное платёжное поручение (ДПП) в адрес партнёра
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
amount | number | false | none | Сумма платежа для поручений с режимом AMOUNT |
amountMode | string | true | none | Режим определения суммы платежа |
clientAccount | string | false | none | Счёт списания клиента |
date | string(date-time) | true | none | Дата составления распоряжения |
externalId | string | true | none | Идентификатор документа, присвоенный партнёром (UUID) |
minimumBalance | number | false | none | Неснижаемый остаток для поручений с режимом REMAINDER |
number | string | false | none | Номер распоряжения плательщика |
partnerAccount | string | true | none | Счёт получателя платежа |
periodicity | Periodicity | true | none | Определение периодичности исполнения |
purpose | string | true | none | Назначение платежа |
startDate | string(date-time) | false | none | Дата начала действия |
vat | Vat | false | none | Данные НДС |
Enumerated Values
Property | Value |
---|---|
amountMode | AMOUNT |
amountMode | REMAINDER |
TariffPlansDetails
{
"billingObjectCode": "ft-payment",
"billingObjectName": "Создание рублевого платежного поручения",
"billingObjectStrategy": "MAX",
"tariffPackCount": 1000,
"tariffPackFree": 500
}
Тарифицируемые объекты тарифного плана
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
billingObjectCode | string | false | none | Код тарифицируемого объекта |
billingObjectName | string | false | none | Наименование тарифицируемого объекта |
billingObjectStrategy | string | false | none | Стратегия тарификации |
tariffPackCount | integer(int64) | false | none | Пакетные тарифы. Количество сообщений в тарифе |
tariffPackFree | integer(int64) | false | none | Пакетные тарифы. Количество бесплатных сообщений в тарифе |
Enumerated Values
Property | Value |
---|---|
billingObjectStrategy | MAX |
billingObjectStrategy | LAST |
SalaryAgreementRequestIdentityDoc
{
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"firstName": "Иван",
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"lastName": "Иванов",
"middleName": "Иванович",
"number": "123456",
"serial": "1234",
"typeCode": "21",
"typeName": "Паспорт гражданина Российской Федерации"
}
Сведения ДУЛ
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
birthDate | string(date-time) | true | none | Дата рождения |
birthPlace | string | true | none | Место рождения |
firstName | string | true | none | Имя |
issueDate | string(date-time) | true | none | Дата выдачи ДУЛ |
issuer | string | true | none | Кем выдан ДУЛ |
lastName | string | true | none | Фамилия |
middleName | string | true | none | Отчество |
number | string | true | none | Номер ДУЛ |
serial | string | true | none | Серия ДУЛ |
typeCode | string | true | none | Код вида ДУЛ |
typeName | string | true | none | Наименование ДУЛ |
AccountBlockInfo
{
"beginDate": "2018-12-31",
"blockedQueues": 0,
"cause": "string",
"endDate": "2018-12-31",
"initiator": "string",
"sum": 1.01,
"taxAuthorityCode": "string"
}
Данные о блокировках счета клиента
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
beginDate | string(date-time) | false | none | Дата начала действия ограничения |
blockedQueues | integer(int32) | false | none | Наибольшая разрешённая очерёдность платежей (от 1 до 5). Указывается, если есть блокировка по очерёдности. Пример: значение 3 означает, что заблокированы очерёдности 4 - 6 |
cause | string | false | none | Основание ареста |
endDate | string(date-time) | false | none | Дата снятия ограничения |
initiator | string | false | none | Наименование органа, наложившего арест |
sum | number | false | none | Заблокированная (арестованная) сумма на счёте |
taxAuthorityCode | string | false | none | Код налогового органа, наложившего арест |
ValidationFault
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
],
"fieldNames": "[\"externalId\", \"paymentNumber\"]"
}
Описание ошибки валидации со списком некорректных полей
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
referenceId | string | false | none | Уникальный идентификатор ошибки (UUID) |
message | string | false | none | Сообщение |
checks | [Check] | false | none | Список проверок, приведших к ошибке |
fieldNames | [string] | false | none | Названия полей с некорректным значением (только для VALIDATION_FAULT) |
DictArchive
{
"archive": "string",
"name": "string"
}
Архив справочника
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
archive | string | false | none | Содержимое архива в Base64 |
name | string | false | none | Идентификатор справочника |
Signature
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
Электронная подпись
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
base64Encoded | string | true | none | Значение электронной подписи, закодированное в Base64 |
certificateUuid | string | true | none | Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID) |
EioCryptoInfo
{
"certBank": "string",
"certBankUuid": "string",
"certCenterCode": "А000",
"certCenterNum": "02",
"certsCA": [
"string"
],
"cryptoUserInfos": [
{
"cryptoProfileInfos": [
{
"alias": "Profile alias",
"certificateInfos": [
{
"active": false,
"cert": "string",
"issuer": "ISSUER",
"serialNumber": "SN:000F18",
"uuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"typeName": "Инфокрипт"
}
],
"sub": "string"
}
]
}
Информация о КУЦ и информация о пользователях
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
certBank | string | false | none | Сертификат технологического криптопрофиля банка |
certBankUuid | string | false | none | Уникальный идентификатор сертификата технологического криптопрофиля Банка |
certCenterCode | string | false | none | Код удостоверяющего центра |
certCenterNum | string | false | none | Текущий порядковый номер для генерации запроса на сертификат |
certsCA | [string] | false | none | Сертификаты удостоверяющих центров |
cryptoUserInfos | [CryptoUserInfo] | false | none | Информация о пользователях |
SalaryAgreementAdmissionValueType
{
"admissionCode": "01",
"admissionName": "Заработная плата",
"admissionType": "Зарплатный"
}
Вид зачисления
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
admissionCode | string | false | none | Код зачисления |
admissionName | string | false | none | Наименование зачисления |
admissionType | string | false | none | Тип зачисления |
EncashAddRequestSchedule
{
"day": "Fri",
"timeFrom": 9,
"timeTo": 18
}
График работы
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
day | string | true | none | День недели графика работы |
timeFrom | integer(int32) | true | none | Время работы с |
timeTo | integer(int32) | true | none | Время работы по |
Enumerated Values
Property | Value |
---|---|
day | Mon |
day | Tue |
day | Wed |
day | Thu |
day | Fri |
day | Sat |
day | Sun |
MandatorySaleTransf
{
"accountNum": "40802810600000200000",
"bankSwiftCode": "SABRRUMM",
"bankSwiftName": "SBERBANK",
"chargedCur": {
"amount": 1.01,
"currencyName": "USD"
},
"commission": {
"amount": 1.01,
"currencyName": "USD"
},
"transferAmount": {
"amount": 1.01,
"currencyName": "USD"
},
"transferTo": "orgAccount",
"valueDate": "2018-12-31"
}
Блок валютного перевода
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
accountNum | string | true | none | Счёт для зачисления валюты |
bankSwiftCode | string | false | none | SWIFT код банка |
bankSwiftName | string | false | none | SWIFT наименование банка |
chargedCur | Amount | false | none | Сумма |
commission | Amount | false | none | Сумма |
transferAmount | Amount | true | none | Сумма |
transferTo | string | true | none | Тип зачисления валютного перевода |
valueDate | string(date-time) | false | read-only | Дата валютирования перевода средств |
Enumerated Values
Property | Value |
---|---|
transferTo | orgAccount |
transferTo | bankAccount |
transferTo | prcomAccount |
CurrencyOperationDetailsDoc
{
"additionalInfo": "Дополнительная информация",
"amount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"contractDate": "2018-12-31",
"contractNumber": "123",
"contractNumberType": "0",
"creditAmount": {
"amount": 1.01,
"currencyCode": "840",
"currencyName": "USD"
},
"dataComposition": "1",
"expectedDate": "2018-12-31",
"operationCode": "20300",
"operationCodeDescription": "Оплата нерезидента резиденту по договору аренды движимого или недвижимого имущества",
"operationReason": "1",
"passportNumber": "120123A0/1234/GU23/1/2",
"paymentConditions": "0",
"serialNumber": 1
}
Документ валютного контроля
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
additionalInfo | string | false | none | Примечание |
amount | AmountCurrency | true | none | Сумма и валюта |
contractDate | string(date-time) | false | none | Дата договора |
contractNumber | string | false | none | Номер договора |
contractNumberType | string | false | none | Тип указание номера договора |
creditAmount | AmountCurrency | false | none | Сумма и валюта |
dataComposition | string | false | none | Состав предоставляемой информации |
expectedDate | string(date-time) | false | none | Ожидаемый срок |
operationCode | string | true | none | Код вида валютной операции |
operationCodeDescription | string | true | none | Описание валютной операции |
operationReason | string | true | none | Основание проведения операции |
passportNumber | string | false | none | Уникальный номер контракта (кредитного договора) |
paymentConditions | string | false | none | Условия расчета |
serialNumber | integer(int32) | false | none | Номер по порядку |
Enumerated Values
Property | Value |
---|---|
contractNumberType | 0 |
contractNumberType | 1 |
contractNumberType | 2 |
dataComposition | 1 |
dataComposition | 2 |
dataComposition | 3 |
dataComposition | 4 |
dataComposition | 5 |
dataComposition | 6 |
dataComposition | 8 |
operationReason | 1 |
operationReason | 2 |
operationReason | 3 |
operationReason | 4 |
paymentConditions | 0 |
paymentConditions | 1 |
ClientTariff
{
"activationDate": "2018-12-31",
"code": "N",
"description": "Описание тарифа N",
"expireDate": "2018-12-31",
"expireTrialModeDate": "2018-12-31",
"name": "Тариф N",
"plannedPaymentDate": "2018-12-31",
"rateAmount": 1.01,
"ratePeriodMonths": 12,
"tokenUrl": "https://www.partner.ru/tariffs",
"trialMode": true,
"url": "https://www.partner.ru/tariffs"
}
Тариф пользователя по подключённому сервису
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
activationDate | string(date-time) | false | none | Дата активации тарифа |
code | string | true | none | Код тарифа |
description | string | false | none | Описание тарифа |
expireDate | string(date-time) | false | none | Дата окончания тарифа |
expireTrialModeDate | string(date-time) | false | none | Дата завершения триального периода |
name | string | true | none | Наименование тарифа |
plannedPaymentDate | string(date-time) | false | none | Плановая дата списания денежных средств за сервис |
rateAmount | number | true | none | Стоимость |
ratePeriodMonths | integer(int32) | true | none | Периодичность оплаты в месяцах |
tokenUrl | string | false | none | Ссылка на страницу управления тарифом для токенных клиентов |
trialMode | boolean | false | none | none |
url | string | false | none | Ссылка на страницу управления тарифом |
FromTo_bigdecimal_
{
"from": 0,
"to": 0
}
Диапазон От До
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
from | number | false | none | От |
to | number | false | none | До |
FromTo_int_
{
"from": 0,
"to": 0
}
Диапазон От До
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
from | integer(int32) | false | none | От |
to | integer(int32) | false | none | До |