The Storage Transaction Object in Detail

{
    "insights_transaction_id": ?String,
    "reference": ?String,
    "bank_references": ? {
        "unstructured": ?String,
        "structured": ?String,
        "end_to_end": ?String
    },
    "amount" : ?Amount,
    "booking_date": ?Date,
    "value_date": ?Date,
    "state": ?Enum<'PROCESSED', 'PENDING', 'CANCELED', 'FAILED'>,
    "type": ?Enum<'CREDIT', 'DEBIT'>,
    "method": ?Enum<'TRANSFER', 'DIRECT_DEBIT', 'INSTANT', 'UNKNOWN'>,
    "bank_transaction_code": ? {
        "code": ?String,
        "sub_code": ?String,
        "description": ?String
    },
    "counter_party": ?{
        "iban": ?String,
        "account_number": ?String,
        "bic": ?String,
        "bank_code": ?String,
        "holder_name": ?String,
        "holder_address": ?{
            "country": ?String
        }
    }
}

insights_transaction_id String, optional

The identifier for this transaction that is a string of up to 128 characters.

Endpoint specific infos:

  • create-transactions: If this value is not provided it will be generated.
  • update/replace-transactions: This value is required to identify the transaction that should be updated/replaced.

reference String, optional

The reference of the transaction.

bank_references Object, optional

Some banks offer a subset of the transactions reference in different fields. Those fields are given in the BankReference object.

bank_references.unstructured String, optional

The unstructured reference that was really returned from the bank without any modifications.

bank_references.structured String, optional

Part of the reference as delivered by bank.

bank_references.end_to_end String, optional

This value can be used for reconciliation and transaction matching.

amount Amount, optional

The amount of the transaction. If this property is not set the default is XXX (as defined in ISO 4217).

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

The date on which the transaction was booked.

If this property and the value_date is not set it will be set to today.

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

The date on which the transaction was valued by the bank (usually in accounting).

If this property and the booking_date is not set it will be set to today.

state Enum, optional

The state of the transaction. If this property is not set the default is PROCESSED.

  • PROCESSED - The transaction was processed
  • PENDING - The transaction is still pending and not yet processed
  • CANCELED - The transactions was canceled
  • FAILED - The transaction was not processed

type Enum, optional

The type of this transacton.

  • DEBIT - Funds were withdrawn from the account
  • CREDIT - Funds were applied to the account

Must be set if an amount is set.

method Enum, optional

The type property indicates which transaction method was used.

Possible values are:

  • TRANSFER - A DEBIT transaction that was initiated by the consumer
  • DIRECT_DEBIT - A DEBIT transaction
  • INSTANT - An INSTANT transaction
  • UNKNOWN - A transaction that could not be classified

bank_transaction_code Object, optional

The Bank Transaction Code as provided by the bank. This information allows the customer to correctly report a transaction, which will help to - for example - perform reconciliation operations.

The values of this object are not normalized and the meaning and format could differ per PSD2-framework or even per bank. For more information, visit the related PSD2-API documentation of the specific banks. Some banks (e.g. Berlin-Group PSD2) follow the ISO-20022 Standard.

bank_transaction_code.code String, optional

Specifies the business area of the underlying transaction. There is no guarantee that the code-field follows the ISO-20022 Standard.

bank_transaction_code.sub_code String, optional

Specifies the sub-product family within a specific family. There is no guarantee that the sub_code-field follows the ISO-20022 Standard.

bank_transaction_code.description String, optional

A textual description of the bank_transaction_code.

counter_party Object, optional

The other party involved in the transaction. Can be empty for some transactions.

counter_party.iban String, optional

The IBAN of the counter party account.

counter_party.account_number String, optional

The account number of the counter party account.

counter_party.bic String, optional

The BIC of the counter party account.

counter_party.bank_code String, optional

The bank code of the counter party account.

counter_party.holder_name String, optional

The name of the counter party account holder.

counter_party.holder_address.country String, optional

The country of the counter party account holder.

results matching ""

    No results matching ""