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.Create a code
Send a
POST request to /api/v4/main-account/codes with ticker (e.g., ETH), amount (string, max 8 decimals), optional passphrase (max 25 characters, latin letters + numbers + symbols, no whitespace), and optional description (max 75 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.Share the code
Transmit the code string to the intended recipient. If a passphrase was set, share the passphrase separately.
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.| Endpoint | Purpose | Rate limit |
|---|---|---|
POST /api/v4/main-account/codes | Create a new code | 1,000 req / 10 sec |
POST /api/v4/main-account/codes/apply | Apply (redeem) a code | 60 req / 1 sec |
POST /api/v4/main-account/codes/my | List codes created by the account | 1,000 req / 10 sec |
POST /api/v4/main-account/codes/history | Full code history (created + applied) | 1,000 req / 10 sec |
Create parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | string | Yes | Currency ticker (e.g., ETH, BTC) |
amount | string | Yes | Amount to encapsulate. Max precision: 8 decimals. Must be greater than 0 and less than or equal to the Main balance. |
passphrase | string | No | Optional protection. Latin letters, numbers, symbols only. Max 25 characters. No whitespace. |
description | string | No | Internal note visible only to the creator. Max 75 characters. |
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:| Code | Description |
|---|---|
| 0 | Fiat currencies available on the front-end only |
| 1 | Currency is not withdrawable |
| 3 | Amount is too small |
| 5 | Not enough balance |
| 6 | Amount is less than or equal to fee |
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.