Following are the successful and invalid examples for Knab bank:

Successful

Request

Example Request

[
    {
        "iban": "NL04KNAB0255200000",
        "currency": "EUR",
        "transactions": {
            "transactions": {
                "booked": [
                    {
                        "debtorAccount": {
                            "iban": "NL01KPNN0123456789"
                        },
                        "debtorName": "Mc Donalds",
                        "transactionAmount": {
                            "currency": "EUR",
                            "amount": "2200.12"
                        },
                        "remittanceInformationUnstructured": "Salaris juli",
                        "transactionId": "S0M4THINGSOMETHING426",
                        "bookingDate": "2023-07-26",
                        "proprietaryBankTransactionCode": "Incoming transfer",
                        "extra_info": {
                            "somekey": "some value"
                        }
                    },
                    {
                        "creditorAccount": {
                            "iban": "NL01KPNN0123456789"
                        },
                        "creditorName": "Yet Another Test Company",
                        "transactionAmount": {
                            "currency": "EUR",
                            "amount": "225.62"
                        },
                        "remittanceInformationUnstructured": "Betaling",
                        "transactionId": "S0M4THINGSOMETHING426",
                        "bookingDate": "2023-07-26",
                        "proprietaryBankTransactionCode": "Outgoing transfer"
                    }
                ],
                "pending": []
            }
        }
    }
]

Request parameters

Name	Type	Required	Description
body	List of objects	true	List of objects. Each object represents one account.
iban	String	true	IBAN of the payment account on which the accounting entry is posted.
currency	String	true	Three character currency code of account.
transactions	Object	true	Object that contains a list of transactions of the given account.
transactions.transactions	Object	true	Nested object that contains a list of transactions of the given account.
booked	List of objects	true	List of booked transaction objects
debtorAccount	Object	false	Transaction debtor account details (if the transaction is incoming) possibly containing iban and/or bban.
debtorAccount.iban	String	false	IBAN of the debtor side of the transaction.
debtorAccount.bban	String	false	BBAN of the debtor side of the transaction.
debtorName	String	false	Name of the debtor side of the transaction.
creditorAccount	Object	false	Transaction creditor account details (if the transaction is outgoing) possibly containing iban and/or bban.
iban	String	false	IBAN of the creditor side of the transaction.
bban	String	false	BBAN of the creditor side of the transaction.
creditorName	String	false	Name of the creditor side of the transaction.
transactionAmount	Object	true	Transaction amount object that contains currency and amount
transactionAmount.currency	String	true	Currency of the transactionAmount object.
transactionAmount.amount	String or Float	true	Transactions amount of the transactionAmount object. Positive value, amount flows from debtorAccount to creditorAccount.
remittanceInformationStructured	String	false	Processed transaction description.
remittanceInformationUnstructured	String	false	Raw transaction description.
transactionId	String	true	Identifier of the transaction as shared by the bank.
bookingDate	String	true	Timestamp when the transaction was booked.
proprietaryBankTransactionCode	String	false	Transaction code that has been shared by the bank.
endToEndId	String	false	Identifier shared by the bank.
creditorId	String	false	Identifier shared by the bank.
mandateId	String	false	Identifier shared by the bank.
extra_info	Object	false	Object containing extra info shared by the bank.

Response

200

Response 200

{
    "id": "42e2fce0-3cd8-4e25-896b-7f93a93731fc",
    "revision_number": 0,
    "metadata": {
        "version_tix": "1.41.3",
        "version_category": "5.9.10",
        "version_periodicity": "5.0.1",
        "version_adapter": "2.3.0",
        "version_end_user_config": "1.0.0",
        "version_userrule_config": null,
        "calculation_datetime": "2025-05-01T13:45:42.283797Z"
    },
    "account_details": [
        {
            "iban": "NL04KNAB0255200000",
            "currency": "EUR",
            "first_transaction_datetime": "2023-07-26T00:00:00.000000Z",
            "last_transaction_datetime": "2023-07-26T00:00:00.000000Z",
            "number_of_transactions": 2
        }
    ],
    "category_groups": [
        {
            "category_group_id": "041b92cd-98ec-4a65-96bb-c4d15aace5bf",
            "category_group_name": "Expenses",
            "categories": []
        },
        {
            "category_group_id": "c648f305-721b-4082-9413-f55ca2cbb75f",
            "category_group_name": "Income",
            "categories": [
                {
                    "category_id": 1032,
                    "category_name": "Salary",
                    "sequences": [
                        {
                            "counterparty_iban": "NL01KPNN0123456789",
                            "counterparty_bban": "0123456789",
                            "counterparty_name": "MC DONALDS",
                            "credit_debit_indicator": "CRDT",
                            "first_transaction_datetime": "2023-07-26T00:00:00.000000Z",
                            "last_transaction_datetime": "2023-07-26T00:00:00.000000Z",
                            "number_of_transactions": 1,
                            "duration_days": 0,
                            "periodicity": "no_periodicity",
                            "time_delta_consistency": 0.0,
                            "amount_consistency": 0.0,
                            "statistics": {
                                "eur_min": 2200.12,
                                "eur_max": 2200.12,
                                "eur_median": 2200.12,
                                "eur_mean": 2200.12,
                                "eur_last": 2200.12,
                                "eur_sum": 2200.12
                            },
                            "transaction_details": [
                                {
                                    "acct_id": "NL04KNAB0255200000",
                                    "acct_ccy": "EUR",
                                    "ntry_seq_nb": 2307260000000,
                                    "bookg_dt_tm_gmt": "2023-07-26 00:00:00.000000",
                                    "bookg_amt": "2200.12",
                                    "rmt_inf_ustrd1": "Salaris juli",
                                    "engine_category_id": 1032,
                                    "userrule_category_id": null,
                                    "engine_category_group_id": "c648f305-721b-4082-9413-f55ca2cbb75f",
                                    "userrule_category_group_id": null
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}

Response parameters

Name	Type	Description
body	Object	The main output object of Tix containing the full Tix Report.
id	String	Unique identifier (uuid) of Tix Report.
revision_number	Integer	This value is always zero.
metadata	Object	Metadata fields related to versioning and calculation datetime.
metadata.version_tix	String	Version number of Tix model used to generate report.
metadata.version_category	String	Version number of Category model used to generate report.
metadata.version_periodicity	String	Version number of Periodicity model used to generate report.
metadata.version_adapter	String	Version number of Adapter used to generate report.
metadata.version_end_user_config	String	Version number of end user config used to generate report.
metadata.version_userrule_config	String	Version number of user rules engine used to generate report. This can be None if no user rules or old user rules were applied.
metadata.calculation_datetime	String	Calculation datetime (UTC) of report. Formatted as ISO 8601 string (%Y-%m-%dT%H:%M:%S.%fZ).
category_groups	List of objects	List of category_groups containing one element per category_group configured for the end user.
category_groups[].category_group_id	String	Unique identifier (uuid) of category_group. Use this field to derive (business) logic instead of category_group_name.
category_groups[].category_group_name	String	Name of category_group. Do not use this field to derive (business) logic, use category_group_id instead.
category_groups[].categories	List of objects	List of categories containing one element per category identified within the category_group.
categories[].category_id	Integer	Unique identifier of category in the Category model. Use this field to write (business) logic instead of category_name.
categories[].category_name	String	Name of category. Do not use this field to write (business) logic, use category_id instead.
categories[].sequences	List of objects	List of sequences containing one element per sequence identified within the category.
sequences[].counterparty_iban	String	IBAN of the counterparty.
sequences[].counterparty_bban	String	BBAN of the counterparty.
sequences[].counterparty_name	String	Name of the counterparty.
sequences[].credit_debit_indicator	String	Credit debit indicator. Possible values: "CRDT", "DBIT".
sequences[].first_transaction_datetime	String	Min datetime (UTC) of transactions in the sequence. Formatted as ISO 8601 string (%Y-%m-%dT%H:%M:%S.%fZ).
sequences[].last_transaction_datetime	String	Max datetime (UTC) of transactions in the sequence. Formatted as ISO 8601 string (%Y-%m-%dT%H:%M:%S.%fZ).
sequences[].number_of_transactions	Integer	Number of transactions in the sequence.
sequences[].duration_days	Integer	Duration of the sequence in days (number of days between first/last datetime).
sequences[].periodicity	String	Indicates the periodicity of the sequence such as monthly or weekly. Possible values:
		"w" -(weekly)
		"bw"-(bi-weekly)
		"fw"-(four-weekly)
		"m" -(monthly)
		"bm" -(bi-monthly)
		"q" -(quarterly)
		"ha" -(half-annually)
		"a" -(annually)
		"no_periodicity" -(no periodicity)
sequences[].time_delta_consistency	Number	Time-delta consistency of sequence. Score between 0 and 1 indicating whether transactions occur at regular intervals over time, e.g. every month.
sequences[].amount_consistency	Number	Amount consistency of sequence. Score between 0 and 1 indicating whether the booking amounts of the transactions in the sequence are roughly the same.
sequences[].statistics		Statistics calculated on the booking amounts of transactions in the sequence.
sequences[].transaction_details	List of objects	Detailed information about the transactions contained within the sequence. Contains one element per transaction.
transaction_details.acct_id	String	IBAN of account.
transaction_details.acct_ccy	String	Currency code of account, e.g. 'EUR' or 'USD'.
transaction_details.ntry_seq_nb	Integer	Entry sequence number. Transaction counter used to uniquely identify transactions for a certain acct_id/acct_ccy combination.
transaction_details.bookg_dt_tm_gmt	String	Booking datetime (GMT) formatted as a string (%Y-%m-%d %H:%M:%S.%f).
transaction_details.bookg_amt	String	Booking amount.
transaction_details.rmt_inf_ustrd1	String	Description field.
transaction_details.engine_category_id	Integer	category_id according to the Category model.
transaction_details.userrule_category_id	Integer	category_id according to the user rules.
transaction_details.engine_category_group_id	String	category_group_id according to the TIX Category Mapping.
transaction_details.userrule_category_group_id	String	category_group_id according to the user rules.

To know more about default categories, read that Default categories available in Mock dataset - TIX.

🚧
If you receive 57x error code, it is because of an internal application error, the x in the 57x status code corresponds to the application component that caused the error. Make sure to specify the code when contacting our Support team.

Invalid

Request

Invalid request example

[
    null
]

Response - 422 Unprocessable Entity

Error response

{
    "details": [
        {
            "loc": [
                "body",
                0
            ],
            "msg": "none is not an allowed value",
            "type": "type_error.none.not_allowed"
        }
    ]
}

Error response schema

Name	Type	Description
body	List of objects	List of error objects.
loc	List of objects	List error messages and values, may be used for debugging faulty requests.
msg	String	Error message describing the (validation) error.
type	String	Error type.