Wallet Consolidation
The Wallets Consolidation API allows merchants to consolidate funds from multiple permanent addresses into a wallet balance of the same currency.
Withdrawing from permanent addresses requires consolidating individual address balances into a wallet balance. This consolidation process incurs specific fees:
- Activation Fee: A one-time fee applied per address upon its initial consolidation.
- Transfer Fee: A per-address fee applied to each consolidation transaction.
Automatic Consolidation
This method leverages the spend request endpoint to initiate both a withdrawal and the required address consolidation automatically.
By providing only the wallet and desired amount, the user delegates address selection to the CoinPayments system. The platform algorithmically determines the most efficient combination of addresses to consolidate, considering the withdrawal amount, address balances, and activation statuses to optimize the transaction.
This approach streamlines withdrawals, especially when specific address preservation (i.e. permanent address strategic funds) is not a requirement.
Manual Consolidation
This method grants merchants direct control over address selection for consolidation using specific endpoints designed for either single- or multi-wallet consolidation tasks.
- POST /merchant/wallets/:id/consolidation/:to to consolidate select addresses within a single source wallet.
- POST /merchant/wallets/consolidation/:id to consolidate select addresses from multiple same-currency wallets into a target wallet.
This approach offers granular control over address consolidation, but requires additional effort for identification and input.
Auto-Sweep via Dashboard
Auto-Sweeping, which can be used for any wallet type, can also be configured on the dashboard under Wallets > Expand Target Currency:
Auto-Sweep automatically withdraws your selected wallet to the address you specify once the balance reaches the trigger amount.
