Skip to main content
GET
Get withdrawal

Overview

Returns one merchant withdrawal record for the authenticated merchant. Use this endpoint when you already have a withdrawal ID and need its latest state, timestamps, or transaction references.
The older GET /v1/withdrawals/{id} route still exists. This merchant-prefixed route is an alias added for consistency with POST /v1/merchant/withdrawals.

Authentication

X-Api-Key
string
required
Your merchant API key

Path Parameters

id
string
required
Withdrawal ID in UUID format.Example: 550e8400-e29b-41d4-a716-446655440000

Request Examples

Response

id
string
Unique withdrawal identifier.
amount_usd
string
Withdrawal amount in USD.
fee_usd
string
Fee charged for the withdrawal, in USD.
token
string
Token sent on-chain.
chain
string
Destination chain.
destination_address
string
Recipient on-chain address.
status
string
Current withdrawal status.Common values: PENDING, SUBMITTED, SETTLED, FAILED
provider_tx_id
string
Provider-side transfer identifier, when available.
tx_hash
string
On-chain transaction hash, when available.
failure_code
string
Failure code for unsuccessful withdrawals.
failure_message
string
Human-readable failure detail for unsuccessful withdrawals.
created_at
string
Time the withdrawal was created.
submitted_at
string
Time the withdrawal was submitted to the provider.
settled_at
string
Time the withdrawal was settled.
updated_at
string
Last update time for the withdrawal.

Success Response

Error Responses

This endpoint may return:
  • 400: Invalid withdrawal ID format
  • 401: Unauthorized
  • 404: Withdrawal not found
  • 500: Internal server error

Next Steps

List Withdrawals

Browse recent withdrawals and paginate through history

Create Withdrawal

Initiate another merchant balance withdrawal