Transactions
Initiates a transfer using either an internal account or an external blockchain address.
Get All Transactions
Use Case
This endpoint retrieves a paginated list of transactions, with support for filtering via query parameters. It is commonly used to list transaction histories, audit flows, or search for specific transactions across various dimensions.
Transaction Response
This is the standard shape of a transaction returned by the API.
A unique identifier automatically generated by the system for each transaction. This ID is used for tracking, referencing, and retrieving specific transactions across the platform.
The exact timestamp (ISO 8601 format) indicating when the transaction was first recorded in the system. Useful for chronological sorting and audit logs.
The most recent timestamp (ISO 8601) when the transaction details were modified. Typically updated when the transaction status changes (e.g., from pending to success).
A custom or system-generated identifier used to ensure idempotency. It helps prevent duplicate submissions and allows for reliable transaction lookups.
The blockchain transaction hash (TXID), which can be used to verify or trace the transaction on a blockchain explorer. Only available for on-chain transactions.
A free-text field that allows users to add notes or context to the transaction, such as 'payout to contractor' or 'wallet funding'.
The symbol or code of the currency used in the transaction. For example, 'BTC' for Bitcoin, 'ETH' for Ethereum, or 'USDT' for Tether.
The full transaction amount in standard units (e.g., 0.08 ETH). This is the human-readable value shown in most UI elements.
The total fee charged for the transaction, represented in standard units. This includes network fees and any platform service charges.
The transaction amount represented in the smallest possible unit of the currency (e.g., 80000000 wei for 0.08 ETH). This format avoids floating-point errors in computations.
The transaction fee expressed in the currency’s smallest denomination (e.g., 1000000 wei for 0.001 ETH). Essential for accurate financial records.
The recipient or destination address involved in the transaction. In blockchain transactions, this is the wallet or contract address funds were sent to.
Indicates the type of transaction operation performed, such as 'send_btc', 'receive_eth', 'topup_wallet', etc. This helps in categorizing and filtering transaction types.
Defines the direction of the transaction: `debit` for outgoing funds and `credit` for incoming funds. Useful for balance calculation and reporting.
The current state of the transaction. Common values include 'pending', 'success', 'failed'. Status helps determine transaction completeness and processing stage.
The channel or method through which the transaction was processed. Examples include 'wallet', 'onchain', 'manual', or 'card'. Used for system routing and display.
Specifies the blockchain network used for the transaction. Examples include 'bitcoin', 'ethereum', 'polygon'. Essential for validating on-chain transactions.
The unique identifier of the company or business entity associated with this transaction. Used to segregate data between clients or environments.
Transaction Sample Request with Query Parameters
Use the query parameters to filter and paginate through the list of transactions. This request retrieves the first page (page=1) with a limit of 10 transactions (limit=10) and filters for only successful credit transactions.
Transaction Sample Response
Get Transaction By ID Or Reference
Use Case
Retrieve a single transaction using its UUID or reference.
You can pass either the system-generated id (UUID) or your own provided reference to retrieve the transaction. Useful for tracking or verifying transactions.
Path Parameters
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.
Get Transaction Sample Request By ID Or Reference
Returns a single | TransactionResponse.
Get Transaction By ID Sample Response
Query Parameters
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.