Account Balance (balance) Query
The API created for querying available balances aims to automate balance retrieval, integrating it into other applications (e.g., a financial dashboard). This allows an overview of the available balances of all accounts held at Raiffeisen Bank to be obtained at any moment, providing a clear picture of the company's or group's current liquidity, which is essential for supporting daily treasury operations.
Query method: API request
Request message: Camt.060 JSON
Response message: Camt.052 JSON
Content: The bank returns two balance values:
- ITAV – available balance
- ITBD – current balance
The formal description can be found in the payment-api documentation.
| JSON field | M/O | Length | Value | Note |
|---|---|---|---|---|
| AcctRptgReq.RptgReq.ReqdMsgNmId | M | fixed value | always "BALN" | If a different value is provided, the request is invalid. |
| AcctRptgReq.GrpHdr.CreDtTm | M | see regex → | CharValidation-DateTime | ISO8601 date-time format |
| AcctRptgReq.GrpHdr.MsgId | M | min: 1 max: 35 | CharValidation-X-set | |
| AcctRptgReq.RptgReq.Acct.Id.IBAN | M | see regex → | CharValidation-IBAN | |
| AcctRptgReq.RptgReq.AcctOwnr.Pty.Nm | M | min: 1 max: 140 | CharValidation-TR-EIS | |
| consentList [ ] | M | element count: 2, per element: min 1 char, max 10 chars | 2 ConsentIds | Similar to transfers, two valid ConsentIds must be provided. |
Query Steps
Steps:
- Prepare the query
- Attach a certificate (CERT) to the query
- Attach 2 consent IDs to the query
- Send query + CERT + consent IDs to the Bank
- The bank verifies the validity of the CERT and consent
- If valid, processing begins
Full workflow
-
Select Consents:
- Select the consents where:
- The desired account (
debtorAccount) is found in the consent's account list. - The consent's validity period has not expired (
expiry). - The consent's status is
APPROVED. - The signing person (
signer) listed in the consent has signing authority on the account to be queried.
- The desired account (
- If the signer is the sole signatory, a single consent is sufficient.
- If the signer is one of a signing pair, the second consent must also be found, in which the other member of the pair is the signer.
- Select the consents where:
-
If no usable consent exists:
- Before the query:
- If there is a consent awaiting approval:
- Notify the approver.
- Poll the consent status.
- If there is no consent awaiting approval:
- Consents must be created.
- If there is a consent awaiting approval:
- Before the query:
-
Submit the balance query via the API.