Создание письма свободного формата (в банк)

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

POST

/v1/generic-letters/to-bank

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

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

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

Запрос

Header Parameters

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

• application/json

Body

required

Письмо свободного формата (в банк)

date

date

required

Дата составления документа

digestSignatures

FintechSignature[]

Электронные подписи по дайджесту документа

Array [

base64Encoded

string

required

Значение электронной подписи, закодированное в Base64

certificateUuid

uuid

required

Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)

]

number

string

Возможные значения: <= 10 characters

Номер документа

attachments

object[]

Вложенные документы

Array [

content

byte[]

Вложение закодированное в Base64

mimeType

string

Тип формат файла

name

string

Имя файла

]

bfAttachments

object[]

required

Идентификатор (-ы) больших файлов

Array [

fileId

string

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

]

externalId

uuid

required

Идентификатор документа, присвоенный партнером (UUID)

text

string

required

Возможные значения: <= 4000 characters

Текст сообщения

typeCode

string

required

Возможные значения: <= 255 characters

Системное имя темы письма

Ответы

• 201
• 202
• 400
• 401
• 403
• 500
• 503

Created

• application/json

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

Schema

bankComment

string

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

bankStatus

string

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

date

date

required

Дата составления документа

digestSignatures

FintechSignature[]

Электронные подписи по дайджесту документа

Array [

base64Encoded

string

required

Значение электронной подписи, закодированное в Base64

certificateUuid

uuid

required

Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)

]

number

string

Возможные значения: <= 10 characters

Номер документа

attachments

object[]

Вложенные документы

Array [

content

byte[]

Вложение закодированное в Base64

mimeType

string

Тип формат файла

name

string

Имя файла

]

bfAttachments

object[]

required

Идентификатор (-ы) больших файлов

Array [

fileId

string

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

fileName

string

Имя файла

]

crmNumber

string

Номер ПСФ в CRM

externalId

uuid

required

Идентификатор документа, присвоенный партнером (UUID)

integrationId

string

Идентификатор цепочки

text

string

required

Возможные значения: <= 4000 characters

Текст сообщения

typeCode

string

required

Возможные значения: <= 255 characters

Системное имя темы письма

typeName

string

Возможные значения: <= 254 characters

Тип письма

{
  "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

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"
}

Loading...

Loading...