Transactions

A unique identifier automatically generated by the system for each transaction. This is used to track and reference a specific transaction.

The account number associated with this transaction.

The currency of the transaction (e.g., 'USDT', 'USDC', 'BTC').

Specifies the type of transaction performed, e.g., 'WITHDRAWAL_INITIATED', 'DEPOSIT_CONFIRMED'.

The current state of the transaction: 'PENDING' for in-progress, 'SETTLED' for completed transactions.

The transaction amount in the smallest unit of the currency. Negative values indicate debits.

The total fee charged for the transaction in the smallest unit.

A unique reference string (system or custom-generated) used for idempotency and reliable transaction lookups.

A unique key used to ensure the transaction is not duplicated on retry.

Identifier for an associated trade, if applicable.

Additional transaction details including hold_type, order_id, side, channel, chain, addresses, and other contextual information.

The exact timestamp (ISO 8601 format) when the transaction was first recorded in the system.

The most recent timestamp (ISO 8601 format) when the transaction details were updated.

The date when the transaction value is effective (YYYY-MM-DD format).

Human-readable formatted amount with currency symbol (e.g., '-10.0 USDT').

Human-readable formatted fee with currency symbol (e.g., '1.2 USDT').

Indicates the direction of funds — 'Credit' for incoming, 'Debit' for outgoing.

You can pass either the system-generated id (UUID) or your own provided reference to retrieve the transaction. Useful for tracking or verifying transactions.

A unique identifier used to fetch the transaction details. This can either be the system-generated UUID or a custom reference string provided during transaction creation. It helps ensure idempotency and traceability of transactions.

Specifies the current page number to retrieve in paginated results. Defaults to 1 if not provided. Useful for navigating through large datasets.

Defines how many transaction records to return per page. Default is 20. Helps optimize response size and manage pagination efficiently.

Filter results by a specific transaction reference. Allows precise lookups of transactions using an external or internal identifier.

Filter results by a blockchain transaction hash (TXID). Useful for locating onchain transactions quickly by their unique identifier.

Filter by transaction action type, such as 'send', 'receive', 'fund_wallet', or 'withdraw'. Enables viewing only specific types of operations.

Filter by transaction channel like 'onchain', 'lightning', or 'internal'. Helps narrow results to specific transfer technologies.

Transaction flow direction: 'credit' means incoming funds, 'debit' means outgoing funds. Filters results based on how funds moved.

Filter by transaction status, such as 'pending', 'completed', or 'failed'. Useful for viewing only successful or failed transactions.

Specify the currency to filter results, such as 'USD', 'BTC', 'USDT'. Helps isolate transactions in a specific asset or denomination.

Filter transactions by a specific linked bank account. Useful when viewing fiat-related deposits or withdrawals tied to a given account.

A unique identifier for a previously registered user in your system. It could be an email address or user id.

Filter results to show only transactions associated with a particular wallet ID. Useful for wallet-based reporting and analysis.

Filter by blockchain address involved in the transaction. Helps trace activity from or to a specific public key.