API Reference

Rabobank

Following are the successful and invalid examples for Rabobank:

Successful

Request

Example Request

[
    {
        "iban": "NL01RABO0123456789",
        "currency": "EUR",
        "transactions": {
            "transactions": {
                "pending": [],
                "booked": [
                    {
                        "mandateId": "",
                        "creditorId": "",
                        "ultimateCreditor": "",
                        "remittanceInformationStructured": "",
                        "transactionAmount": {
                            "currency": "EUR",
                            "amount": -800.33
                        },
                        "creditorAccount": {
                            "iban": "NL31RABO0444455043"
                        },
                        "creditorName": "P. artner",
                        "debtorAccount": {
                            "iban": "NL01RABO0123456789"
                        },
                        "debtorName": "DUMMY-TEST",
                        "remittanceInformationUnstructured": "mentatie deze maand",
                        "raboDetailedTransactionType": "544",
                        "raboTransactionTypeName": "bg",
                        "raboBookingDateTime": "2019-12-02T14:10:58Z",
                        "entryReference": 14,
                        "extra_info": {
                            "somekey": "some value"
                        } 
                    }
                ]
            }
        }
    }
]

 

Request parameters

NameTypeRequiredDescription
bodyList of objectstrueList of objects. Each object represents one account.
ibanStringtrueIBAN of the payment account on which the accounting entry is posted.
currencyStringtrueThree character currency code of account.
transactionsObjecttrueObject that contains a list of transactions of the given account.
transactions.transactionsObjecttrueNested object that contains a list of transactions of the given account.
pendingList of objectsfalseList of pending transaction objects
bookedList of objectstrueList of booked transaction objects
mandateIdStringfalseIdentifier shared by the bank.
creditorIdStringfalseIdentifier shared by the bank.
ultimateCreditorStringfalseUltimate creditor information provided by the bank.
remittanceInformationStructuredStringfalseProcessed transaction description.
transactionAmountObjecttrueTransaction amount object that contains currency and amount
transactionAmount.currencyStringtrueCurrency of the transactionAmount object.
transactionAmount.amountString or FloattrueTransactions amount of the transactionAmount object.
creditorAccountObjecttrueTransaction creditor account details (if the transaction is outgoing) possibly containing iban and/or bban.
creditorAccount.ibanStringfalseIBAN of the creditor side of the transaction.
creditorAccount.bbanStringfalseBBAN of the creditor side of the transaction.
creditorNameStringfalseName of the creditor side of the transaction.
debtorAccountObjecttrueTransaction debtor account details (if the transaction is incoming) possibly containing iban and/or bban.
debtorAccount.ibanStringfalseIBAN of the debtor side of the transaction.
debtorAccount.bbanStringfalseBBAN of the debtor side of the transaction.
debtorNameStringfalseName of the debtor side of the transaction.
remittanceInformationUnstructuredStringfalseRaw transaction description.
raboDetailedTransactionTypeStringfalseTransaction type identifier given by the bank.
raboTransactionTypeNameStringfalseTransaction type name given by the bank.
raboBookingDateTimeStringtrueTimestamp of the transaction booking.
entryReferenceStringtrueEntry reference code.
extra_infoObjectfalseObject containing extra info shared by the bank.

Response

200

Response 200

{
    "id": "06321bd4-871f-4945-9ea0-2a615b389841",
    "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:47:12.463118Z"
    },
    "account_details": [
        {
            "iban": "NL01RABO0123456789",
            "currency": "EUR",
            "first_transaction_datetime": "2019-12-02T14:10:58.000000Z",
            "last_transaction_datetime": "2019-12-02T14:10:58.000000Z",
            "number_of_transactions": 1
        }
    ],
    "category_groups": [
        {
            "category_group_id": "041b92cd-98ec-4a65-96bb-c4d15aace5bf",
            "category_group_name": "Expenses",
            "categories": [
                {
                    "category_id": 1038,
                    "category_name": "Alimony",
                    "sequences": [
                        {
                            "counterparty_iban": "NL31RABO0444455043",
                            "counterparty_bban": "0444455043",
                            "counterparty_name": "P. ARTNER",
                            "credit_debit_indicator": "DBIT",
                            "first_transaction_datetime": "2019-12-02T14:10:58.000000Z",
                            "last_transaction_datetime": "2019-12-02T14:10:58.000000Z",
                            "number_of_transactions": 1,
                            "duration_days": 0,
                            "periodicity": "no_periodicity",
                            "time_delta_consistency": 0.0,
                            "amount_consistency": 0.0,
                            "statistics": {
                                "eur_min": 800.33,
                                "eur_max": 800.33,
                                "eur_median": 800.33,
                                "eur_mean": 800.33,
                                "eur_last": 800.33,
                                "eur_sum": 800.33
                            },
                            "transaction_details": [
                                {
                                    "acct_id": "NL01RABO0123456789",
                                    "acct_ccy": "EUR",
                                    "ntry_seq_nb": 191202141058,
                                    "bookg_dt_tm_gmt": "2019-12-02 14:10:58.000000",
                                    "bookg_amt": "800.33",
                                    "rmt_inf_ustrd1": "mentatie deze maand",
                                    "engine_category_id": 1038,
                                    "userrule_category_id": null,
                                    "engine_category_group_id": "041b92cd-98ec-4a65-96bb-c4d15aace5bf",
                                    "userrule_category_group_id": null
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        {
            "category_group_id": "c648f305-721b-4082-9413-f55ca2cbb75f",
            "category_group_name": "Income",
            "categories": []
        }
    ]
}

Response parameters

NameTypeDescription
bodyObjectThe main output object of Tix containing the full Tix Report.
idStringUnique identifier (uuid) of Tix Report.
revision_numberIntegerThis value is always zero.
metadataObjectMetadata fields related to versioning and calculation datetime.
metadata.version_tixStringVersion number of Tix model used to generate report.
metadata.version_categoryStringVersion number of Category model used to generate report.
metadata.version_periodicityStringVersion number of Periodicity model used to generate report.
metadata.version_adapterStringVersion number of Adapter used to generate report.
metadata.version_end_user_configStringVersion number of end user config used to generate report.
metadata.version_userrule_configStringVersion 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_datetimeStringCalculation datetime (UTC) of report. Formatted as ISO 8601 string (%Y-%m-%dT%H:%M:%S.%fZ).
category_groupsList of objectsList of category_groups containing one element per category_group configured for the end user.
category_groups[].category_group_idStringUnique identifier (uuid) of category_group. Use this field to derive (business) logic instead of category_group_name.
category_groups[].category_group_nameStringName of category_group. Do not use this field to derive (business) logic, use category_group_id instead.
category_groups[].categoriesList of objectsList of categories containing one element per category identified within the category_group.
categories[].category_idIntegerUnique identifier of category in the Category model. Use this field to write (business) logic instead of category_name.
categories[].category_nameStringName of category. Do not use this field to write (business) logic, use category_id instead.
categories[].sequencesList of objectsList of sequences containing one element per sequence identified within the category.
sequences[].counterparty_ibanStringIBAN of the counterparty.
sequences[].counterparty_bbanStringBBAN of the counterparty.
sequences[].counterparty_nameStringName of the counterparty.
sequences[].credit_debit_indicatorStringCredit debit indicator. Possible values: "CRDT", "DBIT".
sequences[].first_transaction_datetimeStringMin datetime (UTC) of transactions in the sequence. Formatted as ISO 8601 string.
sequences[].last_transaction_datetimeStringMax datetime (UTC) of transactions in the sequence. Formatted as ISO 8601 string.
sequences[].number_of_transactionsIntegerNumber of transactions in the sequence.
sequences[].duration_daysIntegerDuration of the sequence in days (number of days between first/last datetime).
sequences[].periodicityStringIndicates the periodicity of the sequence such as monthly or weekly. Possible values: "w", "bw", "fw", "m", "bm", "q", "ha", "a", "no_periodicity".
sequences[].time_delta_consistencyNumberTime-delta consistency of sequence. Score between 0 and 1 indicating whether transactions occur at regular intervals over time.
sequences[].amount_consistencyNumberAmount consistency of sequence. Score between 0 and 1 indicating whether the booking amounts of the transactions in the sequence are roughly the same.
sequences[].statisticsStatistics calculated on the booking amounts of transactions in the sequence.
sequences[].transaction_detailsList of objectsDetailed information about the transactions contained within the sequence. Contains one element per transaction.
transaction_details.acct_idStringIBAN of account.
transaction_details.acct_ccyStringCurrency code of account, e.g. EUR or USD.
transaction_details.ntry_seq_nbIntegerEntry sequence number. Transaction counter used to uniquely identify transactions for a certain acct_id/acct_ccy combination.
transaction_details.bookg_dt_tm_gmtStringBooking datetime (GMT) formatted as a string.
transaction_details.bookg_amtStringBooking amount.
transaction_details.rmt_inf_ustrd1StringDescription field.
transaction_details.engine_category_idIntegercategory_id according to the Category model.
transaction_details.userrule_category_idIntegercategory_id according to the user rules.
transaction_details.engine_category_group_idStringcategory_group_id according to the TIX Category Mapping.
transaction_details.userrule_category_group_idStringcategory_group_id according to the user rules.

To know more about default categories, read 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

[
    null
]

Response – 422 Unprocessable Entity

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

Error response schema

NameTypeDescription
bodyList of objectsList of error objects.
locList of objectsList error messages and values, may be used for debugging faulty requests.
msgStringError message describing the (validation) error.
typeStringError type.