Skip to main content
POST
Preview a stablecoin withdrawal

What this endpoint does

Calculates the effective withdrawal fee, total source debit, current eligibility, and any hold reason for a saved destination without creating an operation.

When to use it

Call it after the user chooses the active destination and amount, then show the returned terms on the final review screen before confirmation.

Before you call

Use a secret API key with treasury:write. The saved destination must belong to this tenant account and match an enabled asset and network.

Money and balance effect

Previewing does not reserve, debit, or send stablecoin. The create request rechecks the balance, destination, screening, limits, and provider capacity before reserving funds.

States and completion

canProceed reports current static eligibility. A holdReason identifies a current block or review path; only a later accepted create response records a durable reservation.

Safe retries

Send a unique Idempotency-Key for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out. Read Conversions and withdrawals for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Headers

Idempotency-Key
string
required

A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.

Required string length: 8 - 255

Body

application/json
asset
enum<string>
required
Available options:
USDC,
USDT
network
enum<string>
required
Available options:
ethereum,
base,
arbitrum,
optimism,
polygon,
bsc,
avalanche,
solana,
tron
amount
string
required
Pattern: ^\d+(\.\d+)?$
destinationId
string
required
Minimum string length: 1
externalReference
string
required
Minimum string length: 1

Response

200 - application/json
principal
object
required
fee
object
required
sourceDebit
object
required
asset
enum<string>
required
Available options:
AUD,
USDC,
USDT
configurationId
string
required
Minimum string length: 1
canProceed
boolean
required
network
enum<string>
Available options:
ethereum,
base,
arbitrum,
optimism,
polygon,
bsc,
avalanche,
solana,
tron
holdReason
string
Minimum string length: 1