Создание справки о подтверждающих документах
/v1/confirmatory-documents-inquiries
Для создания СПД необходимо отправить POST-запрос /fintech/api/v1/confirmatory-documents-inquiries
с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами документа в теле.
В параметре scope ссылки авторизации пользователя должен быть указан сервис CONFIRMATORY_DOCUMENTS_INQUIRY
для получения доступа к этому запросу.
- Если в запросе на создание заявления передать ЭП к документу (объект 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=BfAttachments | Значение указывается при наличии UUID-ов больших файлов | |
fileId | UUID больших файлов | 08ba3412-118a-4f4d-be23-e93f81d58fdc |
# | Разделитель строк таблицы | |
fileId | UUID больших файлов | e0687514-2c3d-471d-917c-f3e8f9fde1e0 |
# | Разделитель строк таблицы | |
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 |
Пример дайджеста
authPersonName=Иванов Иван Иванович
authPersonTelfax=4955005550
customerBankBic=044525225
customerBankName=ПАО "СБЕРБАНК"
customerINN=2406877205
customerName=Общество с ограниченной ответственностью "Клиент"
customerOKPO=3698203661
date=2019-05-20
dealDate=2019-05-20
externalId=14d62475-e8da-4f24-bcc7-68e4add64131
psNumber=11111111/0011/0000/1
TABLES
Table=BfAttachments
fileId=3e7333db-dbb4-4bc1-a2e2-49cbc5ab834d
#
fileId=e0687514-2c3d-471d-917c-f3e8f9fde1e0
#
Table=Docs
addInfo=Примечание
confDocDate=2019-05-20
confDocNumber=123
contractSum.amount=4.03
contractSum.currencyCode=840
contractSum.currencyName=USD
contractSumDel=1.01
correctionDate=2019-05-20
countryCode=826
countryName=СОЕДИНЕННОЕ КОРОЛЕВСТВО
docCode=03_3
docName=О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам,
указанным в подпункте 5.1.2 пункта 5.1 настоящей Инструкции
docSum.amount=4.03
docSum.currencyCode=840
docSum.currencyName=USD
docSumDel=2.02
expectedLife=2019-05-20
hasConfDocNumber=1
ordinalNumber=0
supplyFeature=2
#
addInfo=Примечание
confDocDate=2019-05-20
confDocNumber=135
contractSum.amount=4.03
contractSum.currencyCode=840
contractSum.currencyName=USD
contractSumDel=2.02
correctionDate=2019-05-20
correctionNumber=1
countryCode=826
countryName=СОЕДИНЕННОЕ КОРОЛЕВСТВО
docCode=03_3
docName=О передаче резидентом на территории Российской Федерации товаров и оказании услуг нерезиденту по контрактам,
docSum.amount=8.08
docSum.currencyCode=840
docSum.currencyName=USD
docSumDel=2.02
expectedLife=2019-05-20
hasConfDocNumber=true
ordinalNumber=2
supplyFeature=3
#
Запрос
Успешный код возврата
Операция не завершена полностью
"Ошибка в запросе или его жизненном цикле"
Cause | Message | Description |
---|---|---|
DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос. |
WORKFLOW_FAULT | Документ с такими реквизитами уже существует | В АС Банка также присутствует проверка на дублирование документов по полям. Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует." |
VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
"Не авторизован"
Cause | Message | Description |
---|---|---|
UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
Некорректное значение Access Token | Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
"Запрещено"
Cause | Message | Description |
---|---|---|
ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CONFIRMATORY_DOCUMENTS_INQUIRY . Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
"Превышен лимит запросов"
Cause | Message | Description |
---|---|---|
TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
"Внутренняя ошибка сервера"
Cause | Message | Description |
---|---|---|
UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
"Сервис временно недоступен"
Cause | Message | Description |
---|---|---|
UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |