Accounts

The accounts flow can be used to acquire a list of the consumer’s bank accounts.

Once the flow is finished a list of accounts can be obtained from the XS2A-API. The information about the accounts can differ depending on the selected bank, as some banks provide more information than others.

The request does not require a payload.

Result of an Accounts Flow

{
    "data": {
        "result": ?{
            "accounts": Array<Account>,
            "type": string
        },
        "state": enum<'PROCESSING', 'CONSUMER_INPUT_NEEDED', 'ABORTED', 'EXCEPTION', 'FINISHED'>
    }
}

data.result.type String, always present

For successful flows the type property always holds the value accounts.

data.result.accounts Account[], always present

The accounts property holds the available details of the accounts.

Response Example for a successful Flow

{
    "data": {
        "result": {
            "accounts": [
                {
                    "id": "0",
                    "alias": "Girokonto(MaxMustermann)",
                    "iban": "DE06000000000023456789",
                    "bic": "SFRTDE20XXX",
                    "account_number": "23456789",
                    "holder_name": "MaxMustermann",
                    "bank_code": "",
                    "transfer_type": "FULL",
                    "account_type": "DEFAULT",
                    "balance": {
                        "amount": 12345,
                        "currency": "EUR"
                    }
                },
                {
                    "id": "1",
                    "alias": "Girokonto (Musterman, Petra)",
                    "iban": "DE86000000002345678902",
                    "bic": "SFRTDE20XXX",
                    "account_number": "2345678902",
                    "holder_name": "Musterman, Petra",
                    "bank_code": "",
                    "transfer_type": "FULL",
                    "account_type": "DEFAULT"
                }
            ],
            "type": "accounts"
        },
        "state": "FINISHED"
    }
}

results matching ""

    No results matching ""