Получение статуса письма

Обновлено 29 ноября 2024

/fintech/api/v1/generic-letters/to-bank/{externalId}/state

Запрос позволяет получить статус ранее созданного документа «Письмо в Банк».

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

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

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

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

Request

/fintech/api/v1/generic-letters/to-bank/{externalId}/state

Модель
Пример

Наименование	Тип	Формат	Regexp	Обязательность	Описание
HEADER
Authorization	string	string	^[a-zA-Z0-9]{38}$	required	Access token пользователя, полученный через SSO.
PATH PARAMETERS
externalId	string	UUID	^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$	required	Идентификатор документа, присвоенный вами при создании документа

GET /fintech/api/v1/generic-letters/to-bank/d3d78b7f-8f2a-400a-a114-ab841f9d427d/state HTTP/1.1
Authorization: Bearer xbgDF3brf456ghi789jkl012mNKFtEpqr678
Accept: */*

Responses

200 (OK)

Модель
Пример

Наименование	Тип	Обязательность	Описание
DocState {
bankComment	string	optional	Банковский комментарий к статусу документа,
bankStatus	string	optional	Статус документа,
channelInfo	string	optional	Комментарий, специфичный для документа, полученного по данному каналу
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "bankComment": "Документ в обработке",
  "bankStatus": "PROCESSING",
  "channelInfo": "string"
}

400 (Bad request)

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
ResourceFault {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
checks	array[Check]	optional	Список проверок, приведших к ошибке,
fieldNames	array[string]	optional	Названия полей с некорректным значением (только для VALIDATION_FAULT)
}
Check {
level	string	optional	Уровень результата = ['ERROR', 'WARNING'],
message	string	optional	Сообщение,
fields	array[string]	optional	Названия полей (при наличии связи с моделью)
}

HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8

{
    "cause": "DESERIALIZATION_FAULT",
    "referenceId": "4a0e6754-ad22-4d7d-ac82-810afd08b5b2",
    "message": "Неверный формат запроса",
    "checks": [
        {
            "level": "ERROR",
            "message": "Cannot deserialize instance of `java.util.ArrayList<Signature>` out of START_OBJECT token",
            "fields": [
                "digestSignatures"
            ]
        }
    ],
    "fieldNames": [
        "digestSignatures"
    ]
}

401 (Unauthorized Error)

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "UNAUTHORIZED",
    "referenceId": "014ec3a1-3e41-4805-9e22-d07947b012af",
    "message": "accessToken not found by value = 3513f959-bbd5-490a-9f9f-67fb7380fae5-2"
}

403 (Forbidden)

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция `GENERIC_LETTER_TO_BANK`. Необходимо добавить эту операцию в scope. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 403 Forbidden
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "ACTION_ACCESS_EXCEPTION",
    "referenceId": "7535c2bb-7706-4b16-9882-d68aedbf2fef",
    "message": "Операция не может быть выполнена: доступ к ресурсу запрещен"
}

404 (Not Found)

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

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 404 Not Found
Content-Type: application/json;charset=UTF-8
 
{
    "cause": "NOT_FOUND",
    "referenceId": "1bd1b8b9-1bd3-4159-9909-d30536211114",
    "message": "Документ с указанным ID не найден"
}

500 (Internal Server Error)

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

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset=UTF-8
 
{
  "cause": "UNKNOWN_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a65d",
  "message": "Внутренняя ошибка сервера"
}

503 (Service Temporarily Unavailable)

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

Модель
Пример

Наименование	Тип	Обязательность	Описание
Notice {
cause	string	optional	Причина или основание сообщения,
referenceId	string	optional	Уникальный идентификатор ошибки (UUID),
message	string	optional	Сообщение,
}

HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: application/json;charset=UTF-8

{
  "cause": "UNAVAILABLE_RESOURCE_EXCEPTION",
  "referenceId": "9e209109-4b0d-408c-a2fd-e1983c20a67d",
  "message": "Внутренняя ошибка сервера"
}

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

bankStatus (string)

Код состояние документа	Наименование статуса	Назначение кода состояния
Промежуточные статусы/Продолжать опрашивать
`ACCEPTED`	Принят	Электронный документ принят на стороне Банка
`ACCEPTED_BY_ABS`	Принят АБС	Электронный документ был принят к обработке в АБС Банка
`CREATED`	Создан	Документ записан в БД, проверки не выполнялись
`DELIVERED`	Доставлен	Запрос доставлен в ДБО и взят в обработку
`EXPORTED`	Выгружен	Электронный документ выгружен Банком в АБС
`IN_WORK`	В работе	Документ в работе
`PARTSIGNED`	Частично подписан	ЭД подписан частью подписей, входящих в предусмотренный для данного документа комплект подписей.
`PREPARING_ANSWER`	Подготовка ответа	Подготовка ответа
`RECEIVED_BY_CRM`	Принят CRM	Документ принят CRM
`REGISTERED_CRM`	Зарегистрирован в CRM	Документ зарегистрирован CRM
`SIGNED`	Подписан	ЭД подписан предусмотренным для него комплектом подписей. Документ с этим статусом может быть отправлен для исполнения в банк либо с документа может быть снята подпись (ЭД возвращается к статусу "Частично подписан").
Окончательные статусы/Прекратить опрос
`CHECKERROR`	Ошибка контроля	ЭД сформирован, но при сохранении не прошел проверку корректности заполнения полей и сохранен с имеющимися в нем ошибками.
`REQUISITEERROR`	Ошибка реквизитов	ЭД не прошел проверки при приеме на стороне Банка
`REFUSEDBYABS`	Отказан АБС	Документ отказан АБС
`REFUSEDBYBANK`	Отвергнут Банком	Документ отвергнут Банком
`INVALIDEDS`	ЭП/АСП не верна	Проверка ЭП под ЭД на стороне Банка дала отрицательный результат
`DELETED`	Удален	Документ удален
Окончательные(Успешные) статусы/Прекратить опрос
`PROCESSED`	Обработан	Документ обработан

Получение статуса письма

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

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