Skip to main content
POST
Create withdrawal fee quote

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
string
header
required

Path Parameters

vault_id
string
required

Vault identifier the withdrawal would be debited from, a V-prefixed 14-char base32 string with a final check character.

Example:

"VABCDEF234567A"

Body

application/json
asset
string
required

Asset code to be withdrawn (e.g. BTC, ETH, USD). Determines the asset the fee tiers are denominated in.

Example:

"BTC"

asset_class
string
required

Asset class of the withdrawn asset. Currently only currency is supported.

Example:

"currency"

amount
string
required

Withdrawal amount as a fixed-precision decimal string. Must be positive.

Example:

"0.5"

fee_included
boolean

Whether the fee should be deducted from amount (true) or charged on top (false). Defaults to false when omitted.

Example:

false

address_name
string

Optional name of a previously whitelisted destination address. When supplied, the quote is scoped to that address; some networks vary the fee by destination.

Example:

"My BTC Wallet"

Response

Fee quote generated successfully. The returned fee_quote_id can be passed as fee_quote_id on a request_withdrawal instruction to POST /v0/insto/custody/tasks to submit the withdrawal with one of the listed fee tiers.

fee_quote_id
string
required

Identifier of the generated fee quote. Pass this value as fee_quote_id when submitting the matching withdrawal. A Q-prefixed 14-char base32 string.

Example:

"QABCDEF234567A"

asset
string
required

Asset code the quote was generated for. Mirrors the asset supplied in the request.

Example:

"BTC"

asset_class
string
required

Asset class of the quoted asset. Currently always currency.

Example:

"currency"

fees
object[]
required

Available fee tiers for the quoted withdrawal. Each entry is a self-contained option the caller can pick when submitting the withdrawal.