Transactions

The Transactions API allows you to initiate transfers, query transaction history, retrieve specific transactions, look up bank details by IBAN, and download account statements.

circle-exclamation

Get transactions by Account

get
/api/v1/transactions

Retrieves a paginated list of transactions for a specified account within a date range.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters
account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
date_fromstring · date-timeRequired

Start date for the filter period (YYYY-MM-DD).

Example: 2025-04-01
date_tostring · date-timeRequired

End date for the filter period (YYYY-MM-DD).

Example: 2025-04-27
per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15
pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1
directionstring · enumOptional

Sort direction for the transaction list.

Default: descPossible values:
sortstring · enumOptional

Field to sort the transaction list by.

Default: created_atPossible values:
Responses
chevron-right
200

A paginated list of transactions matching the criteria.

application/json
get
/api/v1/transactions

Create a new transaction

post
/api/v1/transactions

Create a new transaction

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters
account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Header parameters
X-Request-IDstring · uuidOptional

A unique identifier for the request. This header can be used for tracking and idempotency control, ensuring the same request is not processed multiple times.

Body

Data required to initiate a new transaction.

account_uuidstring · uuidRequired

The UUID of the source account for the transaction.

Example: d8f7b4a0-6e3c-4b5a-8d1e-2f7c9a8b4e1f
amountnumber · floatRequired

The monetary amount of the transaction. Must be greater than 0 and have a maximum of two decimal places.

Example: 199.99
payment_detailsstring · max: 140 · nullableOptional

Unstructured payment details or remittance information. Mandatory via validation rules if 'payment_code' is not provided.

Example: Payment for invoice #ABC-123
payment_codestring · max: 35 · nullableOptional

Structured payment code (e.g., Purpose Code). Mandatory via validation rules if 'payment_details' is not provided.

Example: RENT
end_to_end_identstring · max: 35 · nullableOptional

Optional End-to-End payment identifier for tracking.

Example: E2E-REF-001
payment_typestring · enum · nullableOptional

Indicates the type of payment. If not specified, SEPA will be selected by default. Accepted values: swift, sepa.

Example: SEPAPossible values:
Responses
post
/api/v1/transactions
circle-info

Important: API error responses during transaction creation reflect only the technical outcome of a request and do not represent the final business state of a payment. The authoritative and final payment status is delivered through the webhook events and should be treated as the source of truth.

More information about webhook event statuses can be found here: Transaction Event | Documentationarrow-up-right

More information about error handling can be found here: Error Handling | Documentation

Get specific transaction by UUID

get
/api/v1/transactions/{uuid}

Retrieves the details of a specific transaction by its UUID, scoped to an account.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters
uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Query parameters
account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
Responses
chevron-right
200

Successful retrieval of the transaction details.

application/json
get
/api/v1/transactions/{uuid}

Get bank details by IBAN

get
/api/v1/transactions/iban-details

Retrieves bank details (like BIC, bank name) based on a provided IBAN.

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters
ibanstringRequired

The International Bank Account Number (IBAN) to look up.

Example: LT89370400440532014200
Responses
chevron-right
200

Successfully retrieved IBAN details.

application/json
get
/api/v1/transactions/iban-details

Download account statement

get
/api/v1/transactions/statements

Downloads an account statement for the specified period in the requested format. Supported formats:

  • CSV

  • XML

  • PDF

  • XLSX

Authorizations
AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters
account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$
date_fromstring · dateRequired

Start date for the statement period (YYYY-MM-DD).

Example: 2025-04-01
date_tostring · dateRequired

End date for the statement period (YYYY-MM-DD).

Example: 2025-04-27
formatstring · enumRequired

The desired file format for the statement.

Default: XLSXPossible values:
balance_typestring · enumOptional

Determines how account statement balances are calculated — either using only settled transactions (balance) or including pending ones (available_balance, legacy option).

Default: available_balancePossible values:
Responses
chevron-right
200

Successful download of the statement file in the requested format.

Responsestring · binary

PDF Statement File

get
/api/v1/transactions/statements
triangle-exclamation

Last updated

Was this helpful?