Спецификация форматов и порядок обмена данными в канале «Сбербанк Интеграция» (API). Версия 33.000 - часть 8

 

  Главная      Книги - Разные     Спецификация форматов и порядок обмена данными в канале «Сбербанк Интеграция» (API). Версия 33.000

 

поиск по сайту            правообладателям  

 

   

 

    

 

содержание      ..     6      7      8      9     ..

 

 

 

Спецификация форматов и порядок обмена данными в канале «Сбербанк Интеграция» (API). Версия 33.000 - часть 8

 

 

6
@protocolVersion
Версия протокола
xs:string
Простой тип
[0..1
Актуально
XML Schema
]
с версии 27
7
Incoming
Запрос о получении
данных, подготовленных
дляУС ("ночных
Актуально
[1]
выписок", выписок,
с версии 27
тикетов после отказа в
РС, новостей)
Идентификатор
*.1
@correspondentDi
xs:long
Простой тип
последнего обновления
Актуально
ctStepId
[0..1
XML Schema
справочника
с версии 27
]
контрагентов
Идентификатор
*.2
@bicDictStepId
xs:long
Простой тип
Актуально
[0..1
последнего обновления
XML Schema
с версии 27
]
справочника БИК
Дата и время последнего
*.3
@lastIncomingTim
xs:dateTi
Простой тип
запроса Incoming(всегда
Актуально
e
me
[0..1
XML Schema
идёт во временной зоне
с версии 27
]
«Москва»)
Идентификатор
*.4
@beneficiarDictSte
xs:long
Простой тип
последнего обновления
Актуально
pId
[0..1
XML Schema
справочника
с версии 27
]
бенефициаров
Признак того, что
*.5
@includeRZKPay
BoolType
Простой тип
необходимо выгружать
Актуально
DocsRu
[0..1
XML Schema
рублевые платежные
с версии 27
]
поручения
Признак того, что
*.6
@includeRZKPay
BoolType
Простой тип
необходимо выгружать
Актуально
DocsCurr
[0..1
XML Schema
валютные платежные
с версии 27
]
поручения
Признак того, что
*.7
@includeRZKSala
BoolType
Простой тип
[0..1
Актуально
необходимо выгружать
ryDocs
XML Schema
]
с версии 27
зарплатную ведомость
Признак того, что
*.8
@includeStatement
BoolType
Простой тип
[0..1
Актуально
необходимо выгружать
s
XML Schema
]
с версии 27
выписки
Признак того, что
*.9
@includeExchange
BoolType
Простой тип
[0..1
Актуально
необходимо выгружать
MessageFromBank
XML Schema
]
с версии 27
сообщения из банка
Признак того, что
*.1
@includeNews
BoolType
Простой тип
Актуально
[0..1
необходимо выгружать
0
XML Schema
с версии 27
]
новости
Признак того, что
*.1
@includeLetterFro
BoolType
Простой тип
Актуально
[0..1
необходимо выгружать
1
mBanks
XML Schema
с версии 27
]
сообщения из банка
Признак того, что
*.1
@includePayReque
BoolType
Простой тип
Актуально
[0..1
необходимо выгружать
2
sts
XML Schema
с версии 27
]
платежные требования
Признак того, что
*.1
@includeChanged
BoolType
Простой тип
необходимо выгружать
3
Docs
XML Schema
информацию о
Актуально
[0..1
документах, принявших,
с версии 27
]
либо изменивших
финальный статус.
Признак того, что
*.1
@includeOrgSettin
BoolType
Простой тип
необходимо выгружать
Актуально
4
gs
[0..1
XML Schema
информацию об
с версии 27
]
организации
Признак того, что
*.1
@includeIntCtrlSt
BoolType
Простой тип
необходимо выгружать
5
atement
XML Schema
Добавлено
[0..1
ведомости банковского
в версии 28
]
контроля по контрактам,
кредитным договорам
Признак того, что
*.1
@includeDealPass
BoolType
Простой тип
необходимо выгружать
6
Con138I
[0..1
Актуально
XML Schema
паспорта сделок по
]
с версии 27
контракту
Признак того, что
*.1
@includeDealPass
BoolType
Простой тип
необходимо выгружать
7
Cred138I
[0..1
Актуально
XML Schema
паспорта сделок по
]
с версии 27
кредиту
Признак того, что
*.1
@includeCurrency
BoolType
Простой тип
необходимо выгружать
8
Notice
XML Schema
уведомления о
[0..1
Актуально
поступлении денежных
]
с версии 27
средств на транзитный
валютный счет
Идентификатор
*.1
dictsForDepositsDi
BoolType
Простой тип
последнего обновления
Актуально
9
ctStepId
[0..1
XML Schema
справочника
с версии 27
]
актуальных ставок
Идентификатор
*.2
cardDepositDictSte
BoolType
Простой тип
последнего обновления
Актуально
0
pId
[0..1
XML Schema
справочника карточек
с версии 27
]
депозита
*.2
cardPermBalance
Идентификатор
BoolType
Простой тип
последнего обновления
Актуально
1
DictStepId
[0..1
XML Schema
справочника карточек
с версии 27
]
НСО
Счёта, подготовленные
*.2
Accounts
выписки, по которым
2
нужно выгрузить. Для
счетов, не вошедших в
Актуально
[0..1
список, предоставлять
с версии 27
]
выписки по запросу с
данным элементом не
требуется
*.1
Account
Acc,
расширен
ие
AccNumT
[1..1
Актуально
ype
000]
с версии 27
(xs:string[
20]
RegEx:
[0-9])
*.1
@bic
БИК
BicType
БИК, 9 цифр
Актуально
[1]
с версии 27
*.2
@docNum
Номер документа
xs:string [
[0..1
Изменено в
max: 6]
]
версии 29
*.23
Orgs
Организации, письма по
[0..1
Актуально
которым нужно
]
с версии 27
выгрузить. Если список
пуст, возвращаются
только письма по
организации, указанной в
верхнем элементе
*.1
Org
UuidSepa
UUID с
[1..1
Актуально
rated
разделителями
000
с версии 27
в виде
дефисов.
Набор из 32
символов [0-9],
[a-f] или [A-F]
и дефисов
Пример
<Request xmlns='http://bssys.com/upg/request' orgId='4dd71d3b-3d16-44ce-8fb0-7a2f3626b494'
requestId='fa04ce73-0342-440a-9628-2e03aca94120' version='01.004.01' sender='Ромашка'
receiver='SBBOL_DBO'>
<Incoming correspondentDictStepId='6427827' lastIncomingTime='2015-10-07T12:02:10'/>
<Sign>
<Issuer>CN=ЛавринСВ-Тестовая печать-УЦ-9</Issuer>
<SN>74431C03FC68F0F54973</SN>
<Value>dnenujcvma20d0W4S98ucGOcXAmFUYeevq2SVUapKbY6JdjrsGE4gvN5u6myqSBi
AXjdSD3xK3ZDoF7ixWIRmg==</Value>
<PcPropHash>ECCB0C2EA8F72D3961A9BADFC5BF67A4C1E3154A59F2CC39A62F9EA69
76426481DE75A977F79BD00CDE82E059126EBAA2B496D2F5C4182EF91EB9798EF62B32E</Pc
PropHash>
<Fraud>
<Login>Тестовый Пользователь</Login>
<TokenInfo> BCRYPT;;;;;</TokenInfo>
<HttpAcceptLanguage>ru-RU</HttpAcceptLanguage>
<IpMACAddresses>10.23.168.2;C8-9C-DC-E1-19-90</IpMACAddresses>
<GeolocationInfo>;;;;4</GeolocationInfo>
<PcProp>8FBE0BC4-5F7C-11E1-AEBF-
DF3EA9FF2800;BFEBFBFF000206A7;PBAF441;
Z2AMA1FK</PcProp>
<DevicePrint>version%3D3.4.1.0_1%26pm_fpua%3DWin64%7C0%7Cx64%7Cru%7C01.005.
00%26pm_fpsc%3D32%7C1600%7C900%7C1600%26pm_fpsw%3Dabk%3D6%2C1%2C7601%2C
17514%7Cwnt%3D6%2C1%2C7601%2C18952%7Cdht%3D11%2C0%2C9600%2C18376%7Cie5%
3D%7Cibe%3D11%2C0%2C9600%2C18376%7Cieh%3D11%2C0%2C9600%2C18376%7Ciee%3D
6%2C3%2C9600%2C18376%7Cwmp%3D12%2C0%2C7601%2C19148%7Cobp%3D11%2C0%2C9
600%2C18376%7Coex%3D6%2C1%2C7601%2C17514%7Cvbs%3D5%2C6%2C0%2C8833%26pm
_fptz%3D3%26pm_fpln%3Dlang%3Dru%7Csyslang%3Dru%7Cuserlang%3Dru%26pm_fpjv%3D0%
26pm_fpco%3D0%26pm_fpasw%3D%26pm_fpan%3DSBB%26pm_fpacn%3DSBB%26pm_fpol%3
Dfalse%26pm_fposp%3D%26pm_fpup%3D%26pm_fpsaw%3D1600%26pm_fpspd%3D32%26pm_f
psbd%3D%26pm_fpsdx%3D96%26pm_fpsdy%3D96%26pm_fpslx%3D96%26pm_fpsly%3D96%26
pm_fpsfse%3Dfalse%26pm_fpsui%3D%26pm_os%3DWindows%26pm_brmjv%3D01.005.00%26pm
_br%3DSBB%26pm_inpt%3D%26pm_expt%3D</DevicePrint>
</Fraud>
<Order>0</Order>
<SignDate>2016-08-22T13:12:25</SignDate>
</Sign>
<Fraud>
<Login>Тестовый Пользователь</Login>
<TokenInfo> BCRYPT;;;;;</TokenInfo>
<HttpAcceptLanguage>ru-RU</HttpAcceptLanguage>
<IpMACAddresses>10.23.168.2;C8-9C-DC-E1-19-90</IpMACAddresses>
<GeolocationInfo>;;;;4</GeolocationInfo>
<PcProp>8FBE0BC4-5F7C-11E1-AEBF-
DF3EA9FF2800;BFEBFBFF000206A7;PBAF441;
Z2AMA1FK</PcProp>
</Fraud>
</Request>
2.6.3.2. Формат передачи изменений документа со стороны
СББОЛ
Response/ChangedDocs
Версионнос
Элемент
Описание элемента
Тип
Описание типа
Мн.
ть
Ответ СББОЛ на запрос
Response
Response
Актуально
[1]
УС
с версии 27
Дата и время
Простой тип
1
@createTime
xs:dateTi
формирования ответа
XML Schema
me
местному по времени
[0..1
Актуально
запрашивающего
]
с версии 27
сервера, с указанием его
часового пояса
Уникальный
UUID с
2
@responseId
UuidSepa
идентификатор ответа
разделителями
rated
в виде дефисов.
[0..1
Актуально
Набор из 32
]
с версии 27
символов [0-9],
[a-f] и дефисов
Идентификатор запроса,
UUID с
3
@requestId
UuidSepa
в результате которого
разделителями
rated
был сформирован
в виде дефисов.
[0..1
Актуально
данный ответ
Набор из 32
]
с версии 27
символов [0-9],
[a-f] и дефисов
Номер версии формата
Простой тип
4
@version
xs:string
обмена
XML Schema
RegEx:
[0..1
Актуально
"[0-
]
с версии 27
9\.]{1,20}
"
Система-отправитель
Простой тип
5
@sender
xs:string
XML Schema
RegEx:
«[-a-zA-Z
[0..1
Актуально
а-яА-Я0-
]
с версии 27
9:
_]{1,20}»
Система-получатель.
Простой тип
6
@receiver
xs:string
Если система
XML Schema
RegEx:
получатель СББОЛ, то
«[-a-zA-Z
[0..1
Актуально
SBBOL_DBO
а-яА-Я0-
]
с версии 27
9:
_]{1,20}»
Измененные документы
7
ChangedDocs
[0..1
Актуально
]
с версии 27
Идентификатор
UUID с
*.1
docId
UuidSepa
измененного документа
разделителями
rated
в виде дефисов.
[0..n
Актуально
Набор из 32
]
с версии 27
символов [0-9],
[a-f] и дефисов
*.2
Sign
DigitalSig
[0..1
Актуально
n
]
с версии 27
Идентификатор
Простой тип
*.1
Issuer
xs:string
поставщика сертификата
XML Schema
[min:1;
Например, "
max:1024
[0..1
Актуально
issuer="E=IdleCA,
]
]
с версии 27
C=RU, S=Idle CA, L=Idle
CA, O=Idle CA, OU=Idle
CA, CN=Idle CA" "
Серийный номер
Простой тип
*.2
SN
xs:string
[0..1
Актуально
сертификата
XML Schema
[min:1;
]
с версии 27
max:255]
Значение ЭП
Простой тип
*.3
Value
xs:base64
[0..1
Актуально
XML Schema
Binary
]
с версии 27
Имя схемы подписи
Простой тип
[0..1
Актуально
*.4
DigestName
xs:string
XML Schema
]
с версии 27
Версия схемы подписи
Простой тип
[0..1
Актуально
*.5
DigestVersion
xs:string
XML Schema
]
с версии 27
Пример
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response sender="DBO" version="7" requestId="fa04ce73-0342-440a-9628-2e03aca94120"
responseId="14433273-3586-48ee-b741-99ae837f77e6" createTime="2015-10-08T13:20:02.164+03:00"
xmlns="http://bssys.com/upg/response">
<ChangedDocs>
<docId>6d0211fe-4f91-4d34-a3c7-01e45123c00d</docId>
<docId>06d8ff19-8d7b-44d7-ae1b-83992c12e598</docId>
<docId>95621e93-7f00-4ec9-bde7-60485d0678d6</docId>
<docId>7eb67d0e-ef5b-4b2f-aaeb-d30ca76df53e</docId>
<Sign>
<Issuer>CN = УЦ Сбербанка России,O = ОАО "Сбербанк России",C = RU</Issuer>
<SN>3032313531343839</SN>
<Value>LtCYog2/fj9gcUgTaG88DVNBkkfWWDdSrWLjm5jWSn1mU4p1BEoCP4Lddo1gbnpXsK92kr
3yu1zNakKcmW+s7w==</Value>
<DigestName>for_upg</DigestName>
<DigestVersion>1</DigestVersion>
</Sign>
</ChangedDocs>
</Response>
2.7. Обеспечение возможности внесения средств через
устройства самообслуживания Банка
2.7.1.Общие сведения
Для использования данного функционала у организации на стороне Банка должен быть
заведен договор о «Приёме денежной наличности через устройства
самообслуживания и её зачислении на счета корпоративных клиентов ПАО Сбербанк».
В СББОЛ для этого функционала присутствуют 2 типа документов:
1) Вносители средств
2) Шаблоны внесения средств
А также справочники:
1) Справочник торговых точек организации (для АДМ(Автоматических депозитных машин)
2) Журнал операций внесения средств
3) История изменений вносителей средств и шаблонов
Оба типа документов можно добавлять/редактировать/удалять посредством отправки
запросов в УПШ: Request/AdmCashierAdd, Request/ADMCashierDel и
Request/AdmPayTemplate, Request/AdmPayTemplateDel соответственно. Кроме того,
можно запрашивать существующие документы обоих типов из СББОЛ: соответственно
Request/AdmCashierList и Request/AdmPayTemplateList
Подтвержденный шаблон внесения средств возможно редактировать, отправив запрос
Request/AdmPayTemplate с соответствующим docId подтвержденного шаблона.
После добавления вносителя и шаблона внесения вноситель в устройстве для внесения
наличных средств (банкомате) проходит аутентификацию по логину, полученному из
УПШ по запросу Request/AdmCashierGetLogin, и паролю, сгенерированному по запросу
Request/AdmGenSMSPass и направленному вносителю по SMS. После чего вноситель
может выбрать шаблон внесения и внести средства.
2.7.2.Дайджест добавления/редактирования «Вносители средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста запроса:
№
Пример
Версионнос
Наименование поля
Описание
п/п
значения
ть
ATTRIBUTES
Актуально с
1.
<Наименование полях=<Значение полях, например
версии 27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
OrgId
Идентификатор организации
963084ba-7079-
в ДБО (может быть
4b9d-bbab-
использован сторонней
c4972dee82d9
Актуально с
2.
системой для
версии 27
дополнительной
идентификации)
Sender
Отправитель, а также тип
Ромашка
использованного Клиентом
Актуально с
3.
программного обеспечения
версии 27
при отправке документа
ExtId
Уникальный* идентификатор
3a6378ef-07ee-
документа в учетной системе
4535-a10a-
(УС) Клиента.
0c82817cae23
Актуально с
4.
версии 27
*Уникальность
контролируется на стороне
банка
FIELDS
<Наименование полях=<Значение полях, например
Актуально с
5.
версии 27
AccDoc.AccDocNo=444
После последней строки НЕ делать перевод строки
ФИО вносителя
CashierInfo.FullName
Иванов Иван
Актуально с
6.
Иванович
версии 27
Актуально с
7.
Номер телефона
79299985566
CashierInfo.Phone
версии 27
Актуально с
PowerOfAttorneyInfo.Nu
8.
Номер доверености
1258
версии 27
mber
Устройства
Актуально с
9.
ADM
DeviceInfo.DeviceType
самообслуживания
версии 27
2.7.3.Формат взаимодействия при добавлении/редактировании
«Вносители средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmCashierAdd
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
2.7.3.1. Формат отправки запроса в СББОЛ
Request/AdmCashierAdd
Описание
Версионнос
Элемент
Описание элемента
Тип
Мн.
типа
ть
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии 27
1
@requestId
Уникальный
UuidSeparated
UUID с
идентификатор запроса
разделителям
и в виде
дефисов.
Актуально
[1]
Набор из 32
с версии 27
символов [0-
9], [a-f] и
дефисов
2
@orgId
Идентификатор
UuidSeparated
UUID с
организации в ДБО
разделителям
(может быть
и в виде
использован сторонней
дефисов.
Актуально
[1]
системой для
Набор из 32
с версии 27
дополнительной
символов [0-
идентификации)
9], [a-f] и
дефисов
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии 27
9\.]{1,20}
4
@sender
Система-отправитель
xs:string
RegEx: [-a-
Актуально
[1]
zA-Zа-яА-Я0-
с версии 27
9: _]{1,20}
5
@receiver
Система-получатель
xs:string
Если система
RegEx: [-a-
[0..1
Актуально
получатель СББОЛ, то
zA-Zа-яА-Я0-
]
с версии 27
SBBOL_DBO
9: _]{1,20}
6
@protocolVersion
Версия протокола
xs:string
Простой тип
[0..1
Актуально
XML Schema
]
с версии 27
7
AdmCashierAdd
Вносители средств
AdmCashier
Запрос на
добавление/р
едактировани
Актуально
[1]
е документа
с версии 27
Вносители
средств
*.1
@docId
Идентификатор
UuidSeparated
UUID с
сущности в СББОЛ.
разделителям
При отсутствии
и в виде
идентификатора -
дефисов.
СББОЛ будет создана
Набор из 32
новая запись. При
символов [0-
[0..1
Актуально
наличии
9], [a-f] и
]
с версии 27
идентификатора - в
дефисов
СББОЛ будет
произведено изменение
существующей записи
с данным id
*.2
@docExtId
UuidSeparated
UUID с
Уникальный*
разделителям
идентификатор
и в виде
документа в учетной
дефисов.
Актуально
[1]
системе (УС) Клиента.
Набор из 32
с версии 27
*Уникальность
символов [0-
контролируется на
9], [a-f] и
стороне банка
дефисов
*.3
CashierInfo
Актуально
[1]
с версии 27
*.1
@fullName
ФИО вносителя
xs:string [min:
[0..1
Актуально
1, max: 255]
]
с версии 27
*.2
@dateOfBirth
Дата рождения
xs:date
[0..1
Актуально
]
с версии 27
*.3
@phone
Номер телефона
xs:string [min:
Актуально
[1]
1, max: 11]
с версии 27
*.4
@blocked
Блокировка вносителя,
BoolType
Двоичное
1 - признак установлен,
значение: 0
Актуально
[1]
0 - признак не
или 1
с версии 27
установлен.
*.5
@agreeSavePD
Согласие на обработку
BoolType
Двоичное
[0..1
Актуально
персональных данных
значение: 0
]
с версии 27
или 1
*.6
DocInfo
Реквизиты вносителя
[0..1
Актуально
для УС
]
с версии 27
*.1
@docType
Вид документа,
xs:string
содержит следующие
enum:
значения:
PassportOfRu
ssia
PassportOfRussia -
ForeignPasspo
Паспорт гражданина
rt
РФ
OtherKindOf
[0..1
Актуально
Document
]
с версии 27
ForeignPassport-
Паспорт иностранного
гражданина
OtherKindOfDocument -
Другой вид документа
*.2
@citizenship
Цифровой Код в
xs:string [min:
соответствии с
1, max: 3]
Общероссийским
классификатором
[0..1
Актуально
]
с версии 27
стран мира OK (MK
(ИСО 3166) 004-97)
025-2001 (ОКСМ)
*.3
@docSeries
Серия документа
xs:string [min:
[0..1
Актуально
1, max: 20]
]
с версии 27
*.4
@docNumb
Номер документа
xs:string [min:
[0..1
Актуально
1, max: 20]
]
с версии 27
*.5
@docIssueDt
Дата выдачи
xs:date
[0..1
Актуально
]
с версии 27
*.6
@docIssuePl
Кем выдан
xs:string [min:
[0..1
Актуально
ace
1, max: 100]
]
с версии 27
*.7
@docIssueC
Код подразделения
xs:string [min:
[0..1
Актуально
ode
1, max: 15]
]
с версии 27
*.8
@docName
Наименование другого
xs:string [min:
[0..1
Актуально
документа
1, max: 100]
]
с версии 27
*.9
@citizenship
Наименование страны
xs:string
[0..1
Актуально
CountryNam
гражданства
[max:100]
]
с версии 27
e
*.4
PowerOfAttorneyInf
Информация по
[0..1
Актуально
o
доверенности
]
с версии 27
*.1
@beginDate
Дата начала действия
xs:date
[0..1
Актуально
]
с версии 27
*.2
@endDate
Дата окончания
xs:date
[0..1
Актуально
действия
]
с версии 27
*.3
@currentLimit
Суточный лимит
xs:decimal
[0..1
Актуально
вносителя
]
с версии 27
(оставшийся)
*.4
@limit
Суточный лимит
xs:decimal
[0..1
Актуально
вносителя
]
с версии 27
*.5
@number
Номер доверености
xs:string
[0..1
Актуально
[max: 1000]
]
с версии 27
*.5
DeviceInfo
Информация об
Актуально
устройстве внесения
[1]
с версии 27
средств
*.1
@deviceType
Устройства
AdmDeviceTy
Устройства
самообслуживания:
pe
самообслужи
ADM - "Устройства
вания: ADM -
самообслуживания на
"Устройства
территории Клиента
самообслужи
(АДМ)", US -
вания на
Актуально
[1]
"Устройство
территории
с версии 27
самообслуживания
Клиента
(УС)"
(АДМ)", US -
"Устройство
самообслужи
вания (УС)"
*.2
@tradePointNa
Торговая точка для
xs:string
[0..1
Актуально
me
устройства
[max: 128]
]
с версии 27
самообслуживания
*.6
ADMTemplates
Шаблоны внесения
Актуально
[1]
средств
с версии 27
*.1
Template
Шаблоны внесения
[1..n
Актуально
средств
]
с версии 27
*.1
@templateI
Идентификатор
UuidSeparated
UUID с
d
шаблона внесения
разделителям
средств
и в виде
дефисов.
[0..1
Актуально
Набор из 32
]
с версии 27
символов [0-
9], [a-f] и
дефисов
2.7.3.2. Особенности получения статусов об обработке из СББОЛ
Информация об обработке документа доставляется в УС:
1. Без запроса со стороны УС:
a. В ответ на отправленный документ СББОЛ отправляет сообщение в формате
Response/Tickets, в котором передается:
 Tickets/Ticket@docId
- Идентификатор документа, с помощью которого
впоследствии можно запрашивать со стороны УС в формате
Request/DocIds/DocId - все последующие статусы обработки докуемнта.
 Tickets/Ticket/Info@statusStateCode="DELIVERED".
2. Путем запроса со стороны УС в формате Request/DocIds/DocId:
a. Имея данные идентификатора документа, которые были получены с первым
сообщением Response/Tickets -> СББОЛ передает текущее состояние документа.
 Tickets/Ticket/Info/BankDate/@statusDateTime
- дата и время присвоения
статуса.
Статусы обработки документа, передаваемые со стороны СББОЛ в УПШ в рамках
Response/Tickets:
Статус /системное
№
Версионно
название статуса на
Сообщение
Комментарий
п/п
сть
англ. яз.
Запись добавлена в справочник
Доставлен/DELIVER
Актуально с
1.
-
Вносителей средств, требуется
ED
версии 27
подтверждение по SMS
Запись в справочнике Вносителей
Актуально с
2.
Принят/ACCEPTED
-
средств подтверждена по SMS
версии 27
Ошибка реквизитов/
ЭД не прошел логические контроли
Актуально с
3.
FAIL
REQUISITE_ERROR
СББОЛ при приеме на стороне Банка
версии 27
Необходимы
ЭД не прошел логические контроли
Актуально с
4.
FAIL
исправления/
СББОЛ при приеме на стороне Банка,
версии 27
CHECK_ERROR
документ доступен на редактирование
Актуально с
5.
Удален/DELITED
-
ЭД удален Пользователем
версии 27
2.7.4.Дайджест запроса на удаление сущности «Вноситель
средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста запроса:
№
Наименование
Пример
Версионно
Описание
п/п
поля
значения
сть
1.
ATTRIBUTES
Актуально
<Наименование полях=<Значение полях, например
с версии
27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
Идентификатор организации в ДБО
963084ba-
OrgId
Актуально
(может быть использован сторонней
7079-4b9d-
с версии
системой для дополнительной
bbab-
27
идентификации)
c4972dee82d9
3.
Отправитель, а также тип
Ромашка
Sender
Актуально
использованного Клиентом
с версии
программного обеспечения при
27
отправке документа
4.
FIELDS
Актуально
<Наименование полях=<Значение полях, например
с версии
AccDoc.AccDocNo=444
27
После последней строки НЕ делать перевод строки
5.
DocId
Идентификатор документа
863054ba-
6666-4gts-
Актуально
bbab-
с версии
c49234deegsd
27
9
2.7.5.Формат запроса на удаление сущности «Вноситель средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmCashierDel
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
2.7.5.1. Формат отправки запроса в СББОЛ
Request/AdmCashierDel
Версионнос
Элемент
Описание элемента
Тип
Описание типа
Мн.
ть
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии 27
1
@requestId
Уникальный идентификатор
UuidSeparated
UUID с
запроса
разделителями
в виде
Актуально
дефисов.
[1]
с версии 27
Набор из 32
символов [0-9],
[a-f] и дефисов
2
@orgId
Идентификатор организации
UuidSeparated
UUID с
в ДБО (может быть
разделителями
использован сторонней
в виде
Актуально
системой для
дефисов.
[1]
с версии 27
дополнительной
Набор из 32
идентификации)
символов [0-9],
[a-f] и дефисов
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии 27
9\.]{1,20}
4
@sender
Система-отправитель
xs:string
RegEx: [-a-
Актуально
[1]
zA-Zа-яА-Я0-
с версии 27
9: _]{1,20}
5
@receiver
Система-получатель Если
xs:string
система получатель СББОЛ,
RegEx: [-a-
[0..1
Актуально
то SBBOL_DBO
zA-Zа-яА-Я0-
]
с версии 27
9: _]{1,20}
6
@protocolVersi
Версия протокола
xs:string
Простой тип
[0..1
Актуально
on
XML Schema
]
с версии 27
7
AdmCashierDel
Запрос на удаление
Актуально
сущности «Вноситель
[1]
с версии 27
средств»
*.1
@docId
UuidSeparated
UUID с
разделителями
в виде
Актуально
дефисов.
[1]
с версии 27
Набор из 32
символов [0-9],
[a-f] и дефисов
*.2
@docExtId
Идентификатор сущности в
UuidSeparated
UUID с
УС.
разделителями
в виде
дефисов.
Актуально
[1]
Набор из 32
с версии 27
символов [0-9],
[a-f] или [A-F]
и дефисов
2.7.6.Дайджест списка сущностей «Вноситель средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста:
№
Наименование
Пример
Версионно
Описание
п/п
поля
значения
сть
1.
ATTRIBUTES
Актуально
<Наименование полях=<Значение полях, например
с версии
27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор организации в ДБО
963084ba-7079-
Актуально
(может быть использован сторонней
4b9d-bbab-
с версии
системой для дополнительной
c4972dee82d9
27
идентификации)
3.
FIELDS
Актуально
<Наименование полях=<Значение полях, например
с версии
AccDoc.AccDocNo=444
27
После последней строки НЕ делать перевод строки
4.
StepId
Идентификатор последнего
155
Актуально
обновления справочника
с версии
27
5.
TABLES
Актуально
с версии
27
6.
TABLE=CashierInf
Разделитель строк таблицы - # ,
Актуально
o
сортировка по DocId
с версии
27
7.
6d463ref-07ee-
Актуально
DocId
Идентификатор документа
4535-a10a-
с версии
0c82817cae23
27
8.
FullName
ФИО вносителя
Актуально
Иванов Иван
с версии
Иванович
27
9.
Login
Логин вносителя
Актуально
73564892
с версии
27
2.7.7.Формат взаимодействия при получении списка сущностей
«Вноситель средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmCashierList
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/AdmCashiers
2.7.7.1. Формат отправки запроса в СББОЛ
Request/AdmCashierList
Описание
Версионност
Элемент
Описание элемента
Тип
Мн.
типа
ь
Request
Запрос УС к СББОЛ
Request
Актуально с
[1]
версии 27
1
@requestId
Уникальный идентификатор
UuidSeparat
UUID с
запроса
ed
разделителя
ми в виде
дефисов.
Актуально с
[1]
Набор из 32
версии 27
символов
[0-9], [a-f] и
дефисов
2
@orgId
Идентификатор организации в
UuidSeparat
UUID с
ДБО (может быть использован
ed
разделителя
сторонней системой для
ми в виде
дополнительной
дефисов.
Актуально с
[1]
идентификации)
Набор из 32
версии 27
символов
[0-9], [a-f] и
дефисов
3
@version
Номер версии формата обмена
xs:string
Актуально с
RegEx: [0-
[1]
версии 27
9\.]{1,20}
4
@sender
Система-отправитель
xs:string
RegEx: [-a-
Актуально с
zA-Zа-яА-
[1]
версии 27
Я0-9:
_]{1,20}
5
@receiver
Система-получатель Если
xs:string
система получатель СББОЛ,
RegEx: [-a-
[0..1
Актуально с
то SBBOL_DBO
zA-Zа-яА-
]
версии 27
Я0-9:
_]{1,20}
6
@protocolVersio
Версия протокола
xs:string
Простой тип
[0..1
Актуально с
n
XML
]
версии 27
Schema
7
AdmCashierList
Запрос списка документов
AdmCashie
Запрос
вносители средств
rList
списка
Актуально с
документов
[1]
версии 27
"Вносители
средств"
*.1
@stepId
Идентификатор последнего
xs:long
обновления справочника или
[0..1
Актуально с
пустой идентификатор, если
]
версии 27
нужна полная репликация
справочника
2.7.7.2. Формат ответа из СББОЛ
Response/AdmCashiers
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Ответ СББОЛ на
Response
Актуально
запрос УС
[1]
с версии
27
1
@createTime
Дата и время
xs:dateTi
формирования ответа
me
Актуально
местному по времени
[1]
с версии
запрашивающего
27
сервера, с указанием
его часового пояса
2
@responseId
Уникальный
UuidSepa
UUID с
идентификатор ответа
rated
разделител
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
3
@requestId
Идентификатор
UuidSepa
UUID с
запроса, в результате
rated
разделител
которого был
ями в виде
сформирован данный
дефисов.
Актуально
ответ
Набор из
[1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
4
@version
Номер версии
xs:string
Актуально
формата обмена
RegEx:
[1]
с версии
[0-
27
9\.]{1,20}
5
@sender
Система-отправитель
xs:string
RegEx: [-
Актуально
[0..1
a-zA-Zа-
с версии
]
яА-Я0-9:
27
_]{1,20}
6
@receiver
Система-получатель.
xs:string
Если система
RegEx: [-
Актуально
[0..1
получатель СББОЛ,
a-zA-Zа-
с версии
]
то SBBOL_DBO
яА-Я0-9:
27
_]{1,20}
7
choice: должен присутствовать один из перечисленных ниже элементов
Актуально
[1]
с версии
27
*.1
AdmCashiers
Список вносителей
AdmCas
Шаблоны
Актуально
средств
hiers
внесения
[1]
с версии
средств
27
*.1
@stepId
Идентификатор
xs:long
Актуально
последнего
[1]
с версии
обновления
27
справочника
*.2
AdmCashier
AdmCas
Запрос на
hier
добавлени
е/редактир
Актуально
[0..n
ование
с версии
]
документа
27
Вносители
средств
*.1
@docId
Идентификатор
UuidSepa
UUID с
сущности в СББОЛ.
rated
разделител
При отсутствии
ями в виде
идентификатора -
дефисов.
СББОЛ будет создана
Набор из
новая запись. При
32
Актуально
наличии
символов
[1]
с версии
идентификатора - в
[0-9], [a-f]
27
СББОЛ будет
и дефисов
произведено
изменение
существующей
записи с данным id
*.2
all: должны присутствовать все перечисленные ниже элементы
Актуально
[1]
с версии
27
*.1
CashierInfo
Актуально
[1]
с версии
27
*.1
@fullName
ФИО вносителя
xs:string
Актуально
[min: 1,
[1]
с версии
max: 255]
27
*.2
@dateOfBirt
Дата рождения
xs:date
Актуально
[0..1
h
с версии
]
27
*.3
@login
Логин вносителя
xs:string
Актуально
[min: 1,
[1]
с версии
max: 9]
27
*.4
@phone
Номер телефона
xs:string
Актуально
[min: 1,
[1]
с версии
max: 11]
27
*.5
@blocked
Блокировка
BoolType
Двоичное
вносителя, 1 -
значение:
Актуально
признак установлен, 0
0 или 1
[1]
с версии
- признак не
27
установлен.
*.6
@doc
Номер ДУЛ
xs:string
Актуально
[255]
[1]
с версии
27
*.7
DocInfo
Реквизиты вносителя
Актуально
для УС
[1]
с версии
27
*.1
@docType
Вид документа,
xs:string
содержит следующие
[min: 1,
значения:
max: 15]
PassportOfRussia -
Паспорт гражданина
РФ
Актуально
ForeignPassport-
[1]
с версии
Паспорт
27
иностранного
гражданина
OtherKindOfDocument
- Другой вид
документа
*.2
@citizens
Цифровой Код в
xs:string
hip
соответствии с
[min: 1,
Общероссийским
max: 3]
Актуально
классификатором
[1]
с версии
стран мира OK (MK
27
(ИСО 3166) 004-97)
025-2001 (ОКСМ)
*.3
@docSerie
Серия документа
xs:string
Актуально
[0..1
s
[min: 1,
с версии
]
max: 20]
27
*.4
@docNum
Номер документа
xs:string
Актуально
b
[min: 1,
[1]
с версии
max: 20]
27
*.5
@docIssue
Дата выдачи
xs:date
Актуально
Dt
[1]
с версии
27
*.6
@docIssue
Кем выдан
xs:string
Актуально
Place
[min: 1,
[1]
с версии
max: 100]
27
*.7
@docIssue
Код подразделения
xs:string
Актуально
[0..1
Code
[min: 1,
с версии
]
max: 15]
27
*.8
@docNam
Наименование
xs:string
Актуально
e
другого документа
[min: 1,
[1]
с версии
max: 100]
27
*.2
PowerOfAttorneyI
Информация по
Актуально
[0..1
nfo
доверенности
с версии
]
27
*.1
@beginDate
Дата начала действия
xs:date
Актуально
[0..1
с версии
]
27
*.2
@endDate
Дата окончания
xs:date
Актуально
[0..1
действия
с версии
]
27
*.3
@currentLim
Суточный лимит
xs:decima
Актуально
[0..1
it
вносителя
l
с версии
]
(оставшийся)
27
*.4
@limit
Суточный лимит
xs:decima
Актуально
[0..1
вносителя
l
с версии
]
27
*.5
@number
Номер доверености
xs:string
Актуально
[0..1
[max:
с версии
]
1000]
27
*.3
DeviceInfo
Информация об
Актуально
устройстве внесения
[1]
с версии
средств
27
*.1
@deviceType
Устройства
String[10]
самообслуживания:
ADM - "Устройства
самообслуживания на
Актуально
территории Клиента
[1]
с версии
(АДМ)", US -
27
"Устройство
самообслуживания
(УС)"
*.2
@tradePoint
Торговая точка для
xs:string
Актуально
[0..1
Name
устройства
[max:
с версии
]
самообслуживания
128]
27
*.4
ADMTemplates
Шаблоны внесения
Актуально
средств
[1]
с версии
27
*.1
Template
Шаблоны внесения
Актуально
[1..n
средств
с версии
]
27
*.1
@templat
Идентификатор
UuidSepa
UUID с
eId
шаблона внесения
rated
разделител
средств
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
2.7.8.Формат взаимодействия при получении логина Вносителя
средств
Дайджест: не формируется
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmCashierGetLogin
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/AdmCashierLogin
2.7.8.1. Формат отправки запроса в СББОЛ
Request/AdmCashierGetLogin
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии
27
1
@requestId
Уникальный идентификатор
UuidSeparated
UUID с
запроса
разделителям
и в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
2
@orgId
Идентификатор организации
UuidSeparated
UUID с
в ДБО (может быть
разделителям
использован сторонней
и в виде
Актуально
системой для
дефисов.
[1]
с версии
дополнительной
Набор из 32
27
идентификации)
символов [0-
9], [a-f] и
дефисов
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии
9\.]{1,20}
27
4
@sender
Система-отправитель
xs:string
Актуально
RegEx: [-a-
[1]
с версии
zA-Zа-яА-Я0-
27
9: _]{1,20}
5
@receiver
Система-получатель Если
xs:string
Актуально
система получатель СББОЛ,
RegEx: [-a-
[0..1
с версии
то SBBOL_DBO
zA-Zа-яА-Я0-
]
27
9: _]{1,20}
6
@protocolVersion
Версия протокола
xs:string
Простой тип
Актуально
[0..1
XML Schema
с версии
]
27
7
AdmCashierGetLogi
Запрос логина «Вносителя
AdmCashier
Запрос
Актуально
n
средств»
GetLogin
логина
[1]
с версии
«Вносителя
27
средств»
*.1
@docId
Идентификатор сущности
UuidSeparated
UUID с
«Вноситель средств»
разделителям
и в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
2.7.8.2. Формат ответа из СББОЛ
Response/AdmCashierLogin
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Ответ СББОЛ на запрос УС
Response
Актуально
[0..1
с версии
]
27
1
@createTime
Дата и время
xs:dateTime
формирования ответа
Актуально
местному по времени
[0..1
с версии
запрашивающего сервера, с
]
27
указанием его часового
пояса
2
@responseId
Уникальный
UuidSeparated
UUID с
идентификатор ответа
разделителями
в виде
Актуально
[0..1
дефисов.
с версии
]
Набор из 32
27
символов [0-9],
[a-f] и дефисов
3
@requestId
Идентификатор запроса, в
UuidSeparated
UUID с
результате которого был
разделителями
сформирован данный ответ
в виде
Актуально
[0..1
дефисов.
с версии
]
Набор из 32
27
символов [0-9],
[a-f] и дефисов
4
@version
Номер версии формата
xs:string
Актуально
[0..1
обмена
RegEx: [0-
с версии
]
9\.]{1,20}
27
5
@sender
Система-отправитель
xs:string
Актуально
RegEx: [-a-zA-
[0..1
с версии
Zа-яА-Я0-9:
]
27
_]{1,20}
6
@receiver
Система-получатель. Если
xs:string
Актуально
система получатель
RegEx: [-a-zA-
[0..1
с версии
СББОЛ, то SBBOL_DBO
Zа-яА-Я0-9:
]
27
_]{1,20}
7
AdmCashierLogi
Передача логина вносителя
AdmCashierLog
Передача
Актуально
n
средств в УС
in
логина
[0..1
с версии
вносителя
]
27
средств в УС
*.1
@docId
Идентификатор сущности
UuidSeparated
UUID с
«Вноситель средств»
разделителями
в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов [0-9],
[a-f] и дефисов
*.2
@login
Логин вносителя
xs:string [min: 1,
Актуально
max: 9]
[1]
с версии
27
2.7.9.Дайджест запроса на добавление/редактирование «Шаблона
внесения средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста запроса:
№
Версионнос
п/
Наименование поля
Описание
Пример значения
ть
п
1.
ATTRIBUTES
Актуально с
<Наименование полях=<Значение полях, например
версии 27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор
963084ba-7079-4b9d-
организации в ДБО
bbab-c4972dee82d9
(может быть использован
Актуально с
сторонней системой для
версии 27
дополнительной
идентификации)
3.
Sender
Отправитель, а также тип
Ромашка
использованного
Актуально с
Клиентом программного
версии 27
обеспечения при
отправке документа
4.
ExtId
3a6378ef-07ee-4535-
Уникальный*
a10a-0c82817cae23
идентификатор
документа в учетной
Актуально с
системе (УС) Клиента.
версии 27
*Уникальность
контролируется на
стороне банка
5.
FIELDS
<Наименование полях=<Значение полях, например
Актуально с
версии 27
AccDoc.AccDocNo=444
После последней строки НЕ делать перевод строки
6.
DocId
Идентификатор
863054ba-6666-4gts-
Актуально с
документа в СББОЛ
bbab-c49234deegsd9
версии 27
7.
TemplateInfo.DeviceTy
Тип устройства
ADM
Актуально с
pe
самообслуживания
версии 27
8.
TemplateInfo.Name
Наименование шаблона
Зачисление на
Актуально с
расчетный счет
версии 27
9.
PayeeInfo.PayeeName
Наименование
АО «Ясеньͩ
Актуально с
организации
версии 27
10.
PayeeInfo.AccNum
Номер счета
402078106000445505
Актуально с
48
версии 27
PayeeInfo.Bic
БИК
040008965
Изменено в
версии 29
11.
PayeeInfo.AdditionalInf
Дополнительная
Внесение средств
Актуально с
o
информация к
версии 27
назначению платежа
12.
Budget.BbudgetAccoun
Лицевой счет
402078106022445588
Актуально с
t
бюджетополучателя
88
версии 27
13.
Budget.BudgetInn
ИНН бюджетополучателя
2548963215
Актуально с
версии 27
14.
Budget.BudgetName
Наименование
ПАО «Штильͩ
Актуально с
бюджетополучателя
версии 27
2.7.10.
Формат запроса на добавление/редактирование
«Шаблона внесения средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmPayTemplate
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
Request/AdmPayTemplate
Описание
Версионно
Элемент
Описание элемента
Тип
Мн.
типа
сть
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии 27
1
@requestId
Уникальный
UuidSepa
UUID с
идентификатор запроса
rated
разделител
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии 27
32
символов
[0-9], [a-f]
и дефисов
2
@orgId
Идентификатор
UuidSepa
UUID с
организации в ДБО
rated
разделител
(может быть
ями в виде
использован сторонней
дефисов.
Актуально
системой для
Набор из
[1]
с версии 27
дополнительной
32
идентификации)
символов
[0-9], [a-f]
и дефисов
3
@version
Номер версии формата
xs:string
обмена
RegEx:
Актуально
[1]
[0-
с версии 27
9\.]{1,20}
4
@sender
Система-отправитель
xs:string
RegEx: [-
Актуально
a-zA-Zа-
[1]
с версии 27
яА-Я0-9:
_]{1,20}
5
@receiver
Система-получатель
xs:string
Если система
RegEx: [-
[0..1
Актуально
получатель СББОЛ, то
a-zA-Zа-
]
с версии 27
SBBOL_DBO
яА-Я0-9:
_]{1,20}
6
@protocolVersion
Версия протокола
xs:string
Простой
[0..1
Актуально
тип XML
]
с версии 27
Schema
7
AdmPayTemplate
Шаблоны внесения
AdmPay
Работа со
средств
mentTem
справочни
plate
ком
Актуально
[1]
Шаблоны
с версии 27
внесения
средств
*.1
@docId
Идентификатор
UuidSepa
UUID с
сущности в СББОЛ.
rated
разделител
При отсутствии
ями в виде
идентификатора -
дефисов.
СББОЛ будет создана
Набор из
новая запись. При
32
[0..1
Актуально
наличии
символов
]
с версии 27
идентификатора - в
[0-9], [a-f]
СББОЛ будет
и дефисов
произведено изменение
существующей записи
с данным id
*.2
@docExtId
UuidSepa
UUID с
Уникальный*
rated
разделител
идентификатор
ями в виде
документа в учетной
дефисов.
Актуально
системе (УС) Клиента.
Набор из
[1]
с версии 27
*Уникальность
32
контролируется на
символов
стороне банка
[0-9], [a-f]
и дефисов
*.3
@GenSMSSign
Сгенерировать SMS-
xs:string
код для подтверждения
[lenght: 1]
[0..1
Актуально
записи
]
с версии 27
1- генерировать, 0 - не
генерировать
*.4
all: должны присутствовать все перечисленные ниже элементы
Актуально
[1]
с версии 27
*.1
TemplateInfo
Информация об
Актуально
устройстве внесения
[1]
с версии 27
средств
*.1
@deviceType
Устройства
AdmDevi
Устройства
самообслуживания:
ceType
самообслу
ADM - "Устройства
живания:
самообслуживания на
ADM -
территории Клиента
"Устройств
(АДМ)", US -
а
"Устройство
самообслу
самообслуживания
живания на
[0..1
Актуально
(УС)"
территории
]
с версии 27
Клиента
(АДМ)",
US -
"Устройств
о
самообслу
живания
(УС)"
*.2
@name
Наименование
xs:string
Актуально
шаблона
[max:
[1]
с версии 27
128]
*.2
PayeeInfo
Актуально
[1]
с версии 27
*.1
@payeeName
Наименование
xs:string
Изменено в
[max:
[1]
версии 30
380160]
*.2
@payeeInn
ИНН
xs:string
Актуально
[1]
с версии 27
*.3
@payeeKpp
КПП
xs:string
[0..1
Актуально
]
с версии 27
*.4
@enrollmentForBu
признак "Зачисление
BoolType
Двоичное
dget
для
значение: 0
бюджетополучателя", 1
или 1
Актуально
[1]
- признак установлен, 0
с версии 27
- признак не
установлен
*.5
@additionalInfo
Дополнительная
xs:string
[0..1
Актуально
информация к
[max:
]
с версии 27
назначению платежа
255]
*.6
all: должны присутствовать все перечисленные ниже элементы
Актуально
[1]
с версии 27
*.
Account
Реквизиты счета
Актуально
[1]
1
с версии 27
@accNum
AccNumT
Номер
ype
счёта или
Актуально
1
корр.
[1]
с версии 27
счёта, 20
цифр
all: должны присутствовать все перечисленные ниже
Актуально
элементы
[1]
с версии 27
2
Bank
Реквизиты банка, в
Актуально
котором открыт счёт
[1]
с версии 27
1
*.
@bic
БИК
BicType
БИК, 9
Актуально
[1]
1
цифр
с версии 27
*.
@corres
кор счет
AccNumT
Номер
2
pAcc
ype
счёта или
[0..1
Актуально
корр.
]
с версии 27
счёта, 20
цифр
*.
all: должны присутствовать все перечисленные ниже
Актуально
[1]
3
элементы
с версии 27
*.
Name
Наименование Банка
xs:string
Актуально
1
[1]
с версии 27
*.
Bank
Название населённого
xs:string
[0..1
Актуально
2
City
пункта банка
]
с версии 27
*.3
Budget
Реквизиты
[0..1
Актуально
бюджетополучателя
]
с версии 27
*.1
@budgetAccount
Лицевой счет
xs:string
[0..1
Актуально
бюджетополучателя
[max: 20]
]
с версии 27
*.2
@budgetInn
ИНН
xs:string
[0..1
Актуально
бюджетополучателя
[max: 12]
]
с версии 27
*.3
@budgetKbk
КБК
xs:string
[0..1
Актуально
бюджетополучателя
[max: 20]
]
с версии 27
*.4
@budgetKpp
КПП
xs:string
[0..1
Актуально
бюджетополучателя
[max: 9]
]
с версии 27
*.5
@budgetName
Наименование
xs:string
[0..1
Актуально
бюджетополучателя
[max:
]
с версии 27
165]
*.6
@budgetOktmo
ОКТМО
xs:string
[0..1
Актуально
бюджетополучателя
[max: 11]
]
с версии 27
*.4
CashSymbols
Кассовые символы
[0..1
Актуально
]
с версии 27
*.1
CashSymbol
[1..n
Актуально
]
с версии 27
*.1
@CashSymbol
Заполняется кодом
xs:string
Id
кассового символа.
[max: 3]
Значение справочника
[0..1
Актуально
UpgRplDictionary/ADM
]
с версии 27
CashSymbolsDict/@cas
hSymbols
2.7.11.
Особенности получения статусов об обработке из
СББОЛ
Информация об обработке документа доставляется в УС:
3. Без запроса со стороны УС:
a. В ответ на отправленный документ СББОЛ отправляет сообщение в формате
Response/Tickets, в котором передается:
 Tickets/Ticket@docId
- Идентификатор документа, с помощью которого
впоследствии можно запрашивать со стороны УС в формате
Request/DocIds/DocId - все последующие статусы обработки докуемнта.
 Tickets/Ticket/ Info@statusStateCode ="DELIVERED".
4. Путем запроса со стороны УС в формате Request/DocIds/DocId:
a. Имея данные идентификатора документа, которые были получены с первым
сообщением Response/Tickets -> СББОЛ передает текущее состояние документа.
 Tickets/Ticket/Info/BankDate/@statusDateTime
- дата и время присвоения
статуса.
Статусы обработки документа, передаваемые со стороны СББОЛ в УПШ в рамках
Response/Tickets:
Статус /системное
№
Версионно
название статуса на
Сообщение
Комментарий
п/п
сть
англ. яз.
-
Запись добавлена в справочник
Актуально с
1.
Доставлен/DELIVERED
Вносителей
средств,
требуется
версии 27
подтверждение по SMS
-
Запись в справочнике Вносителей
Актуально с
2.
Принят/ACCEPTED
средств подтверждена по SMS
версии 27
Ошибка реквизитов/
ЭД не прошел логические контроли
Актуально с
3.
FAIL
REQUISITE_ERROR
СББОЛ при приеме на стороне Банка
версии 27
Необходимы
ЭД не прошел логические контроли
Актуально с
4.
FAIL
исправления/
СББОЛ при приеме на стороне Банка,
версии 27
CHECK_ERROR
документ доступен на редактирование
-
Актуально с
5.
Удален/DELITED
ЭД удален Пользователем
версии 27
2.7.12.
Дайджест запроса на удаление «Шаблона внесения
средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста запроса:
№
Наименова
Пример
Версионно
Описание
п/п
ние поля
значения
сть
1.
ATTRIBUTES
Актуально
<Наименование полях=<Значение полях, например
с версии
27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор организации в ДБО (может
963084ba-7079-
Актуально
быть использован сторонней системой для
4b9d-bbab-
с версии
дополнительной идентификации)
c4972dee82d9
27
3.
Sender
Отправитель, а также тип использованного
Ромашка
Актуально
Клиентом программного обеспечения при
с версии
отправке документа
27
4.
FIELDS
Актуально
<Наименование полях=<Значение полях, например
с версии
AccDoc.AccDocNo=444
27
После последней строки НЕ делать перевод строки
5.
DocId
Идентификатор документа
863054ba-6666-
Актуально
4gts-bbab-
с версии
c49234deegsd9
27
2.7.13.
Формат запроса на удаление «Шаблона внесения
средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmPayTemplateDel
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
2.7.14.
Формат отправки запроса в СББОЛ
Request/AdmPayTemplateDel
Версионн
Элемент
Описание элемента
Тип
Описание типа
Мн.
ость
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии
27
1
@requestId
Уникальный
UuidSeparated
UUID с
идентификатор запроса
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9], [a-
f] и дефисов
2
@orgId
Идентификатор
UuidSeparated
UUID с
организации в ДБО
разделителями в
(может быть
виде дефисов.
Актуально
использован сторонней
Набор из 32
[1]
с версии
системой для
символов [0-9], [a-
27
дополнительной
f] и дефисов
идентификации)
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии
9\.]{1,20}
27
4
@sender
Система-отправитель
xs:string
Актуально
RegEx: [-a-zA-
[1]
с версии
Zа-яА-Я0-9:
27
_]{1,20}
5
@receiver
Система-получатель
xs:string
Актуально
Если система
RegEx: [-a-zA-
[0..1
с версии
получатель СББОЛ, то
Zа-яА-Я0-9:
]
27
SBBOL_DBO
_]{1,20}
6
@protocolVersion
Версия протокола
xs:string
Простой тип XML
Актуально
[0..1
Schema
с версии
]
27
7
AdmPayTemplateDel
Удаление документа
AdmPaymentT
Удаление
Актуально
вносители средств
emplateDel
документа
[1]
с версии
"Шаблон внесения
27
средств"
*.1
@docId
Идентификатор
UuidSeparated
UUID с
документа
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9], [a-
f] и дефисов
*.2
@docExtId
Идентификатор
UuidSeparated
UUID с
сущности в УС.
разделителями в
виде дефисов.
Актуально
Набор из 32
[1]
с версии
символов [0-9], [a-
27
f] или [A-F] и
дефисов
2.7.15.
Дайджест списка сущностей «Шаблон внесения
средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста:
№
Наименование
Версионно
Описание
Пример значения
п/п
поля
сть
1.
ATTRIBUTES
Актуально
<Наименование полях=<Значение полях, например
с версии
27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор организации в
963084ba-7079-4b9d-
Актуально
ДБО (может быть использован
bbab-c4972dee82d9
с версии
сторонней системой для
27
дополнительной идентификации)
3.
FIELDS
<Наименование полях=<Значение полях, например
Актуально
с версии
AccDoc.AccDocNo=444
27
После последней строки НЕ делать перевод строки
4.
StepId
Идентификатор последнего
213
Актуально
обновления справочника
с версии
27
5.
TABLES
Актуально
с версии
27
6.
TABLE=TemplateInfo
Разделитель строк таблицы - # ,
Актуально
соритровка по DocId
с версии
27
7.
Актуально
6d463ref-07ee-4535-
DocId
Идентификатор документа
с версии
a10a-0c82817cae23
27
8.
Актуально
DeviceType
Устройство самообслуживания
ADM
с версии
27
9.
Name
Наименование шаблона
Актуально
Взнос средств
с версии
27
2.7.16.
Формат взаимодействия при получении списка
сущностей «Шаблон внесения средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmPayTemplateList
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/AdmPayTemplates
2.7.16.1. Формат отправки запроса в СББОЛ
Request/AdmPayTemplateList
Версионн
Элемент
Описание элемента
Тип
Описание типа
Мн.
ость
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии
27
1
@requestId
Уникальный идентификатор
UuidSeparat
UUID с
запроса
ed
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9],
[a-f] и дефисов
2
@orgId
Идентификатор организации в
UuidSeparat
UUID с
ДБО (может быть использован
ed
разделителями в
Актуально
сторонней системой для
виде дефисов.
[1]
с версии
дополнительной
Набор из 32
27
идентификации)
символов [0-9],
[a-f] и дефисов
3
@version
Номер версии формата обмена
xs:string
Актуально
RegEx: [0-
[1]
с версии
9\.]{1,20}
27
4
@sender
Система-отправитель
xs:string
RegEx: [-a-
Актуально
zA-Zа-яА-
[1]
с версии
Я0-9:
27
_]{1,20}
5
@receiver
Система-получатель Если
xs:string
система получатель СББОЛ, то
RegEx: [-a-
Актуально
[0..1
SBBOL_DBO
zA-Zа-яА-
с версии
]
Я0-9:
27
_]{1,20}
6
@protocolVersi
Версия протокола
xs:string
Простой тип
[0..1
Актуально
on
XML Schema
]
с версии
27
7
AdmPayTempla
Запрос списка документов
AdmPayme
Запрос списка
teList
вносители средств
ntTemplate
документов
Актуально
List
"Шаблоны
[1]
с версии
внесения
27
средств"
*.1
@stepId
Идентификатор последнего
xs:long
обновления справочника или
Актуально
[0..1
пустой идентификатор, если
с версии
]
нужна полная репликация
27
справочника
2.7.16.2. Формат получения ответа из СББОЛ
Response/AdmPayTemplates
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Ответ СББОЛ на
Respons
Актуально
запрос УС
e
[1]
с версии
27
1
@createTime
Дата и время
xs:dateT
формирования ответа
ime
Актуально
местному по времени
[0..1]
с версии
запрашивающего
27
сервера, с указанием
его часового пояса
2
@responseId
Уникальный
UuidSep
UUID с
идентификатор ответа
arated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
3
@requestId
Идентификатор
UuidSep
UUID с
запроса, в результате
arated
разделителя
которого был
ми в виде
Актуально
сформирован данный
дефисов.
[0..1]
с версии
ответ
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
4
@version
Номер версии формата
xs:string
обмена
RegEx:
Актуально
[0-
[0..1]
с версии
9\.]{1,20
27
}
5
@sender
Система-отправитель
xs:string
RegEx:
Актуально
[-a-zA-
[0..1]
с версии
Zа-яА-
27
Я0-9:
_]{1,20}
6
@receiver
Система-получатель.
xs:string
Если система
RegEx:
Актуально
получатель СББОЛ, то
[-a-zA-
[0..1]
с версии
SBBOL_DBO
Zа-яА-
27
Я0-9:
_]{1,20}
7
AdmPayTemplates
Шаблоны внесения
AdmPa
Шаблоны
Актуально
средств
ymentT
внесения
[0..1]
с версии
emplate
средств
27
s
*.1
@stepId
Идентификатор
xs:string
Актуально
последнего обновления
[0..1]
с версии
справочника
27
*.2
AdmPayTemplate
AdmPa
Шаблон
Актуально
ymentT
внесения
[0..n]
с версии
emplate
средств
27
*.1
@docId
Идентификатор
UuidSep
UUID с
сущности в СББОЛ
arated
разделителя
ми в виде
Актуально
дефисов.
[0..1
с версии
Набор из 32
]
27
символов
[0-9], [a-f] и
дефисов
*.2
all: должны присутствовать все перечисленные ниже элементы
Актуально
[1]
с версии
27
*.1
TemplateInfo
Информация об
Актуально
устройстве внесения
[1]
с версии
средств
27
*.1
@deviceType
Устройства
xs:string
самообслуживания:
ADM - "Устройства
самообслуживания на
Актуально
территории Клиента
[1]
с версии
(АДМ)", US -
27
"Устройство
самообслуживания
(УС)"
*.2
@name
Наименование
xs:string
Актуально
шаблона
[max:
[1]
с версии
128]
27
*.3
@blocked
Блокировка. 1 -
BoolTyp
Двоичное
Актуально
признак установлен, 0 -
e
значение: 0
[1]
с версии
признак не установлен
или 1
27
*.4
@signed
Наличие подписи у
BoolTyp
Двоичное
Актуально
шаблона. 1 - подписан,
e
значение: 0
[1]
с версии
0 - не подписан
или 1
27
*.2
PayeeInfo
Актуально
[1]
с версии
27
*.1
@payeeName
Наименование
xs:string
Актуально
[max:
[1]
с версии
380]
27
*.2
@payeeInn
ИНН
xs:string
Актуально
[1]
с версии
27
*.3
@payeeKpp
КПП
xs:string
Актуально
[0..1
с версии
]
27
*.4
@enrollmentForBu
признак "Зачисление
BoolTyp
Двоичное
dget
для
e
значение: 0
Актуально
бюджетополучателя", 1
или 1
[1]
с версии
- признак установлен, 0
27
- признак не
установлен
*.5
@additionalInfo
Дополнительная
xs:string
Актуально
[0..1
информация к
[max:
с версии
]
назначению платежа
255]
27
*.6
all: должны присутствовать все перечисленные ниже элементы
Актуально
[1]
с версии
27
Account
Реквизиты счета
Актуально
[1]
с версии
1
27
@accNum
AccNum
Номер счёта
Актуально
Type
или корр.
[0..1
с версии
1
счёта, 20
]
27
цифр
all: должны присутствовать все перечисленные ниже
Актуально
элементы
[1]
с версии
2
27
Bank
Реквизиты банка, в
Актуально
котором открыт счёт
[1]
с версии
1
27
@bic
БИК
BicType
БИК, 9
Актуально
[0..1
цифр
с версии
]
1
27
@corres
кор счет
AccNum
Номер счёта
Актуально
pAcc
Type
или корр.
[0..1
с версии
2
счёта, 20
]
27
цифр
all: должны присутствовать все перечисленные ниже
Актуально
элементы
[1]
с версии
3
27
Nam
Наименование Банка
xs:string
Актуально
e
[1]
с версии
1
27
Bank
Название населённого
xs:string
Актуально
[0..1
City
пункта банка
с версии
]
2
27
*.3
Budget
Реквизиты
Актуально
бюджетополучателя
[1]
с версии
27
*.1
@budgetAccount
Лицевой счет
xs:string
Актуально
[0..1
бюджетополучателя
[max:
с версии
]
20]
27
*.2
@budgetInn
ИНН
xs:string
Актуально
[0..1
бюджетополучателя
[max:
с версии
]
12]
27
*.3
@budgetKbk
КБК
xs:string
Актуально
[0..1
бюджетополучателя
[max:
с версии
]
20]
27
*.4
@budgetKpp
КПП
xs:string
Актуально
[0..1
бюджетополучателя
[max: 9]
с версии
]
27
*.5
@budgetName
Наименование
xs:string
Актуально
[0..1
бюджетополучателя
[max:
с версии
]
165]
27
*.6
@budgetOktmo
ОКТМО
xs:string
Актуально
[0..1
бюджетополучателя
[max:
с версии
]
11]
27
*.4
CashSymbols
Кассовые символы
Актуально
[1]
с версии
27
*.1
CashSymbol
Актуально
[0..n
с версии
]
27
*.1
@CashSymbol
Заполняется кодом
xs:string
Id
кассового символа.
[max: 3]
Актуально
Значение справочника
[0..1
с версии
UpgRplDictionary/ADM
]
27
CashSymbolsDict/@cas
hSymbols
*.3
Sign
DigitalS
Актуально
ign
[0..1]
с версии
27
*.1
Issuer
Идентификатор
xs:string
поставщика
сертификата
Например, "
Актуально
[0..1
issuer="E=IdleCA,
с версии
]
C=RU, S=Idle CA,
27
L=Idle CA, O=Idle CA,
OU=Idle CA, CN=Idle
CA" "
*.2
SN
Серийный номер
xs:string
Актуально
[0..1
сертификата
с версии
]
27
*.3
Value
Значение ЭП
xs:base6
Актуально
[0..1
4Binary
с версии
]
27
*.4
DigestName
Имя схемы подписи
xs:string
Актуально
[0..1
с версии
]
27
*.5
DigestVersion
Версия схемы подписи
xs:string
Актуально
[0..1
с версии
]
27
2.7.17.
Дайджест списка «Операции внесений средствª
Подписывается:
o Единственная подпись или
o Первая подпись и Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.После последней строки в дайджесте этот
символ не ставится.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается.
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест.
Формат дайджеста ответа:
№
Версионно
п/
Наименование поля
Описание
Пример значения
сть
п
1.
ATTRIBUTES
Актуально
<Наименование полях=<Значение полях, например
с версии
27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор организации в
963084ba-7079-4b9d-
ДБО (может быть использован
bbab-c4972dee82d9
Актуально
сторонней системой для
с версии
дополнительной
27
идентификации)
3.
FIELDS
Актуально
<Наименование полях=<Значение полях, например
с версии
AccDoc.AccDocNo=444
27
После последней строки НЕ делать перевод строки
4.
StepId
Идентификатор последнего
213
Актуально
обновления справочника
с версии
27
5.
TABLES
Актуально
с версии
27
6.
TABLE=AdmOperatio
Разделитель строк таблицы - #
Актуально
n
, соритровка по DocId
с версии
27
7.
CashierInfo.CashierFI
ФИО вносителя средств
Иванов Иван
Актуально
O
Иванович
с версии
27
8.
Актуально
6d463ref-07ee-4535-
OperationInfo.DocId
Идентификатор документа
с версии
a10a-0c82817cae23
27
9.
OperationInfo.Opera
Сумма внесения средств
10000
Актуально
tionSumm
с версии
27
10.
DeviceInfo.DeviceTy
Тип устройства
ADM
Актуально
pe
с версии
27
2.7.18.
Формат взаимодействия при получении списка
«Операции внесений средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmOperationList
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/AdmOperations
2.7.18.1. Формат отправки запроса в СББОЛ
Request/AdmOperationList
Версионн
Элемент
Описание элемента
Тип
Описание типа
Мн.
ость
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии
27
1
@requestId
Уникальный идентификатор
UuidSeparated
UUID с
запроса
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9],
[a-f] и дефисов
2
@orgId
Идентификатор организации
UuidSeparated
UUID с
в ДБО (может быть
разделителями в
Актуально
использован сторонней
виде дефисов.
[1]
с версии
системой для
Набор из 32
27
дополнительной
символов [0-9],
идентификации)
[a-f] и дефисов
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии
9\.]{1,20}
27
4
@sender
Система-отправитель
xs:string
Актуально
RegEx: [-a-
[1]
с версии
zA-Zа-яА-Я0-
27
9: _]{1,20}
5
@receiver
Система-получатель Если
xs:string
Актуально
система получатель СББОЛ,
RegEx: [-a-
[0..1
с версии
то SBBOL_DBO
zA-Zа-яА-Я0-
]
27
9: _]{1,20}
6
@protocolVersio
Версия протокола
xs:string
Простой тип
[0..1
Актуально
n
XML Schema
]
с версии
27
7
AdmPayTemplate
Запрос списка документов
AdmPayment
Запрос списка
List
вносители средств
TemplateList
документов
Актуально
"Шаблоны
[1]
с версии
внесения
27
средств"
*.1
@stepId
Идентификатор последнего
xs:long
обновления справочника или
Актуально
[0..1
пустой идентификатор, если
с версии
]
нужна полная репликация
27
справочника
2.7.18.2. Формат получения ответа из СББОЛ
Response/AdmOperations
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Ответ СББОЛ на запрос УС
Response
Актуально
[1]
с версии
27
1
@createTime
Дата и время формирования
xs:dateTime
ответа местному по времени
Актуально
запрашивающего сервера, с
[0..1]
с версии
указанием его часового
27
пояса
2
@responseId
Уникальный идентификатор
UuidSeparat
UUID с
ответа
ed
разделител
ями в виде
дефисов.
Актуально
Набор из
[0..1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
3
@requestId
Идентификатор запроса, в
UuidSeparat
UUID с
результате которого был
ed
разделител
сформирован данный ответ
ями в виде
дефисов.
Актуально
Набор из
[0..1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
4
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[0..1]
с версии
9\.]{1,20}
27
5
@sender
Система-отправитель
xs:string
RegEx: [-a-
Актуально
zA-Zа-яА-
[0..1]
с версии
Я0-9:
27
_]{1,20}
6
@receiver
Система-получатель. Если
xs:string
система получатель СББОЛ,
RegEx: [-a-
Актуально
[0..1
то SBBOL_DBO
zA-Zа-яА-
с версии
]
Я0-9:
27
_]{1,20}
7
AdmOperations
Операции внесения средств
AdmOperat
Операции
Актуально
[0..1
ions
внесения
с версии
]
средств
27
@stepId
Идентификатор последнего
xs:string
Актуально
обновления справочника
[1]
с версии
1
27
AdmOperation
Операция внесения средств
AdmOperat
Операция
Актуально
[0..n
ion
внесения
с версии
]
2
средств
27
OrgInfo
Информация об организации
Актуально
[0..1
с версии
]
1
27
@orgName
Наименование организации
xs:string
Актуально
[0..1
[max: 350]
с версии
]
1
27
@payeeBic
БИК счета
BicType
БИК, 9
Актуально
[0..1
цифр
с версии
]
2
27
@payeeAccount
Номер счета
AccNumTyp
Номер
e
счёта или
Актуально
[0..1
3
корр.
с версии
]
счёта, 20
27
цифр
CashierInfo
Информация о вносителе
Актуально
[0..1
средств
с версии
]
2
27
@cashierFio
ФИО вносителя средств
xs:string
Актуально
[max: 256]
[1]
с версии
1
27
@cashierId
БИК счета
UuidSeparat
UUID с
ed
разделител
2
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
@templateName
Наименование шаблона
xs:string
Актуально
[0..1
внесения средств
[max: 128]
с версии
]
3
27
OperationInfo
Информация об операции
Актуально
[0..1
с версии
]
3
27
@docId
Идентификатор выписки в
UuidSeparat
UUID с
СББОЛ (UUID документа)
ed
разделител
1
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии
32
27
символов
[0-9], [a-f]
и дефисов
@operationTime
Дата и время операции
xs:dateTime
Актуально
[0..1
с версии
]
2
27
@operationID
Идентификатор операции
UuidSeparat
Актуально
(admOpInfo.TransactionUID)
ed
[1]
с версии
3
27
@operationSum
Сумма внесения средств
xs:decimal
Актуально
m
[1]
с версии
4
27
@payDocComme
Комментарий к платежному
xs:string
Актуально
[0..1
nt
документу
[max: 4000]
с версии
]
5
27
@payDocId
Идентификатор платежного
UuidSeparat
UUID с
документа
ed
разделител
6
ями в виде
дефисов.
Актуально
[0..1
Набор из
с версии
]
32
27
символов
[0-9], [a-f]
и дефисов
@payDocNumber
Номер платежного
xs:string
Актуально
[0..1
документа
[max: 50]
с версии
]
7
27
@payDocStateSys
Статус платежного
xs:string
Актуально
[0..1
temName
документа
[max: 255]
с версии
]
8
27
@rejectReason
Причина отклонения
xs:string
Актуально
[0..1
[max: 128]
с версии
]
9
27
DeviceInfo
Информация об устройстве
Актуально
[0..1
с версии
]
4
27
@deviceType
Тип устройства
xs:string
Актуально
[1]
с версии
1
27
@adaptedPayCas
Кассовый символ (для
xs:string
Актуально
[0..1
hSymbolName
устройств
[max: 1024]
с версии
]
2
самообслуживания)
27
@usAddress
Адрес устройства
xs:string
Актуально
[0..1
самообслуживания
[max: 128]
с версии
]
3
27
@admId
Идентификатор устройства
xs:string
Актуально
[0..1
самообслуживания
[max: 128]
с версии
]
4
27
@cashSymbol
Кассовый символ (для
xs:string
Актуально
устройств
[max: 3]
[0..1
с версии
5
самообслуживания),
]
27
цифровое значение
@tradePointNam
Наименование торговой
xs:string
Актуально
[0..1
e
точки
[max: 255]
с версии
]
6
27
2.7.19.
Формат запроса на генерацию пароля «Вносителя
средствª
Взаимодействие: Перечень документов передается из СББОЛ в УС
Инициатор получения списка документов: УС
Формат запроса на сторону СББОЛ: Request/AdmGenSMSPass
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
Request/AdmGenSMSPass
Версионн
Элемент
Описание элемента
Тип
Описание типа
Мн.
ость
Request
Запрос УС к СББОЛ
Request
Актуально
[1]
с версии
27
1
@requestId
Уникальный идентификатор
UuidSeparated
UUID с
запроса
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9],
[a-f] и дефисов
2
@orgId
Идентификатор организации
UuidSeparated
UUID с
в ДБО (может быть
разделителями в
Актуально
использован сторонней
виде дефисов.
[1]
с версии
системой для
Набор из 32
27
дополнительной
символов [0-9],
идентификации)
[a-f] и дефисов
3
@version
Номер версии формата
xs:string
Актуально
обмена
RegEx: [0-
[1]
с версии
9\.]{1,20}
27
4
@sender
Система-отправитель
xs:string
Актуально
RegEx: [-a-
[1]
с версии
zA-Zа-яА-Я0-
27
9: _]{1,20}
5
@receiver
Система-получатель Если
xs:string
Актуально
система получатель СББОЛ,
RegEx: [-a-
[0..1
с версии
то SBBOL_DBO
zA-Zа-яА-Я0-
]
27
9: _]{1,20}
6
@protocolVersion
Версия протокола
xs:string
Простой тип
Актуально
[0..1
XML Schema
с версии
]
27
7
AdmGenSMSPass
Запрос на генерацию пароля
AdmGenSMS
Запрос на
«Вносителю средств»
Pass
генерацию
Актуально
пароля
[1]
с версии
«Вносителю
27
средств»
*.
@docId
Идентификатор сущности
UuidSeparated
UUID с
1
«Вноситель средств»
разделителями в
Актуально
виде дефисов.
[1]
с версии
Набор из 32
27
символов [0-9],
[a-f] и дефисов
*.
@login
Логин вносителя
xs:string [min:
Актуально
2
1, max: 9]
[1]
с версии
27
2.8. Работа с Большими Файлами
2.8.1.Общие сведения
Текущий объем прикрепляемых к документу вложений ограничен 2 мегабайтами. Для
отправки большего объема вложений, в УПШ предусмотрена работа с Большими
Файлами.
2.8.1.1. Общая схема взаимодействия
УС Клиента
УПШ
Request/EssenceLinks
Response/UploadLinks
Request/BigFilesStatusRequest
Response/BigFilesStatus
2.8.1.2. Алгоритм взаимодействия
1) Для загрузки файла в подсистему БФ, необходимо предварительно получить ссылку на
загрузку - отправить запрос Request/EssenceLinks;
2) В ответе УПШ Response/UploadLinks вернется:
 UploadJobId - Идентификатор задачи на загрузку файла, он необходим для получения
статуса обработки большого файла;
 WebUploadLink - ссылка на загрузку файла;
3) Необходимо загрузить файл по полученной ссылке HTTP методом POST;
4) Далее нужно опрашивать статус загрузки файла запросом Request/BigFilesStatusRequest,
вплоть до получения в ответе Response/BigFilesStatus статуса FINISHED или
FINISHED_DMZ_TO_ALPHA;
5) После чего можно отправить документ с указанием соответствующего идентификатора
задачи на загрузку файла в элементе ../BigFileAttachments/BigFileAttachment/UploadJobId.
ПРИМЕЧАНИЕ
Один загруженный файл с уникальным UploadJobId, можно прикрепить только к одному
документу.
Для прикрепления того же файла к другому документу, необходимо выполнить его
загрузку в подсистему БФ повторно и использовать в связке с новым уникальным
UploadJobId.
6) Для скачивания файла БФ, необходимо предварительно получить ссылку на скачивание
- отправить запрос Request/DownloadLinks, в котором необходимо передать FileID файла,
полученный в документе из банка;
7) В ответе УПШ Response/DownloadLinks вернется начальный статус загрузки файла из
подсистемы БФ - STARTED_FILENET_TO_ALPHA.
8)
Далее необходимо опрашивать статус загрузки файла БФ методом
Request/DownloadLinks, вплоть до получения в ответе Response/DownloadLinks статуса
FINISHED или FINISHED_DMZ_TO_ALPHA. Вместе с данным статусом в ответе придет и
ссылка для скачивания файла БФ.
2.8.2.Дайджест запроса на получение ссылок на загрузку БФ
Подпись документа на стороне УС Клиента:
 Первая и Вторая подписи или
 Единственная подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
Формат дайджеста:
№
Пример
Версионност
Наименование поля
Описание
п/п
значения
ь
1.
ATTRIBUTES
Актуально с
<Наименование поля>=<Значение поля>, например:
версии 27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор
fb8360e9-69ae-
Актуально с
организации в ДБО
40d4-b5e2-
версии 27
b7e60f2a3fd7
3.
Sender
Отправитель, а также тип
Морашка
использованного Клиентом
Актуально с
программного обеспечения
версии 27
при отправке документа
4.
TABLES
Актуально с
Разделитель строк таблицы — #
версии 27
5.
Table=EssenceLinks
Изменено в
версии 29
6.
EssenceLinks.BigFilesJobType
Тип загружаемой сущности
DOC
Актуально с
версии 27
7.
EssenceLinks.BigFilesJobSubTy
Тип передаваемого
DebtRegistry
Актуально с
pe
документа
версии 27
8.
EssenceLinks.LinkUUID
Внутренний уникальный
fb8360e9-69ae-
Актуально с
идентификатор запроса
40d4-b5e2-
версии 27
b7e60f2a3fd7
9.
Криптопрофиль
EssenceLinks.CryptoProfileID
подписанта вложения.
Параметр заполняется
если
Изменено в
BIG_FILES_TOKEN_ENA
версии 32.001
BLED
BF_TOKEN_SIGN_ENABL
ED(справочник
DocTypeParam) = true
10.
Подпись файла вложения.
EssenceLinks.SignAttachment
Параметр заполняется если
BIG_FILES_TOKEN_ENA
Изменено в
BLED
версии 32.001
BF_TOKEN_SIGN_ENABL
ED(справочник
DocTypeParam) = true
2.8.3.Формат запроса на получение ссылок на загрузку БФ
Request/EssenceLinks
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Request
Запрос СББ к СББОЛ
Request
Актуально
[1
с версии
]
27
1
@orgId
Идентификатор
UuidSeparat
UUID с
организации в СББОЛ
ed
разделителями
в виде
Актуально
дефисов.
[1
с версии
Набор из 32
]
27
символов [0-
9], [a-f] и
дефисов
2
@requestId
Уникальный
UuidSeparat
UUID с
идентификатор запроса
ed
разделителями
в виде
Актуально
дефисов.
[1
с версии
Набор из 32
]
27
символов [0-
9], [a-f] и
дефисов
3
@version
Номер версии формата
xs:string
Простой тип
Актуально
[1
обмена
RegEx: "[0-
XML Schema
с версии
]
9\.]{1,20}"
27
4
@sender
Система-отправитель
xs:string
Простой тип
RegEx: «[-a-
XML Schema
Актуально
[1
zA-Zа-яА-
с версии
]
Я0-9:
27
_]{1,20}»
5
@receiver
Система-получатель
xs:string
Простой тип
RegEx: «[-a-
XML Schema
Актуально
zA-Zа-яА-
[0..1]
с версии
Я0-9:
27
_]{1,20}»
6
@protocolVersion
Версия протокола
xs:string
Простой тип
[0..1]
Актуально
XML Schema
с версии
27
7
EssenceLinks
Данные файлов, для
GetEssence
Данные
Актуально
которых запрашиваются
Links
файлов
[1]
с версии
ссылки
27
*.1
EssenceLink
Данные конкретного
GetEssence
Данные файла
Актуально
файла
Link
[1..n]
с версии
27
*.1
BigFilesJob
Тип загружаемой
xs:string
Простой тип
Type
сущности (для реестра
enumeration
XML Schema
Изменено
задолженностей
:
[1
в версии
указывать значение для
DOC
]
32.001
документов DOC, для
DICT
справочников — DICT)
*.2
BigFilesJob
Тип передаваемого
xs:string
Простой тип
SubType
документа/справочника
XML Schema
(для реестра
задолженностей
указывать
Изменено
[1
значение DebtRegistry)
в версии
]
Возможные значения
32.001
указаны в таблице
"Типы документов" в
ч.1 Документации API
УПШ
*.3
LinkUUID
Внутренний уникальны
UuidSeparat
UUID с
й идентификатор
ed
разделителями
запроса (используется
в виде
Актуально
учётной системой для
дефисов.
[1
с версии
связывания запроса
Набор из 32
]
27
ссылки и самой ссылки)
символов [0-
9], [a-f] и
дефисов
*.4
CryptoProfi
Криптопрофиль
UuidSeparat
UUID с
leID
подписанта вложения.
ed
разделителями
Подставить значение из
в виде
Response/OrganizationsIn
дефисов.
fo/OrganizationInfo/Sign
Набор из 32
Devices/SignDevice/Sign
символов [0-
Изменено
DeviceId.
9], [a-f] и
[0..1]
в версии
Параметр заполняется
дефисов
32.001
если
BIG_FILES_TOKEN_E
NABLED
BF_TOKEN_SIGN_ENA
BLED(справочник
DocTypeParam) = true
*.5
SignAttach
Подпись файла
xs:base64Bi
ment
вложения.
nary
CMS подпись,
наложенная на
бинарное представление
файла.
Изменено
Параметр заполняется
[0..1]
в версии
если
32.001
BIG_FILES_TOKEN_E
NABLED
BF_TOKEN_SIGN_ENA
BLED(справочник
DocTypeParam) = true
2.8.4.Дайджест ответа со ссылками на загрузку БФ
Подпись документа на стороне СББОЛ:
 Технологическая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
Формат дайджеста:
№
Версионн
Наименование поля
Описание
Пример значения
п/п
ость
1.
TABLES
Актуально
Разделитель строк таблицы — #
с версии
27
2.
Table=UploadLinks
Актуально
с версии
27
3.
UploadLinks.LinkUUID
Внутренний уникальный
99DDE2C8-5AD6-4F08-
Актуально
идентификатор запроса
913E-38E76D248D6D
с версии
27
4.
UploadLinks.UploadJobId
Идентификатор задачи на
77963a3f-6e25-4995-8180-
Актуально
загрузку файла
27902f54ff56
с версии
27
5.
UploadLinks.WebUploadL
Ссылка на загрузку файла
\\192.168.78.27\share\IN\2
Актуально
ink
015-08-27_16\f505a80e-
с версии
e344-4ebd-a9b5-
27
c0af9a8d1470
«
Изменено
в версии
30
UploadLinks.LinkUUID
Внутренний уникальный
99DDE2C8-5AD6-4F08-
Изменено
идентификатор запроса
913E-38E76D248D6E
в версии
30
UploadLinks.UploadJobId
Идентификатор задачи на
77963a3f-6e25-4995-8180-
Изменено
загрузку файла
27902f54ff57
в версии
30
UploadLinks.WebUploadL
Ссылка на загрузку файла
\\192.168.78.27\share\IN\2
Изменено
ink
015-08-27_16\f505a80e-
в версии
e344-4ebd-a9b5-
30
c0af9a8d1471
2.8.5.Формат ответа со ссылками на загрузку БФ
Response/UploadLinks
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Запрос СББ к СББОЛ
Response
Актуально
[1]
с версии
27
1
@createTime
Дата формирования
xs:dateTim
Актуально
ответа
e
[0..1]
с версии
27
2
@responseId
Уникальный
UuidSepar
UUID с
идентификатор ответа
ated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
3
@requestId
Уникальный
UuidSepar
UUID с
идентификатор запроса
ated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
4
@version
Номер версии формата
xs:string
Простой
Актуально
обмена
RegEx:
тип XML
[0..1]
с версии
"[0-
Schema
27
9\.]{1,20}"
5
@sender
Система-отправитель
xs:string
Простой
RegEx: «[-
тип XML
Актуально
a-zA-Zа-
Schema
[0..1]
с версии
яА-Я0-9:
27
_]{1,20}»
6
UploadLinks
UploadLin
Ссылки на
Актуально
ks
загрузку
[0..1]
с версии
файлов
27
*.1
UploadLink
Данные для загрузки
UploadLin
Актуально
файла
k
[1..n]
с версии
27
*.1
LinkUUID
Внутренний уникальны
UuidSepar
UUID с
й идентификатор
ated
разделителя
запроса
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.2
UploadJobId
Идентификатор задачи
UuidSepar
UUID с
на загрузку файла
ated
разделителя
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.3
WebUploadLin
Ссылка на загруженный
xs:string
Простой
Актуально
k
файл
тип XML
[1]
с версии
Schema
27
*.4
Errors
Ошибки вложенных
Добавлено
файлов
[0..1]
в версии
29
*.1
Error
BFError
Добавлено
[0..n]
в версии
29
*.
@errorMessa
Детали ошибки
xs:string
Добавлено
1
ge
[0..1]
в версии
29
*.2
Подпись
DigitalSign
Добавлено
Sign
[0..1]
в версии
30
*.1
Issuer
Поставщик
xs:string
сертификата.
Обязательно и
достаточно для
идентификации
Добавлено
клиентского
[0..1]
в версии
сертификата в СББОЛ
30
передавать атрибут CN
поля ISSUER в виде
«CN=<значение
атрибута>»
*.2
SN
Серийный номер
xs:string
Добавлено
сертификата
[0..1]
в версии
30
*.3
Value
Значение ЭП
xs:base64B
Добавлено
inary
[0..1]
в версии
30
*.4
DigestName
Имя схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
*.5
DigestVersion
Версия схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
2.8.6.Дайджест запроса статуса загрузки БФ
Подпись документа на стороне УС:
 Первая подпись и вторая подпись или
 Единственная подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 Если наполнение всех таблиц блока TABLES пустое, то и сам TABLES в дайджест не
включается
 Если наполнение какой-то таблицы блока TABLES пустое, то Table=TableName не включать в
дайджест
Формат дайджеста:
№
Версионн
Наименование поля
Описание
Пример значения
п/п
ость
1.
ATTRIBUTES
Актуально
с версии
27
2.
OrgId
Идентификатор
fb8360e9-69ae-40d4-b5e2-
Актуально
организации в
b7e60f2a3fd7
с версии
ДБО
27
3.
Sender
Отправитель
Ромашка
Актуально
с версии
27
4.
RequestId
Идентификатор
fb8360e9-69ae-40d4-b5e2-
Актуально
запроса
b7e60f2a3fd7
с версии
27
5.
TABLES
Сначала указываются все UploadJobId в порядке следования в запросе, потом все
DownloadJobId в порядке следования в запросе.
Разделитель строк таблицы — #, например:
TABLES
Актуально
Table=BigFilesStatus
с версии
BigFilesStatus.TransferJobId=fb8360e9-69ae-40d4-b5e2-b7e60f2a3fd7
27
#
BigFilesStatus.TransferJobId=fb8360e9-69ae-40d4-b5e2-b7e60f2a3fd
#
BigFilesStatus.TransferJobId=fb8360e9-69ae-40d4-b5e2-b7e60f2a3fd7
#
5.
Table=BigFilesStatus
Актуально
с версии
27
6.
BigFilesStatus.TransferJobId
fb8360e9-69ae-40d4-b5e2-
Актуально
b7e60f2a3fd7
с версии
27
7.
BigFilesStatus.TransferJobId
fb8360e9-69ae-40d4-b5e2-
Актуально
b7e60f2a3fd7
с версии
27
8.
BigFilesStatus.TransferJobId
Актуально
с версии
27
Актуально
«
с версии
27
N.
BigFilesStatus.TransferJobId
Актуально
с версии
27
Пример дайджеста.
ATTRIBUTES
OrgId=5e218ae3-1969-4411-a9cf-b10c9f730e5c
Sender=Оператор услуг
RequestId=5112c27b-e263-32b1-b35c-31283d8e678c
TABLES
Table=BigFilesStatus
BigFilesStatus.TransferJobId=4ecc638e-1576-4fef-8dcf-753af5c4a199
#
2.8.7.Формат взаимодействия при запросе статуса загрузки БФ
Взаимодействие: Документ передается из УС Клиента в СББОЛ
Инициатор получения документа: УС Клиента
Формат, в котором запрашиваются документы со стороны УС:
Request/BigFilesStatusRequest
Формат передачи документа на сторону УС: Response/BigFilesStatus
2.8.8.Формат отправки запроса статуса загрузки БФ
Request/BigFilesStatusRequest
Описание
Версионн
Элемент
Тип
Описание типа
Мн.
элемента
ость
Request
Request
Актуальн
[1]
о с версии
27
1
@requestId
Уникальный
UuidSeparated
UUIDс
идентификатор
разделителями в
Актуальн
запроса
виде дефисов.
[1]
о с версии
Набор из 32
27
символов [0-9], [a-f]
или [A-F] и дефисов
2
@orgId
Идентификатор
UuidSeparated
UUIDсразделителям
организациив ДБО
иввидедефисов.
(может быть
Набориз 32
Актуальн
использован
символов [0-9], [a-f]
[1]
о с версии
сторонней
или [A-F] идефисов
27
системой для
дополнительной
идентификации)
3
@version
Номер версии
xs:string
Простой тип XML
Актуальн
формата обмена
RegEx: "[0-
Schema
[1]
о с версии
9\.]{1,20}"
27
4
@sender
Система-
xs:string
Простой тип XML
Актуальн
отправитель
RegEx: «[-a-zA-Zа-
Schema
[1]
о с версии
яА-Я0-9: _]{1,20}»
27
5
@receiver
Система-
xs:string
Простой тип XML
получатель - если
RegEx: «[-a-zA-Zа-
Schema
Актуальн
система получатель
яА-Я0-9: _]{1,20}»
[0..1]
о с версии
СББОЛ, то
27
SBBOL_DBO
6
@protocolVersion
Версия протокола
xs:string
Простой тип XML
Актуальн
Schema
[0..1]
о с версии
27
7
BigFilesStatusReque
Запрос статуса
BigFilesStatusReques
Запрос статусов
st
загруженных
t
сущностей «Гос.
файлов
контракт»
Актуальн
При загрузке
[1]
о с версии
указывается
27
UploadJobId, при
скачивании
DownloadJobId
*.
UploadJobId
Уникальный
UuidSeparated
Изменено
1
идентификатор
[0..1]
в версии
задачи на закачку
[0..n]
32.001
файла в БФ
*.
DownloadJobId
Уникальный
UuidSeparated
2
идентификатор
Изменено
[0..1]
задачи на
в версии
[0..n]
скачивание файла
32.001
из БФ
Пример.
<Request
orgId='5e218ae3-1969-4411-a9cf-b10c9f730e5c'
requestId='5112c27b-e263-32b1-b35c-31283d8e678c'
sender='Оператор услуг'
version='123'
receiver='SBBOL_DBO'
xmlns='http://bssys.com/upg/request'>
<BigFilesStatusRequest>
<UploadJobId>4ecc638e-1576-4fef-8dcf-753af5c4a199</UploadJobId>
</BigFilesStatusRequest>
<Sign>
<Issuer>CN=ЛавринСВ-Тестовая печать-УЦ-9</Issuer>
<SN>752FB189A8C1871B689F</SN>
<Value>NPN2PiVTuU9UGF+yH/ugV5tMKYHEssvWgb4rYc4Npxpn+snR6VHiyMdosoV5kM2qhmaI
HU+M5QoD5tkOTVRp5g==</Value>
<DigestName>for_upg</DigestName>
<DigestVersion>1</DigestVersion>
</Sign>
</Request>
2.8.9.Формат получения статуса загрузки БФ
Response/BigFilesStatus
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Response
Актуально
[1]
с версии
27
1
@createTime
Дата и время
xs:dateTime
Простой тип
формирования ответа
XML Schema
Актуально
местному по времени
[0..1
с версии
запрашивающего
]
27
сервера, с указанием
его часового пояса
2
@responseId
Уникальный
UuidSeparated
UUID с
идентификатор
разделителями
ответа
в виде
Актуально
[0..1
дефисов.
с версии
]
Набор из 32
27
символов [0-9],
[a-f] и дефисов
3
@requestId
Идентификатор
UuidSeparated
UUID с
запроса, в результате
разделителями
которого был
в виде
Актуально
[0..1
сформирован данный
дефисов.
с версии
]
ответ
Набор из 32
27
символов [0-9],
[a-f] и дефисов
4
@version
Номер версии
xs:string
Простой тип
Актуально
[0..1
формата обмена
RegEx: "[0-9\.]{1,20}"
XML Schema
с версии
]
27
5
@sender
Система-отправитель
xs:string
Простой тип
Актуально
[0..1
RegEx: «[-a-zA-Zа-
XML Schema
с версии
]
яА-Я0-9: _]{1,20}»
27
6
@receiver
Система-получатель
xs:string
Простой тип
Актуально
Если система
RegEx: «[-a-zA-Zа-
XML Schema
[0..1
с версии
получатель СББОЛ,
яА-Я0-9: _]{1,20}»
]
27
то SBBOL_DBO
7
BigFilesStatus
Запрос статусов
BigFilesStatusRespons
Актуально
[0..1
сущностей «Гос.
e
с версии
]
контракт»
27
*.
BigFilesStatus
BigFilesStatus
Актуально
[0..n
1
с версии
]
27
*.
UploadJobId
Уникальный
UuidSeparated
Актуально
1
идентификатор
[0..1
с версии
задачи на закачку
]
27
файла в БФ
*.
DownloadJobId
Уникальный
UuidSeparated
Актуально
2
идентификатор задач
[0..1
с версии
и на скачивание
]
27
файла из БФ
*.
FileNetId
Уникальный
xs:string
Актуально
3
идентификатор
[0..1
с версии
сохраненного
]
27
документа в FileNet
*.
Status
Статус файла,
xs:string
Актуально
4
загружаемого в
[0..1
с версии
БФ/скачиваемого из
]
27
БФ
*.
Errors
Описание Ошибки
Актуально
[0..1
5
вложенных файлов
с версии
]
27
*.
Error
BFError
Актуально
[0..n
1
с версии
]
27
*.
@errorM
Детали ошибки
xs:string
Актуально
[0..1
1
essage
с версии
]
27
Пример.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response sender="DBO" version="7" requestId="5112c27b-e263-32b1-b35c-31283d8e678c"
responseId="79f0c8ba-339b-4800-8bf2-513bb032b15d" createTime="2017-05-
15T13:40:04.724+03:00" xmlns="http://bssys.com/upg/response">
<BigFilesStatus>
<BigFilesStatus>
<UploadJobId>4ecc638e-1576-4fef-8dcf-753af5c4a199</UploadJobId>
<FileNetId>{ABCC3613-CB6D-4841-A47D-D0C6392A8981}/{66C0ADC4-
3BF2-4B17-A777-0C157DAB13CE}</FileNetId>
<Status>FINISHED</Status>
</BigFilesStatus>
</BigFilesStatus>
</Response>
2.8.10.
Особенности получения статусов загруженных файлов
Статусы загрузки файлов:
№
Системное название статуса
Версионност
Комментарий
п/п
в СББОЛ
ь
ЗАГРУЗКА ФАЙЛА В БФ (BigFilesDownloadJob) (BigFilesUploadJob)
Изменено в
версии
32.001
1
STARTED_DMZ_TO_ALPHA
Начата загрузка файла из хранилища больших
Актуально с
файлов в DMZ в хранилище больших файлов в
версии 27
зоне ALPHA
2
STARTED_ALPHA_TO_FILE
Начата загрузка файла из хранилища больших
Актуально с
NET
файлов в зоне ALPHA в FileNet
версии 27
3
FINISHED
Закончена загрузка больших файлов в конечную
точку в FileNet
Актуально с
версии 27
Статус окончательный успешный
4
FINISHED_DMZ_TO_ALPH
Закончена загрузка больших файлов в
A
хранилище больших файлов в зоне ALPHA
Актуально с
Статус окончательный успешный
версии 27
(промежуточный статус для некоторых типов
документов)
5
ERROR_DMZ_TO_ALPHA
Ошибка при загрузке файла из хранилища
больших файлов в DMZ в хранилище больших
Актуально с
файлов в зоне ALPHA
версии 27
Статус окончательный неуспешный
6
ANTIVIRUS_ERROR
Файл заражен вирусом
Актуально с
версии 27
Статус окончательный неуспешный
7
FILE_TYPE_ERROR
Ошибка типа файла
Актуально с
версии 27
Статус окончательный неуспешный
8
FILE_EXTENSION_ERROR
Ошибка расширения файла
Актуально с
версии 27
Статус окончательный неуспешный
9
ERROR_ALPHA_TO_FILEN
Ошибка при загрузке файла из хранилища
ET
больших файлов в зоне ALPHA в хранилище
Актуально с
FileNet
версии 27
Статус окончательный неуспешный
10
TECHNICAL_ERROR
Техническая ошибка
Актуально с
версии 27
Статус окончательный неуспешный
11
MAX_SIZE_ERROR
Превышен размер файла
Добавлено в
версии
Статус окончательный неуспешный
32.001
12
CLIENT_SMS_SIGN_REQUE
Клиент запросил смс код для подписи файла
Добавлено в
STED
версии
32.001
13
CLIENT_SIGN_INPROGRES
Идет процесс подписи или проверки подписи
Добавлено в
S
вложения
версии
32.001
14
CLIENT_PARTSIGN_VALID
Вложение успешно подписано одной подписью,
Добавлено в
подпись проверена, ожидается вторая подпись
версии
32.001
15
CLIENT_SIGN_VALID
Вложение успешно подписано и подпись
Добавлено в
проверена
версии
32.001
16
CLIENT_SIGN_INVALID
Ошибка при подписи или проверке подписи
Добавлено в
вложения
версии
32.001
Статус окончательный неуспешный
17
CLIENT_SIGN_SKIPPED
Подпись или проверка подписи вложения была
Добавлено в
пропущена, т.к. выключена настройками
версии
системы
32.001
18
PARTIALLY_UPLOADED
Частично загружен
Добавлено в
версии
32.001
СКАЧИВАНИЕ ФАЙЛА ИЗ БФ (BigFilesUploadJob) (BigFilesDownloadJob)
Изменено в
версии
32.001
1
STARTED_ALPHA_TO_DMZ
Начата загрузка файла из хранилища больших
Актуально с
файлов в ALPHA в хранилище больших файлов
версии 27
в зоне DMZ
2
STARTED_FILENET_TO_AL
Начата загрузка файла из хранилища больших
Актуально с
PHA
файлов в зоне FileNet в ALPHA
версии 27
3
FINISHED
Файл загружен и готов к скачиванию
Актуально с
версии 27
Статус окончательный успешный
4
FINISHED_FILENET_TO_AL
Закончена загрузка файла из хранилища в
Актуально с
PHA
ALPHA
версии 27
5
FINISHED_ALPHA_TO_DM
Закончена загрузка файла из ALPHA в DMZ
Актуально с
Z
версии 27
6
ERROR_ALPHA_TO_DMZ
Ошибка загрузки файла из ALPHA в DMZ
Актуально с
версии 27
Статус окончательный неуспешный
7
ERROR_FILENET_TO_ALPH
Ошибка загрузки файла из хранилища в ALPHA
Актуально с
A
версии 27
Статус окончательный неуспешный
8
ERROR
Ошибка подготовки файла к скачиванию
Актуально с
версии 27
Статус окончательный неуспешный
9
OUTDATED
Файл устарел
Актуально с
версии 27
10
SPOILED
Файл поврежден
Актуально с
версии 27
Статус окончательный неуспешный
2.8.11.
Дайджест запроса на получение ссылок на скачивание
БФ из банка
Подпись документа на стороне УС Клиента:
 Первая или Вторая подписи или
 Единственная подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
Формат дайджеста:
№
Пример
Версионност
Наименование поля
Описание
п/п
значения
ь
1.
ATTRIBUTES
Актуально с
<Наименование поля>=<Значение поля>, например:
версии 27
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор
fb8360e9-69ae-
Актуально с
организации в ДБО
40d4-b5e2-
версии 27
b7e60f2a3fd7
3.
Sender
Отправитель, а также тип
Морашка
использованного Клиентом
Актуально с
программного обеспечения
версии 27
при отправке документа
4.
TABLES
Актуально с
Разделитель строк таблицы — #
версии 27
5.
Table=DownloadLinks
Актуально с
версии 27
6.
DownloadLinks.LinkUUID
Внутренний уникальный
fb8360e9-69ae-
Актуально с
идентификатор запроса
40d4-b5e2-
версии 27
b7e60f2a3fd7
7.
DownloadLinks.FileID
Уникальный
{D0AA9685-
идентификатор файла БФ
0000-CC12-
Актуально с
82B1-
версии 27
58600C27EC8D
}
8.
Уникальный
DownloadLinks.DocID
212452c0-4585-
идентификатор документа
47a9-bf45-
Актуально с
банка, к которому
914b86a6f739
версии 27
прикреплен файл вложения
БФ
9.
Тип документа, к которому
DownloadLinks.BigFilesJobSub
GenericLetterFr
Актуально с
прикреплен файл вложения
Type
omBank
версии 27
БФ
2.8.12.
Формат запроса на получение ссылок на скачивание
файла БФ из банка
Request/DownloadLinks
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Request
Запрос СББ к СББОЛ
Request
Актуально
[1]
с версии
27
1
@orgId
Идентификатор
UuidSeparat
UUID с
организации в СББОЛ
ed
разделителями
в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
2
@requestId
Уникальный
UuidSeparat
UUID с
идентификатор запроса
ed
разделителями
в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
3
@version
Номер версии формата
xs:string
Простой тип
Актуально
обмена
RegEx: "[0-
XML Schema
[1]
с версии
9\.]{1,20}"
27
4
@sender
Система-отправитель
xs:string
Простой тип
RegEx: «[-a-
XML Schema
Актуально
zA-Zа-яА-
[1]
с версии
Я0-9:
27
_]{1,20}»
5
@receiver
Система-получатель
xs:string
Простой тип
RegEx: «[-a-
XML Schema
Актуально
zA-Zа-яА-
[0..1]
с версии
Я0-9:
27
_]{1,20}»
6
@protocolVersion
Версия протокола
xs:string
Простой тип
[0..1]
Актуально
XML Schema
с версии
27
7
DownloadLinks
Данные файлов, для
Get
Данные
Актуально
которых запрашиваются
DownloadL
файлов
[1]
с версии
ссылки
inks
27
*.1
DownloadLink
Данные конкретного
Get
Данные файла
Актуально
файла
DownloadL
[1..n]
с версии
inks
27
*.1
LinkUUID
Внутренний уникальны
UuidSeparat
UUID с
й идентификатор
ed
разделителями
запроса (используется
в виде
Изменено
учётной системой для
дефисов.
[1]
в версии
связывания запроса
Набор из 32
32.001
ссылки и самой ссылки)
символов [0-
9], [a-f] и
дефисов
*.2
FileID
Уникальный
xs:string
Простой тип
Изменено
идентификатор файла
XML Schema
[1]
в версии
БФ
32.001
*.3
DocID
Уникальный
UuidSeparat
UUID с
идентификатор
ed
разделителями
документа банка, к
в виде
Актуально
которому прикреплен
дефисов.
[1]
с версии
файл вложения БФ
Набор из 32
27
символов [0-
9], [a-f] и
дефисов
*.4
BigFilesJob
Тип документа, к
xs:string
Простой тип
Изменено
SubType
которому прикреплен
XML Schema
[1]
в версии
файл вложения БФ
32.001
Пример.
<Request requestId="9e10cb46-ca5c-4b18-aebd-026c97f88450"
orgId="50cecd13-80b6-48d0-8c6b-b8c934481d8a" version="3.0"
sender="HOLD_GOLOVA"
receiver="SBBOL_DBO" xmlns="http://bssys.com/upg/request"
protocolVersion='35'>
<DownloadLinks>
<DownloadLink>
<LinkUUID>c6d8caba-2186-4d05-b54c-ad0f26eafde7</LinkUUID>
<FileID>{D0AA9685-0000-CC12-82B1-58600C27EC8D}</FileID>
<DocID>212452c0-4585-47a9-bf45-914b86a6f739</DocID>
<BigFilesJobSubType>GenericLetterFromBank</BigFilesJobSubType>
</DownloadLink>
</DownloadLinks>
<Sign>
<Issuer>CN=ПАО Сбербанк УЦ (ТЕСТ Q)</Issuer>
<SN>7A5F2B4B01C556AA1D9D</SN>
<Value>
MIIMhwYJKoZIhvcNAQcCoIIMeDCCDHQCAQExDjAMBggqhQMHAQECAgUAMAsG
CSqGSIb3DQEHAaCCCWIwggRKMIID96ADAgECAgp6XytLAcVWqh2dMAoGCCqFA
wcBAQMCMIIBazEbMBkGA1UECAwSNzcg0LMu0JzQvtGB0LrQstCwMRgwFgYDVQQ
HDA/Qsy7QnNC/==
</Value>
</Sign>
</Request>
2.8.13.
Формат получения ссылки на скачивание файла БФ из
банка
Response/DownloadLinks
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Запрос СББ к СББОЛ
Response
Актуально
[1]
с версии
27
1
@createTime
Дата формирования
xs:dateTim
Актуально
ответа
e
[0..1]
с версии
27
2
@responseId
Уникальный
UuidSepar
UUID с
идентификатор ответа
ated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
3
@requestId
Уникальный
UuidSepar
UUID с
идентификатор запроса
ated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
4
@version
Номер версии формата
xs:string
Простой
Актуально
обмена
RegEx:
тип XML
[0..1]
с версии
"[0-
Schema
27
9\.]{1,20}"
5
@sender
Система-отправитель
xs:string
Простой
RegEx: «[-
тип XML
Актуально
a-zA-Zа-
Schema
[0..1]
с версии
яА-Я0-9:
27
_]{1,20}»
6
DownloadLinks
Download
Ссылки на
Актуально
Links
скачивание
[0..1]
с версии
файлов
27
*.1
DownloadLink
Данные для скачивания
Download
Актуально
файла
Link
[1..n]
с версии
27
*.1
LinkUUID
Внутренний уникальны
UuidSepar
UUID с
й идентификатор
ated
разделителя
запроса
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.2
DownloadJobId
Идентификатор задачи
UuidSepar
UUID с
на скачивание файла
ated
разделителя
ми в виде
Актуально
дефисов.
[0..1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.3
WebDownloadL
Ссылка на файл для
xs:string
Простой
Актуально
ink
скачивания
тип XML
[0..1]
с версии
Schema
27
*.4
State
Статус загрузки файла
xs:string
Простой
Добавлено
тип XML
[0..1]
в версии
Schema
29
*.2
Подпись
DigitalSign
Добавлено
Sign
[0..1]
в версии
30
*.1
Issuer
Поставщик
xs:string
сертификата.
Обязательно и
достаточно для
идентификации
Добавлено
клиентского
[0..1]
в версии
сертификата в СББОЛ
30
передавать атрибут CN
поля ISSUER в виде
«CN=<значение
атрибута>»
*.2
SN
Серийный номер
xs:string
Добавлено
сертификата
[0..1]
в версии
30
*.3
Value
Значение ЭП
xs:base64B
Добавлено
inary
[0..1]
в версии
30
*.4
DigestName
Имя схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
*.5
DigestVersion
Версия схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
Пример.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response sender="DBO"
version="7" requestId="9e10cb46-ca5c-4b18-aebd-026c97f88451"
responseId="d147fd2d-b9e7-491f-b84b-7d6384d582b1"
createTime="2023-01-11T12:09:54.371+03:00" xmlns="http://bssys.com/upg/response">
<DownloadLinks>
<DownloadLink>
<LinkUuid>c6d8caba-2186-4d05-b54c-ad0f26eafde7</LinkUuid>
<DownloadJobId>e3fa03fb-3009-4454-a559-fc2e3e455288</DownloadJobId>
<WebDownloadLink>
https://bf2.testsbi.sberbank.ru:9443/sbns-app/download/e3fa03fb-3009-4454-a559-
fc2e3e455288</WebDownloadLink>
<State>FINISHED</State>
</DownloadLink>
<Sign>
<Issuer>E = casbrf@sberbank.ru,CN = ПАО Сбербанк УЦ (ТЕСТ Q),OU =
Департамент безопасности (ТЕСТ),O = ПАО Сбербанк (ТЕСТ),C = RU,1.2.643.100.1 =
1027700132195,STREET = ул. Вавилова, д.19,1.2.643.3.131.1.1 = 007707083893,L =
г.Москва,S = 77 г.Москва</Issuer>
<SN>7A77BD88CF61F48F6C99</SN>
<Value>
KdTyvjmvBro6ODNlH8X9GxIrhc03k+NWNQj7UqYjxCIHH2GE79u72wQdJeQrGrOFjom
Up19Ysuke2CHmL1xLvg==</Value>
<DigestName>for_upg</DigestName>
<DigestVersion>1</DigestVersion>
</Sign>
</DownloadLinks>
</Response>
2.9. Печатная форма документа в канале УПШ
2.9.1.Дайджест запроса на создание печатной формы документа
Подпись документа на стороне УС Клиента(подписывается ЭП пользователя ДЗО):
 Единственная подпись или
 Первая подпись или
 Вторая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 В случае использования 2-х ЭП дайджест строится точно также как и при единственной ЭП.
Формат дайджеста:
№
Наименование
Описание
Пример
Версионно
п/п
поля
значения
сть
1.
ATTRIBUTES
Актуально
с версии
30
Идентификатор организации в ДБО
fb8360e9-
2.
OrgId
69ae-40d4-
Актуально
b5e2-
с версии
b7e60f2a3fd7
30
Отправитель,
а
также
тип
Ромашка
3.
Sender
Актуально
использованного
Клиентом
с версии
программного
обеспечения
при
отправке документа
30
4.
FIELDS
Актуально
<Наименование поля>=<Значение поля>, например
с версии
BeginDate=2011-11-24
30
После последней строки НЕ делать перевод строки
5.
Statement.BeginDa
Дата начала периода
2011-11-24
Актуально
te
с версии
30
6.
Statement.EndDate
Дата окончания периода
2011-11-24
Актуально
с версии
30
7.
Document.DocId
Глобальный UUID
документа СББОЛ, по которому
Актуально
нужно сформировать печатную
с версии
форму
30
2.9.2.Дайджест ответа со ссылкой на скачивание печатной формы
документа
Подпись документа на стороне СББОЛ:
 Технологическая подпись
Дайджест: формируется
Ключевой буфер (дайджест):
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
Формат дайджеста:
№
Версионно
Наименование поля
Описание
Пример значения
п/п
сть
1.
TABLES
Добавлено в
Разделитель строк таблицы — #
версии 31
2.
Table=DownloadLink
Добавлено в
версии 31
3.
DownloadJobId
Идентификатор задачи
77963a3f-6e25-4995-
Добавлено в
на скачивание файла
8180-27902f54ff56
версии 31
4.
WebDownloadLink
Ссылка на скачивание
\\192.168.78.27\share\IN
файла
\2015-08-
Добавлено в
27_16\f505a80e-e344-
версии 31
4ebd-a9b5-
c0af9a8d1470
5.
͙
Добавлено в
версии 31
2.9.3.Формат взаимодействия при запросе на создание печатной
формы документа
Взаимодействие: Документ передается из УС Клиента в СББОЛ
Инициатор получения справочника: УС
Формат передачи документа на сторону СББОЛ:
Request/BigFilesDownloadPrintFormLink
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: <!--NOT PROCESSED YET--> или ответ Response/DownloadLinks с ссылкой на
скачивание из БФ
2.9.3.1. Формат запроса на создание печатной формы документа
Request/BigFilesDownloadPrintFormLink
Элемент
Описание элемента
Тип
Описани
М
Версионно
е типа
н.
сть
Актуально
Request
Запрос УС к СББОЛ
Request
[1]
с версии 30
1
@requestId
Уникальный идентификатор
UuidSeparated
UUID с
запроса
разделител
ями в виде
дефисов.
Актуально
Набор из
[1]
с версии 30
32
символов
[0-9], [a-f]
и дефисов
2
@orgId
Идентификатор организации в
UuidSeparated
UUID с
ДБО (может быть использован
разделител
сторонней системой для
ями в виде
дополнительной
дефисов.
Актуально
идентификации)
Набор из
[1]
с версии 30
32
символов
[0-9], [a-f]
и дефисов
3
@version
Номер версии формата обмена
xs:string
Простой
Актуально
RegEx: "[0-
тип XML
[1]
с версии 30
9\.]{1,20}"
Schema
4
Система-отправитель
xs:string
Простой
@sender
RegEx: «[-a-zA-
тип XML
Актуально
[1]
Zа-яА-Я0-9:
Schema
с версии 30
_]{1,20}»
5
@receiver
Система-получатель - Если
xs:string
Простой
система получатель СББОЛ,
RegEx: «[-a-zA-
тип XML
Актуально
[0..1]
то SBBOL_DBO
Zа-яА-Я0-9:
Schema
с версии 30
_]{1,20}»
6
@protocolVersion
Версия протокола
xs:string
Простой
Актуально
тип XML
[0..1]
с версии 30
Schema
7
BigFilesDownload
Запрос на создание печатной
BigFilesDownload
Актуально
[1]
PrintFormLink
формы
PrintFormLink
с версии 30
*.1
@extension
Расширение получаемого
Актуально
[1]
файла: pdf, rtf, docx, html, excel
с версии 30
*.2
Актуально
choice: должен присутствовать один из перечисленных ниже элементов
[1]
с версии 30
*.1
Statement
Актуально
Печатная форма выписки
[0..1]
с версии 30
*.1
@begin
Дата начала периода
xs:date
Простой тип
Актуально
[1]
Date
XML Schema
с версии 30
*.2
@endD
Дата окончания периода
xs:date
Простой тип
Актуально
[1]
ate
XML Schema
с версии 30
*.3
@type
Тип выписки:
xs:string
Простой тип
XML Schema
1 - Выписка из лицевого счета
2 - Выписка из лицевого счета с
арестами и ограничениями
3 - Выписка из лицевого счета
(расширенная)
4 - Выписка с приложениями
Актуально
[1]
5 - Выписка из лицевого счета
с версии 30
(расширенная) с приложениями
Для рублевого счета доступны
следующие типы выписок: 1, 2,
3, 4, 5
Для валютного счета доступны
следующие типы выписок: 1, 3,
4, 5
*.4
@accou
Номер счёта
Acc,
nt
расширение
AccNumTyp
Актуально
e
[1]
с версии 30
(xs:string[20]
RegEx: [0-
9])
*.5
@bic
Актуально
БИК
BicType
БИК, 9 цифр
[1]
с версии 30
*.1
Document
Печатная форма документа
Печатные формы доступны для
следующих типов документов:
AppForDepositNew
-
Заявление
на
открытие/пролонгацию
депозита
CertifRequest
- Запрос на
сертификат
CurrControlInfoRequest
-
Изменено в
[0..1]
Запрос информации ВК
версии 32
ExchangeMessagesWithBank
- Письмо для целей ВК
PayDocRu
-
Рублевое
платежное поручение
PermBalanceNew - Заявление
о присоединении к условиям
размещения
денежных
средств в виде НСО
SalaryDoc
-
Зарплатная
ведомость
*.1
@docId
Глобальный UUID документа
СББОЛ, по которому нужно
Актуально
сформировать печатную
[1]
с версии 30
форму(Не указывается для
выписки)
2.9.3.2. Формат ответа со ссылкой на скачивание печатной
формы документа
Response/DownloadLinks
Описание
Версионн
Элемент
Описание элемента
Тип
Мн.
типа
ость
Response
Запрос СББ к СББОЛ
Response
Актуально
[1]
с версии
27
1
@createTime
Дата формирования
xs:dateTime
Актуально
ответа
[1]
с версии
27
2
@responseId
Уникальный
UuidSeparat
UUID с
идентификатор ответа
ed
разделителя
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
3
@requestId
Уникальный
UuidSeparat
UUID с
идентификатор
ed
разделителя
запроса
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
4
@version
Номер версии формата
xs:string
Простой
Актуально
обмена
RegEx: "[0-
тип XML
[1]
с версии
9\.]{1,20}"
Schema
27
5
@sender
Система-отправитель
xs:string
Простой
RegEx: «[-a-
тип XML
Актуально
zA-Zа-яА-
Schema
[1]
с версии
Я0-9:
27
_]{1,20}»
6
DownloadLinks
DownloadL
Ссылки на
Актуально
inks
скачивание
[0..1]
с версии
файлов
27
*.1
DownloadLink
Данные для
DownloadL
Актуально
скачивания файла
ink
[1..n]
с версии
27
*.1
LinkUUID
Внутренний уникальн
UuidSeparat
UUID с
ый идентификатор
ed
разделителя
запроса
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.2
DownloadJobI
Идентификатор задачи
UuidSeparat
UUID с
d
на скачивание файла
ed
разделителя
ми в виде
Актуально
дефисов.
[1]
с версии
Набор из 32
27
символов
[0-9], [a-f] и
дефисов
*.3
WebDownload
Ссылка на файл для
xs:string
Простой
Актуально
Link
загрузки
тип XML
[1]
с версии
Schema
27
*.4
State
Статус файла в БФ
xs:string
Простой
Добавлено
тип XML
[0..1]
в версии
Schema
30
*.2
Подпись
DigitalSign
Добавлено
Sign
[0..1]
в версии
30
*.1
Issuer
Поставщик
xs:string
сертификата.
Обязательно и
достаточно для
идентификации
Добавлено
клиентского
[0..1]
в версии
сертификата в СББОЛ
30
передавать атрибут CN
поля ISSUER в виде
«CN=<значение
атрибута>»
*.2
SN
Серийный номер
xs:string
Добавлено
сертификата
[0..1]
в версии
30
*.3
Value
Значение ЭП
xs:base64Bi
Добавлено
nary
[0..1]
в версии
30
*.4
DigestName
Имя схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
*.5
DigestVersion
Версия схемы подписи
xs:string
Добавлено
[0..1]
в версии
30
2.10. Заявление об изменении перечня банковских счетов
Компании Холдинга
2.10.1.
Общие сведения
Документ позволяет инициировать прикрепление/открепление счетов дочернего
зависимого общества к/от головной компании холдинга.
2.10.2.
Дайджест
Подпись документа на стороне УС Клиента (подписывается только ЭП пользователя
ДЗО):
 Первая и Вторая подписи или
 Единственная подпись
Дайджест: формируется
 Для формирования электронной подписи из документа формируется строковая
последовательность (ключевой буфер или дайджест), включающая все значимые данные
документа, поля, содержащие пустые значения, не включаются.
 Ключевой буфер (дайджест) для подписания ЭП образует строковый массив в кодировке
UTF-8, Отдельные записи массива разделены символом перевода строки. В качестве
символа перевода строки используется 0x0A.
 При наличии в мультистроковых данных последовательности из двух символов перевода
строки CR+LF (ASCII 0x0D 0x0A) необходимо удалять символ возврата каретки CR (ASCII
0x0D) и оставлять только символ подачи строки LF (ASCII 0x0A).
 В случае использования 2-х ЭП дайджест строится точно также как и при единственной ЭП.
Формат дайджеста:
№
Пример
Версионно
п/
Наименование поля
Описание
значения
сть
п
1.
ATTRIBUTES
Актуально
<Наименование поля>=<Значение поля>, например
с версии 30
OrgId=963084ba-7079-4b9d-bbab-c4972dee82d9
2.
OrgId
Идентификатор дочерней
963084ba-7079-
Актуально
организации в ДБО
4b9d-bbab-
с версии 30
c4972dee82d9
3.
Sender
Отправитель, а также тип
Ромашка
использованного Клиентом
Актуально
программного обеспечения при
с версии 30
отправке документа
4.
ExtId
Уникальный* идентификатор
3a6378ef-07ee-
документа в учетной системе
4535-a10a-
Актуально
(УС) Клиента.
0c82817cae23
с версии 30
*Уникальность контролируется
на стороне банка
5.
OperationType
Тип действия, возможные
значения:
Актуально
add - прикрепление счетов
с версии 30
rem - открепление счетов
6.
FIELDS
<Наименование поля>=<Значение поля>, например
Актуально
с версии 30
AccDoc.AccDocNo=444
После последней строки НЕ делать перевод строки
7.
DocData.DocNum
Номер сформированного
12345
Актуально
документа
с версии 30
8.
DocData.DocDate
Дата создания документа по
2012-02-01
Актуально
местному времени
с версии 30
9.
DzoOrgData.OrgName
Наименование организации
Актуально
с версии 30
10.
DzoOrgData.Inn
ИНН ДЗО
123123123123
Актуально
с версии 30
11.
DzoOrgData.Kpp
КПП
Актуально
с версии 30
12.
DzoOrgData.OrgAddress
Почтовый или юридический
Актуально
адрес организации Клиента
с версии 30
13.
TABLES
Актуально
с версии 30
14.
Table=Accounts
Изменено в
Счета ДЗО, прикрепляемые к головной компании холдинга
версии 31
Сортировка - по возрастанию Account
15.
Account
Номер счёта
407028109381700
Актуально
15285
с версии 30
16.
Bic
БИК
044444444
Актуально
с версии 30
Актуально
«
с версии 30
2.10.3.
Формат взаимодействия
Взаимодействие: Документ передается из УС в СББОЛ
Инициатор получения справочника: УС
Формат передачи документа на сторону СББОЛ: Request/DzoAccAttach
Формат предоставления ответа (квитанции) об исполнении документа со стороны
СББОЛ: Response/Tickets
2.10.3.1. Формат отправки документа в СББОЛ
Request/DzoAccAttach
Описание
М
Версионн
Элемент
Описание элемента
Тип
типа
н.
ость
Request
Запрос Сбербанк
Request
Актуально
Бизнес SMB к СББОЛ
[1]
с версии
30
1
@requestId
Уникальный
UuidSepar
UUID с
идентификатор
ated
разделителя
запроса
ми в виде
дефисов.
Актуально
Набор из 32
[1]
с версии
символов
30
[0-9], [a-f]
или [A-F] и
дефисов
2
@orgId
Идентификатор
UuidSepar
UUID с
дочерней организации
ated
разделителя
в ДБО
ми в виде
дефисов.
Актуально
Набор из 32
[1]
с версии
символов
30
[0-9], [a-f]
или [A-F] и
дефисов
3
@version
Номер версии формата
xs:string
Простой
Актуально
обмена
тип XML
[1]
с версии
Schema
30
4
@sender
Система-отправитель
xs:string
Простой
Актуально
тип XML
[1]
с версии
Schema
30
5
@receiver
Система-получатель
xs:string
Простой
Актуально
Если система
тип XML
[0..1]
с версии
получатель СББОЛ, то
Schema
30
SBBOL_DBO
6
@protocolVersion
Версия протокола
xs:string
Простой
Актуально
тип XML
[0..1]
с версии
Schema
30
7
DzoAccAttach
Прикрепление счетов
DzoAccAtta
Актуально
дочерней организации
ch
[1]
с версии
к головной компании
30
холдинга
*.1
@docExtId
Идентификатор
UuidSepar
UUID с
документа в УС
ated
разделителя
ми в виде
дефисов.
Актуально
Набор из 32
[1]
с версии
символов
30
[0-9], [a-f]
или [A-F] и
дефисов
*.2
@headOrgId
Идентификатор
UuidSepar
UUID с
головной организации
ated
разделителя
в ДБО
ми в виде
дефисов.
Актуально
Набор из 32
[1]
с версии
символов
30
[0-9], [a-f]
или [A-F] и
дефисов
*.3
@operationType
Тип действия,
xs:string
возможные значения:
Актуально
add - прикрепление
[1]
с версии
счетов
30
rem - открепление
счетов
*.4
DocData
Реквизиты документа
Актуально
[1]
с версии
30
*.1
@docNum
Номер
xs:string
Простой
Актуально
сформированного
[min: 1,
тип XML
[1]
с версии
документа
max: 6]
Schema
30
*.2
@docDate
Дата создания
xs:date
Дата:
документа по
DD.MM.YY
Изменено
местному времени
YY
[1]
в версии
YYYY.MM.
31
DD
*.5
DzoOrgData
Основные реквизиты
OrgData
Актуально
дочерней организации
[1]
с версии
30
*.1
@orgName
Наименование
xs:string
Простой
Актуально
организации
тип XML
[1]
с версии
Schema
30
*.2
@inn
ИНН
InnType
ИНН
юридическо
го или
Актуально
физическог
[1]
с версии
о лица
30
РФ, до 12
цифр
*.3
@kpp
КПП
KppType
КПП, 9
Актуально
цифр
[1]
с версии
30
*.4
@orgAddress
Почтовый или
xs:string
Простой
Актуально
юридический адрес
[min: 1,
тип XML
[1]
с версии
организации Клиента
max: 1024
Schema
30
*.6
Accounts
Счета ДЗО,
Accs
Актуально
прикрепляемые к
[1]
с версии
головной компании
30
холдинга
*.1
Account
Номер счёта
Acc
AccNumTyp
Актуально
xs:string
e
[1..99
с версии
RegEx: [0-
9]
30
9]{20}
*.1
@bic
БИК
BicType
БИК, 9
Актуально
xs:string
цифр
[1]
с версии
RegEx: [0-
30
9]{9}
2.10.4.
Особенности получения статусов об обработке из
СББОЛ
Информация об обработке документа доставляется в УС:
1. Без запроса со стороны УС:
a. В ответ на отправленный документ СББОЛ отправляет сообщение в формате
Response/Tickets, в котором передается:
 Tickets/Ticket@docId
- Идентификатор документа, с помощью которого
впоследствии можно запрашивать со стороны УС в формате
Request/DocIds/DocId - все последующие статусы обработки документа
 Tickets/Ticket/Info@statusStateCode="DELIVERED"
2. Путем запроса со стороны УС в формате Request/DocIds/DocId:
a. Имея данные идентификатора документа, которые были получены с первым
сообщением Response/Tickets->СББОЛ передает текущее состояние документа
 Tickets/Ticket/Info/BankDate/@statusDateTime
- дата и время присвоения
статуса.
Статусы обработки документа, передаваемые со стороны СББОЛ в УПШ в рамках Response/Tickets:
Передаваем
Описание
ый из
Описание
Атрибут
передаваемо
№п/
Версионн
СББОЛ
операции на
Response/Tickets для
го из
п
ость
статус
стороне СББОЛ
передачи в УПШ
СББОЛ
документа
значения
1.
Актуально
Response/Tickets/Ticket/I
INVALIDED
с версии
nfo/@statusStateCode
S
30
Проверки
документа привели
INVALIDED
Может
к неуспешному
S
бытьпередан
результату
(АСП/ЭП
о сообщение
(статус
Response/Tickets/Ticket/I
Актуально
неверна)
о том, что
окончательный - не
nfo/MsgFromBank/@mes
с версии
подлинность
успешно)
sage
30
документа не
подтвержден
а
2.
Актуально
Response/Tickets/Ticket/I
REQUISITE_
с версии
Логические
nfo/@statusStateCode
ERROR
30
проверки документа
REQUISITE_
привели к
Должны
ERROR
неуспешному
передаваться
(Ошибка
результату
Response/Tickets/Ticket/I
сообщения
Актуально
реквизитов)
(статус
nfo/MsgFromBank/@mes
об ошибках,
с версии
окончательный - не
sage
выявленных
30
успешно)
на стороне
Банка
3.
Документ доставлен
на сторону Банка,
Актуально
DELIVERED
Response/Tickets/Ticket/I
но не прошел
DELIVERED
с версии
(Доставлен)
nfo/@statusStateCode
проверку подписи и
30
реквизитов
4.
Актуально
Response/Tickets/Ticket/
ACCEPTED
с версии
@statusStateCode
30
Прием документа
на стороне Банка.
ACCEPTED
Дата
Документ прошел
(Принят)
поступления
проверку подписи и
Response/Tickets/Ticket/I
Актуально
в Банк
реквизитов.
nfo/BankDate/@receiptD
с версии
плательщика
ate
30
и принятия в
обработку
5.
Актуально
Подтверждение
Response/Tickets/Ticket/I
IMPLEMENT
с версии
исполнения
nfo/@statusStateCode
ED
30
документа
IMPLEMEN
(статус
Дата
TED
окончательный
поступления
(Исполнен)
- успешно)
Response/Tickets/Ticket/I
Актуально
в Банк
nfo/BankDate/@receiptD
с версии
плательщика
ate
30
и принятия в
обработку
Сообщение
Response/Tickets/Ticket/I
Актуально
из Банка,
nfo/MsgFromBank/@mes
с версии
если
sage
30
требуется
Реквизиты
ответственно
Response/Tickets/Ticket/I
Актуально
го
nfo/MsgFromBank/@aut
с версии
сотрудника
hor
30
Банка, если
требуется
6.
Актуально
Response/Tickets/Ticket/I
PARTIMPLE
с версии
nfo/@statusStateCode
MENTED
30
Сообщение
Response/Tickets/Ticket/I
Актуально
из Банка,
nfo/MsgFromBank/@mes
с версии
если
sage
30
требуется
Актуально с
Информация о счетах
версии 30
Подтверждение
частичного
Response/Tickets/Ticket/I
Актуально
PARTIMPLE
исполнения
nfo/AddInfo/HoldingInfo/
Номер Счета
с версии
MENTED
документа.
AccInfo/Account
30
(Частично
(статус
исполнен)
окончательный -
Response/Tickets/Ticket/I
Актуально
nfo/AddInfo/HoldingInfo/
БИК
с версии
успешно)
AccInfo/Account/@bic
30
Response/Tickets/Ticket/I
Актуально
Статус
nfo/AddInfo/HoldingInfo/
с версии
обработки
AccInfo/Account/Status
30
Дополнитель
Response/Tickets/Ticket/I
ное
Актуально
nfo/AddInfo/HoldingInfo/
сообщение
с версии
AccInfo/Account/Messag
по статусу
30
e
обработки
7.
Актуально
Ошибка создания
Response/Tickets/Ticket/I
FAIL
с версии
документа в СББОЛ
nfo/@statusStateCode
30
FAIL (Ошиб
(статус
ка создания)
окончательный - не
Response/Tickets/Ticket/I
успешно)
Актуально с
nfo/MsgFromBank/@mes
версии 30
sage
2.11. Передача клиенту данных о структуре холдинга
2.11.1.
Общие сведения
Запрос позволяет получить базовую информацию об организациях, входящих в состав
холдинга, а также их счетах, доступных для головной компании.
2.11.2.
Дайджест
Запрос данных:
Подпись документа на стороне УС: нет
Дайджест: не формируется
Ответ с данными:
Подпись документа на стороне СББОЛ: нет
Дайджест: не формируется
2.11.3.
Формат взаимодействия
Взаимодействие: Документ передается из СББОЛ в УС
Инициатор получения справочника: УС
Формат передачи запроса данных на сторону СББОЛ: Request/HoldingInfoRequest
Формат передачи данных на сторону УС: Response/HoldingInfo
2.11.3.1. Формат отправки запроса
Request/HoldingInfoRequest
Версио
Элемент
Описание элемента
Тип
Описание типа
Мн.
нность
Request
Запрос УС к СББОЛ
Request
Добавлено
[1]
в версии
31
1
@requestId
Уникальный
UuidSeparated
UUID с
идентификатор
разделителями
Добавлено
запроса
в виде дефисов.
[1]
в версии
Набор из 32
31
символов [0-9],
[a-f] и дефисов
2
@orgId
Идентификатор
UuidSeparated
UUID с
головной организации
разделителями
Добавлено
в ДБО
в виде дефисов.
[1]
в версии
Набор из 32
31
символов [0-9],
[a-f] и дефисов
3
@version
Номер версии формата
xs:string
Простой тип
Добавлено
обмена
RegEx: "[0-
XML Schema
[1]
в версии
9\.]{1,20}"
31
4
@sender
Система-отправитель
xs:string
Простой тип
Добавлено
RegEx: «[-a-
XML Schema
[1]
в версии
zA-Zа-яА-Я0-
31
9: _]{1,20}»
5
@receiver
Система-получатель -
xs:string
Простой тип
Добавлено
если система
RegEx: «[-a-
XML Schema
[0..1]
в версии
получатель СББОЛ, то
zA-Zа-яА-Я0-
31
SBBOL_DBO
9: _]{1,20}»
6
@protocolVersion
Версия протокола
xs:string
Простой тип
Добавлено
XML Schema
[0..1]
в версии
31
7
HoldingInfoReque
Запрос персональных
HoldingInfoRe
Добавлено
st
данных
quest
[1]
в версии
31
Пример
<Request xmlns='http://bssys.com/upg/request'
orgId='ba54de8f-8225-4f46-a53f-619a19531fe3'
requestId='01011018-14ae-4d9b-80ac-935042dd1210' version='01.002.02'
sender='Ромашка' receiver='SBBOL_DBO'>
< HoldingInfoRequest/>
</Request>
2.11.3.2.
Формат получения ответа
Response/HoldingInfo
Элемент
Описание элемента
Тип
Описание
Версионн
Мн.
типа
ость
Response
Response
Добавлено
[1
в версии
]
31
1
@createTime
Дата и время
xs:dateTime
формирования ответа
Добавлено
местному по времени
[0..1]
в версии
запрашивающего
31
сервера, с указанием
его часового пояса
2
@responseId
Уникальный
UuidSeparated
Добавлено
идентификатор ответа
[0..1]
в версии
31
3
@requestId
Идентификатор
UuidSeparated
Добавлено
запроса, в результате
[0..1]
в версии
которого был
31
сформирован данный
ответ
4
@version
Номер версии формата
xs:string
Добавлено
обмена
RegEx: "[0-
[0..1]
в версии
9\.]{1,20}"
31
5
@sender
Система-отправитель
xs:string
Добавлено
RegEx: «[-a-
[0..1]
в версии
zA-Zа-яА-Я0-
31
9: _]{1,20}»
6
@receiver
Система-получатель.
xs:string
Добавлено
Если система
RegEx: «[-a-
[0..1]
в версии
получатель СББОЛ, то
zA-Zа-яА-Я0-
31
SBBOL_DBO
9: _]{1,20}»
7
HoldingInfo
HoldingInfo
Добавлено
[0..1]
в версии
31
*.
Orgs
Организации,
Добавлено
1
включенные в холдинг
[0..1]
в версии
31
*.1
Org
Организация,
Добавлено
включенная в холдинг
[0..n]
в версии
31
*.1
OrgId
UUID дочерней
UuidSeparated
UUID с
организаций
разделителя
ми в виде
Добавлено
дефисов.
[0..1]
в версии
Набор из 32
31
символов
[0-9], [a-f] и
дефисов
*.2
Name
Наименование
xs:string [max:
Простой
Добавлено
организации
350]
тип XML
[0..1]
в версии
Schema
31
*.3
INN
ИНН дочерней
InnType
ИНН
Добавлено
организации
юридическо
[0..1]
в версии
го лица РФ,
31
до 12 цифр
*.4
Accounts
Доступные для ГК
UuidSeparated
Добавлено
счета ДЗО
[0..1]
в версии
31
*.1
Accoun
Номер счёта
Простой
Добавлено
t
тип XML
[0..n]
в версии
Schema
31
*.1
@bi
БИК банка
Добавлено
c
[0..1]
в версии
31
Пример
<Response sender='DBO' version='7' requestId='01011018-14ae-4d9b-80ac-935042dd1210'
responseId='828607ac-a6b4-4e6a-937f-f9cc8f4ccd33' createTime='2018-09-22T11:38:59.431+03:00'
xmlns='http://bssys.com/upg/response'>
<HoldingInfo>
<Orgs>
<Org>
<OrgId>ac54de3f-8245-4f46-ad3f-6c9a49551fe3</OrgId>
<Name>ООО Дочка</Name>
<INN>7706732008</INN>
<Accounts>
<Account bic='040349745'>40702810738110106985</Account>
</Accounts>
</Org>
</Orgs>
</HoldingInfo>
</Response>
История изменений
Дата
Верси
Описание
Флаг
я
совместимости с
предыдущей
версией
Версия 31.000.00
06.08.2018
0.66
Рекомендуется
В дайджесте документа Request/DzoAccAttach, изменено
тестирование со
описание Table=Accounts (необходима сортировка по
стороны УС
возрастанию Account)
клиента
23.08.2018
0.67
Рекомендуется
В Response/OrganizationsInfo изменено описание поля
тестирование со
SignUse
стороны УС
клиента
Изменено описание поля Response/Dict/Step/@postFix.
05.09.2018
0.68
Совместимо с
Дополнено описание раздела «Репликация справочников
предыдущей
на сторону Клиента»: уточнен метод получения ссылки
версией
репликационног пакета справочника.
01.10.2018
0.69
Совместимо с
Добавлен дайджест ответа со ссылкой на скачивание
предыдущей
печатной формы документа
версией
01.10.2018
0.70
Совместимо с
Добавлен раздел «Передача клиенту данных о структуре
предыдущей
холдинга»
версией
02.10.2018
0.71
Рекомендуется
тестирование со
Изменено описание поля DzoAccAttach/DocData/@docDate
стороны УС
клиента
02.10.2018
0.72
Совместимо с
Добавлен элемент
предыдущей
Response/OrgSetting/CommonSettingsDictChanged
версией
05.11.2018
0.73
Рекомендуется
Уточнены документы, для которых доступно получение
тестирование со
печатной формы в канале УПШ
стороны УС
клиента
Версия 32.000.00
06.11.2018
0.74
Рекомендуется
Добавлено новое состояние счета: RESERVED -
Зарезервирован, передается в элементе
тестирование со
Response/OrganizationsInfo/OrganizationInfo/OrgData/Accou
стороны УС
nts/Account/OtherAccountData/State
клиента
29.11.2018
0.75
Совместимо с
Уточнено описание полей Request/ActivateCert
предыдущей
версией
13.12.2018
0.76
Не совместимо с
Исключен раздел «Запрос на отзыв документов»
предыдущей
версией
Добавлена возможность получать справочник типов писем
09.01.2019
0.77
Совместимо с
свободного формата GenericLetterType, описание
предыдущей
справочника в разделе «Репликация справочников на
версией
сторону Клиента»
Версия 32.001.00
Для использования версии документации 32.001.00,
следует указывать в запросах и документах значение
@protocolVersion=32
01.02.2019
0.78
Уточнено описание
Совместимо с
EssenceLinks/EssenceLink/BigFilesJobType и
предыдущей
EssenceLinks/EssenceLink/BigFilesJobSubType
версией
Множественность элементов
01.02.2019
0.79
Совместимо с
BigFilesStatusRequest/UploadJobId и
предыдущей
BigFilesStatusRequest/DownloadJobId приведена в
версией
соответствие со схемой XSD
В связи с изменениями по 595-П, увеличена размерность
07.03.2019
0.80
Совместимо с
следующих элементов до 160 символов:
предыдущей
 Response/OrganizationsInfo/OrganizationInfo/OrgData/Corr
espondents/Correspondent/Bank/@name
версией
 Request/CorrAdd/Bank/Name
03.04.2019
0.81
Изменено описание полей в формате запроса и дайджесте:
Не совместимо с
Request/EssenceLinks/EssenceLink/CryptoProfileID,
предыдущей
Request/EssenceLinks/EssenceLink/SignAttachment
версией
04.04.2019
0.82
Рекомендуется
тестирование со
Изменена таблица БФ «Статусы загрузки файлов»
стороны УС
клиента
Версия 33.000.00
В формат передачи клиенту персональных данных
01.07.2019
0.83
Совместимо с
Response/OrganizationsInfo/OrganizationInfo/SalaryContracts
предыдущей
/SalaryContract добавлен блок полей «Допустимые типы
версией
карт» CardTypes и «Допустимые виды зачислений»
SalTypes
01.07.2019
0.84
В справочник типов пластиковых карт ЗП проект
Совместимо с
MzpCard добавлен новый элемент @endDate - дата
предыдущей
окончания срока активности типа карты
версией
В разделы «Особенности получения статусов об обработке
01.07.2019
0.85
Совместимо с
из СББОЛ» добавлена информация о том, что Путем
предыдущей
запроса со стороны УС в формате Request/DocIds/DocId в
версией
Tickets/Ticket/Info/BankDate/@statusDateTime
возвращается дата и время присвоения статуса.
В разделе «Репликация справочников на сторону Клиента»
02.07.2019
0.86
Совместимо с
уточнено, что ограничений на объем zip-архива
предыдущей
справочника не устанавливается
версией
В Request/Incoming добавлены необязательные элементы:
02.07.2019
0.87
Совместимо с
@includeGenericLettersFromBank
предыдущей
@commonSettingsDictStepId
версией
В алгоритм взаимодействия с БФ добавлено примечание:
02.07.2019
0.88
Рекомендуется
Один загруженный файл с уникальным UploadJobId,
тестирование со
можно прикрепить только к одному документу.
стороны УС
Для прикрепления того же файла к другому документу,
необходимо выполнить его загрузку в подсистему БФ
клиента
повторно и использовать в связке с новым уникальным
UploadJobId.
Максимальное количество дней от текущей даты в
02.07.2019
0.89
Рекомендуется
Request/Incoming/@lastIncomingTime ограничено
тестирование со
значением параметра
стороны УС
UPG_INCOMING_LASTINCOMINGTIME_MAX_DEPTH_
IN_DAYS из справочника CommonSetting
клиента
Снято нижнее ограничение количества цифр ОГРН
02.07.2019
0.90
Рекомендуется
тестирование со
стороны УС
клиента
Добавление справочника кодов вида дохода
16.03.2020
0.91
Рекомендуется
CodeOfRevenueType
тестирование со
стороны УС
клиента
В запросе Request/CorrAdd добавлена обязательность
18.11.2020
0.92
Рекомендуется
ввода корр. счета при создании контрагента с БИК УФК.
тестирование со
Добавлена информаця о неуникальнсти записей
стороны УС
справочника BicEntry - по счетам УФК у одного БИК
может быть несколько корр.счетов.
клиента
Добавлено уточнение по заполнению в запросе
29.01.2021
0.93
Совместимо с
Request/CorrAdd/CorrAdd/Bank реквизитов из справочника
предыдущей
БИКов банка.
версией
Дополнены справочники:
03.02.2021
0.94
Совместимо с
IBANEntry тегами @natIdLen и @ typeRec;
предыдущей
GenericLetterType тегом @letterTypeId;
версией
LetterType тегом @typeId.
Добавлено описание методов получения ссылки на
16.01.2023
0.95
Совместимо с
скачивание файлов БФ, п. 2.8.11 - 2.8.13.
предыдущей
В п.2.8.1.2. добавлено описание процесса взаимодействия
версией
при скачивании БФ из банка.
Удалено описание методов добавления\удаления
12.07.2024
0.96
Совместимо с
контрагентов и бенефициаров, методы CorrAdd, CorrDel,
предыдущей
BenefAdd, BenefDel.
версией

 

 

 

 

 

 

 

содержание      ..     6      7      8      9     ..