Skip to main content
POST
Preview a withdrawal

Authorizations

x-app-id
string
header
required

Your application ID. Required for all app-tier and user-tier routes.

Authorization
string
header
required

JWT access token returned by POST /auth/verify. Required for user-tier routes.

Body

application/json
amountRaw
string
required

Amount to withdraw, as a positive integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain). Minimum is one whole token. Fees are deducted from this amount.

Pattern: ^[1-9][0-9]*$
tokenSymbol
enum<string>
required

Stable-coin symbol the withdrawal is denominated in.

Available options:
USDC,
USDC.e,
USDT
destinationAddress
string
required

Recipient address. EVM destinations: 0x-prefixed 20-byte hex. Solana: base58 (32–44 chars).

Pattern: ^(0x[a-fA-F0-9]{40}|[1-9A-HJ-NP-Za-km-z]{32,44})$
destinationChainId
integer
required

Chain ID where the recipient address should receive funds.

Required range: x >= 1
requestId
string<uuid>

Optional idempotency key for an exact-amount transfer. Reuse with the identical body to recover a lost response. Not combined with max.

max
boolean

Cap to the deliverable maximum (withdraw-max intent).

Response

200

receiveAmountRaw
string | null
required

Estimated amount delivered. null when unviable. Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).

feeRaw
string | null
required

Estimated fee, deducted from the withdrawn amount (amount in minus amount delivered). Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).

relayFeeRaw
string | null
required

Bridge provider part of feeRaw; currently equal to it. Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).

networkFeeRaw
string | null
required

Reserved for a separate network fee; currently always null.

pricingStatus
enum<string>
required

quoted: the withdrawal can be routed. unviable: it cannot; see unviableReason.

Available options:
quoted,
unviable
quoteExpiresAt
string | null
required

ISO-8601 time the quote expires (60 seconds after quoting).

unviableReason
string | null
required

Readable reason when unviable: insufficient balance, too small to cover fees, no liquidity, or no safe route.

maxDeliverableRaw
string | null
required

Set only when the request exceeds the balance: the most that can be delivered. Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).