Retrieve the Withdrawal Status

get https://apex-crypto/api/v2/transfers/withdraw/coin/{clientTransactionId}

Use this action to proactively request the status of a previously submitted withdrawal request. Bakkt provides this service as a convenience to ask about specific withdrawals. Since Crypto systems must confirm withdrawals on the blockchain, the request always has a network-dependent time lag from the moment a user submits a withdrawal on chain until the transfer completes. While client systems may use this service to ask for the latest update for a given transfer, Bakkt encourages clients to rely on the transfer websockets mechanism to receive timely updates to transfers as they post to Bakkt systems and move through the blockchain.

Responses

Response body

object

blockchainHash

string

Blockchain hash for this transaction, if the transaction has already been written to the blockchain

createdAt

date-time

required

Time at which a withdrawal was submitted

fee

string

Fee for the withdrawal in coin that is taken out of the investor's account on top of the requested withdrawal quantity

string

required

Bakkt Transaction ID

network

string

Arbitrum Bitcoin Bitcoin_Cash Celo Dogecoin Ethereum Ethereum_Classic Litecoin Polygon Ronin Solana Tron

rejectReason

string

DEPRECATED, please use statusReason. Reason for a reject, if any

request

object

required

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

Blockchain Network associated to currency tied to withdraw request.

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.

vaspName

string

Name of the VASP that owns the receiving wallet

status

string

required

PENDING IN_PROGRESS COMPLETE REJECTED CANCELLED ACCEPTED

statusReason

string

reason for the current status of the withdrawal

totalQuantity

string

The total amount of coin to move out of the investor account to make the requested coin transfer happen (i.e., equals quantity plus fee)

usdEquivalentFee

string

Fee for the withdrawal in USD

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apex-crypto/api/v2/transfers/withdraw/coin/clientTransactionId \
3
     --header 'accept: application/json'

Choose an example:

application/json

200This response provides the withdrawal status.

404This response returns if the system can not complete this request, because it can not find the withdrawal.

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