Transactions

Get transactions for all client accounts

Retrieve a list of the client's transactions, optionally filtered by currency and value date and time with pagination support

get/transactions

Request

  • Base URL: https://api.ebury.io
  • URL: https://api.ebury.io/transactions
  • Auth: API key in header x-api-key

Query parameters

currenciesstring

A comma-separated list of currency codes compliant to ISO 4217

client_idstring required

The identifier of a client.

credit_debit_indicator'credit' | 'debit'

Filter transactions by debit/credit type

from_value_datetimestring

Only return transactions with value date and time after this UTC date and time. YYYY-MM-DDThh:mm format

to_value_datetimestring

Only return transactions with value date and time before this UTC date and time. YYYY-MM-DDThh:mm format

pageinteger

The desired page number for pagination

page_sizeinteger

The number of items per page for pagination

transaction_typestring[]

A comma-separated list of transaction types.

trade_idstring

A comma-separated list of trade IDs to filter transactions by. Maximum of 50 IDs.

extended_detailsboolean

Include extended transaction details in the response. When true, the response includes a cashback field with cashback information if cashback is enabled for the client; otherwise this field is null.

languagestring

Language code used to localize the transaction description fields (e.g. transaction_information). Defaults to en if omitted.

Headers

Authorizationstring required

The access token.

X-Contact-IDstring

The identifier of a contact.

Response

A list with the client's transactions.

account_idstring required

The UUID of the account.

additional_transaction_informationstring required

Additional information for the transaction.

booking_datetimestring required

Date and time (UTC) when the transaction was booked

client_idstring required

Identifier of the client.

credit_debit_indicator'Credit' | 'Debit' required

Whether the balance is credit or debit

creditor_namestring

Name of the creditor

debtor_namestring

Name of the debtor

status'Booked' required

This is an enumeration of the types of status for a transaction.

transaction_idstring required

The UUID of the transaction.

transaction_informationstring required

Basic information for the transaction

transaction_referencestring required

Reference for the transaction

transaction_type'credit' | 'debit' | 'incoming' | 'margin' | 'payment_returned' | 'trade' required

Type of the transaction

value_datetimestring required

Value date and time (UTC) of the transaction

additional_informationstring nullable

Additional information about the transaction (only returned when extended_details=true)

conceptstring nullable

Transaction concept (only returned when extended_details=true)

end_referencestring nullable

End-to-end reference (only returned when extended_details=true)

funds_codestring

Funds code indicator (only returned when extended_details=true)

remittance_informationstring nullable

Remittance information (only returned when extended_details=true)

returnedstring nullable

Indicates if the payment was returned (only returned when extended_details=true)

schemastring nullable

Schema information (only returned when extended_details=true)

uetrstring nullable

Unique End-to-End Transaction Reference (only returned when extended_details=true)

Changes

No recorded changes to this operation across all 1 revision of this API.