Получение письма свободного формата (отправленного в банк)
/v1/generic-letters/to-bank/{externalId}
Запрос для получения деталей документа "Письмо в банк", а также дополнительных атрибутов: номер обращения в CRM и идентификатор цепочки писем.
Актуален для писем, имеющих наименование группы письма (groupName
) из справочника GenericLetterType:
- Номер обращения в CRM. Сообщите этот номер службе поддержки в случае возникновения вопросов.
- Идентификатор цепочки. Связывает исходящее письмо в Банк и входящее письмом из Банка.
Должен содержать токен доступа (access_token) пользователя в параметре Authorization заголовка и идентификатор (externalId) созданного письма.
Для доступа к этому методу в параметре scope
ссылки авторизации пользователя должен быть указан сервис GENERIC_LETTER_FROM_BANK
.
Запрос
Path Parameters
Внешний UUID письма свободного формата (в банк)
Header Parameters
Access token организации-клиента, полученный через SSO
OK
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Array [
]
Array [
]
Банковский комментарий к статусу документа
Статус документа
Дата составления документа
digestSignatures
FintechSignature[]
Электронные подписи по дайджесту документа
Значение электронной подписи, закодированное в Base64
Уникальный идентификатор сертификата ключа проверки электронной подписи (UUID)
Возможные значения: <= 10 characters
Номер документа
attachments
object[]
Вложенные документы
Вложение закодированное в Base64
Тип формат файла
Имя файла
bfAttachments
object[]
required
Идентификатор (-ы) больших файлов
Уникальный идентификатор файла
Имя файла
Номер ПСФ в CRM
Идентификатор документа, присвоенный партнером (UUID)
Идентификатор цепочки
Возможные значения: <= 4000 characters
Текст сообщения
Возможные значения: <= 255 characters
Системное имя темы письма
Возможные значения: <= 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
Array [
]
Уникальный идентификатор ошибки (UUID)
Сообщение
checks
object[]
Список проверок, приведших к ошибке
Уровень результата
Сообщение
Названия полей (при наличии связи с моделью)
{
"referenceId": "string",
"message": "string",
"checks": [
{
"level": "ERROR",
"message": "string",
"fields": [
"string"
]
}
]
}
Не авторизован
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Запрещено
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Не найдено
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Внутренняя ошибка сервера
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}
Сервис временно недоступен
- application/json
- Схема
- Пример из схемы
Schema
Причина или основание сообщения
Уникальный идентификатор (UUID)
Сообщение
{
"cause": "string",
"referenceId": "string",
"message": "string"
}