Получение статуса письма свободного формата (в банк)

Обновлено 13 марта 2025

GET

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

Запрос для получения статуса документа "Письмо в банк".

Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор (externalId) созданного письма.

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

Запрос

Path Parameters

externalId

string

required

Внешний UUID письма свободного формата (в банк)

Header Parameters

Authorization
string
required
Access token организации-клиента, полученный через SSO
Example: f8ad3141-b7e8-4924-92de-3de4fd0a464e-1

Ответы

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

OK

• application/json

• Схема
• Пример из схемы

Schema

bankComment

string

Банковский комментарий к статусу документа

bankStatus

string

Статус документа

channelInfo

string

Комментарий, специфичный для документа, полученного по данному каналу

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

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

• application/json

• Схема
• Пример из схемы

Schema

referenceId

string

Уникальный идентификатор ошибки (UUID)

message

string

Сообщение

checks

object[]

Список проверок, приведших к ошибке

Array [

level

string

Уровень результата

message

string

Сообщение

fields

string[]

Названия полей (при наличии связи с моделью)

]

{
  "referenceId": "string",
  "message": "string",
  "checks": [
    {
      "level": "ERROR",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Не авторизован

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Запрещено

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Не найдено

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

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

• application/json

• Схема
• Пример из схемы

Schema

cause

string

Причина или основание сообщения

referenceId

string

Уникальный идентификатор (UUID)

message

string

Сообщение

{
  "cause": "string",
  "referenceId": "string",
  "message": "string"
}

Loading...

Loading...