Transactions

The transactions flow can be used to acquire a list of transactions of a specific account of the consumer.

The flow is not available for all accounts. Please check the capabitilies of the account to see if it's available.

If a timeframe is defined in the consent_scope.transactions then the transactions request can only fetch transactions from dates within the defined frame.

NOTE: There is a new functionality added. When adding a preferred_pagination_size to your request you can now activate pagination for your transactions when it is available. For more information regarding this see Paginate Transactions.

Request

POST /xs2a/v1/consents/{consent-id}/transactions/get HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Token <Token>
Host: <Host>
{
    "consent_token": String,
    "account_id": String,
    "from_date": Date,
    "to_date": Date,
    "preferred_pagination_size": ?Integer,
    "psu": ?{
        "user_agent": String,
        "ip_address": String
    }
}

consent_token String, required

The consent_token can be obtained as described here.

account_id String, required

The account identifier provided in the result from an accounts request (from either the XS2A API or the Consent API) has to be passed in the payload of the request. The id of an account can change and it is recommended to request an updated list of accounts in order to use the latest ids.

from_date Date (String: "YYYY-MM-DD"), required

The from_date property (in combination with the to_date property) is used to determine the inclusive start date of the transactions search range.

to_date Date (String: "YYYY-MM-DD"), required

The to_date property (in combination with the from_date property) is used to determine the inclusive end date of the transactions search range.

psu Object, optional

The psu object is optional, however, if the consumer is present, it is recommended to provide it. Some banks soften their daily consent usage restrictions if the PSU data is available.

psu.user_agent String, required

The user_agent property holds the user agent string of the consumer's client application, e.g. the web browser.

psu.ip_address String, required

The ip_address property holds the IP address of the consumer. Both IPv4 and IPv6 are accepted formats.

preferred_pagination_size Integer, optional

The preferred_pagination_size property when defined enables pagination of transactions. The set value for the preferred_pagination_size will be used as the basis for a page size. It is not possible to ensure this page size because not every bank is compatible with every value. We will try to match the closest possible value here.

Response

{
    "data": {
        "result": ?{
            "transactions": Array<Transaction>,
            "from_date": String,
            "to_date": String,
            "pagination": ?Pagination
        },
        "consent_token": String
    }
}

data.result.transactions Transaction[], always present

An array that contains the extracted transactions.

data.result.from_date Date (String: "YYYY-MM-DD"), always present

The start date of the timeframe for which the transactions were extracted.

data.result.to_date Date (String: "YYYY-MM-DD"), always present

The end date of the timeframe for which the transactions were extracted.

data.result.pagination Pagination, optional

The pagination object indicates whether or not a pagination is available. This object will not be present if there are no available pages. See Transactions Next for more information on this use case.

data.consent_token String, always present

The response contains a new consent_token that has to be used in the following request.

NOTE: The returned information can differ depending on the selected bank, as some banks provide more information than others.

Example

Request

POST /xs2a/v1/consents/gp4cb0g6d9r3qf4d68fkrlb7ejo8mqqk/transactions/get

{
    "consent_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6IjEyMzQ1Njc4OTAifQ.na71ipK8ASvggoM6C5vMjBKgJlZLxV-m6ElgHBrNtlU",
    "account_id": "fdff8f6f-d923-4489-90b3-43d11c021e1b",
    "from_date": "2018-10-05",
    "to_date": "2018-10-25",
    "preferred_pagination_size": 4000,
    "psu": {
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.162 Safari/537.36",
        "ip_address": "192.168.2.1"
    }
}

Response

200 OK

{
    "data": {
        "result": {
            "transactions": [
                {
                    "reference": "Flight 123",
                    "amount": {
                        "amount": 1200,
                        "currency": "EUR"
                    },
                    "original_amount": {
                        "amount": 12345,
                        "currency": "SEK"
                    },
                    "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"
                    },
                    "bank_transaction_code": {
                        "code": "CCRD",
                        "sub_code": "CreditCardPayment",
                        "description": "Transaction is related to a payment of credit card."
                    }
                    "date": "2018-10-23",
                    "booking_date": "2018-10-23",
                    "value_date": "2018-10-25",
                    "state": "PROCESSED",
                    "type": "DEBIT",
                    "method": "TRANSFER"
                }
            ],
            "from_date": "2018-10-05",
            "to_date": "2018-10-25",
            "pagination": {
                "count": 4000,
                "url": "https://api.openbanking.playground.klarna.com/xs2a/v1/consents/gp4cb0g6d9r3qf4d68fkrlb7ejo8mqqk/transactions/list",
                "next": {
                    "offset": "EYNYcTCDOqx4+8RhyMHjPKnW87ifsANLiUANDD4zDt5oO3I3y4y5Rpt0J7Cxn2RpcljIjVKm7jrGUSIVJZpkhvD7boUxUww0CTeryoLYp5fGJBWM4M+/kION/bVOCRtOSc2qT6rKcj4I5n4I2H7z+9qCWoJ5lxnRebmTxXu7y2f2+/QjrJd2K8TZak+c11rScvdMkU0ak1Fp3dxUdbRqPfO5BvBPv1rpk3a9Sb4DRlyF7Laq1WVzmK/DG0vE1zvAYk2MO5z3b0vFxnn+8LoAWD4ePDWdXtd0pFk+J7BigFv8VDC5K+8uTyG4IU8LO/0Wn2nM7j1ch1l4dsQeqze0tkEIo/PhwOrMqMlEpSQeFycLcWjzmy/ZWFIjOj8orLXJxn3/u8hD2uGD/ZkVHXOALPSOKfo20WvQMRW+pW1cZiJVDNHloGeVXa1lt4BzZH0ws2vqwEokp+xb+wejDJGWzM8sL+5ECrtavK4P1EpUQybZoauJXRbrUfMo8VxejyF1q+ugch38LQWL0zfalQegWd76nAyZ1dp2lXSqIbayUW+KBlBFCK+2DQvWB8cJgrXo+qnJKYaSdLhpCGprrjusfIaGnBul1HSWcMqRo6HSuM0KR7pic5TpukoJl4gF9BBs2QmW1p93CVWOyD45em0QtRa7W+d7Rl5ThP3xto7fw+mkgCjp69R1eOh4YBLBpBH4TIeybv2pKcKKPBMi7tPbjvZsB6VWkYG9AEqEeNtJ4KGmC7yO2ITnSjBP5JOKxMgTlA44GZwFuaZ5wo15Y6DeyL6Huik3o21x+TtfSzjl/WqIUc5aDMLphavo8ccTcQa8eOjEpM+gy5uJTB3tiC/zWV8Dyg4IIB2tsNgq3xIL2nNufaYlGKXl/tr0VDiWOLA8x5V2QroLXWBDUpSm4+gsuhLB+yNgG/V88T8A9YY=.DPEvt4m0TPRiaOuA"
                }
            }
        },
        "consent_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6Ijg4OTk3Nzg4In0.QQscn9a6-nQXuVK4Rwbft_LFMF3-r2xzWROEZMS2lW0"
    }
}

results matching ""

    No results matching ""