Получение статуса письма для целей ВК (в банк)

Обновлено 27 мая 2025

GET

/v1/curr-control-messages/to-bank/{externalId}/state

Для получения статуса письма необходимо отправить GET-запрос /fintech/api/v1/curr-control-messages/to-bank/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

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

Запрос

Ответы

• 200
• 400
• 401
• 403
• 404
• 429
• 500
• 503

OK

Статусы письма

bankStatus	Наименование статуса	Назначение
Промежуточные статусы/Продолжать опрашивать
ACCEPTED	Принят	Электронный документ принят на стороне Банка
ACCEPTED_BY_ABS	Принят АБС	Электронный документ был принят к обработке в АБС Банка
CREATED	Создан	Документ записан в БД, проверки не выполнялись. Документ не отправлен в банк, требуется подпись
DELIVERED	Доставлен	Запрос доставлен в ДБО и взят в обработку
EXPORTED	Выгружен	Электронный документ выгружен Банком в АБС
SIGNED	Подписан	ЭД подписан предусмотренным для него комплектом подписей. Документ не отправлен в банк, требуется отправить
SUBMITTED	Представлен	Документ находится в обработке на стороне банка
TRIED_BY_CFE	Проверяется ВК	Документ проверяется ВК
Окончательные статусы/Прекратить опрос
CHECKERROR	Ошибка контроля	ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками.
INVALIDEDS	ЭП/АСП не верна	Проверка ЭП под ЭД на стороне Банка дала отрицательный результат
REFUSED_BY_CFE	Отказан ВК	Документ отказан валютным контролем
REFUSEDBYABS	Отказан АБС	Документ отказан АБС
REQUISITEERROR	Ошибка реквизитов	ЭД не прошел проверки при приеме на стороне Банка
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFE	Принят ВК	Документ принят валютным контролем

Ошибка в запросе или его жизненном цикле

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_TO_BANK. Необходимо добавить одному или несколько операций в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

Не найдено

Cause	Message	Description
NOT_FOUND	Документ с указанным ID не найден

"Превышен лимит запросов"

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

Внутренняя ошибка сервера

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Сервис временно недоступен

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Loading...

Loading...