Transfer between balances
The endpoint transfers the specified amount between main, trade and collateral balances.
Rate limit: 1000 requests/10 sec.
The API does not cache the response.
Also, fiat currencies can’t be transferred without KYC verification.
The request takes no idempotency key, and two identical requests move the funds twice. A 201 response means
WhiteBIT accepted the transfer: the funds move after the response, and the response carries no transfer
identifier. After a timeout or a 5xx response, the transfer can still complete, so check
Get transfer history for a record whose from_balance,
to_balance, currency and amount match the request, created after the failed request was sent. A transfer
between the spot and collateral balances appears as two records, spot → main and main → collateral. A matching
record means the transfer completed. A failed transfer leaves no record, and no record can also mean the transfer
is still queued, so repeat the check and do not resend automatically. A transfer that never shows is a manual
check.
The caller cannot attach its own reference to a transfer, so the match is ambiguous when two identical transfers are sent close together. An integration that transfers per purchase stores its own record of each transfer before the call, and treats an ambiguous match as a manual check, not an automatic resend.
Used in these guides
- Payment Integration — crypto deposits, withdrawals, conversion, WhiteBIT Codes, and Express Withdraw.
Authorizations
Body
Currency's ticker. Example: BTC
"XLM"
Amount to transfer. Max precision = 8, value must be greater than zero and less than or equal to the available balance.
"0.9"
Transfer method.
⚠️ We highly recommend to use from and to fields, which provides more flexibility. This way will be deprecated in future.
Example: deposit to transfer from main to trade / withdraw to transfer from trade balance to main. For collateral balances use collateral-deposit to transfer from main to collateral and collateral-withdraw to transfer from collateral to main
Not required if from and to are set.
deposit, withdraw, collateral-deposit, collateral-withdraw "deposit"
Balance FROM which funds will move to. Acceptable values: main, spot, collateral
Not required if method is set.
main, spot, collateral "main"
Balance TO which funds will move to. Acceptable values: main, spot, collateral
Not required if method is set.
main, spot, collateral "spot"
Response
Transfer accepted. The body is an empty JSON array, []. The funds move after the response, and the response carries no transfer identifier.
Was this page helpful?