/fintech/api/v1/bank-control-statements/reg-curr-contracts
Запрос позволяет создать заявление на регистрацию валютного контракта (ВК).
Для создания заявления на регистрацию ВК необходимо отправить POST-запрос /fintech/api/v1/bank-control-statements/reg-curr-contracts
с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами на регистрацию контракта.
В параметре scope ссылки авторизации пользователя должен быть указан сервис BANK_CONTROL_STATEMENT
для получения доступа к этому запросу.
- Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
- Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.
Для обращения к ресурсу необходимо отправлять запрос на:
- Тестовый контур
https://iftfintech.testsbi.sberbank.ru:9443
- Промышленный контур
https://fintech.sberbank.ru:9443
Request
- Модель
- Пример
Наименование | Тип | Формат | Regexp | Обязательность | Описание |
---|---|---|---|---|---|
HEADER | |||||
Authorization | string | string | ^[a-zA-Z0-9]38$ | required | Access token пользователя, полученный через SSO. |
BODY | |||||
CurrContract { | |||||
amount | number | float | ^[0-9]16\.[0-9]2$ | optional | Сумма платежа, |
bankControlStatementInfo | BankControlStatementInfo | object | required | Информация о ведомости банковского контроля, | |
contractDate | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | required | Дата контракта |
contractEndDate | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | optional | Дата окончания обязательств по контракту, |
contractNumber | string | string | ^.100$ | optional | Номер контракта, |
contractType | string | string | ^(PRODUCT_EXPORT|SERVICE_EXPORT|MULTI_CONTRACT)$ | optional | Код вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта. Заполнять обязательно, если creationMode=ICS_CONTRACT_INFORMATION , |
currencyCode | string | Цифровой ISO-код валюты | ^[0-9]3$ Актуальный список значений можно получить с помощью справочника CurDict | optional | Код валюты контракта. Заполнять обязательно, если creationMode=ICS_CONTRACT_INFORMATION, |
date | string | ISO 8601 YYYY-MM-DD | ^[0-9]4-[0-9]2-[0-9]2$ | required | Дата составления документа, |
digestSignatures | array[Signature] | array | optional | Электронные подписи по дайджесту документа. - Если ЭП передана/ы в API, то они сохраняются вместе с документом, а сам документ продвигается дальше по своему жизненному циклу. - Если ЭП не была/и передана/ы, то документ сохраняется в своем начальном статусе и ожидает дальнейшего подписания в интерфейсе СберБизнес. О подписании дайджеста документа подробно рассказали в соответствующем разделе документации. | |
nonResidents | array[BankControlStatementNonResident] | array | optional | Информация о нерезидентах, | |
number | string | string | ^[a-zA-Z0-9. \ _ -]7$ | optional | Номер документа, |
} | |||||
BankControlStatementInfo { | |||||
authPersonName | string | string | ^.60$ | optional | ФИО ответственного лица, |
authPersonTelfax | string | string | ^.40$ | optional | Телефон ответственного лица, |
bfAttachments | array[BfAttachment] | array | optional | Прикрепленные большие файлы, | |
creationMode | string | string | ^(ICS_CONTRACT_INFORMATION|ICS_CONTRACT_REGISTRATION)$ | required | Режим создания ВБК,ICS_CONTRACT_REGISTRATION - указывается при регистрации контракта, когда необходимо отправить сам контракт во вложении, чтобы поставить его на учет.ICS_CONTRACT_INFORMATION - заполняется в случае, если необходимо предоставить только информацию о контракте, для отправки СВО, к примеру (см. 181-И). |
currencyName | string | Буквенный ISO-код валюты | ^[a-zA-Z0-9. \ _ -]3$ Актуальный список значений можно получить с помощью справочника CurDict | optional | Код валюты контракта, |
externalId | string | UUID | ^[0-9a-f]8-[0-9a-f]4-[0-9a-f]4-[0-9a-f]4-[0-9a-f]12$ | required | Идентификатор документа, который вы присваиваете самостоятельно |
} | |||||
Signature { | |||||
base64Encoded | string | base64 | ^[a-zA-Z0-9]+$ | required | Значение электронной подписи (ЭП), закодированное в Base64, |
certificateuuid | string | UUID | ^[0-9a-f]8-[0-9a-f]4-[0-9a-f]4-[0-9a-f]4-[0-9a-f]12$ | required | Уникальный идентификатор сертификата ключа проверки электронной подписи |
} | |||||
BankControlStatementNonResident { | |||||
countryCode | string | ОКСМ | ^[0-9]3$ Актуальный список значений можно получить с помощью справочника Country | required | Цифровой код страны, |
countryName | string | string | ^.255$ Актуальный список значений можно получить с помощью справочника Country | required | Наименование страны, |
isAffiliatedPerson | boolean | boolean | ^(true|false)$ | optional | Признак аффилированного лица, |
name | string | string | ^.400$ | required | Наименование иностранного контрагента |
} | |||||
BfAttachment { | |||||
fileId | string | string | ^[a-zA-Z0-9. \ _ -]+$ | optional | Уникальный идентификатор файла |
} |
POST /fintech/api/v1/bank-control-statements/reg-curr-contracts HTTP/1.1
Content-Type: application/json
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678
{
"amount": 1.01,
"balance": 1.01,
"bankComment": "string",
"bankControlStatementInfo": {
"authPersonName": "Иванов Иван Иванович",
"authPersonTelfax": "4955005550",
"bankCommentAuthor": "Иванов Иван Иванович",
"bankDate": "string",
"bfAttachments": [
{
"fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"fileName": "SB_7718830000_40702810038290010000_T18.txt"
}
],
"chainId": "1234567890123",
"creationMode": "ICS_CONTRACT_INFORMATION",
"currencyName": "USD",
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"failReasons": [
{
"docField": "Номер контракта",
"reasonComment": "Указан неверно",
"reasonId": "PS_REST_REJ_PART_2-9",
"returnComment": "Отказ проверки"
}
],
"isActual": false,
"unk": "string"
},
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractEndDate": "2018-12-31",
"contractNumber": "123АБВ",
"contractType": "MULTI_CONTRACT",
"currencyCode": "840",
"date": "2018-12-31",
"decNonresToResidentLiabSum": 1.01,
"decResidentToNonresLiabSum": 1.01,
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"finalTransCurrencyCode": "643",
"finalTransCurrencyName": "USD",
"incNonresidLiabilitySum": 1.01,
"incResidentLiabilitySum": 1.01,
"nonResidents": [
{
"countryCode": "643",
"countryName": "РОССИЯ",
"isAffiliatedPerson": false,
"name": "Kazan"
}
],
"number": "1",
"totalCredit": 1.01,
"totalDebit": 1.01,
"transDate": "2018-12-31",
"xmlBodies": [
"string"
]
}
digestSignatures
- Формат
- Пример
Наименование поля | Описание поля | Пример |
---|---|---|
amount | Сумма контракта | 1.01 |
bankControlStatementInfo.authPersonName | ФИО ответственного лица | Петров Петр Иванович |
bankControlStatementInfo.authPersonTelfax | Телефон ответственного лица | 79263689379 |
bankControlStatementInfo.creationMode | Режим создания ВБК | ICS_CONTRACT_REGISTRATION |
bankControlStatementInfo.currencyName | Буквенный ISO-код валюты договора | USD |
bankControlStatementInfo.externalId | Идентификатор документа в организации-партнере | 550e8400-e29b-41d4-a716-446655440000 |
contractDate | Дата договора | 2019-05-16 |
contractEndDate | Дата договора | 2019-05-16 |
contractNumber | Номер контракт а | 2442 |
contractType | Код вида контракта, заполняемый для экспортных контрактов при представлении сведений по контракту без контракта (Режим создания ВБК) | MULTI_CONTRACT |
currencyCode | Цифровой код валюты договора | 840 |
date | Дата создания документа по местному времени | 2019-05-16 |
TABLES | Значение указывается при наличии UUID-ов больших файлов или данных о нерезидентах | |
Table=BfAttachments | Значение указывается при наличии UUID-ов больших файлов | |
fileId | UUID больших файлов | 31663ef5-7975-4016-b0f3-f1d70a4e9c22 |
# | Разделитель значений UUID-ов больших файлов | |
fileId | UUID больших файлов | 51663ef5-7975-4016-b0f3-f1d70a4e9c22 |
# | Разделитель значений UUID-ов больших файлов | |
Table=NonResidents | ||
countryCode | Цифровой код страны иностранного контрагента | 38 |
countryName | Наименование страны иностранного контрагента | Казахстан |
name | Наименование иностранного контрагента | Kazan |
# | Разделитель нерези дентов |
amount=1.01
bankControlStatementInfo.authPersonName=Иванов Иван Иванович
bankControlStatementInfo.authPersonTelfax=4955005550
bankControlStatementInfo.creationMode=ICS_CONTRACT_REGISTRATION
bankControlStatementInfo.currencyName=USD
bankControlStatementInfo.externalId=16d6a46e-e05f-48eb-ac69-a44980ae64cf
contractDate=2019-09-26
contractEndDate=2019-09-26
contractNumber=123АБВ
contractType=MULTI_CONTRACT
currencyCode=840
date=2019-09-26
TABLES
Table=NonResidents
countryCode=038
countryName=Казахстан
name=Kazan
#