Categorized Transactions Report

Build a report with transactions belonging to requested customer and account and fitting the provided date range. It will show all transactions enriched with category and brand information.

URL and Request Body Structure of a Provide Transactions call

POST /insights/v1/reports/categorized/create HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Bearer <Token>
Host: <Host>
{
    "insights_consumer_id": string,
    "insights_account_ids": Array<string>,
    "time_frame": TimeFrame
}

insights_consumer_id String, required

The insights_consumer_id parameter identifies the consumer whose transactions are used to generate the report.

insights_account_ids String[], required

The list of accounts, identified by the 'insights_account_id', which will filter all transactions from the consumer to only those accounts.

time_frame TimeFrame, required

The 'time_frame' will filter transactions used for this report to be included in this TimeFrame.

TimeFrame

{
    "from": Date,
    "to": Date
}

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

The from property (in combination with the to property) will be used as the start date for this Timeframe. It has to be provided in the YYYY-MM-DD format according to ISO 8601.

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

The to property (in combination with the from property) will be used as the end date for this Timeframe. It has to be provided in the YYYY-MM-DD format according to ISO 8601.

Response Structure of Categorized Transactions Report

{
    "data": {
        "insights_consumer_id" : string,
        "accounts": Array<AccountWithTransactions>
        }
}

data.insights_consumer_id String, always present

The generated report was stored with this insights_consumer_id. It can be used to identify this consumer when generating a report later.

data.insights_account_id AccountWithTransactions, always present

Since this report supports multiple accounts, the transactions are grouped by account within the 'AccountWithTransactions' object.

AccountWithTransactions

{
    "insights_account_id" : string,
    "iban": ?String,
    "account_number": ?string,
    "bic": ?string,
    "bank_code": ?string,
    "bank_name": ?string,
    "holder_address" : ?ProvidedTransactionAddressData,
    "holder_name": ?string,
    "transactions": Array<CategorizedTransaction>
}

insights_account_id String, always present

The insights_account_id is used to identify a specific account within Account Insights.

iban String, optional

The IBAN of the consumer account.

account_number String, optional

The account number of the consumer account.

bic String, optional

The BIC of the consumer bank.

bank_code String, optional

The bank code of the consumer bank.

bank_name String, optional

The name of the consumer bank.

holder_address ProvidedTransactionAddressData, optional

The account holder address, for details see here.

holder_name String, optional

The account holder name.

transactions CategorizedTransaction[], always present

List of all transactions for the account identified by the insights_account_id parameter.

CategorizedTransaction

{
    "date": Date,
    "reference": ?string,
    "amount": ?Amount,
    "counterParty": ?ProvidedTransactionCounterPartyAccount,
    "categories": ?Array<CategorizedTransactionCategory>,
    "brand": ?Brand,
    "recurring": ?boolean,
    "id": string
}

date Date (String: "YYYY-MM-DD"), always present

The date on which the transaction was booked or the value date if it is a pending transaction.

reference String, optional

The reference for the transaction.

amount Amount, optional

The amount of the transaction.

counter_party ProvidedTransactionCounterPartyAccount, optional

The account info of the other party involved in the transaction.

categories CategorizedTransactionCategory[], optional

Any transaction could match a number of categories. All those matched categories will be reported as a list here.

brand Brand, optional

If the transaction was sent to or received from a known brand, this will be shown in the brand property.

recurring boolean, optional

Shows if the transaction has been categorized as recurring.

id String, always present

The id is an unique identifier for this transaction.

CategorizedTransactionCategory

{
    "id": string,
    "name": string
}

id String, always present

The internal id of this category.

name String, optional

The name of this category.

Brand

{
    "id": string,
    "name": ?string,
    "url": ?string,
    "icon_url": ?string
}

id String, always present

The internal id of this brand.

name String, optional

The name of the brand.

url String, optional

The url showing to the main webside of the brand.

icon_url String, optional

With the icon_url a link to this brands icon will be provided.

Example response

{
    "data": {
        "insights_consumer_id": "8ddab879-c715-4271-ba7c-761aa8c7a633",
        "accounts": [
            {
                "insights_account_id": "3b3d678f-66b7-4b23-a2a5-0bfd275e86a1",
                "transactions": [
                    {
                        "date": "2020-01-01",
                        "reference": "transfer to esprit online shop",
                        "counter_party": {
                            "holder_name": "esprit germany",
                            "holder_address": {
                                "country": "DE"
                            }
                        },
                        "categories": [
                            {
                                "id": "a9184d59-25be-5f03-aebb-f639a5ed9a8a",
                                "name": "Clothes"
                            }
                        ],
                        "brand": {
                            "id": "664bb3a2-62c9-52b7-9ccd-81cfe904258c",
                            "name": "Esprit"
                        },
                        "recurring": false,
                        "id": "ae66102e-f4ff-5e02-8f95-ad0bbd225e19"
                    },
                    {
                        "date": "2020-01-01",
                        "reference": "rewe sagt danke",
                        "counter_party": {
                            "holder_name": "rewe gmbh"
                        },
                        "categories": [
                            {
                                "id": "edde5df6-fbf4-5e79-afb1-97de52d93aca",
                                "name": "Groceries"
                            }
                        ],
                        "brand": {
                            "id": "71569e21-bfe3-5871-9a5a-f791cca811c0",
                            "name": "Rewe",
                            "icon_url": "https://x.klarnacdn.net/openbanking-de/icons/110ed771-7f71-43fc-9bcb-b8921e2881fe.png"
                        },
                        "recurring": false,
                        "id": "3a1cf972-a9bb-5fc7-b36d-12ad707f29aa"
                    }
                ]
            }
        ]
    }
}

results matching ""

    No results matching ""