HEhel
Withdrawals

Get a Withdrawal Transaction

Returns a single withdrawal transaction by ID for the authenticated merchant account. Requires an API key with the WITHDRAWS_READ permission.

get/v1/withdrawal-transactions/{id}/api-key

Request

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

Path parameters

idstring required

Withdrawal detail ID.

Query parameters

apiKeystring required

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

Response

Withdrawal transaction 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