Balances Report
[deprecated] Please see our report generation as described here.
This report shows the lastest balances of an account.
This report can be requested via the Modular Report endpoint.
ReportOptions
This report has no options to be considered.
Response Structure of Balances Report
The generated report will be part of the modular report response.
{
"type": "BALANCES",
"balance": ?Amount,
"available": ?Amount,
"limit": ?Amount,
"reserved": ?Amount
}
limit Amount, optional
The limit property holds the amount that represents the overdraft for the account, the additional amount the consumer can withdraw beyond 0.
reserved Amount, optional
The reserved property holds the amount that is reserved for known future payments.
Example request
{
"insights_consumer_id": "6c03aff-8fa0046-ffae74-b0cbc-4d5fd1",
"report_days": 3,
"reports": [
{
"type": "BALANCES"
}
]
}
Example response
{
"data": {
"accounts": [
{
"insights_account_id": "3b3d678f-66b7-4b23-a2a5-0bfd275e86a1",
"reports": [
{
"type": "BALANCES",
"balance": {
"amount": 100000,
"currency": "EUR"
},
"available": {
"amount": 120000,
"currency": "EUR"
},
"limit": {
"amount": 30000,
"currency": "EUR"
},
"reserved": {
"amount": 10000,
"currency": "EUR"
}
}
]
}
]
}
}