What’s available
How it works
1
Have somewhere to send the funds
A trusted destination that reads
ACTIVE, or the ID of another account in your organization.2
Create the withdrawal
POST /v4/accounts/{accountId}/withdrawals with a list of items, each naming the asset, the quantity, and where it goes. The 202 response carries a result per item.3
Track it to completion
Each withdrawal starts
PENDING and ends COMPLETE, CANCELED, or FAILED. Poll GET /v4/accounts/{accountId}/withdrawals/{withdrawalId}, or watch for the matching WITHDRAWAL entry in transactions. Webhooks are coming soon.Withdrawal status
Once a withdrawal is processed it carries a
transactionId, the ID of the matching WITHDRAWAL transaction. Use it to reconcile against balances and transactions.
Integration steps
Step 1: Create withdrawals
POST /v4/accounts/{accountId}/withdrawals
The body is a list. Each item:
202 means the batch was accepted. An item that failed comes back as status: ERROR with the reason in error, while the other items may still have succeeded. Only treat the id of a SUCCESS item as a created withdrawal.
Timed out? Retry with the same
Idempotency-Key. You get the original result back instead of a second withdrawal.Step 2: Get a withdrawal
GET /v4/accounts/{accountId}/withdrawals/{withdrawalId}
Step 3: List withdrawals
GET /v4/accounts/{accountId}/withdrawals lists an account’s withdrawals, most recent first. Filter with status, assetType, or quantity. Page with limit and after.
Step 4: Cancel a withdrawal
POST /v4/accounts/{accountId}/withdrawals/{withdrawalId}/cancel
Only a PENDING withdrawal can be canceled. Anything else returns 409 Conflict. The 202 response returns the withdrawal. Poll it until status reads CANCELED.