Transaction Models

These models are returned by the get all transactions and get an account transactions endpoints.

TransactionData

  {
    "account_id": "c18a42df-6652-d462-351b-0485a6d6bc16",
    "additional_transaction_information": "EURGBP 0.876804 - other",
    "amount": {
        "amount": "100.00",
        "currency": "EUR"
    },
    "balance": {
        "amount": {
            "amount": "50212.85",
            "currency": "EUR"
        },
        "credit_debit_indicator": "Credit",
        "type": "InterimAvailable",
    },
    "booking_datetime": "2019-11-11T20:37:30.598",
    "client_id": "EBPCLI285330",
    "credit_debit_indicator": "Credit",
        "creditor_account": {
        "account_name": "EBURY OFFICE ACC CHF",
        "account_number": "",
        "bank_identifier": "",
        "bank_identifier_code": "",
        "iban": "GB78BARC12345678901234",
        "swift": ""
    },
    "creditor_name": "Jorge Chapa",
    "debtor_account": {
        "account_name": "Cool Account",
        "account_number": "1234567890",
        "bank_identifier": "123456",
        "bank_identifier_code": "",
        "iban": "",
        "swift": "RACZHUH1123"
    },
    "debtor_name": "Jorge Corp",
    "status": "Booked",
    "transaction_id": "3ae5b450-1e1a-b116-1fde-3cb4f0353e16",
    "transaction_information": "Bought EUR EBPOTR002772",
    "transaction_reference": "EBPOTR002772",
    "transaction_type": "credit",
    "value_datetime": "2019-11-11T20:37:30.598"
  }

This model is a representation of a single transaction for an account within Ebury. Fields

string

The UUID of the account

string

Additional information for the transaction

object

The Amount of the transaction

object

The Balance of the transaction

string

Date and time (UTC) when the transaction was booked

string

Identifier of the client

string

One of CreditDebitIndicator

object

The Bank Account information of the creditor

string

Name of the creditor

object

The Bank Account information of the debtor

string

Name of the debtor

string

One of TransactionStatus

string

The UUID of the transaction

string

Basic information for the transaction

string

Reference for the transaction

string

The TransactionType of the transaction

string

Comma separated list of trade ids

string

Value date and time (UTC) of the transaction

TransactionBalance

{
    "amount": {
        "amount": "50212.85",
        "currency": "EUR"
    },
    "credit_debit_indicator": "Credit",
    "type": "InterimAvailable"
}

This model is a representation of the balance of the account (rounded to the currency decimal places) when the transaction happens. Fields

object

The Amount of the transaction

string

One of CreditDebitIndicator

string

Type of the balance. One of BalanceType

TransactionStatus

This is an enumeration of the transaction status types Values

Value	Description
`Booked`	Booked

TransactionType

This is an enumeration of the transaction types Values

Value	Description
`credit`	Record of any activity that generates a positive(credit) transaction on the account.
`debit`	Record of any activity that generates a negative(debit) transaction on the account (debit from the customer account).
`incoming`	Record of the incoming funds from an external source (credit into customer account from third parties, other clients, client’s own accounts at other banks etc.,). incoming as a type exclusively covers a subset of transactions which are originally of the type credit.
`margin`	Record of the deposits, refunds related to forward trades.
`payment_returned`	Record created when funds can’t be credited to the beneficiary and the counterparty returned the funds to the customer.
`trade`	Record of any trade operation (credit and debit)

CreditorDebtorAccount

{
    "account_name": "Cool Account",
    "account_number": "1234567890",
    "bank_identifier": "123456",
    "bank_identifier_code": "",
    "iban": "",
    "swift": "RACZHUH1123"
}

This model is a representation of the bank account information for the creditor/debtor of a transaction Fields

string

The name of the account’s owner

string

Account number

string

Account bank identifier

string

Account bank identifier code (UK sort code, US ABA/FedWire, etc.)

string

Account IBAN

string

Account SWIFT code

​TransactionData

​TransactionBalance

​TransactionStatus

​TransactionType

​CreditorDebtorAccount

TransactionData

TransactionBalance

TransactionStatus

TransactionType

CreditorDebtorAccount