Skip to main content
GET
Get withdrawal info

Authorizations

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

Path Parameters

vault_id
string
required

Vault identifier, a V-prefixed 14-char base32 string with a final check character.

Example:

"VABCDEF234567A"

Query Parameters

asset
string
required

Asset code to look up withdrawal methods for (e.g. BTC, USD). Required because this endpoint resolves the funding details for a single asset; the list-methods endpoint instead treats asset as an optional filter. Must be supplied together with asset_class.

Example:

"BTC"

asset_class
string
required

Asset class for the supplied asset. Currently currency is the only supported value.

Example:

"currency"

Response

Withdrawal methods and limits available for the requested asset in the vault.

method_id
string

Funding method identifier (matches method_id on the deposit-info contract).

Example:

"11111111-1111-1111-1111-111111111111"

type
string

Withdrawal method type code.

Example:

"crypto"

type_name
string

Human-readable withdrawal method type name.

Example:

"Crypto"

asset
string

Asset code (e.g. BTC, USD).

Example:

"BTC"

asset_class
string

Asset class. Currently always currency.

Example:

"currency"

name
string

Internal funding method name.

Example:

"Bitcoin"

name_display
string

Display name shown to end users.

Example:

"Bitcoin"

fee_amount
string

Withdrawal fee amount, fixed-precision decimal as string.

Example:

"0.00010000"

fee_asset
string

Asset code the fee is charged in.

Example:

"BTC"

fee_asset_class
string

Asset class of the fee asset.

Example:

"currency"

fee_percentage
string

Percentage-based fee component, when applicable.

Example:

"0.00"

min_amount
string

Minimum withdrawal amount, fixed-precision decimal as string.

Example:

"0.00100000"

max_amount
string

Maximum withdrawal amount, fixed-precision decimal as string.

Example:

"100.00000000"

sort_weight
integer<int32>

Relative sort order for display.

Example:

1

validate
object

Address validation rules for this method, when available.

Example:
validate_meta
object

Supplemental validation metadata for this method, when available.

Example:
temp_disabled_public
boolean

Whether this method is temporarily disabled for public use.

Example:

false

needs_activation
boolean

Whether the method requires activation before use.

Example:

false

beneficiary
object

Beneficiary confirmation requirements for this method, when applicable.

needs_deposit
boolean

Whether a prior deposit is required before withdrawals are allowed.

Example:

false

deposited
boolean

Whether the activation deposit has already been made. Paired with needs_deposit.

Example:

0

test
boolean

Whether this method is a test-only entry.

Example:

false

withdrawal_network_info
object

Network metadata for the underlying chain, when available.

rates
object[]

Indicative exchange rates quoted against other assets.