Transaction amounts are stored in the token’s smallest unit (e.g., 6 decimals for USDC). The
amount_usd field provides the USD equivalent at the time of the transaction.The Transaction object
string
Unique identifier for the transaction (e.g.,
tx_abc123).string
Current status of the transaction. One of:
pending, confirming, completed, failed.string
Transaction amount in the token’s smallest unit.
string
USD equivalent of the transaction amount at the time of payment.
string
Contract address of the received token.
number
Chain ID where the payment was received.
string | null
On-chain transaction hash. Null while
pending.string
Wallet address of the payer.
string
Wallet address that received the payment.
string | null
Associated customer ID, if the payer is a known customer.
string | null
Payment link that originated this transaction.
string | null
Checkout session that originated this transaction.
number | null
If the payer paid from a different chain, this is the chain they paid from.
string | null
If the payer paid with a different token, this is the token they paid with.
string | null
The amount the payer sent (before swap/bridge), in the source token’s smallest unit.
string | null
Platform fee amount in the received token’s smallest unit.
object | null
Custom form data submitted by the customer during checkout.
object | null
Shipping address provided by the customer.
object | null
Selected shipping option.
object | null
Metadata from the checkout session.
string
ISO 8601 timestamp when the transaction was initiated.
string | null
ISO 8601 timestamp when the transaction reached
confirming status.string | null
ISO 8601 timestamp when the transaction reached
completed status.Transaction statuses
List transactions
Retrieve a paginated list of transactions with optional filters.string
Filter by status:
pending, confirming, completed, failed.string
Filter by customer ID.
string
Filter by payment link ID.
string
Filter transactions created on or after this ISO 8601 date (e.g.,
2026-01-01).string
Filter transactions created on or before this ISO 8601 date (e.g.,
2026-02-28).number
default:1
Page number for pagination.
number
default:20
Number of results per page (max 100).
- Response
Retrieve a transaction
string
required
The transaction ID (e.g.,
tx_abc123).- Response
Returns the full Transaction object.
Get transaction stats
Retrieve aggregate statistics across all your transactions.- Response
Export transactions
Export transaction data in CSV or JSON format. The response is streamed as a file download.string
required
Export format. One of:
csv, json.string
Filter by status:
pending, confirming, completed, failed.string
Filter transactions created on or after this ISO 8601 date.
string
Filter transactions created on or before this ISO 8601 date.
Exports are limited to 50,000 records. For larger datasets, use date range filters to break exports into smaller chunks.
- CSV Response
- JSON Response
HypeDuel