Создание письма для целей ВК (в банк)
/v1/curr-control-messages/to-bank
Для создания и отправки письма в ВК необходимо отправить POST-запрос /fintech/api/v1/curr-control-messages/to-bank
с токеном доступа (access_token) пользователя в параметре Authorization заголовка и реквизитами письма в теле.
В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_TO_BANK
для получения доступа к этому запросу.
- Если в запросе на создание заявления передать ЭП к документу (объект digestSignatures), то Банк сразу начнет обработку документа.
- Если в запросе не передавать ЭП к документу, то заявление будет создано в статусе черновик. Для начала обработки документа Банком потребуется зайти в интерфейс СберБизнес и подписать его.
Дайджест запроса
Дайджест это текстовый документ, содержащий перечень и значения полей запроса, к которому он относится и предназначенный для подписания ЭЦП. Сохраняйте порядок и количество полей дайджеста, как показано в примере ниже, иначе подписать его не получится.
Формат дайджеста:
Наименование поля | Описание поля | Пример |
---|---|---|
authPersonName | ФИО ответственного лица | Петров Петр Иванович |
authPersonTelfax | Телефон ответственного лица | 79263689379 |
date | Дата документа | 28.02.2019 |
externalId | Идентификатор документа в организации-партнере | 550e8400-e29b-41d4-a716-446655440000 |
orgName | Наименование организации клиента | ООО "ТЕСТ" |
subject | Тема письма | Договор ВК |
text | Текст письма | Добрый день! |
TABLES | Значение указывается при наличии UUID-ов больших файлов | |
Table=BfAttachments | Значение указывается при наличии UUID-ов больших файлов | |
fileId | UUID больших файлов | 31663ef5-7975-4016-b0f3-f1d70a4e9c22 |
# | Разделитель значений UUID-ов больших файлов | |
fileId | UUID больших файлов | 51663ef5-7975-4016-b0f3-f1d70a4e9c22 |
# | Разделитель значений UUID-ов больших файлов |
Пример дайджеста:
aauthPersonName=Иванов Алексей Сергеевич
authPersonTelfax=8(495)1234567
date=2019-04-16
externalId=31663ef5-7975-4016-b0f3-f1d70a4e9c22
orgName=ООО"Риэль"
subject=ТЕМА ПИСЬМА
text=ТЕКСТ ПИСЬМА
TABLES
Table=BfAttachments
fileId=31663ef5-7975-4016-b0f3-f1d70a4e9c22
#
fileId=51663ef5-7975-4016-b0f3-f1d70a4e9c22
#
Запрос
Created
Операция не завершена полностью
Ошибка в запросе или его жизненном цикле
Cause | Message | Description |
---|---|---|
DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request запроса. Скорректируйте заполнение атрибутов и повторите запрос. |
VALIDATION_FAULT | Ошибка валидации | Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request запроса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос. |
Не авторизован
Cause | Message | Description |
---|---|---|
UNAUTHORIZED | accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х | Указан некорректный или просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос. |
Запрещено
Cause | Message | Description |
---|---|---|
ACTION_ACCESS_EXCEPTION | Операция не может быть выполнена: доступ к ресурсу запрещен | Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CURR_CONTROL_MESSAGE_FROM_BANK . Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token. |
"Превышен лимит запросов"
Cause | Message | Description |
---|---|---|
TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
Внутренняя ошибка сервера
Cause | Message | Description |
---|---|---|
UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
Сервис временно недоступен
Cause | Message | Description |
---|---|---|
UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |