Withdrawals

Prepare a Withdrawal

Quotes a withdrawal and returns a lane-specific payload for the holder to sign. No authentication required (rate-limited). sourceCurrencyId is required.

post/v1/withdraw/{withdrawalConfigId}/prepare

Path parameters

withdrawalConfigIdstring required

The withdrawal config ID.

Request body

ownerAddressstring required

Holder's source wallet address. Format is lane-specific (e.g. Solana base58 for Solana raw, EVM checksummed address for EVM raw/hyperliquid).

recipientstring required

Destination address on any supported chain.

amountstring required

Amount in atomic units as a decimal-free string (e.g. 1500000 for 1.5 USDC).

toCurrencyIdstring required

Destination currency Mongo ID.

sourceCurrencyIdstring required

Source currency Mongo ID from the withdrawal config.

customerIdstring

Optional merchant identifier for the end user (max 255 characters). Persisted on prepare and echoed on the withdrawal detail and webhooks. Not applied on re-quote.

Response

Withdrawal prepared successfully.

withdrawalDetailIdstring

Per-request ID. Use for submit and status polling.

tokenstring

JWT quote token. Pass verbatim on submit.

Changes

No recorded changes to this endpoint across all 1 revision of this API.