Common Objects when providing Data

ProvidedAccount

{
    "insights_account_id" : ?string,
    "alias": ?string,
    "account_number": ?string,
    "iban": ?string,
    "bank_code": ?string,
    "bic": ?string,
    "holder_name": ?string,
    "transfer_type": ?enum<'NONE', 'DOMESTIC', 'FULL', 'REFERENCE', 'RESTRICTED'>,
    "account_type": ?enum<'DEFAULT', 'SAVING', 'CREDITCARD', 'DEPOT'>,
    "holder_address" : ?ProvidedTransactionAddressData,
    "balance": ?Amount,
    "available": ?Amount,
    "limit": ?Amount,
    "reserved": ?Amount
}

insights_account_id String, optional

The ID which represents this account. Any string with less than 128 characters can be used to identify the account. If left empty it will be generated by Account Insights. Needed for delete, replace or update calls.

alias String, optional

The alias can be used as a name for the account to be identified more easily.

account_number String, optional

The account number of the consumer account.

iban String, optional

The IBAN of the consumer account.

bank_code String, optional

The bank code of the consumer's bank.

bic String, optional

The BIC of the consumer's bank.

holder_name String, optional

The account holder's name.

transfer_type Enum, optional

Indicates if the account can be used for a transaction or not.

NONE - It is not possible to use the account for transfers.
DOMESTIC - The account can only be used for domestic transfers.
FULL - The account is fully usable.
REFERENCE - The account can only be used for transfers to one specific account.
RESTRICTED - The account might be under protection from execution or something similar. Transfers are possible, but with restricted functionality (e.g. limited transfer amount).

account_type Enum, optional

Indicates the type of the account.

DEFAULT - A regular account.
SAVING - A savings account.
CREDITCARD - A credit card account.
DEPOT - A depot for broking or similar.

holder_address ProvidedTransactionAddressData, optional

The account holder's address, for details see here.

balance Amount, optional

The account balance which is saved for the provided account with the date provided in the data_refresh_at parameter.

available Amount, optional

The available amount which is saved for the provided account with the date provided in the data_refresh_at parameter.

limit Amount, optional

The limit as amount which is saved for the provided account with the date provided in the data_refresh_at parameter.

reserved Amount, optional

The accounts reserved amount which is saved for the provided account with the date provided in the data_refresh_at parameter.

ProvidedTransactionAddressData

{
    "country": ?string
}

country String, optional

The country code in the ISO 3166-1 alpha-2 format, e.g. DE, GB, SE.

ProvidedTransaction

{
    "insights_transaction_id": ?string,
    "reference": ?string,
    "date": ?Date,
    "amount" : ?Amount,
    "booking_date": ?Date,
    "value_date": ?Date,
    "counter_party": ?ProvidedTransactionCounterPartyAccount
}

transaction_id String, optional

The ID for this transaction, any string with less than 128 characters can be used to identify the transaction. Needed for delete, replace or update calls.

reference String, optional

The reference for the transaction.

date Date (String: "YYYY-MM-DD"), optional

The date on which the transaction was booked or the value date if it is a pending transaction.

amount Amount, optional

The amount of the transaction.

booking_date Date (String: "YYYY-MM-DD"), optional

The booking date of the transaction: the date when the transfer was booked.

value_date Date (String: "YYYY-MM-DD"), optional

The value date of the transaction: when funds transferred to an account become available for immediate use.

counter_party ProvidedTransactionCounterPartyAccount, optional

The account info of the other party involved in the transaction.

ProvidedTransactionCounterPartyAccount

{
    "account_number": ?string,
    "iban": ?string,
    "bank_code": ?string,
    "bic": ?string,
    "holder_name": ?string,
    "holder_address" : ?ProvidedTransactionAddressData
}