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 provided in the result from an accounts flow or an 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 is present.

Request Body Structure of a Balance Flow

{
    "iban": ?string,
    "account_id": ?string
}

Response Structure of a successful Balance Flow

{
    "data": {
        "state": enum<'INITIALIZED', 'PROCESSING', 'CONSUMER_INPUT_NEEDED', 'ABORTED', 'EXCEPTION', 'FINISHED'>,
        "result": ?{
            "type": string,
            "account": Account,
            "balance": ?Amount,
            "available": ?Amount,
            "limit": ?Amount,
            "reserved": ?Amount
        }
    }
}

The type property always holds the value balances.

The account property holds details of the account. Detailed information on the Account object can be found here.

The balance property holds the actual balance 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.

Detailed information on the Amount object can be found here.

Example Response for a successful Balance Flow

{
    "data": {
        "state": "INITIALIZED",
        "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"
            }
        }
    }
}