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

Object

true

Nested object that contains a list of transactions of the given account.

pending

List of objects

true

List of pending transaction objects

booked

List of objects

true

List of booked transaction objects

transactionId

String

true

Identifier of the transaction as shared by the bank.

executionDateTime

String

true

Timestamp of the transaction execution.

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.

creditorName

String

false

Name of the creditor side of the transaction.

creditorAccount

Object

false

Transaction creditor account details possibly containing iban and/or bban.

creditorAccount.iban

String

false

IBAN of the creditor side of the transaction.

creditorAccount.bban

String

false

BBAN of the creditor side of the transaction.

debtorName

String

false

Name of the debtor side of the transaction.

debtorAccount

Object

false

Transaction debtor account details 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.

transactionType

String

false

Transaction type.

remittanceInformationStructured

String

false

Processed transaction description.

remittanceInformationUnstructured

Object

false

Additional transaction metadata in structured form. Accepted keys:

• "referenceType"
• "referenceIssuer"
• "reference"

extra_info

Object

false

Object containing extra info shared by the bank.

Name

Type

Required

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.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.

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