Skip to main content
POST
Quote withdrawable amount

Integration guide

Authorizations

x-app-id
string
header
required

Your application ID. Required on app-tier and user-tier routes. Omitted on routes that authenticate with x-app-api-key only.

Authorization
string
header
required

JWT access token from POST /auth/verify. Required with x-app-id on user routes. On the smart-route quote it is optional and turns a preview into an executable quote.

Body

application/json
tokenSymbol
enum<string>
required

Stable-coin symbol the withdrawal is denominated in.

Available options:
USDC,
USDC.e,
USDT
destinationChainId
integer
required

Chain ID where the recipient would receive funds.

Required range: x >= 1
signingAddress
string

Self-custody: quote the Max of this linked EVM wallet (the amount it can debit). Omit for managed custody.

Required string length: 42
approveMode
enum<string>

Self-custody only (ignored without signingAddress): what the signing wallet can sign. Send the same value to the quote, preview and withdraw. sponsored (default): the wallet can sign an EIP-7702 authorization and Calibur batch, so every source is available. user_broadcast: it cannot (e.g. MetaMask). The withdrawal still never asks it to send a transaction or hold gas; sources that would need a batch (an approve, a same-chain swap, or a same-chain transfer of anything but native Circle USDC; decided by token) are left out of Max, preview and selection. A same-chain native USDC transfer is then two EIP-3009 signatures (amount less the network fee, and the fee).

Available options:
sponsored,
user_broadcast

Response

200

tokenSymbol
enum<string>
required

Stable-coin symbol the withdrawal is denominated in.

Available options:
USDC,
USDC.e,
USDT
destinationChainId
integer
required

Echo of the request.

Required range: x >= 1
maxDeliverableRaw
string
required

Most the user can receive on the destination, after estimated fees and excluding balances too small to move. Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).

Pattern: ^[0-9]+$
rawBalanceRaw
string
required

Total eligible balance before those deductions. Integer string in the destination token's atomic units (6 decimals, so 1000000 = 1 USDC; 18 decimals on BNB Chain).

Pattern: ^[0-9]+$
decimals
integer
required

Decimals of the destination token; scales the *Raw fields.

Required range: 0 <= x <= 36