Skip to main content
POST
Quote withdrawable amount

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
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

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