The Transaction Object in Detail

{
    "transaction_id": string,
    "reference": ?string,
    "amount": Amount,
    "counter_party": ?Account,
    "date": string,
    "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,
    },
}

transaction_id String, optional

A unique identifier for the transaction across sessions. The id could differ between direct access and PSD2 sessions. The transaction_id is optional for PENDING transactions, because a consistent id can only be guaranteed after the transaction is finally processed by the banking system. For any other state the id is always present.

transaction_id

reference String, optional

The reference for the transaction.

amount Amount, always present

The unsigned amount of the transaction.

counter_party Account, optional

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

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

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

state Enum, always present

The state of the transaction.

Possible values are:

  • 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, always present

The type property indicates whether funds were withdrawn (DEBIT) or applied (CREDIT) to the account.

Possible values are:

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

method Enum, always present

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.

Example

{
    "transaction_id": "r29ndc7gqflfcgdnvpala41njf6c8j7s",
    "reference": "Flight 123",
    "amount": {
        "amount": 12345,
        "currency": "EUR"
    },
    "counter_party": {
        "id": "123e4567-e89b-12d3-a456-426655440000",
        "alias": "Girokonto",
        "account_number": "123456789",
        "iban": "DE44500105175407324931",
        "holder_name": "Max Mustermann",
        "holder_address": {
            "street_address": "Konrad-Adenauer-Straße 21",
            "street_address2": "Backside of the House, Floor 2",
            "postalcode": "35440",
            "city": "Linden",
            "region": "Hesse",
            "country": "DE"
        },
        "bank_code": "51091700",
        "bic": "VRBUDE51XXX",
        "bank_name": "VR Bank Untertaunus eG",
        "bank_address": {
            "street_address": "Konrad-Adenauer-Straße 21",
            "street_address2": "Backside of the House, Floor 2",
            "postalcode": "35440",
            "city": "Linden",
            "region": "Hesse",
            "country": "DE"
        },
        "transfer_type": "NONE",
        "account_type": "DEFAULT"
    },
    "date": "2018-10-23",
    "state": "PROCESSED",
    "type": "DEBIT",
    "method": "TRANSFER",
    "bank_transaction_code": {
        "code": "CCRD",
        "sub_code": "CreditCardPayment",
        "description": "Transaction is related to a payment of credit card."
    }
}

results matching ""

    No results matching ""