Create a Crypto Withdrawal Request

post

https://apex-crypto/api/v2/transfers/withdraw/coin

This endpoint initiates a withdrawal from the investor's positions to a wallet on the blockchain. This action requires users to request a fee estimate first.

Body Params

Information required to complete the withdrawal

account

string

required

Bakkt client account identifier

clientTransactionId

uuid

required

length ≤ 64

Client-specified unique identifier

currency

string

required

Coin in which to withdraw; must match the estimated coin

feeEstimateId

uuid

required

The estimate provided for this withdrawal; this fee estimate must be recent and cannot be expired

network

string

enum

quantity

string

required

Quantity of coin in which to withdraw; must match the estimated quantity

receivingWallet

string

required

Address of the wallet in which to deposit

recipientFamilyName

string

Family name of the recipient of the withdrawal

recipientGivenName

string

Given name of the recipient of the withdrawal

requestEstimateExtension

boolean

Using this flag allows clients to request an extension to the expiry time of the fee estimate

selfHosted

boolean

Using this flag allows clients to indicate that they are the owner of the receiving wallet

tag

string

Tag Details tied to withdrawal. Only applicable for Tag/Memo based Assets.

vaspDid

string

Decentralized identifier of the receiving VASP when it has been registered

vaspName

string

Name of the VASP that owns the receiving wallet when the VASP has not been registered

vaspWebsite

string

Website of the VASP that owns the receiving wallet when the VASP has not been registered

Responses

Language

Credentials

Header

Response

Choose an example:

application/json

200This response returns the result of the withdrawal attempt.

400This response returns if the request to submit the withdrawal request is improperly submitted.

defaultThis response returns if the system encounters an unexpected error while handling this request.