ym88659208ym87991671
Создание справки о подтверждающих документах | Документация для разработчиков

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

Обновлено 29 ноября 2024
Компаниям
Холдингам

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

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

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

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

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

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

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

Request

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

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

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

digestSignatures

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

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

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

Responses

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