Withdrawal to Whitelist
Sweeps funds from a deposit wallet to your pre-configured whitelist address.
Operates independently of regular withdrawal settings and limits.
Requirements
The following conditions must be met:
- The deposit wallet must have a
clientIdassigned. Wallets without aclientIdare not eligible for this flow. - A whitelist address must be configured for the corresponding asset + network combination.
Settings
| Setting | Description |
|---|---|
| Withdrawal to whitelist | Enables the whitelist sweep flow |
| Auto-delegation | Enables automatic energy/bandwidth rental for TRON withdrawals |
| Tronegy API key | Your Tronegy API key. If not provided, the system key is used |
How It Works
The merchant initiates the flow manually. Once triggered, the system:
- Creates a withdrawal to the configured whitelist address
- Approves the withdrawal
- Submits the transaction to the blockchain
- Waits for confirmation — status becomes
COMPLETE
If network resources are insufficient, the system resolves them automatically (see below) and retries within ~1 minute.
transferAll Parameter
When creating a withdrawal via API, pass:
{
"transferAll": true
}
This sweeps the entire balance from the sender address, ignoring the amount field.
The actual transferred amount is recorded in the withdrawal after execution.
Example Request
Request Body (JSON):
{
"amount": "0",
"asset": {
"short": "USDT",
"network": "tron"
},
"addressFrom": "TNLskNQzcmZ4P6peKx1f9tuf6xbv6FzT3y",
"addressTo": "TX2HAFUc32wTBJ5nTySF9wZMmK6gC7v8ot",
"clientId": "testClientID4",
"transferAll": true
}
When
transferAll: trueis set, theamountfield is ignored — the system will sweep the entire balance fromaddressFrom. You can pass any value or omit it.
TRON: Automatic Resource Rental
TRON token transfers (e.g. USDT) require energy and bandwidth.
The system automatically rents these resources via Tronegy, so no manual setup is required.
Energy
| Scenario | Energy rented |
|---|---|
| First withdrawal to this whitelist address | 135,000 |
| Subsequent withdrawals | 65,000 |
| Rental duration | 1 hour |
After the first successful withdrawal, the address is marked active, reducing energy requirements for future withdrawals.
Bandwidth
When required, the system rents:
- 1,000 bandwidth units for 1 hour
Bandwidth is rented only if required for the transaction.
Approximate Cost per Withdrawal
| Scenario | Approximate cost |
|---|---|
| Active address | ~5–7 TRX |
| New address | ~10–12 TRX |
TRON Account Activation
If a deposit address has never received TRX, it must be activated before a transfer can be sent.
The system automatically:
- Sends 0.01 TRX to activate the address
- Proceeds with the withdrawal
No manual action is required.
Gas for Other Networks
For token withdrawals on networks such as Ethereum, BSC, and similar networks:
- If the deposit address lacks gas, the system automatically covers the deficit from your fee wallet.
For native coin withdrawals (ETH, BNB, SOL, etc.):
- If the balance is insufficient to cover the transaction fee, the withdrawal is cancelled, because the fee must be paid from the same balance.
Withdrawal Statuses
| Status | Description |
|---|---|
OPEN | Created, pending approval |
APPROVED | Approved, pending execution |
COMPLETE | Confirmed on blockchain |
CANCELLED | Failed — see status comment for reason |