20. Отправка письма в Банк

Размер передаваемого в банк сообщения не должен превышать 50 МБ.
Отправленные ранее в банк письма отозвать нельзя.
Информация для тестирования

Для получения статуса "Принято" [ACPT] необходимо корректно составить и подписать запрос (пример запроса есть ниже в настоящей документации). Затем необходимо написать на п/я h2h@alfabank.ru с просьбой согласовать письмо.

Для получения статуса "Отклонен" [RJCT] достаточно, например, некорректно заполнить один из реквизитов.

URI

POST: /API/v1/ISO20022/Letters

XSD схема

auth.026.001.01

Описание схемы

№ R/
O		 Описание Путь Комментарий/
Пример

Document.CcyCtrlReqOrLttr.GrpHdr

1

R

Уникальный ID сообщения

MsgId

-

2

R

Дата и время создания сообщения

CreDtTm

Формат даты YYYY-MM-DDThh:mm:ss[.mmm]TZD (В случае, если часовой пояс не указан или указан отличный от московского, то время будет приведено к UTC +3).

3

R

Количество транзакций в сообщении

NbOfItms

Кол-во блоков ReqOrLttr

4

R

Наименование организации отправителя сообщения

InitgPty.Pty.Nm

-

5

R

ИНН организации отправителя сообщения

InitgPty.Pty.Id.OrgId.Othr.Id

-

6

R

Признак использования ИНН

InitgPty.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'TXID'

7

R

Номер счёта

InitgPty.Pty.Id.OrgId.Othr.Id

-

8

R

Признак использования счёта

InitgPty.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'ACC'

Document.CcyCtrlReqOrLttr.ReqOrLttr

9

R

Уникальный ID запроса на создание письма

ReqOrLttrId

-

10

R

Наименование организации отправителя запроса на создание письма

Sndr.Pty.Nm

-

11

R

Номер счета (Идентификация отправителя запроса)

Sndr.Pty.Id.OrgId.Othr.Id

-

12

R

Признак использования счета

Sndr.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'ACC'

13

R

ИНН Организации отправителя запроса на создание письма

Sndr.Pty.Id.OrgId.Othr.Id

-

14

R

Признак использования ИНН

Sndr.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'TXID'

15

R

Тема

Sbjt

-

16

R

Тип запроса

Tp

категория письма

17

R

Текст письма

Desc

-

18

R

Признак необходимости предоставления ответа на запрос

RspnReqrd

-

19

O

Вложения к письму

Attchmnt

Описание файлов-вложений к письму. Подробнее в разделе (Работа с вложенными файлами)

Блок с подписью Document.CcyCtrlReqOrLttr

20

R

Подпись

SplmtryData.Envlp.SgntrSt[1..n]

-
Пример исходящего письма 
<?xml version="1.0" encoding="UTF-8"?><Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.026.001.01">
    <CcyCtrlReqOrLttr>
        <GrpHdr>
            <MsgId>TEST_MSG_2024-03-16-20240316</MsgId>
            <CreDtTm>2024-03-16T13:20:23.775</CreDtTm>
            <NbOfItms>1</NbOfItms>
            <InitgPty>
                <Pty>
                    <Nm>Общество с ограниченной ответственностью "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                            <Othr>
                                <Id>40702810200000000083</Id>
                                <SchmeNm>
                                    <Cd>ACC</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Pty>
            </InitgPty>
        </GrpHdr>
        <ReqOrLttr>
            <ReqOrLttrId>TEST_ID_2024-03-16-20240316</ReqOrLttrId>
            <Sndr>
                <Pty>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>40702810200000000083</Id>
                                <SchmeNm>
                                    <Cd>ACC</Cd>
                                </SchmeNm>
                            </Othr>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Pty>
            </Sndr>
            <Sbjt>Запрос на отзыв платежа</Sbjt>
            <Tp>RJCT</Tp>
            <Desc>Текст запроса на отзыв платежа</Desc>
            <RspnReqrd>true</RspnReqrd>
        </ReqOrLttr>
        <SplmtryData>
            <Envlp>
                <SgntrSt>
                </SgntrSt>
            </Envlp>
        </SplmtryData>
    </CcyCtrlReqOrLttr>
</Document>

Таблица кодов ответа

auth.027.001.01

HTTP код Тип Body Описание

200

OK

-

Запрос принят без ошибок.

400

Err

XML does not match schema

Документ не соответствует схеме

401

Err

Wrong username or password

Неверный логин или пароль

401

Err

User was not found

Пользователь не найден

401

Err

Could not find signer by certificate

По сертификату пользователь не найден

403

Err

User is disabled

Пользователь заблокирован

403

Err

Internal error while verifying permissions

Ошибка при проверке полномочий

403

Err

Signer is not allowed to sign this operation type

У подписанта нет полномочий на такой тип операции

403

Err

User does not have permission

Нет прав на выполнение запроса

403

Err

Certificate is not valid

Сертификат подписи невалидный

403

Err

Signer’s warrant is expired

Доверенность подписанта истекла

403

Err

Signer’s warrant is disabled

Доверенность подписанта заблокирована

403

Err

Number of signatures is not enough for this operation type

Недостаточно подписей для типа операции

403

Err

Certificate is disabled

Сертификат заблокирован

406

Err

The signer certificate is not valid (revoked or not active)

Сертификат подписанта отозван или невалидный

406

Err

Signature is missing

Нет подписи

406

Err

Signature value is not valid

Подпись невалидна

406

Err

Internal sign check state error

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

409

Err

MsgId is not unique

Id запроса неуникальный

500

Err

Internal Error

Внутренняя ошибка приложения

500

Err

Warrant service error

Сервис проверки доверенности не отвечает

502

Err

Bad Gateway

Ошибочный шлюз

503

Err

Service Unavailable

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

504

Err

Gateway Timeout

Шлюз не отвечает

Ответ

Ответом является XML-документ, соответствующий схеме auth.027.001.01

Пример ответа при отправке письма 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.027.001.01">
    <CcyCtrlStsAdvc>
        <GrpHdr>
            <MsgId>fb39d65990e24f049232c9e5f78a1205</MsgId>
            <CreDtTm>2024-03-16T13:21:23.342+03:00</CreDtTm>
            <NbOfItms>1</NbOfItms>
            <RcvgPty/>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                    <ClrSysMmbId>
                        <MmbId>044525593</MmbId>
                    </ClrSysMmbId>
                </FinInstnId>
            </RegnAgt>
        </GrpHdr>
        <GrpSts>
            <OrgnlRefs>
                <OrgnlMsgId>TEST_MSG_2024-03-16-20240316</OrgnlMsgId>
                <OrgnlMsgNmId>auth.026.001.01</OrgnlMsgNmId>
                <OrgnlCreDtTm>2024-03-16T13:20:23.775+03:00</OrgnlCreDtTm>
            </OrgnlRefs>
            <RptgPty>
                <PtyId>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>044525593</Id>
                            </Othr>
                        </OrgId>
                    </Id>
                </PtyId>
            </RptgPty>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                </FinInstnId>
            </RegnAgt>
            <Sts>RCVD</Sts>
        </GrpSts>
        <PackgSts>
            <PackgId>undefined</PackgId>
            <Sts>RCVD</Sts>
            <RcrdSts>
                <RcrdId>TEST_ID_2024-03-16-20240316</RcrdId>
                <Sts>RCVD</Sts>
            </RcrdSts>
        </PackgSts>
    </CcyCtrlStsAdvc>
</Document>

21. Запрос статуса письма

URI

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

GET: /API/v1/ISO20022/Letters/<MsgId>

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

GET: /API/v1/ISO20022/Letters/OutLetters/<ReqOrLttrId>

Ответ

Ответом является XML-документ, соответствующий схеме auth.027.001.01.

Пример письма в статусе ACTC 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.027.001.01">
    <CcyCtrlStsAdvc>
        <GrpHdr>
            <MsgId>49e579932da240ee87b9f45b60ef4fd1</MsgId>
            <CreDtTm>2024-03-16T13:25:23.775+03:00</CreDtTm>
            <NbOfItms>1</NbOfItms>
            <RcvgPty/>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                    <ClrSysMmbId>
                        <MmbId>044525593</MmbId>
                    </ClrSysMmbId>
                </FinInstnId>
            </RegnAgt>
        </GrpHdr>
        <GrpSts>
            <OrgnlRefs>
                <OrgnlMsgId>TEST_MSG_2024-03-16-20240316</OrgnlMsgId>
                <OrgnlMsgNmId>auth.026.001.01</OrgnlMsgNmId>
                <OrgnlCreDtTm>2023-03-22T22:49:21.000+03:00</OrgnlCreDtTm>
            </OrgnlRefs>
            <RptgPty>
                <PtyId>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>044525593</Id>
                            </Othr>
                        </OrgId>
                    </Id>
                </PtyId>
            </RptgPty>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                </FinInstnId>
            </RegnAgt>
            <Sts>ACTC</Sts>
        </GrpSts>
        <PackgSts>
            <PackgId>undefined</PackgId>
            <Sts>ACTC</Sts>
            <RcrdSts>
                <RcrdId>TEST_ID_2023-03-22-858600253</RcrdId>
                <Sts>ACTC</Sts>
                <StsDtTm>2023-03-22T22:49:27.028+03:00</StsDtTm>
            </RcrdSts>
        </PackgSts>
    </CcyCtrlStsAdvc>
</Document>
Пример письма в статусе RJCT 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.027.001.01">
    <CcyCtrlStsAdvc>
        <GrpHdr>
            <MsgId>535298c401684c62aa467bcb6bfabe13</MsgId>
            <CreDtTm>2023-03-22T22:54:08.005+03:00</CreDtTm>
            <NbOfItms>1</NbOfItms>
            <RcvgPty/>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                    <ClrSysMmbId>
                        <MmbId>044525593</MmbId>
                    </ClrSysMmbId>
                </FinInstnId>
            </RegnAgt>
        </GrpHdr>
        <GrpSts>
            <OrgnlRefs>
                <OrgnlMsgId>TEST_MSG_2024-03-16-20240316</OrgnlMsgId>
                <OrgnlMsgNmId>auth.026.001.01</OrgnlMsgNmId>
                <OrgnlCreDtTm>2023-03-22T22:49:21.000+03:00</OrgnlCreDtTm>
            </OrgnlRefs>
            <RptgPty>
                <PtyId>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>044525593</Id>
                            </Othr>
                        </OrgId>
                    </Id>
                </PtyId>
            </RptgPty>
            <RegnAgt>
                <FinInstnId>
                    <BICFI>ALFARUMM</BICFI>
                </FinInstnId>
            </RegnAgt>
            <Sts>RJCT</Sts>
        </GrpSts>
        <PackgSts>
            <PackgId>undefined</PackgId>
            <Sts>RJCT</Sts>
            <RcrdSts>
                <RcrdId>TEST_ID_2023-03-22-858600253</RcrdId>
                <Sts>RJCT</Sts>
                <StsRsn>
                    <Rsn>
                        <Cd>NARR</Cd>
                    </Rsn>
                    <AddtlInf>Причина</AddtlInf>
                </StsRsn>
                <StsDtTm>2023-03-22T22:54:08.003+03:00</StsDtTm>
            </RcrdSts>
        </PackgSts>
    </CcyCtrlStsAdvc>
</Document>

Статусная модель для сообщения

№ ISO статус Описание Комментарий/

1

RCVD

Получено

Хотя бы один документ в сообщении находятся в статусе RCVD

2

ACTC

На обработке

Все остальные случаи, когда статусы документов не удовлетворяют условиям п.1, 3, 4, 5 данной таблицы

3

PART

Частично принято

Хотя бы один документ в сообщении находятся в статусе ACPT

4

ACPT

Принято

Все документы в сообщении находятся в статусе ACPT

5

RJCT

Отклонено

Все документы в сообщении находятся в статусе RJCT

Статусная модель для письма

ISO статус Описание

RCVD

Документ получен, приступаем к обработке

ACTC

На обработке

ACPT

Принято

RJCT

Отклонено

Таблица кодов ответа

HTTP код Тип ответа Ответ в body Описание ответа

200

OK

-

401

Err

Wrong username or password

Неверный логин или пароль

401

Err

User was not found

Пользователь не найден

403

Err

User is disabled

Пользователь заблокирован

404

Err

Request has not been found by MsgId

Запрос не найден по идентификатору MsgId

404

Err

Request has not been found by ReqOrLttrId

Запрос не найден по идентификатору ReqOrLttrId

500

Err

Internal Error

Внутренняя ошибка приложения

502

Err

Bad Gateway

Ошибочный шлюз

503

Err

Service Unavailable

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

504

Err

Gateway Timeout

Шлюз не отвечает

22. Запрос списка входящих писем

URI

Запрос на получение списка писем (входящие письма и уведомления о поступлении выручки на транзитный валютный счет)

POST: /API/v1/ISO20022/Letters/Lists

После отправки запроса, в случае ответа 200 ОК, необходимо получить список писем с помощью GET запроса (подробнее в разделе "Получение списка входящих писем").

Запрос списка писем без подписи

Реализована возможность запроса списка писем без подписания УКЭП. Для этого необходимо:

1) В Headers передать параметры:

  • company-tin со значением ИНН компании

  • check-sign-message со значением false

2) Тэг <SgntrSt> оставить пустым.

3) При тестировании использовать данные тестовой компании ООО «Тест Альфа-Линк без подписи».

XSD схема

auth.026.001.01

Описание схемы

№ R/
O		 Описание Путь Комментарий/
Пример

Document.CcyCtrlReqOrLttr.GrpHdr

1

R

Уникальный ID сообщения

MsgId

Указывается идентификатор сообщения присвоенный во внешней системе

2

R

Дата и время создания сообщения

CreDtTm

Формат даты YYYY-MM-DDThh:mm:ss[.mmm]TZD (В случае, если часовой пояс не указан или указан отличный от московского, то время будет приведено к UTC +3).

3

R

Количество транзакций в сообщении

NbOfItms

Кол-во блоков ReqOrLttr

4

R

Наименование организации отправителя сообщения

InitgPty.Pty.Nm

-

5

R

ИНН организации отправителя сообщения

InitgPty.Pty.Id.OrgId.Othr.Id

-

6

R

Признак использования ИНН

InitgPty.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'TXID'

7

R

Номер счета организации отправителя сообщения

InitgPty.Pty.Id.OrgId.Othr.Id

-

8

R

Признак использования счета

InitgPty.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'ACC'

Document.CcyCtrlReqOrLttr.ReqOrLttr

9

R

Уникальный ID запроса на на получения списка писем/ув-ий

ReqOrLttrId

-

10

R

Наименование организации отправителя запроса на получения списка писем/ув-ий

Sndr.Pty.Nm

-

11

R

ИНН Организации отправителя запроса на получения списка писем/ув-ий

Sndr.Pty.Id.OrgId.Othr.Id

-

12

R

Признак использования ИНН

Sndr.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'TXID'

13

R

Номер счета (Идентификация отправителя запроса)

Sndr.Pty.Id.OrgId.Othr.Id

-

14

R

Признак использования счета

Sndr.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'ACC'

15

R

Тема

Sbjt

Параметр обязателен по схеме. Указывается "Запрос списка входящих писем"

16

R

Тип запроса

Tp

Константа 'ALLL' (получение всех типов писем) или 'CCER' (получение только уведомлений о поступлении средств на транзитный счет)

17

R

Признак необходимости предоставления ответа на запрос

RspnReqrd

Параметр обязателен по схеме. Указывается Константа 'false'

Document.CcyCtrlReqOrLttr.SplmtryData.Envlp.AdditionalData

18

R

Дата начала отбора

FrToDt.FrDt

-

19

R

Дата окончания отбора

FrToDt.ToDt

-

20

R

Признак "Только новые"

OnlyNew

TrueFalseIndicator
'True' - только новые (не запрошенные ранее)
'False' - все, включая новые

Блок с подписью Document.CcyCtrlReqOrLttr

21

R

Подпись

SplmtryData.Envlp.SgntrSt[1..n]

-
Пример запроса списка писем 
<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.026.001.01" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
    <CcyCtrlReqOrLttr>
        <GrpHdr>
            <MsgId>TEST_MSG_2024-03-10-20240310</MsgId>
            <CreDtTm>2024-03-06T13:38:20.233</CreDtTm>
            <NbOfItms>1</NbOfItms>
            <InitgPty>
                <Pty>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                            <Othr>
                                <Id>40702810200000000083</Id>
                                <SchmeNm>
                                    <Cd>ACC</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Pty>
            </InitgPty>
        </GrpHdr>
        <ReqOrLttr>
            <ReqOrLttrId>TEST_ID_2024-03-10-20240310</ReqOrLttrId>
            <Sndr>
                <Pty>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                            <Othr>
                                <Id>40702810200000000083</Id>
                                <SchmeNm>
                                    <Cd>ACC</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Pty>
            </Sndr>
            <Sbjt>Запрос списка писем и уведомлений о пвв на твс</Sbjt>
            <Tp>ALLL</Tp>
            <Desc>Запрос списка писем и уведомлений о пвв на твс</Desc>
            <RspnReqrd>false</RspnReqrd>
            <SplmtryData>
                <Envlp>
                    <AdditionalData>
                        <FrToDt>
                            <FrDt>2024-03-01</FrDt>
                            <ToDt>2024-03-10</ToDt>
                        </FrToDt>
                        <OnlyNew>false</OnlyNew>
                    </AdditionalData>
                </Envlp>
            </SplmtryData>
        </ReqOrLttr>
        <SplmtryData>
            <Envlp>
                <SgntrSt>
                </SgntrSt>
            </Envlp>
        </SplmtryData>
    </CcyCtrlReqOrLttr>
</Document>

Таблица кодов ответа

auth.027.001.01

HTTP код Тип Body Описание

200

OK

-

Запрос принят без ошибок.

400

Err

XML does not match schema

Документ не соответствует схеме

400

Error

FrDt/ToDt is in the future

Дата начала/окончания периода запроса списка позднее текущей даты

400

Error

A date period is not specified

Не указан период запроса списка

400

Error

FrDt is later than ToDt

Дата начала периода запроса списка позднее даты окончания

400

Error

ReqOrLttrMessage with id: <Msg_Id> ИЛИ <ReqOrLttrId> already exists

Id запроса неуникальный

400

Error

Document type wasn’t defined

Не определен тип запрашиваемых документов

401

Err

Wrong username or password

Неверный логин или пароль

401

Err

User was not found

Пользователь не найден

401

Err

Could not find signer by certificate

По сертификату пользователь не найден

403

Err

User is disabled

Пользователь заблокирован

403

Err

Internal error while verifying permissions

Ошибка при проверке полномочий

403

Err

Signer is not allowed to sign this operation type

У подписанта нет полномочий на такой тип операции

403

Err

User does not have permission

Нет прав на выполнение запроса

403

Err

Certificate is not valid

Сертификат подписи невалидный

403

Err

Signer’s warrant is expired

Доверенность подписанта истекла

403

Err

Signer’s warrant is disabled

Доверенность подписанта заблокирована

403

Err

Number of signatures is not enough for this operation type

Недостаточно подписей для типа операции

403

Err

Certificate is disabled

Сертификат заблокирован

406

Err

The signer certificate is not valid (revoked or not active)

Сертификат подписанта отозван или невалидный

406

Err

Signature is missing

Нет подписи

406

Err

Signature value is not valid

Подпись невалидна

406

Err

Internal sign check state error

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

409

Err

MsgId is not unique

Id запроса неуникальный

500

Err

Internal Error

Внутренняя ошибка приложения

500

Err

Warrant service error

Сервис проверки доверенности не отвечает

502

Err

Bad Gateway

Ошибочный шлюз

503

Err

Service Unavailable

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

504

Err

Gateway Timeout

Шлюз не отвечает

23. Получение списка входящих писем

URI

Получение списка писем (входящие письма и уведомления о поступлении выручки на транзитный валютный счет)

GET: /API/v1/ISO20022/Letters/Lists/<MsgId>

Таблица кодов ответа

HTTP код Тип ответа Ответ в body Описание ответа

200

OK

-

401

Err

Wrong username or password

Неверный логин или пароль

401

Err

User was not found

Пользователь не найден

403

Err

User is disabled

Пользователь заблокирован

404

Err

Request has not been found by MsgId

Запрос не найден по идентификатору MsgId

500

Err

Internal Error

Внутренняя ошибка приложения

502

Err

Bad Gateway

Ошибочный шлюз

503

Err

Service Unavailable

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

504

Err

Gateway Timeout

Шлюз не отвечает

XSD схема ответа

auth.026.001.01

Описание схемы

№ R/
O		 Описание Путь Комментарий/
Пример

Document.CcyCtrlReqOrLttr.GrpHdr

1

R

Уникальный ID сообщения

MsgId

-

2

R

Дата и время создания сообщения

CreDtTm

Формат даты YYYY-MM-DDThh:mm:ss[.mmm]TZD (В случае, если часовой пояс не указан или указан отличный от московского, то время будет приведено к UTC +3).

3

R

Количество транзакций в сообщении

NbOfItms

Кол-во блоков ReqOrLttr

4

R

Наименование Банка

InitgPty.Agt.FinInstnId.Nm

Константа 'АО Альфа-Банк"'

5

R

SWIFT код банка

InitgPty.Agt.FinInstnId.BICFI

Константа 'ALFARUMM'

6

R

ISO тип данных для БИК банка

InitgPty.Agt.FinInstnId.ClrSysMmbId.ClrSysId.Cd

Константа 'RUCBC'

7

R

БИК Банка

InitgPty.Agt.FinInstnId.ClrSysMmbId.MmbId

Константа '044525593'

Document.CcyCtrlReqOrLttr.ReqOrLttr

8

R

Уникальный ID письма

ReqOrLttrId

-

9

R

Дата и время создания письма

Dt

-

10

R

ISO тип данных для БИК банка

Sndr.Agt.FinInstnId.ClrSysMmbId.ClrSysId.Cd

Константа 'RUCBC'

11

R

БИК Банка

Sndr.Agt.FinInstnId.ClrSysMmbId.MmbId

Константа '44525593'

12

R

Наименование Банка

Sndr.Agt.FinInstnId.Nm

Константа 'АО "Альфа-Банк"'

13

R

ИНН организации получателя сообщения

Rcvr.Pty.Id.OrgId.Othr.Id

-

14

R

Признак использования ИНН

Rcvr.Pty.Id.OrgId.Othr.SchmeNm.Cd

Константа 'TXID'

15

R

ID запроса на предоставление списка писем

OrgnlRefs.OrgnlMsgId

Константа 'TXID'

16

R

Дата и время создания запроса на предоставление списка писем

OrgnlRefs.OrgnlCreDtTm

Константа 'TXID'

17

R

Тема письма

Sbjt

-

18

R

Тип запроса

Tp

заполняется в соответствии с таблицей "Категории писем"

19

O

Текст письма

Desc

-

20

R

Признак необходимости предоставления ответа на запрос

RspnReqrd

Параметр обязателен по схеме. Указывается Константа 'false'

21

O

Тип вложенного файла

Attchmnt.DocTp

Константа 'NONE'

22

O

Уникальный ID вложенного файла

Attchmnt.DocNb

-

23

O

Наименование вложенного файла

Attchmnt.URL

-

Document.CcyCtrlReqOrLttr.SplmtryData.Envlp.AdditionalData

24

O

Комментарий сотрудника банка

Comment

-

25

O

Номер письма (номер уведомления ПВВ на ТВС)

LetterNumber

-

26

O

Номер транзитного валютного счета

CCER.NumTVS

-

27

O

Сумма, поступившая на транзитный валютный счет

CCER.SumTVS

-

28

O

Валюта, поступившая на транзитный валютный счет

CCER.SumTVS@Ccy

-

29

O

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

CCER.LastDate

-

30

O

Дата начала действия нарушения

CCER.ViolationDate

-

31

O

Номер документа, по которому зачислены средства на транзитный валютный счет

CCER.DocNum

-

32

O

Дата документа, по которому зачислены средства на транзитный валютный счет

CCER.DocDate

-
Пример ответа со списком писем 
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.026.001.01">
   <CcyCtrlReqOrLttr>
      <GrpHdr>
         <MsgId>1f850ba58b8046c6a2bb7dea052718bc</MsgId>
         <CreDtTm>2021-08-06T19:02:58.039+03:00</CreDtTm>
         <NbOfItms>2</NbOfItms>
         <InitgPty>
            <Agt>
               <FinInstnId>
                  <BICFI>ALFARUMM</BICFI>
                  <ClrSysMmbId>
                     <ClrSysId>
                        <Cd>RUCBC</Cd>
                     </ClrSysId>
                     <MmbId>044525593</MmbId>
                  </ClrSysMmbId>
                  <Nm>АО "Альфа-Банк"</Nm>
               </FinInstnId>
            </Agt>
         </InitgPty>
      </GrpHdr>
      <ReqOrLttr>
         <ReqOrLttrId>26de598739a24aca87c3567eb0dd6700</ReqOrLttrId>
         <Dt>2021-08-06</Dt>
         <Sndr>
            <Agt>
               <FinInstnId>
                  <ClrSysMmbId>
                     <ClrSysId>
                        <Cd>RUCBC</Cd>
                     </ClrSysId>
                     <MmbId>044525593</MmbId>
                  </ClrSysMmbId>
                  <Nm>АО "Альфа-Банк"</Nm>
               </FinInstnId>
            </Agt>
         </Sndr>
         <Rcvr>
            <Pty>
               <Id>
                  <OrgId>
                     <Othr>
                        <Id>7013602245</Id>
                        <SchmeNm>
                           <Cd>TXID</Cd>
                        </SchmeNm>
                     </Othr>
                  </OrgId>
               </Id>
            </Pty>
         </Rcvr>
         <OrgnlRefs>
            <OrgnlMsgId>TEST__DEV_MSG_234322222223</OrgnlMsgId>
            <OrgnlCreDtTm>2021-08-06T13:34:14.000+03:00</OrgnlCreDtTm>
         </OrgnlRefs>
         <Sbjt>тест456</Sbjt>
         <Tp>OTHR</Tp>
         <Desc>тест456</Desc>
         <RspnReqrd>false</RspnReqrd>
         <Attchmnt>
            <DocTp>NONE</DocTp>
            <DocNb>73001</DocNb>
            <URL>Документы для клиента.zip</URL>
         </Attchmnt>
         <SplmtryData>
            <Envlp>
               <AdditionalData/>
            </Envlp>
         </SplmtryData>
      </ReqOrLttr>
      <ReqOrLttr>
         <ReqOrLttrId>b3f595b42d28495a9b56d210a9f4d7da</ReqOrLttrId>
         <Dt>2021-08-06</Dt>
         <Sndr>
            <Agt>
               <FinInstnId>
                  <ClrSysMmbId>
                     <ClrSysId>
                        <Cd>RUCBC</Cd>
                     </ClrSysId>
                     <MmbId>044525593</MmbId>
                  </ClrSysMmbId>
                  <Nm>АО "Альфа-Банк"</Nm>
               </FinInstnId>
            </Agt>
         </Sndr>
         <Rcvr>
            <Pty>
               <Id>
                  <OrgId>
                     <Othr>
                        <Id>7013602245</Id>
                        <SchmeNm>
                           <Cd>TXID</Cd>
                        </SchmeNm>
                     </Othr>
                  </OrgId>
               </Id>
            </Pty>
         </Rcvr>
         <OrgnlRefs>
            <OrgnlMsgId>TEST__DEV_MSG_234322222223</OrgnlMsgId>
            <OrgnlCreDtTm>2021-08-06T13:34:14.000+03:00</OrgnlCreDtTm>
         </OrgnlRefs>
         <Sbjt>тест123</Sbjt>
         <Tp>OTHR</Tp>
         <Desc>тест123</Desc>
         <RspnReqrd>false</RspnReqrd>
         <Attchmnt>
            <DocTp>NONE</DocTp>
            <DocNb>72998</DocNb>
            <URL>Документы для клиента.zip</URL>
         </Attchmnt>
         <SplmtryData>
            <Envlp>
               <AdditionalData/>
            </Envlp>
         </SplmtryData>
      </ReqOrLttr>
   </CcyCtrlReqOrLttr>
</Document>
Пример ответа с пустым списком писем 
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:auth.026.001.01">
   <CcyCtrlReqOrLttr>
      <GrpHdr>
         <MsgId>21ab4a3d886c4fa5892f4f7fb8004ab0</MsgId>
         <CreDtTm>2021-08-13T18:02:37.908+03:00</CreDtTm>
         <NbOfItms>0</NbOfItms>
         <InitgPty>
            <Agt>
               <FinInstnId>
                  <BICFI>ALFARUMM</BICFI>
                  <ClrSysMmbId>
                     <ClrSysId>
                        <Cd>RUCBC</Cd>
                     </ClrSysId>
                     <MmbId>044525593</MmbId>
                  </ClrSysMmbId>
                  <Nm>АО "Альфа-Банк"</Nm>
               </FinInstnId>
            </Agt>
         </InitgPty>
      </GrpHdr>
   </CcyCtrlReqOrLttr>
</Document>

Получение вложения к входящему письму из банка

Вложения к входящим из банка письмам следует запрашивать (скачивать) отдельным сервисом:

/API/v1/ISO20022/Letters/InLetters/Files/<ReqOrLttrId>/<DocNb>

24. Категории писем

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

"Код ISO Описание

1

ALLL

Получение всех типов писем

2

CCER

Получение только уведомлений о поступлении средств на транзитный счет

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

Код ISO Описание в Банке

1

CCDC

Валютный контроль

2

OTHR

Без категории

3

BPRC

Реестр расчетных документов

4

FCTR

Документы Факторинга

5

FREX

Операции FX в рамках генеральных соглашений

6

LOAN

Сопровождение кредитных сделок

7

PAYR

Зарплатный проект

8

PMTM

Уточнение реквизитов платежа

9

RJCT

Срочно! Отзыв платежа

10

SECU

Депозиты в рамках генеральных соглашений

11

LTBK

Комплаенс - финмониторинг

12

FDOC

Подтверждающие документы. Застройщик

13

LCFC

Аккредитивы/гарантии/инкассо

14

LTOZ

Запрос на справку/дубликаты документов

15

DEPT

Размещение депозита (вклада)

16

ACPT

Акцепт

17

ISPD

Исполнительные документы

18

CPDC

Запрос из досье/ВБК