ym88659208ym87991671
Электронный реестр на открытие счетов и выпуск карт - интеграция для холдингов | Документация SmartMarket
Skip to main content

Электронный реестр на открытие счетов и выпуск карт

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

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

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

Создание реестра

Ресурс позволяет создавать электронный реестр на открытие счетов и выпуск карт по собственной и дочерней организации.

Шаги

1. Получить AccessToken.

2. Сформировать ЭП.

3. Отправить запрос.

Для создания электронного реестра на открытие счетов и выпуск карт необходимо отправить POST-запрос (/v1/card-issues), в котором передать авторизационный токен к данным (Access Token) и реквизиты Электронного реестра. Авторизационный токен передается в параметре **Authorization` заголовка запроса

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.

Модель запроса и ответа

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token организации, полученный через SSO
Пример: Bearer f8ad3141-b7e8-4924-92de-3de4fd0a464e-1
Параметры тела запроса
CardIssue {
accept (boolean)Флаг Согласие физ. лиц получено,
authPersonName (string, optional)ФИО ответственного лица,
authPersonTelfax (string, optional)Телефон ответственного лица,
bankComment (string, optional, read only)Банковский комментарий к статусу документа,
bankStatus (string, optional, read only)Статус документа,
contractDate (string)Дата зарплатного договора,
contractNumber (string)Номер зарплатного договора,
date (string)Дата составления документа,
digestSignatures (Array[Signature], optional)Электронные подписи по дайджесту документа,
employeeCardIssue (Array[CardIssueEmployee])Реквизиты сотрудников в реестре,
employeesNumber (integer)Итоговое количество сотрудников,
externalId (string)Идентификатор документа, присвоенный сервисом (UUID),
number (string)Номер документа,
orgName (string)Наименование организации пользователя,
orgTaxNumber (string)ИНН организации пользователя
}Signature {
base64Encoded (string)Значение электронной подписи, закодированное в Base64,
certificateUuid (string)Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
}CardIssueEmployee {
accountNumber (string, optional, read only)Номер открытого счета,
bankMessage (string, optional, read only)Банковский комментарий к статусу карты,
birthDate (string)Дата рождения,
birthPlace (string)Место рождения,
cardInfo (CardIssueCardInfo)Контактная информация,
cardUniqueDesignCode (string, optional)Код индивидуального дизайна карты,
categoryCode (string)Код категории населения,
citizenship (CardIssueCitizenship)Гражданство сотрудника,
contactInfo (CardIssueContactInfo, optional)Контактная информация,
firstName (string)Имя,
identityDoc (CardIssueIdentityDoc, optional)Документ удостоверяющий личность,
inn (string, optional)ИНН,
issCard (boolean, optional, read only)Признак того что карта выпущена,
lastName (string)Фамилия,
middleName (string, optional)Отчество,
personnelNumber (string, optional)Табельный номер,
placeOfService (CardIssuePlaceOfService)Места обслуживания физических лиц,
position (string, optional)Должность,
registrationAddress (CardIssueAddress)Адрес регистрации,
resident (boolean, optional)Резидент РФ,
residentalAddress (CardIssueAddress, optional)Адрес регистрации,
result (string, optional, read only)Результат открытия счетов / выпуска карт,
sameAddress (boolean, optional)Адреса регистрации и проживания совпадают,
sendReport (boolean, optional)Признак рассылки отчета по Internet ,
serNumber (integer)№ п/п,
sex (boolean)Пол
}CardIssueCardInfo {
bonusId (string, optional)Идентификатор бонус программы,
bonusNum (string, optional)Номер участника в бонусной программе,
cardCurrName (string)Цифровой код валюты счета,
cardTypeCode (string)Код типа карты,
cardTypeName (string)Тип карты,
embossedTextFirstName (string)Текст эмбоссированный Имя,
embossedTextSurname (string)Текст эмбоссированный Фамилия
}CardIssueCitizenship {Гражданство сотрудника:
country (string)наименование страны,
countryCode (string)трехбуквенный код страны,
countryNumericCode (string)цифровой код страны
}CardIssueContactInfo {
email (string, optional)Электронная почта,
homePhone (string, optional)Домашний телефон,
mobileOperatorType (string, optional)Наименование оператора мобильной связи,
mobilePhone (string, optional)Мобильный телефон,
officePhone (string, optional)Рабочий телефон
}CardIssueIdentityDoc {
issueDate (string)Дата выдачи,
issuer (string)Кем выдан,
issuerCode (string)Код органа, выдавшего документ,
number (string)Номер,
serial (string)Серия,
type (string)Наименование ДУЛ,
typeCode (string)Код вида документа
}CardIssuePlaceOfService {
branchCode (string)Код подразделения,
branchName (string)Наименование подразделения,
osb (string)Номер отделения сберегательного банка,
tb (string)Номер территориального банка,
vsp (string)Номер внутреннего структурного подразделения
}CardIssueAddress {
building (string, optional)Номер корпуса,
city (string, optional)Город,
country (string)Наименование страны,
countryCode (string)Трехбуквенный код страны,
countryNumericCode (string)Цифровой код страны,
district (string, optional)Район,
flat (string, optional)Номер офиса/квартиры,
fullAddress (string, optional)Полный адрес,
house (string)Номер дома,
postalCode (string)Индекс,
settlementName (string, optional)Наименование нас. пункта,
state (string)Субъект/Регион,
street (string)Улица
}

Пример запроса

{
"accept": "false",
"authPersonName": "Иванов Алексей Сергеевич",
"authPersonTelfax": "4955005550",
"bankComment": "string",
"bankStatus": "string",
"contractDate": "2018-12-31",
"contractNumber": "1",
"date": "2018-12-31",
"digestSignatures": [
{
"base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
"certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
}
],
"employeeCardIssue": [
{
"accountNumber": "40802810600000200000",
"bankMessage": "Счет успешно открыт",
"birthDate": "2018-12-31",
"birthPlace": "г. Москва",
"cardInfo": {
"bonusId": "AE",
"bonusNum": "77777",
"cardCurrName": "810",
"cardTypeCode": "12",
"cardTypeName": "Visa Classic",
"embossedTextFirstName": "IMIA",
"embossedTextSurname": "FAMILIIA"
},
"cardUniqueDesignCode": "P1112FFF",
"categoryCode": "207",
"citizenship": {
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643"
},
"contactInfo": {
"email": "address@email.ru",
"homePhone": "4955005550",
"mobileOperatorType": "Оператор ТЕСТ",
"mobilePhone": "4955005550",
"officePhone": "4955005550"
},
"firstName": "Дмитрий",
"identityDoc": {
"issueDate": "2018-12-31",
"issuer": "ОВД г.Москва",
"issuerCode": "555-444",
"number": "564534",
"serial": "3434",
"type": "Паспорт гражданина Российской Федерации",
"typeCode": "21"
},
"inn": "7707083893",
"issCard": false,
"lastName": "Петров",
"middleName": "Сергеевич",
"personnelNumber": "3467543",
"placeOfService": {
"branchCode": "3852781654",
"branchName": "доп офис 1654",
"osb": "5278",
"tb": "38",
"vsp": "1654"
},
"position": "Директор",
"registrationAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"resident": false,
"residentalAddress": {
"building": "23",
"city": "Москва",
"country": "РОССИЯ",
"countryCode": "RUS",
"countryNumericCode": "643",
"district": "Ленинский район",
"flat": "77",
"fullAddress": "346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111",
"house": "45",
"postalCode": "346311",
"settlementName": "Дворики",
"state": "Владимирская область",
"street": "Рижская"
},
"result": "Счет открыт",
"sameAddress": false,
"sendReport": false,
"serNumber": 1,
"sex": false
}
],
"employeesNumber": 254,
"externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
"number": "1",
"orgName": "Общество с ограниченной ответственностью \"Клиент\"",
"orgTaxNumber": "7707083893"
}

Передача электронной подписи

Для передачи ЭП под документом используется массив digestSignatures, в котором передаются элементы типа Signature (все поля обязательны):

Наименования поляОписания поляПример
base64Encoded (string)Значение ЭП документаHlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==
certificateUuid (string)Идентификатор сертификата, использованного при создании ЭП ( можно узнать, обратившись к ресурсу /v1/crypto)22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6

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

Документ может быть подписан следующими наборами подписей:

  • одна (единственная) подпись;

  • первая и вторая подписи.

При этом подписант, обладающий полномочием единственной подписи, не может «сочетаться» с подписантом, владеющим первой или второй подписью.

Очередность наложения ЭП при наложении первой и второй подписей не имеет значения, состав полей дайджеста не изменяется. Тип подписи указывается в настройках криптопрофиля, когда пользователь Партнера создается в Банке.

Формирование ЭП

  1. Из документа формируется строковая последовательность (ключевой буфер или дайджест), включающая все значимые данные документа.

  2. Затем от дайджеста вычисляется хеш по стандарту ГОСТ 34.11-94 с параметрами GostR3411-94-CryptoProParamSet.

  3. Полученное значение хеш-функции подписывается по стандарту ГОСТ 34.10-2001 с параметрами GostR3410-2001-CryptoPro-B-ParamSet.

  4. 64 байта, полученные в результате шага 3 и представленные в виде, описанном в пункте 3.1 RFC 4490 и есть сформированная электронная подпись.

Дайджест имеет текстовый формат, поэтому в значении полей могут быть переданы любые символы.

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

Наименование поляОписание поляПример
externalIdИдентификатор документа, присвоенный сервисом550e8400-e29b-41d4-a716-446655440000
numberНомер документа345678
dateДата документа28.02.2019
orgNameНаименование организации пользователяООО "ТЕСТ"
orgTaxNumberИНН организации пользователя1,23457E+11
authPersonNameФИО ответственного лицаПетров Петр Иванович
authPersonTelfaxТелефон ответственного лица79263689379
contractNumberНомер зарплатного договора38172522
contractDateДата зарплатного договора28.02.2019
acceptФлаг Согласие физ. лиц полученоtrue
employeesNumberИтоговое количество сотрудников44
employeeCardIssue.serNumber№ п/п1
employeeCardIssue.lastNameФамилияИванов
employeeCardIssue.firstNameИмяИван
employeeCardIssue.middleNameОтчествоСергеевич
employeeCardIssue.citizenship.countryNumericCodeГражданство сотрудника: цифровой код страны643
employeeCardIssue.citizenship.countryCodeГражданство сотрудника: буквенный код страныRUS
employeeCardIssue.citizenship.countryГражданство сотрудника: наименование страныРОССИЯ
employeeCardIssue.residentРезидент РФ1
employeeCardIssue.birthDateДата рождения28.02.2019
employeeCardIssue.birthPlaceМесто рожденияг. Москва
employeeCardIssue.sexПол1
employeeCardIssue.positionДолжностьДиректор
employeeCardIssue.personnelNumberТабельный номер3467543
employeeCardIssue.innИНН1234567774
employeeCardIssue.registrationAddress.postalCodeАдрес регистрации: Индекс346311
employeeCardIssue.registrationAddress.countryNumericCodeАдрес регистрации: Цифровой код страны643
employeeCardIssue.registrationAddress.countryCodeАдрес регистрации: Буквенный код страныRUS
employeeCardIssue.registrationAddress.countryАдрес регистрации: Наименование страныРОССИЯ
employeeCardIssue.registrationAddress.stateАдрес регистрации: Субъект/РегионВладимирская область
employeeCardIssue.registrationAddress.districtАдрес регистрации: РайонЛенинский район
employeeCardIssue.registrationAddress.cityАдрес регистрации: ГородМосква
employeeCardIssue.registrationAddress.settlementNameАдрес регистрации: Наименование нас. пунктаДворики
employeeCardIssue.registrationAddress.streetАдрес регистрации: УлицаРижская
employeeCardIssue.registrationAddress.houseАдрес регистрации: Номер дома45
employeeCardIssue.registrationAddress.buildingАдрес регистрации: Номер корпуса23
employeeCardIssue.registrationAddress.flatАдрес регистрации: Номер офиса/квартиры77
employeeCardIssue.registrationAddress.fullAddressАдрес регистрации: Полный адрес346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111
employeeCardIssue.sameAddressАдреса регистрации и проживания совпадаютfalse
employeeCardIssue.residentalAddress.postalCodeАдрес проживания: Индекс346311
employeeCardIssue.residentalAddress.countryNumericCodeАдрес проживания: Цифровой код страны643
employeeCardIssue.residentalAddress.countryCodeАдрес проживания: Буквенный код страныRUS
employeeCardIssue.residentalAddress.countryАдрес проживания: Наименование страныРОССИЯ
employeeCardIssue.residentalAddress.stateАдрес проживания: Субъект/РегионВладимирская область
employeeCardIssue.residentalAddress.districtАдрес проживания: РайонЛенинский район
employeeCardIssue.residentalAddress.cityАдрес проживания: ГородМосква
employeeCardIssue.residentalAddress.settlementNameАдрес проживания: Наименование нас. пунктаДворики
employeeCardIssue.residentalAddress.streetАдрес проживания: УлицаРижская
employeeCardIssue.residentalAddress.houseАдрес проживания: Номер дома45
employeeCardIssue.residentalAddress.buildingАдрес проживания: Номер корпуса23
employeeCardIssue.residentalAddress.flatАдрес проживания: Номер офиса/квартиры77
employeeCardIssue.residentalAddress.fullAddressАдрес проживания: Полный адрес346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111
employeeCardIssue.identityDoc.typeCodeКод вида документа21
employeeCardIssue.identityDoc.typeНаименование ДУЛПаспорт гражданина Российской Федерации
employeeCardIssue.identityDoc.serialСерия3434
employeeCardIssue.identityDoc.numberНомер564534
employeeCardIssue.identityDoc.issueDateДата выдачи28.02.2019
employeeCardIssue.identityDoc.issuerКем выданОВД г.Москва
employeeCardIssue.identityDoc.issuerCodeКод органа, выдавшего документ555-444
employeeCardIssue.contactInfo.homePhoneДомашний телефон9161967771
employeeCardIssue.contactInfo.officePhoneРабочий телефон9161967771
employeeCardIssue.contactInfo.mobilePhoneМобильный телефон9161967771
employeeCardIssue.contactInfo.mobileOperatorTypeНаименование оператора мобильной связиОператор ТЕСТ
employeeCardIssue.contactInfo.emailЭлектронная почтаTEST@TEST.ru
employeeCardIssue.cardInfo.cardTypeCodeКод типа карты12
employeeCardIssue.cardInfo.cardTypeNameТип картыVisa Classic "Аэрофлот"
employeeCardIssue.cardInfo.bonusNumНомер участника в бонусной программе77777
employeeCardIssue.cardInfo.bonusIdИдентификатор бонус программыAE
employeeCardIssue.cardInfo.cardCurrNameISO Валюта счета810
employeeCardIssue.cardInfo.embossedTextFirstNameТекст эмбоссированный ИмяIMIA
employeeCardIssue.cardInfo.embossedTextSurnameТекст эмбоссированный ФамилияFAMILIIA
employeeCardIssue.placeOfService.branchNameНаименование подразделениядоп офис 1654
employeeCardIssue.placeOfService.branchCodeКод подразделения3852781654
employeeCardIssue.placeOfService.osbНомер ОСБ5278
employeeCardIssue.placeOfService.vspНомер ВСП1654
employeeCardIssue.placeOfService.tbНомер ТБ38
employeeCardIssue.cardUniqueDesignCodeКод индивидуального дизайна картыP44PS444111
employeeCardIssue.categoryCodeКод категории населения207
employeeCardIssue.sendReportПризнак рассылки отчета по Internettrue

Пример дайджеста

accept=true
authPersonName=Иванов Алексей Сергеевич
authPersonTelfax=8(495)1234567
contractDate=2009-10-12
contractNumber=38172522
date=2019-04-08
employeesNumber=1
externalId=306c694f-8c07-41a3-8dfc-fcbd1ddea3a2
number=679
orgName=ООО "ОСТИН"
orgTaxNumber=7728551510
TABLES
Table=EmployeeCardissues
employeeCardIssue.birthDate=2018-12-31
employeeCardIssue.birthPlace=г. Москва
employeeCardIssue.cardInfo.bonusId=AE
employeeCardIssue.cardInfo.bonusNum=77777
employeeCardIssue.cardInfo.cardCurrName=810
employeeCardIssue.cardInfo.cardTypeCode=12
employeeCardIssue.cardInfo.cardTypeName=Visa Classic
employeeCardIssue.cardInfo.embossedTextFirstName=IMIA
employeeCardIssue.cardInfo.embossedTextSurname=FAMILIIA
employeeCardIssue.cardUniqueDesignCode=P1112FFF
employeeCardIssue.categoryCode=207
employeeCardIssue.citizenship.country=РОССИЯ
employeeCardIssue.citizenship.countryCode=RUS
employeeCardIssue.citizenship.countryNumericCode=643
employeeCardIssue.contactInfo.email=TEST@TEST.ru
employeeCardIssue.contactInfo.homePhone=9161967771
employeeCardIssue.contactInfo.mobilePhone=9161967771
employeeCardIssue.contactInfo.officePhone=9161967771
employeeCardIssue.firstName=Дмитрий
employeeCardIssue.identityDoc.issueDate=2018-12-31
employeeCardIssue.identityDoc.issuer=ОВД
employeeCardIssue.identityDoc.issuerCode=555-444
employeeCardIssue.identityDoc.number=564534
employeeCardIssue.identityDoc.serial=3434
employeeCardIssue.identityDoc.type=Паспорт гражданина Российской Федерации
employeeCardIssue.identityDoc.typeCode=21
employeeCardIssue.inn=222201236445
employeeCardIssue.lastName=Петров
employeeCardIssue.middleName=Сергеевич
employeeCardIssue.personnelNumber=Директор
employeeCardIssue.placeOfService.branchCode=3852781654
employeeCardIssue.placeOfService.branchName=доп офис 1654
employeeCardIssue.placeOfService.osb=5278
employeeCardIssue.placeOfService.tb=38
employeeCardIssue.placeOfService.vsp=1654
employeeCardIssue.position=Директор
employeeCardIssue.registrationAddress.building=23
employeeCardIssue.registrationAddress.city=Москва
employeeCardIssue.registrationAddress.country=РОССИЯ
employeeCardIssue.registrationAddress.countryCode=RUS
employeeCardIssue.registrationAddress.countryNumericCode=643
employeeCardIssue.registrationAddress.district=Ленинский район
employeeCardIssue.registrationAddress.flat=77
employeeCardIssue.registrationAddress.fullAddress=346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111
employeeCardIssue.registrationAddress.house=45
employeeCardIssue.registrationAddress.postalCode=346311
employeeCardIssue.registrationAddress.settlementName=Дворики
employeeCardIssue.registrationAddress.state=Владимирская область
employeeCardIssue.registrationAddress.street=Рижская
employeeCardIssue.resident=0
employeeCardIssue.residentalAddress.building=23
employeeCardIssue.residentalAddress.city=Москва
employeeCardIssue.residentalAddress.country=РОССИЯ
employeeCardIssue.residentalAddress.countryCode=RUS
employeeCardIssue.residentalAddress.countryNumericCode=643
employeeCardIssue.residentalAddress.district=Ленинский район
employeeCardIssue.residentalAddress.flat=77
employeeCardIssue.residentalAddress.fullAddress=346311, РОССИЯ, РЕГИОН, РАЙОН, ГОРОД, УЛИЦА, ДОМ, КОРПУС, 111
employeeCardIssue.residentalAddress.house=45
employeeCardIssue.residentalAddress.postalCode=346311
employeeCardIssue.residentalAddress.settlementName=Дворики
employeeCardIssue.residentalAddress.state=Владимирская область
employeeCardIssue.residentalAddress.street=Рижская
employeeCardIssue.sameAddress=false
employeeCardIssue.sendReport=false
employeeCardIssue.serNumber=1
employeeCardIssue.sex=1

Получение статуса реестра

Ресурс позволяет получить статус ранее отправленного электронного реестра на открытие счетов и выпуск карт.

Шаги

1. Получить AccessToken.

2. Отправить запрос

Для получения статуса необходимо отправить POST-запрос (//v1/card-issues/{externalId}/state), в котором передать авторизационный токен к данным (Access Token) и реквизиты Электронного реестра. Авторизационный токен передается в параметре Authorization заголовка запроса

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token полученный через SSO
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
externalId (String)Идентификатор документа, присвоенный клиентом

Пример запроса

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/cardissues/22a6dd81-103a-4d3a-8e9b-0ba4b527f010/state'

Модель ответа

НаименованиеОписание
DocState {
bankComment (string, optional, read only)Банковский комментарий к статусу документа,
bankStatus (string, optional)Статус документа,
channelInfo (string, optional, read only)Комментарий, специфичный для документа, полученного по данному каналу,
}

Пример ответа

{
"bankStatus": "CREATED",
"bankComment": null,
"channelInfo": null
}

Возможные статусы

Код состояние документаНаименование статусаНазначение кода состояния
VALIDEDSЭП/АСП вернаПромежуточный / Продолжать опрашивать
UNABLE_TO_RECEIVEОшибка при приемеКонечный / Прекратить опрос
TRIEDПроверенПромежуточный / Продолжать опрашивать
SIGNEDПодписанПромежуточный / Продолжать опрашивать
REQUISITEERRORОшибка реквизитовКонечный / Прекратить опрос
REFUSEDBYBANKОтвергнут БанкомКонечный / Прекратить опрос
REFUSEDBYABSОтказан АБСКонечный / Прекратить опрос
PARTSIGNEDЧастично подписанПромежуточный / Прекратить опрос (При получении статуса необходимо подписать документ в СББОЛ)
PARTIMPLEMENTEDЧастично исполненКонечный / Прекратить опрашивать (Для получения подробной информации об исполнении документа выполнить запрос /v1/cardissues/{externalId})
INVALIDEDSЭП/АСП не вернаКонечный / Прекратить опрос
INCONSISTENT_DATAНарушена целостность документаКонечный / Прекратить опрос
IMPORTEDИмпортированПромежуточный / Прекратить опрос
IMPLEMENTEDИсполненУспешный конечный / Прекратить опрос
EXPORTEDВыгруженПромежуточный / Продолжать опрашивать
DELIVEREDДоставленПромежуточный/Продолжать опрашивать
DELAYEDПриостановленПромежуточный / Продолжать опрашивать
CREATEDСозданПромежуточный / Прекратить опрос (При получении статуса необходимо подписать документ в СББОЛ)
CORRESPONDENT_APPROVE_WAITINGОжидает подтверждения контрагентаПромежуточный / Продолжать опрашивать
CHECKERRORОшибка контроляКонечный / Прекратить опрос
ACCEPTED_BY_ABSПринят АБСПромежуточный / Продолжать опрашивать
ACCEPTEDПринятПромежуточный / Продолжать опрашивать

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

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

Шаги

1. Получить AccessToken.

2. Отправить запрос

Для получения документа необходимо отправить POST-запрос (//v1/card-issues/{externalId}), в котором передать авторизационный токен к данным (Access Token) и реквизиты Электронного реестра. Авторизационный токен передается в параметре Authorization заголовка запроса

Чтобы получить доступ к ресурсу, необходимо передать в scope сервис CARD_ISSUE.

Модель запроса

НаименованиеОписание
Параметры заголовка
Authorization (String)Access token полученный через SSO.
Пример: Bearer c76fb018-27c9-43f7-a751-62646eda7e1a-1
Параметры запроса
externalId (String)Идентификатор документа, присвоенный клиентом

Пример запроса

curl -X GET --header 'Accept: application/json' --header
'Authorization: Bearer daf9a14c-821d-4bde-9c10-0e56e63d54a0-1'
'https://edupirfintech.sberbank.ru:9443/fintech/api/v1/cardissues/22a6dd81-103a-4d3a-8e9b-0ba4b527f010'

Модель ответа

Модель и пример ответа соответствуют описанным для /v1/card-issues.

Дополнительная информация

Подписание запроса транспортной подписью

Content-Type может содержать одно из двух значений:

  • application/json – запрос без подписи

  • application/jose – запрос, подписанный транспортной подписью

Если Content-Type имеет значение application/jose, то запрос должен содержать данные (реквизитный состав платежного документа) в виде компактной сериализации RFC 7515: JSON Web Signature (JWS).

JWS состоит из:

1. Заголовка (Header)
2. JSON-документа с реквизитным составом платежного поручения (Payload)
3. Подписи запроса (Signature)

Формирование компактной сериализации JWS

JWS формируется из трех составляющих:

Base64Url(Header) || ’.’ ||  Base64Url(Payload) || ’.’ || Base64Url(Signature)

Signature - это подпись данных приватной частью ключевой пары клиента (используется приватный ключ парный сертификату клиента с UUID, указанному в Заголовке (Header) в параметре kid).

Подпись вычисляется по алгоритму указанному в Заголовке (Header) в параметре alg, в данном случае gost34.10-2012, и вычисляется от исходных данных:

Base64Url(Header) || ‘.’ || Base64Url(Payload).

Формирование исходных данных для вычисления подписи описано в спецификации RFC 7515: JSON Web Signature (JWS).

Следует отметить, что при кодировании JWS используется преобразование Base64Url, отличающееся от Base64 преобразования.
Условно это преобразование можно представить следующим образом:

Base64Url(x) := Base64(x).Split(‘=’)[0].Replace(‘+’, ’-’).Replace(‘/’, ’_’)

здесь функция Split(x), разбивает строку на части ([i] означает взятие i–ой части), используя символ разделитель x, функция Replace(x,y) заменяет все вхождения символа x на символ y.

Преобразование BASE64URL, отличается от BASE64 преобразования:

BASE64URLBASE64
- (minus)+
_ (underline)/
  • В BASE64URL не используется (опускается) padding, т.е. не добавляются знаки ‘=’ на конце закодированного содержимого Padding of Encoded Data.

Коды возврата

Код возвратаОписание кода возвратаПричина возникновения
200 (GET-запрос)ОК
201 (POST-запрос)CREATED
Создан
400DESERIALIZATION_FAULT
Неверный формат запросаНеверный формат запроса
WORKFLOW_FAULT
Для внешнего сервиса недоступны операции по счету: 40702810ХХХХХХХХХХХХДля внешнего сервиса недоступны операции по счету:

счет не добавлен в список разрешенных в оферте;
внешний сервис заблокирован в СББОЛ;
счет указан неверно.

Отсутствует доступный открытый рублевый расчетный счет у организации плательщика
Документ с такими реквизитами уже существуетДокумент с такими реквизитами уже существует. Проверка по номер документа в течении года.
Не указан идентификатор сертификата подписиНе указан идентификатор сертификата подписи(параметр kid заголовка JWS)
Некорректный формат параметра kid заголовка JWSНекорректный формат параметра kid заголовка JWS(ожидается UUID)
VALIDATION_FAULT
Ошибка валидацииОшибка валидации данных запроса с указанием некорректных значений. Значения полей модели или параметров запроса не соответствуют допустимым и определенным в модели.
SIGN_CHECK_EXCEPTION
Подлинность подписи не установлена/Сертификат не обнаружен или не является активнымОшибка возникает, если не удалось установить подлинность подписи
401UNAUTHORIZED
accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-хУказан некорректный или просроченный access_token.
403ACTION_ACCESS_EXCEPTION
Операция не может быть выполнена: доступ к ресурсу запрещенУ пользователя нет прав на использование соответствующего сервиса SberBusinessAPI, доступ к которому не предусмотрен настройками scope; У пользователя отсутствует оферта с внешним сервисом.
415JWS_EXCEPTED
В соответствии с текущими настройками сервиса с clientId=%s необходимо использовать запрос в формате JWS Compact SerializationОшибка возникает, если в настройках внешних сервисов выставлен флаг "Требуется подпись для внешнего сервиса"
500UNKNOWN_EXCEPTION
Внутренняя ошибка сервера
503UNAVAILABLE_RESOURCE_EXCEPTION
Сервис временно недоступенПроводятся технические работы
Обновлено 27 апреля 2022

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней