1. Online balance
Clients have the opportunity to receive the account balance in two formats:
-
Base balance
-
Expanded balance
Request
URI
POST: /API/v1/ISO20022/Statements/AccountBalance - Base balance
POST: /API/v1/ISO20022/Statements/AccountBalanceExtended - Expanded balance
Scheme description
| № | R/O | Description | Link | Comment/Example |
|---|---|---|---|---|
Absolute path Document.AcctRptgReq |
||||
1 |
R |
Unique message ID |
GrpHdr.MsgId |
- |
2 |
R |
Date and time the message was created |
GrpHdr.CreDtTm |
Date format |
3 |
O |
TIN of the company |
GrpHdr.MsgSndr.Pty.Id.OrgId.Othr.Id |
- |
4 |
R |
Unique package ID with request |
RptgReq.Id |
- |
5 |
R |
Get data by type Statement |
RptgReq.ReqdMsgNmId |
Constant 'HMQSTASCF' |
6 |
R |
Account number |
RptgReq.Acct.Id.Othr.Id |
- |
7 |
R |
Name of the company |
RptgReq.AcctOwnr.Pty.Nm |
- |
Signature Document.AcctRptgReq |
||||
8 |
O |
Signature |
SplmtryData.Envlp.SgntrSt[1..n] |
- |
Online balance request example
<?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>2024-03-07T10: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>
Scheme description
| № | Description | Path | Comment/Example |
|---|---|---|---|
Absolute path Document.BkToCstmrAcctRpt |
|||
1 |
Unique message ID |
GrpHdr.MsgId |
- |
2 |
Date and time the message was created |
GrpHdr.CreDtTm |
Date format |
Absolute path Document.BkToCstmrAcctRpt.Rpt |
|||
3 |
ID |
Id |
- |
4 |
Date and time the message was created |
CreDtTm |
Date format |
5 |
Account number |
Acct.Id.Othr.Id |
- |
6 |
Account currency |
Acct.Ccy |
- |
7 |
Name of the account holder |
Acct.Ownr.Nm |
- |
8 |
TIN of the account holder |
Acct.Ownr.Id.OrgId.Othr.Id |
- |
9 |
ISO data type code |
Acct.Ownr.Id.OrgId.Othr.SchmeNm.Cd |
Constant 'TXID' |
Details of the servicing bank |
|||
10 |
BIC Bank |
Acct.Svcr.FinInstnId.BICFI |
- |
11 |
Designation of the Russian settlement system |
Acct.Svcr.FinInstnId.ClrSysMmbId.ClrSysId.Cd |
Constant 'RUCBC' |
12 |
BIC of the bank / branch serving the account |
Acct.Svcr.FinInstnId.ClrSysMmbId.MmbId |
- |
13 |
Name of the bank / branch serving the account |
Acct.Svcr.FinInstnId.Nm |
- |
Section with information about balances for the Base Balance
| № | Description | Path | Comment/Example |
|---|---|---|---|
Available balance |
|||
14 |
Balance type (Available) |
Bal[1].Tp.CdOrPrtry.Cd |
Constant 'ITAV' |
15 |
Amount |
Bal[1].Amt |
- |
16 |
Currency code of the available amount |
Bal[1].Amt@Ccy |
- |
17 |
DBIT/CRDT |
Bal[1].CdtDbtInd |
- |
18 |
Date of balance |
Bal[1].Dt.Dt |
- |
Reserved balance |
|||
19 |
Balance type (Reserved) |
Bal[2].Tp.CdOrPrtry.Cd |
Constant 'INFO' |
20 |
Amount |
Bal[2].Amt |
- |
21 |
Currency code of the reserved amount |
Bal[2].Amt@Ccy |
- |
22 |
DBIT/CRDT |
Bal[2].CdtDbtInd |
- |
23 |
Date of balance |
Bal[2].Dt.Dt |
- |
Section with information about balances for Expanded Balance
| № | Description | Path | Comment/Example |
|---|---|---|---|
Incoming balance |
|||
24 |
Balance type (Incoming) |
Bal[1].Tp.CdOrPrtry.Cd |
Constant 'OPBD' |
25 |
Incoming balance |
Bal[1].Amt@Ccy |
- |
26 |
DBIT/CRDT |
Bal[1].CdtDbtInd |
- |
27 |
Date of balance |
Bal[1].Dt.Dt |
- |
28 |
Date of balance |
Bal[1].Avlbty.Dt.ActlDt |
- |
29 |
Incoming balance in ruble equivalent |
Bal[1].Avlbty.Amt |
- |
30 |
Currency code of the incoming balance in ruble equivalent |
Bal[1].Avlbty.Amt@Ccy |
- |
31 |
DBIT/CRDT |
Bal[1].Avlbty.CdtDbtInd |
- |
Outgoing balance |
|||
32 |
Balance type (Outgoing) |
Bal[2].Tp.CdOrPrtry.Cd |
Constant 'CLBD' |
33 |
Outgoing balance |
Bal[2].Amt |
- |
34 |
Outgoing balance currency code |
Bal[2].Amt@Ccy |
- |
35 |
DBIT/CRDT |
Bal[2].CdtDbtInd |
- |
36 |
Date of balance |
Bal[2].Dt.Dt |
- |
37 |
Date of balance |
Bal[2].Avlbty.Dt.ActlDt |
- |
38 |
Outgoing balance in rubles |
Bal[2].Avlbty.Amt |
- |
39 |
Outgoing balance currency code in ruble equivalent |
Bal[2].Avlbty.Amt@Ccy |
- |
40 |
DBIT/CRDT |
Bal[2].Avlbty.CdtDbtInd |
- |
Available balance |
|||
41 |
Balance type (Available) |
Bal[3].Tp.CdOrPrtry.Cd |
Constant 'ITAV' |
42 |
Amount |
Bal[3].Amt |
- |
43 |
Available balance currency code |
Bal[3].Amt@Ccy |
- |
44 |
DBIT/CRDT |
Bal[3].CdtDbtInd |
- |
45 |
Date of balance |
Bal[3].Dt.Dt |
- |
Reserved balance |
|||
46 |
Balance type (Reserved) |
Bal[4].Tp.CdOrPrtry.Cd |
Constant 'INFO' |
47 |
Reserved balance |
Bal[4].Amt |
- |
48 |
Reserved balance currency code |
Bal[4].Amt@Ccy |
- |
49 |
DBIT/CRDT |
Bal[4].CdtDbtInd |
- |
50 |
Date of balance |
Bal[4].Dt.Dt |
- |
Example base balance
<?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>37f79863e8424f1a92d0632fbd4a71b0</MsgId>
<CreDtTm>2022-05-24T11:50:18.091+03:00</CreDtTm>
</GrpHdr>
<Rpt>
<Id>a83b805424404f0394fbf273807ac75a</Id>
<CreDtTm>2022-05-24T11:50:18.377+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">15996923005.30</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
</Bal>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>INFO</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="RUR">1565224.78</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
</Bal>
</Rpt>
</BkToCstmrAcctRpt>
</Document>
Example expanded balance
<?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>e4d6975f5c6e46fca732fb7597c46fc9</MsgId>
<CreDtTm>2022-05-24T11:57:38.231+03:00</CreDtTm>
</GrpHdr>
<Rpt>
<Id>042100f056b84f8da5ddfcde0a54ccfb</Id>
<CreDtTm>2022-05-24T11:57:38.341+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">15998489805.08</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
<Avlbty>
<Dt>
<ActlDt>2022-05-24</ActlDt>
</Dt>
<Amt Ccy="RUR">15998489805.08</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
</Avlbty>
</Bal>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>CLBD</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="RUR">15998489019.08</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
<Avlbty>
<Dt>
<ActlDt>2022-05-24</ActlDt>
</Dt>
<Amt Ccy="RUR">15998489019.08</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
</Avlbty>
</Bal>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>ITAV</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="RUR">15996923005.30</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
</Bal>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>INFO</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="RUR">1565224.78</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2022-05-24</Dt>
</Dt>
</Bal>
</Rpt>
</BkToCstmrAcctRpt>
</Document>