Получение статуса письма для целей ВК (в банк)
Для получения статуса письма необходимо отправить GET-запрос /fintech/api/v1/curr-control-messages/to-bank/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.
В параметре scope ссылки авторизации пользователя должен быть указан сервис CURR_CONTROL_MESSAGE_TO_BANK для получения доступа к этому запросу.
При получении статуса письма для целей ВК в песочнице, ответ зависит от переданного externalId.
Все остальные поля запроса заполняйте произвольными данными в соответствии с требованиями в документации.
1. Чтобы получить статус письма для целей ВК, нужно в поле externalId передать произвольное значение.
2. Чтобы получить ошибку "Документ с указанным ID не найден.", нужно в поле externalId передать значение 22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6.
3. Чтобы получить статус документа в статусе "IMPORTED", передайте в поле externalId значение 7a021b0b-1015-40aa-b149-6c51e8d8a417.
4. Чтобы получить статус документа в статусе "EXPORTED", передайте в поле externalId значение 7a021b0b-1015-40aa-b149-6c51e8d8a418.
5. Чтобы получить статус документа в статусе "EXPORTING", передайте в поле externalId значение 7a021b0b-1015-40aa-b149-6c51e8d8a419.
6. Чтобы получить статус документа в статусе "PROCESSING", передайте в поле externalId значение 7a021b0b-1015-40aa-b149-6c51e8d8a420.
Запрос
Ответы
OK
В ответе вернется объект статуса документа с полями:
bankStatus- текущий статус документаbankComment- комментарий банка к статусуchannelInfo- дополнительная информация о канале
Ошибка в запросе или его жизненном цикле
| Cause | Message | Description |
|---|---|---|
| DESERIALIZATION_FAULT | Неверный формат запроса | Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в response в массиве 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 |
|---|---|---|
| NOT_FOUND | Документ с указанным ID не найден |
"Превышен лимит запросов"
| Cause | Message | Description |
|---|---|---|
| TOO_MANY_REQUESTS | Превышен лимит запросов. Повторите операцию позже. | Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее |
Внутренняя ошибка сервера
| Cause | Message | Description |
|---|---|---|
| UNKNOWN_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |
Сервис временно недоступен
| Cause | Message | Description |
|---|---|---|
| UNAVAILABLE_RESOURCE_EXCEPTION | Внутренняя ошибка сервера | Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка. |