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

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

URI

POST: /API/v1/ISO20022/Letters

XSD схема

auth.026.001.01

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

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

Document.CcyCtrlReqOrLttr.GrpHdr

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

MsgId

-

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

CreDtTm

-

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

NbOfItms

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

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

InitgPty.Pty.Nm

-

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

InitgPty.Pty.Id.OrgId.Othr.Id

-

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

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

Константа TXID

Document.CcyCtrlReqOrLttr.ReqOrLttr

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

ReqOrLttrId

-

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

Sndr.Pty.Nm

-

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

Sndr.Pty.Id.OrgId.Othr.Id

-

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

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

константа 'TXID'

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

Sndr.Pty.Id.OrgId.Othr.Id

-

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

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

константа 'ACC'

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

Rcvr.Agt.FinInstnId.ClrSysMmbId.ClrSysId.Cd

константа 'RUCBC'

БИК Банка

Rcvr.Agt.FinInstnId.ClrSysMmbId.MmbId

-

Наименование банка получателя сообщения

Rcvr.Agt.FinInstnId.Nm

-

Тема

Sbjt

-

Тип запроса

Tp

Текст письма

Desc

-

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

RspnReqrd

-

Document.CcyCtrlReqOrLttr.SplmtryData.Envlp.AdditionalData

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

Table 1. Категории писем
Код ISO Описание в Банке

CCER

Уведомления по валютному контролю

CCDC

Документы по валютному контролю

CCOR

Документы по валютному контролю

CCGR

Документы по валютному контролю

CCTC

Документы по валютному контролю

FRLS

Документы по валютному контролю

CASD

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

CCRD

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

DEPT

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

EBSR

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

LCFC

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

TRAD

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

FDOC

Финансовые документы. Документы застройщика

PMTU

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

OTHR

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

OVRD

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

BPRC

Реестр Bulk Payments/ответ по реестру

FCTR

Запрос/информация связанные с обслуживанием по Факторингу

FREX

Запрос/Подтверждение по Конверсионной сделке

LOAN

Запрос, связанный с обслуживанием Кредита

PAYR

Зарплатный файл

PMTM

Запрос на изменение реквизитов платежа

RJCT

Запрос на отзыв платежа

SECU

Запрос в Депозитарий

LTBK

Запрос/письмо по финансовому мониторингу В ЮКБ это Запрос, связанные с обслуживанием

LTOZ

Запрос документов по счету (справки, дубликаты)

Ответ

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

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

URI

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

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

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

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

Ответ

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

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

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

1

RCVD

Получено

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

2

ACTC

На обработке

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

3

PART

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

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

4

ACPT

Принято

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

5

RJCT

Отклонено

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

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

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

RCVD

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

ACTC

На обработке

ACPT

Принято

RJCT

Отклонено

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

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

URI

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

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

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

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

XSD схема

auth.026.001.01

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

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

Document.CcyCtrlReqOrLttr.GrpHdr

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

MsgId

-

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

CreDtTm

-

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

NbOfItms

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

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

InitgPty.Pty.Nm

-

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

InitgPty.Pty.Id.OrgId.Othr.Id

-

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

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

-

Document.CcyCtrlReqOrLttr.ReqOrLttr

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

ReqOrLttrId

-

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

Sndr.Pty.Nm

-

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

Sndr.Pty.Id.OrgId.Othr.Id

-

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

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

константа 'TXID'

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

Sndr.Pty.Id.OrgId.Othr.Id

-

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

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

константа 'ACC'

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

Rcvr.Agt.FinInstnId.ClrSysMmbId.ClrSysId.Cd

константа 'RUCBC'

БИК Банка

Rcvr.Agt.FinInstnId.ClrSysMmbId.MmbId

-

Наименование банка получателя сообщения

Rcvr.Agt.FinInstnId.Nm

-

Тема

Sbjt

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

Тип запроса

Tp

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

RspnReqrd

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

Document.CcyCtrlReqOrLttr.SplmtryData.Envlp.AdditionalData

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

FrToDt.FrDt

-

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

FrToDt.ToDt

-

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

OnlyNew

TrueFalseIndicator

'True' - только новые 'False' - все, включая новые

Признак "Вернуть только определенные документы".

DocTp

Необходимо указать код документа. Для получения только списка Уведомлений о ПВВ на ТВС, указать 'RVNT'

Таблица синхронных ответов сервиса "Запрос списка входящих писем"

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

200

OK

-

Запрос на получение списка принят без ошибок

401

Error

Wrong username or password

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

401

Error

User was not found

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

401

Error

User is disabled

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

401

Error

Warrant is expired

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

401

Error

Warrant was not found

Доверенность не найдена

401

Error

Warrant service error

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

401

Error

Signer is not allowed to sign this operation type

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

401

Error

Number of signatures is not enough for this operation type

Недостаточное количество подписей для данного типа документов

406

Error

User does not have permission

Нет права на запрос Списка писем в host-to-host

406

Error

Data signature is required

Нет подписи

406

Error

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

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

406

Error

Signature is not valid

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

406

Error

Internal sign check state error

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

500

Error

Internal Error

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

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

Category(-es) is missing or undefined

Категории писем не указаны или не определены

400

Error

Document type wasn’t defined

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

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

URI

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

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

Ответ либо http кодом, либо по схеме auth.026.001.01

Таблица http кодов

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

200

OK

The request is still being processed. Try later.

Запрос все еще обрабатывается

500

Error

Internal Error

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

500

Error

<текст с причиной отклонения>

-

500

Error

MsgId was not found

Не найден указанный MsgId

XSD схема

auth.026.001.01

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

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

Document.CcyCtrlReqOrLttr.GrpHdr

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

MsgId

-

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

CreDtTm

-

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

NbOfItms

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

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

InitgPty.Pty.Nm

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

InitgPty.Pty.Id.OrgId.Othr.Id

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

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

Константа TXID

Document.CcyCtrlReqOrLttr.ReqOrLttr

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

ReqOrLttrId

-

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

Dt

-

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

Rcvr.Agt.FinInstnId.ClrSysMmbId.ClrSysId.Cd

константа 'RUCBC'

БИК Банка

Rcvr.Agt.FinInstnId.ClrSysMmbId.MmbId

константа '44525593'

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

Rcvr.Agt.FinInstnId.Nm

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

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

Sndr.Pty.Id.OrgId.Othr.Id

-

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

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

константа 'TXID'

Тема письма

Sbjt

-

Тип запроса

Tp

константа 'LFBK'

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

RspnReqrd

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

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

SplmtryData.Envlp.AdditionalData.FrToDt.FrDt

ISODate

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

SplmtryData.Envlp.AdditionalData.FrToDt.ToDt

ISODate

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

SplmtryData.Envlp.AdditionalData.OnlyNew

Пример отправки письма
----------------
<?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>EVRZXXXXXXXX</MsgId>
      <CreDtTm>2017-08-04T14:13:45+03:00</CreDtTm>
      <NbOfItms>1</NbOfItms>
      <InitgPty>
        <Pty>
          <Nm>Холдинг</Nm>
          <Id>
            <OrgId>
              <AnyBIC>EVRZXXXXXXXX</AnyBIC>
              <Othr>
                <Id>00615558</Id>
                <SchmeNm>
                  <Cd>BANK</Cd>
                </SchmeNm>
              </Othr>
            </OrgId>
          </Id>
        </Pty>
      </InitgPty>
    </GrpHdr>
    <ReqOrLttr>
      <ReqOrLttrId>EVRZXXXXXXXX-RQLT-20170804-00000</ReqOrLttrId>
      <Dt>2017-08-04</Dt>
      <Sndr>
        <Pty>
          <Nm>Холдинг</Nm>
          <Id>
            <OrgId>
              <AnyBIC>EVRZXXXXXXXX</AnyBIC>
              <Othr>
                <Id>00615558</Id>
                <SchmeNm>
                  <Cd>BANK</Cd>
                </SchmeNm>
              </Othr>
            </OrgId>
          </Id>
        </Pty>
      </Sndr>
      <Rcvr>
        <Pty>
          <Nm/>
          <Id>
            <OrgId>
              <Othr>
                <Id>ALFARUM@AXXX</Id>
                <SchmeNm>
                  <Prtry>CFTBIC</Prtry>
                </SchmeNm>
              </Othr>
            </OrgId>
          </Id>
        </Pty>
      </Rcvr>
      <Sbjt>test4</Sbjt>
      <Tp>OTHR</Tp>
      <Desc>test4</Desc>
      <RspnReqrd>false</RspnReqrd>
      <Attchmnt>
        <DocTp>NONE</DocTp>
        <DocNb>0</DocNb>
        <URL>attach_Song.mp3</URL>
        <LkFileHash>
          <ds:Reference URI="attach_SongEVRZXXXXXXX20170804141346.mp3">
            <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
            <ds:DigestValue>YIJD+p5MGU0krQlKlfUqkyK9+ok=</ds:DigestValue>
          </ds:Reference>
        </LkFileHash>
      </Attchmnt>
    </ReqOrLttr>
    <SplmtryData>
      <Envlp>
        <SgntrSt>
        --Блок подписи
        </SgntrSt>
      </Envlp>
    </SplmtryData>
  </CcyCtrlReqOrLttr>
</Document>