v1

latestOpenAPI 3.0.32026-07-23215362.6 KB
Transactions

Request withdrawal.

Initiate a withdrawal.

post/v1/withdrawals

Headers

X-Request-Idstring

A unique 'Reference Number' for each incoming withdrawal request. Any retries will retain the same x-request-Id value.

Request body

accountIdstring uuid required
currencystring required
quantitystring required

The quantity to withdraw

clientMemostring nullable

Optional memo or note for the withdrawal

Response

Successful response

transactionType'DEPOSIT' | 'WITHDRAWAL' | 'TRANSFER' required
transactionStatus'FAILED' | 'PROCESSING' | 'CONFIRMING' | 'COMPLETED'
withdrawalIdstring uuid required
customerIdstring uuid required
accountIdstring uuid required
withdrawalCurrencystring required
netWithdrawalQuantitystring required
withdrawalFeeType'FIXED' | 'VARIABLE' | 'LIVE' required
withdrawalFeeRatestring required
withdrawalFeeQuantitystring required
withdrawalFeeCurrencystring required
memostring nullable
txHashstring nullable
clientMemostring nullable
grossWithdrawalQuantitystring required
requestedAtstring date-time required
completedAtstring date-time nullable