Balance
The balance flow can be used to acquire detailed information about the balance of one of the consumer’s accounts.
Once the flow is finished one Balance object can be obtained. The information provided can differ depending on the selected bank, as some banks provide more information than others.
In order to request the balance of a specific account, the account identifier or the IBAN can be passed in the payload of the request. If neither the identifier nor the IBAN is set the consumer has to select an account, if more than one account is present.
Request Body Structure of a Balance Flow
{
"iban": ?String,
"account_id": ?String,
"allowed_accounts": ?AllowedAccounts
}
The IBAN of the account for which the balance flow should be executed.
The account identifier - as provided in the result of an accounts flow - of the account for which the balance flow should be executed.
A configuration for filtering the options at the account selection for the consumer.
This can't be used in combination with the iban and account_id fields.
Response Structure of a successful Balance Flow
{
"data": {
"state": Enum<'PROCESSING', 'CONSUMER_INPUT_NEEDED', 'ABORTED', 'EXCEPTION', 'FINISHED'>,
"result": ?{
"type": String,
"account": Account,
"balance": ?Amount,
"available": ?Amount,
"limit": ?Amount,
"reserved": ?Amount
}
}
}
For successful flows the type property always holds the value balances.
The account property holds the available details of the account.
The available property holds the amount that is available for a transfer.
The limit property holds the amount that represents the overdraft for the account, the additional amount the consumer can withdraw beyond 0.
The reserved property holds the amount that is reserved for known future payments.
Example Response for a successful Balance Flow
{
"data": {
"state": "FINISHED",
"result": {
"type": "balances",
"account": {
"id": "123e4567-e89b-12d3-a456-426655440000",
"alias": "Girokonto",
"account_number": "123456789",
"iban": "DE44500105175407324931",
"holder_name": "Max Mustermann",
"bank_code": "51091700",
"bic": "VRBUDE51XXX",
"bank_name": "VR Bank Untertaunus eG",
"transfer_type": "FULL",
"account_type": "DEFAULT",
"balance": {
"amount": 12345,
"currency": "EUR"
}
},
"balance": {
"amount": 12345,
"currency": "EUR"
},
"available": {
"amount": 12345,
"currency": "EUR"
},
"limit": {
"amount": 12345,
"currency": "EUR"
},
"reserved": {
"amount": 12345,
"currency": "EUR"
}
}
}
}