Skip to main content
POST
Withdraw Funds

Authorizations

API-Key
string
header
required

The "API-Key" header should contain your API key.

API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

asset
string
required

Asset being withdrawn

key
string
required

Withdrawal key name, as set up on your account

amount
string
required

Amount to be withdrawn

aclass
enum<string>
default:currency

Specify the asset class of the asset being withdrawn

Available options:
currency,
tokenized_asset
address
string

Optional, crypto address that can be used to confirm address matches key (will return Invalid withdrawal address error if different)

max_fee
string

Optional, if the processed withdrawal fee is higher than max_fee, withdrawal will fail with EFunding:Max fee exceeded

rebase_multiplier
enum<string> | null
default:rebased

Optional parameter for viewing xstocks data.

  • rebased: Display in terms of underlying equity.
  • base: Display in terms of SPV tokens.
Available options:
rebased,
base

Response

200 - application/json

Withdrawal created.

result
object
error
string[]

Kraken API error