HEhel
Withdrawals

List Withdrawal Transactions

Changed on

Returns withdrawal transactions for the authenticated merchant account. Requires an API key with the WITHDRAWS_READ permission. Supports pagination and filtering by state, chains, date range, and withdrawal config.

get/v1/withdrawal-transactions/api-key

Request

  • Base URL
    https://api.hel.io
  • URL
    https://api.hel.io/v1/withdrawal-transactions/api-key
  • Auth
    HTTP bearer

Query parameters

apiKeystring required

Your API key, which can be generated from the Helio Dashboard settings page.

pagenumber

Page number (1-based).

limitnumber

Page size. Defaults to 20, maximum 100.

lastItemIdstring

Cursor for pagination. Returns items with _id less than this value.

searchstring

Search by withdrawal detail ID, destination wallet (prefix), source token, or destination token.

sortstring

Sort field. Defaults to createdAt.

order'asc' | 'desc'

Sort order. Defaults to desc.

startDatestring

ISO 8601 start of createdAt range (inclusive).

endDatestring

ISO 8601 end of createdAt range (inclusive).

stateWithdrawalState[]

Filter by one or more withdrawal states.

sourceChainstring

Filter by source chain symbol (e.g. SOL, ETH).

destinationChainstring

Filter by destination chain symbol.

withdrawalConfigIdstring

Filter by withdrawal config ID.

Response

Withdrawal transactions retrieved successfully.

withdrawalDetailIdstring

Withdrawal detail ID.

state'QUOTED' | 'SUBMITTING' | 'SUBMITTED' | 'BRIDGING' | 'COMPLETED' | 'FAILED' | 'FAILED_EXPIRED' | 'EXPIRED' | 'REFUNDED_BY_PROVIDER'
sourceChainstring

Source chain symbol.

sourceTokenstring

Source token symbol.

sourceAmountstring

Source amount in atomic units.

destinationChainstring

Destination chain symbol.

destinationTokenstring

Destination token symbol.

destinationAmountstring

Destination amount in atomic units.

destinationWalletAddressstring

Destination wallet address.

txHashstring nullable

Most recent transaction hash associated with the withdrawal.

broadcastAck'acknowledged' | 'unacknowledged' | 'rejected' nullable

acknowledged = confirmed; unacknowledged = sent, keep polling; rejected = terminal failure.

errorReasonstring nullable

Human-readable error when the withdrawal failed.

customerIdstring nullable

Merchant-defined customer identifier set at prepare time, or null when omitted.

createdAtstring date-time
updatedAtstring date-time

Changes