Data Structure

The Category object is a structured representation of the transaction category hierarchy. It is divided into seperate objects based on the categorisation engine that has been used. For Z2 it is divided into four levels of detail (from l0Name to l3Name) and a code that uniquely identifies the category.

The category object is added to the Transaction API result models. These models are described within the Account Information Transaction Data Structures

Z1 category object

Here's a brief overview of each field within the z1 category object:

Field

Description

L0 Name

This represents the highest level of the category and the engine used. In the example provided. At the moment "Retail" is the only available - categorization engine.

L1 Name

This is the first sub-category. Can be "Inflows" or "Outflows".

L2 Name

This is the second sub-category, providing an even more granular level of detail. In the example, it is "Income".

L3 Name

This is the deepest level of categorization. In the example, "Variable income" falls under "Income".

Code

This is a unique identifier for the category. It's a string of alphanumeric characters that corresponds to the specific category path from l0Name to l3Name. In the example, the code "R010102" represents the "Retail > Inflows > Income > Variable income" category.

Example

// Transaction Model
{
    "id": "aeeffb5c-4800-5f6f-8797-7f488351553d",
    "accountNumber": "NL12ABNA9999876523",
    "accountId": "faa409f9-ff20-4462-4729-08dbfaecde2e",
    // ... 
    "category": {
        "l0Name": "Retail",
        "l1Name": "Inflows",
        "l2Name": "Income",
        "l3Name": "Fixed income",
        "code": "R010101",
        "z1": {
            "l0Name": "Retail",
            "l1Name": "Inflows",
            "l2Name": "Income",
            "l3Name": "Fixed income",
            "code": "R010101"
        }
    }
}