Получение писем (из банка)

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

GET

/v1/generic-letters/from-bank

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

Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка, номер страницы документа (page) и дату (messageDate), за которую требуется получить письма.

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

Запрос

Query Parameters

messageDate

date

required

Дата письма (yyyy-MM-dd)

page

int32

required

По умолчанию: 1

Номер страницы (начиная с 1)

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

_links

object[]

Ссылки на связанные ресурсы

Array [

href

string

required

Абсолютный или относительный адрес

rel

string

required

Отношение ссылки к текущей сущности (next, prev)

]

letters

object[]

Письма из Банка

{
  "_links": [
    {
      "href": "?accountNumber=40702810500006103990&statementDate=2018-03-15&page=3",
      "rel": "next"
    }
  ],
  "letters": [
    {
      "bankComment": "string",
      "bankStatus": "string",
      "date": "2018-12-31",
      "digestSignatures": [
        {
          "base64Encoded": "HlaeIHXXEcGT1bFxo1NlpAzpr+kJ2IQrcxVdvDTep6xjsmD1FDb+6NIyLT+/T24S0mPfVCU75sieOMt71TBS7w==",
          "certificateUuid": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6"
        }
      ],
      "number": "1",
      "attachments": [
        {
          "content": "dGVzdA==",
          "mimeType": "image/jpeg",
          "name": "тест.jpg"
        }
      ],
      "bfAttachments": [
        {
          "fileId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
          "fileName": "SB_7718830000_40702810038290010000_T18.txt"
        }
      ],
      "crmNumber": "190410-0033-142400",
      "externalId": "22a6dd81-103a-4d3a-8e9b-0ba4b527f5f6",
      "integrationId": "55daccdf-de87-3879-976c-8b8415c8caf9",
      "text": "У меня все хорошо",
      "typeCode": "payment_recall",
      "typeName": "Направить запрос по 115-ФЗ"
    }
  ]
}

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

• 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...