5. Онлайн остаток

У клиентов есть возможность получить остатки по счетам в режиме реального времени в двух форматах:

  • Базовый остаток

  • Расширенный остаток

Базовый остаток
  • Доступный баланс - Реальная сумма, доступная по счету

  • Зарезервированный баланс - зарезервированная сумма по счету

Расширенный остаток
  • Входящий баланс (Входящее сальдо) - остаток по счёту на начало текущего дня

  • Исходящий баланс (Исходящее сальдо) - рассчитывается как арифметическая сумма входящего сальдо и оборотов за текущий день

  • Доступный баланс - Реальная сумма, доступная по счету

  • Зарезервированный баланс - зарезервированная сумма по счету

Обратите внимание!

Сформированный онлайн остаток приходит в ответ на POST-запрос в синхронном режиме.

Запрос онлайн остатка без подписи

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

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

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

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

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

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

4) При подключении к промышленному стенду в Заявлении о назначении/изменении прав доступа для функциональности Получение информации (выписки) о движениях по Счету выбрать правило подписания – "Без подписи" (роль «Оператор»).

Запрос

URI

POST: /API/v1/ISO20022/Statements/AccountBalance - базовый остаток

POST: /API/v1/ISO20022/Statements/AccountBalanceExtended - расширенный остаток

XML схема

camt.060.001.03

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

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

Общий путь Document.AcctRptgReq

1

R

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

GrpHdr.MsgId

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

2

R

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

GrpHdr.CreDtTm

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

3

O

ИНН организации

GrpHdr.MsgSndr.Pty.Id.OrgId.Othr.Id

-

4

R

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

RptgReq.Id

-

5

R

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

RptgReq.ReqdMsgNmId

Константа "HMQSTASCF"

6

R

Номер счета

RptgReq.Acct.Id.Othr.Id

-

7

R

Наименование организации

RptgReq.AcctOwnr.Pty.Nm

-

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

8

O

Подпись

SplmtryData.Envlp.SgntrSt[1..n]

-

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

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 version="1.0" encoding="utf-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.060.001.03" xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
    <AcctRptgReq>
        <GrpHdr>
            <MsgId>H2H_TEST_STMT_112368042870656700001</MsgId>
            <CreDtTm>2022-05-24T10:00:18</CreDtTm>
        </GrpHdr>
        <RptgReq>
            <Id>H2H_TEST_STMT_112368042870656700001</Id>
            <ReqdMsgNmId>HMQSTASCF</ReqdMsgNmId>
            <Acct>
                <Id>
                    <Othr>
                        <Id>40702810200000000083</Id>
                    </Othr>
                </Id>
            </Acct>
            <AcctOwnr>
                <Pty>
                    <Nm>Общество с ограниченной ответственностью "Тест Альфа-Линк"</Nm>
                </Pty>
            </AcctOwnr>
        </RptgReq>
        <SplmtryData>
            <Envlp>
                <SgntrSt>
                </SgntrSt>
            </Envlp>
        </SplmtryData>
    </AcctRptgReq>
</Document>

Ответ

XSD схема

camt.052.001.05

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

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

Общий путь Document.BkToCstmrAcctRpt

1

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

GrpHdr.MsgId

-

2

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

GrpHdr.CreDtTm

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

Общий путь Document.BkToCstmrAcctRpt.Rpt

3

ID

Id

-

4

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

CreDtTm

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

5

Номер счета

Acct.Id.Othr.Id

-

6

Буквенный код валюты счета

Acct.Ccy

-

7

Наименование владельца счета

Acct.Ownr.Nm

Наименование клиента (организации)

8

ИНН / КИО владельца счета

Acct.Ownr.Id.OrgId.Othr.Id

ИНН Клиента

9

ISO код типа данных для ИНН

Acct.Ownr.Id.OrgId.Othr.SchmeNm.Cd

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

Реквизиты обслуживающего банка

10

BIC банка, обслуживающего счет

Acct.Svcr.FinInstnId.BICFI

-

11

Обозначение российской расчетной системы

Acct.Svcr.FinInstnId.ClrSysMmbId.ClrSysId.Cd

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

12

БИК банка/отделения обслуживающего счет

Acct.Svcr.FinInstnId.ClrSysMmbId.MmbId

-

13

Наименование банка/отделения обслуживающего счет

Acct.Svcr.FinInstnId.Nm

-

Секция с информацией о балансах для Базового остатка

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

Доступный баланс

14

Тип баланса (доступный баланс)
(1 блок)

Bal[1].Tp.CdOrPrtry.Cd

Константа 'ITAV'

15

Доступный баланс

Bal[1].Amt

-

16

Код валюты доступного баланса

Bal[1].Amt@Ccy

-

17

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[1].CdtDbtInd

-

18

Дата баланса

Bal[1].Dt.Dt

-

Зарезервированный баланс

19

Тип баланса (Зарезервированный баланс)
(2 блок)

Bal[2].Tp.CdOrPrtry.Cd

Константа 'INFO'

20

Зарезервированный баланс

Bal[2].Amt

-

21

Код валюты зарезервированного баланса

Bal[2].Amt@Ccy

-

22

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[2].CdtDbtInd

-

23

Дата баланса

Bal[2].Dt.Dt

-

Секция с информацией о балансах для Расширенного остатка

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

Входящий баланс

24

Тип баланса (Входящий)
(1 блок)

Bal[1].Tp.CdOrPrtry.Cd

Константа 'OPBD'

25

Входящий баланс

Bal[1].Amt@Ccy

-

26

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[1].CdtDbtInd

-

27

Дата формирования входящего баланса

Bal[1].Dt.Dt

-

28

Дата формирования входящего баланса в рублёвом эквиваленте

Bal[1].Avlbty.Dt.ActlDt

-

29

Входящий баланс в рублёвом эквиваленте

Bal[1].Avlbty.Amt

-

30

Код валюты входящего остатка в рублёвом эквиваленте

Bal[1].Avlbty.Amt@Ccy

-

31

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[1].Avlbty.CdtDbtInd

-

Исходящий баланс

32

Тип баланса (Исходящий)
(2 блок)

Bal[2].Tp.CdOrPrtry.Cd

Константа 'CLBD'

33

Исходящий баланс

Bal[2].Amt

-

34

Код валюты исходящего баланса

Bal[2].Amt@Ccy

-

35

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[2].CdtDbtInd

-

36

Дата формирования исходящего баланса

Bal[2].Dt.Dt

-

37

Дата формирования исходящего баланса в рублёвом эквиваленте

Bal[2].Avlbty.Dt.ActlDt

-

38

Исходящий баланс в рублёвом эквиваленте

Bal[2].Avlbty.Amt

-

39

Код валюты исходящего баланса в рублёвом эквиваленте

Bal[2].Avlbty.Amt@Ccy

-

40

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[2].Avlbty.CdtDbtInd

-

Доступный баланс

41

Тип баланса (Доступный баланс)
(3 блок)

Bal[3].Tp.CdOrPrtry.Cd

Константа 'ITAV'

42

Доступный баланс

Bal[3].Amt

-

43

Код валюты доступного баланса

Bal[3].Amt@Ccy

-

44

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[3].CdtDbtInd

-

45

Дата баланса

Bal[3].Dt.Dt

-

Зарезервированный баланс

46

Тип баланса (Зарезервированный баланс)
(4 блок)

Bal[4].Tp.CdOrPrtry.Cd

Константа 'INFO'

47

Зарезервированный баланс

Bal[4].Amt

-

48

Код валюты зарезервированного баланса

Bal[4].Amt@Ccy

-

49

Индикатор Дебет ('DBIT') /Кредит ('CRDT')

Bal[4].CdtDbtInd

-

50

Дата баланса

Bal[4].Dt.Dt

-

Пример сформированного Базового остатка
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.052.001.05">
    <BkToCstmrAcctRpt>
        <GrpHdr>
            <MsgId>83a8cdb3e10e4148b08485e7cd2176cc</MsgId>
            <CreDtTm>2024-03-07T10:56:42.588+03:00</CreDtTm>
        </GrpHdr>
        <Rpt>
            <Id>baf5c220be6d412eb9ada2e4f5b18035</Id>
            <CreDtTm>2024-03-07T10:56:42.619+03:00</CreDtTm>
            <Acct>
                <Id>
                    <Othr>
                        <Id>40702810200000000083</Id>
                    </Othr>
                </Id>
                <Ccy>RUR</Ccy>
                <Ownr>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Ownr>
                <Svcr>
                    <FinInstnId>
                        <BICFI>ALFARUMMXXX</BICFI>
                        <ClrSysMmbId>
                            <ClrSysId>
                                <Cd>RUCBC</Cd>
                            </ClrSysId>
                            <MmbId>044525593</MmbId>
                        </ClrSysMmbId>
                        <Nm>АО "АЛЬФА-БАНК"</Nm>
                    </FinInstnId>
                </Svcr>
            </Acct>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>ITAV</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">49926499.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>INFO</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">12446.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
        </Rpt>
        <Rpt>
            <Id>4d10c3a0d73f4a349309fc04ff15876c</Id>
            <CreDtTm>2024-03-07T10:56:42.645+03:00</CreDtTm>
            <Acct>
                <Id>
                    <Othr>
                        <Id>40702840200000000529</Id>
                    </Othr>
                </Id>
                <Ccy>USD</Ccy>
                <Ownr>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Ownr>
                <Svcr>
                    <FinInstnId>
                        <BICFI>ALFARUMMXXX</BICFI>
                        <ClrSysMmbId>
                            <ClrSysId>
                                <Cd>RUCBC</Cd>
                            </ClrSysId>
                            <MmbId>044525593</MmbId>
                        </ClrSysMmbId>
                        <Nm>АО "АЛЬФА-БАНК"</Nm>
                    </FinInstnId>
                </Svcr>
            </Acct>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>ITAV</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">9999982.80</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>INFO</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">0.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
        </Rpt>
    </BkToCstmrAcctRpt>
</Document>
Пример сформированного Расширенного остатка
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.052.001.05">
    <BkToCstmrAcctRpt>
        <GrpHdr>
            <MsgId>e0ba1d35df79423d813c87f5317c9c39</MsgId>
            <CreDtTm>2024-03-07T10:57:58.655+03:00</CreDtTm>
        </GrpHdr>
        <Rpt>
            <Id>11f6665b1a70486cb391df4aee58eebd</Id>
            <CreDtTm>2024-03-07T10:57:58.689+03:00</CreDtTm>
            <Acct>
                <Id>
                    <Othr>
                        <Id>40702810200000000083</Id>
                    </Othr>
                </Id>
                <Ccy>RUR</Ccy>
                <Ownr>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Ownr>
                <Svcr>
                    <FinInstnId>
                        <BICFI>ALFARUMMXXX</BICFI>
                        <ClrSysMmbId>
                            <ClrSysId>
                                <Cd>RUCBC</Cd>
                            </ClrSysId>
                            <MmbId>044525593</MmbId>
                        </ClrSysMmbId>
                        <Nm>АО "АЛЬФА-БАНК"</Nm>
                    </FinInstnId>
                </Svcr>
            </Acct>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>OPBD</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">49943945.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
                <Avlbty>
                    <Dt>
                        <ActlDt>2024-03-07</ActlDt>
                    </Dt>
                    <Amt Ccy="RUR">49943945.00</Amt>
                    <CdtDbtInd>CRDT</CdtDbtInd>
                </Avlbty>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>CLBD</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">49938945.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
                <Avlbty>
                    <Dt>
                        <ActlDt>2024-03-07</ActlDt>
                    </Dt>
                    <Amt Ccy="RUR">49938945.00</Amt>
                    <CdtDbtInd>CRDT</CdtDbtInd>
                </Avlbty>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>ITAV</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">49926499.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>INFO</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="RUR">12446.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
        </Rpt>
        <Rpt>
            <Id>a10f84aae47d4dc8ab3eeaaa427bf67f</Id>
            <CreDtTm>2024-03-07T10:57:58.734+03:00</CreDtTm>
            <Acct>
                <Id>
                    <Othr>
                        <Id>40702840200000000529</Id>
                    </Othr>
                </Id>
                <Ccy>USD</Ccy>
                <Ownr>
                    <Nm>ООО "Тест Альфа-Линк"</Nm>
                    <Id>
                        <OrgId>
                            <Othr>
                                <Id>7013602245</Id>
                                <SchmeNm>
                                    <Cd>TXID</Cd>
                                </SchmeNm>
                            </Othr>
                        </OrgId>
                    </Id>
                </Ownr>
                <Svcr>
                    <FinInstnId>
                        <BICFI>ALFARUMMXXX</BICFI>
                        <ClrSysMmbId>
                            <ClrSysId>
                                <Cd>RUCBC</Cd>
                            </ClrSysId>
                            <MmbId>044525593</MmbId>
                        </ClrSysMmbId>
                        <Nm>АО "АЛЬФА-БАНК"</Nm>
                    </FinInstnId>
                </Svcr>
            </Acct>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>OPBD</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">28865982.80</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
                <Avlbty>
                    <Dt>
                        <ActlDt>2024-03-07</ActlDt>
                    </Dt>
                    <Amt Ccy="RUR">911602432.04</Amt>
                    <CdtDbtInd>CRDT</CdtDbtInd>
                </Avlbty>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>CLBD</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">28865982.80</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
                <Avlbty>
                    <Dt>
                        <ActlDt>2024-03-07</ActlDt>
                    </Dt>
                    <Amt Ccy="RUR">903410446.13</Amt>
                    <CdtDbtInd>CRDT</CdtDbtInd>
                </Avlbty>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>ITAV</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">9999982.80</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
            <Bal>
                <Tp>
                    <CdOrPrtry>
                        <Cd>INFO</Cd>
                    </CdOrPrtry>
                </Tp>
                <Amt Ccy="USD">0.00</Amt>
                <CdtDbtInd>CRDT</CdtDbtInd>
                <Dt>
                    <Dt>2024-03-07</Dt>
                </Dt>
            </Bal>
        </Rpt>
    </BkToCstmrAcctRpt>
</Document>