The Transactions Flow

The transactions flow can be used to acquire a list of transactions of a specific account of the consumer. At the end of the flow the XS2A-API returns one array of Transaction objects which can differ depending on the selected bank, as some banks provide more information than others.

In order to request the transactions 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 available.

The fields from_date and to_date can be used to determine the transactions search range. The format to use is in format yyyy-MM-dd according to ISO 8601 with the request body structured as follows:

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

Alternatively the since field could be used to query the last X days. In this case the fields from_date and to_date must not be set, hence the request body has to be structured this way:

{
    "type": "transactions",
    "iban": ?string,
    "account_id": ?string,
    "since": ?string
}

If neither the from_date and to_date date properties nor the since property are provided, then by default the transactions of the past 30 days are extracted.

Response Structure of a successful Transactions Flow

{
    "data": {
        "result": ?{
            "transactions": Array<Transaction>,
            "account": Account,
            "from_date": string,
            "to_date": string,
            "incomplete": boolean,
            "type": string
        },
        "state": string
    }
}

Detailed information on the Transaction object can be found here.

Detailed information on the Amount object can be found here.

Detailed information on the Account object can be found here.

Detailed information on the AddressData object can be found here.

The "date strings" supplied for the from_date and to_date properties have to be of the format YYYY-MM-DD.

The incomplete boolean indicates whether or not all of the available transactions for the given timeframe could be retrieved. If the incomplete property is true it is recommended to start another transactions flow for which the date of the oldest previously received transaction is set as the from_date property.

Example Response for a successful Transactions Flow

{
    "data": {
        "result": {
            "transactions": [
                {
                    "reference": "Flight 123",
                    "amount": {
                        "amount": 12345,
                        "currency": "EUR"
                    },
                    "counter_party": {
                        "id": "123e4567-e89b-12d3-a456-426655440000",
                        "alias": "Girokonto",
                        "account_number": "123456789",
                        "iban": "DE44500105175407324931",
                        "holder_name": "Max Mustermann",
                        "holder_address": {
                            "street_address": "Konrad-Adenauer-Straße 21",
                            "street_address2": "Backside of the House, Floor 2",
                            "postalcode": "35440",
                            "city": "Linden",
                            "region": "Hesse",
                            "country": "DE"
                        },
                        "bank_code": "51091700",
                        "bic": "VRBUDE51XXX",
                        "bank_name": "VR Bank Untertaunus eG",
                        "bank_address": {
                            "street_address": "Konrad-Adenauer-Straße 21",
                            "street_address2": "Backside of the House, Floor 2",
                            "postalcode": "35440",
                            "city": "Linden",
                            "region": "Hesse",
                            "country": "DE"
                        },
                        "transfer_type": "NONE",
                        "account_type": "DEFAULT"
                    },
                    "date": "2018-10-23",
                    "state": "PROCESSED",
                    "type": "DEBIT",
                    "method": "TRANSFER"
                }
            ],
            "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"
                }
            },
            "from_date": "2018-10-05",
            "to_date": "2018-10-25",
            "incomplete": false,
            "type": "transactions"
        },
        "state": "FINISHED"
    }
}

results matching ""

    No results matching ""