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.
This report can be requested via the Modular Report endpoint. Specific for this report are those options:
ReportOptions
{
"size" : ?int,
"offset": ?int,
"max_amount": ?int,
"min_amount": ?int,
"include_pending": ?boolean,
"transaction_ids": ?Array<string>,
"category_ids": ?Array<string>,
"brand_ids": ?Array<string>,
"order": ?ReportOptionsOrderBy
}
Only return a maximum of size transactions in the report.
Returns the transaction after skipping the first offset number of transactions.
Filter the transactions to include only transactions with amount less or equal the max_amount parameter.
The amount needs to be provided in the smallest unit of currency. See the amount parameter of the amount object.
Filter the transactions to include only transactions with an amount of at least min_amount.
The amount needs to be provided in the smallest unit of currency. See the amount parameter of the amount object.
This flag can filter out or include the transactions in pending state.
Filter the transactions to include only transactions with the given transaction-ids.
Filter the transactions to include only transactions matching the categories identified by the category_ids. The id must match a category from the Category List.
Filter the transactions to include only transactions matching the brands identified by the brand_ids.
Use this parameter to return the transactions in a specific order.
ReportOptionsOrderBy
{
"order": ?enum<'ASC', 'DESC'>,
"field": enum<'AMOUNT','DATE','CATEGORY','BRAND'>
}
Sets the direction of order: ascending or descending. The default setting is ascending.
The transactions will be ordered by the field from this enum.
Response Structure of Categorized Transactions Report
The generated report will be part of the modular report response.
{
"type": "CATEGORIZED_TRANSACTIONS",
"transactions": Array<CategorizedTransaction>
}
The type always contains the value "CATEGORIZED_TRANSACTIONS" for this report.
List of all transactions for one account with added data about categories and brands.
CategorizedTransaction
{
"date": Date,
"reference": ?string,
"amount": ?Amount,
"counterParty": ?ProvidedTransactionCounterPartyAccount,
"categories": ?Array<CategorizedTransactionCategory>,
"brand": ?Brand,
"recurring": ?boolean,
"id": string
}
The date on which the transaction was booked or the value date if it is a pending transaction.
The reference for the transaction.
The account info of the other party involved in the transaction.
Any transaction could match a number of categories. All those matched categories will be reported as a list here.
If the transaction was sent to or received from a known brand, this will be shown in the brand property.
Shows if the transaction has been categorized as recurring.
The id is an unique identifier for this transaction.
CategorizedTransactionCategory
{
"id": string,
"name": string
}
The internal id of this category. Further details about a category will be provided by the Category List call.
The name of this category.
Brand
{
"id": string,
"name": string,
"company": ?string,
"url": ?string,
"icon_url": ?string
}
The internal id of this brand.
The well known name of the brand.
The name of the company of this brand.
The url of the main webside of the brand.
With the icon_url a link to this brands icon will be provided.
Example request
{
"insights_consumer_id": "6c03aff-8fa0046-ffae74-b0cbc-4d5fd1",
"insights_account_ids":
[
"3b3d678f-66b7-4b23-a2a5-0bfd275e86a1"
],
"report_days": 60,
"reports": [
{
"type": "CATEGORIZED_TRANSACTIONS",
"options": {
"max_amount": 1000,
"min_amount": -1000,
"limit": 3
}
},
]
}
Example response
{
"data": {
"accounts": [
{
"insights_account_id": "3b3d678f-66b7-4b23-a2a5-0bfd275e86a1",
"reports": [
{
"type": "CATEGORIZED_TRANSACTIONS",
"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"
}
]
}
]
}
]
}
}