Use cases
Codes provide a simple transfer mechanism without requiring the recipient’s deposit address.- Internal transfers — Move funds between accounts without withdrawal fees
- Partner payouts — Distribute funds to multiple recipients by generating codes programmatically
- Promotions and rewards — Create codes as promotional vouchers; optionally protect with a passphrase
Code lifecycle
The code lifecycle has two phases: creation and application.1
Create a code
Send a
POST request to /api/v4/main-account/codes with ticker (e.g., ETH), amount (string, up to 18 decimal places), optional passphrase (max 25 characters, latin letters + numbers + symbols, no whitespace), and optional description (max 280 characters, visible only to the creator). The amount is debited from the Main balance. The response returns a code string (format: WB{uuid}{TICKER}, e.g., WBe11f4fce-2a53-4edc-b195-66b693bd77e3ETH) and an external_id.2
Share the code
Transmit the code string to the intended recipient. If a passphrase was set, share the passphrase separately.
3
Apply the code
The recipient calls
POST /api/v4/main-account/codes/apply with the code string and passphrase (if set). Funds are credited to the recipient’s Main balance. A code.apply webhook event fires on the creator’s account.API endpoints
WhiteBIT Codes uses 4 authenticated endpoints. All operate on the Main balance.Create parameters
Code example
Create a code for 0.002 ETH with a passphrase, then apply the code on a different account.- cURL
- Python
Error codes
Create endpoint error codes:For apply errors, the most common is “Incorrect code or passphrase” — verify the code string and passphrase are correct.
Regional restrictions
What’s next
Webhook Events
Receive real-time notifications when codes are applied.
Convert
Instantly convert between currencies at a quoted rate.