Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

Use this file to discover all available pages before exploring further.

Collection and Auto Sweep Rules automate the movement and consolidation of funds from wallets into a designated settlement destination based on predefined automation rules. This helps centralize liquidity, simplify treasury operations, and reduce manual treasury management across wallets.
Trigger Condition: Auto-sweep rules are triggered by deposits. Whenever funds are received in eligible wallets, the sweep logic is evaluated based on your configured settings.

​
Default Sweep Destinations

ProductDefault DestinationChannel
Wallet-as-a-ServicePrime WalletOff-chain (no fees)
Smart AccountsSettlement Account WalletOn-chain

​
Smart Accounts

Smart Accounts support wallet-level auto-sweep configuration during wallet creation or through wallet updates.

​
Enable Auto Sweep

{
  "autoSweep": true
}
When autoSweep is enabled, deposited funds are automatically moved to the default settlement destination wallet.

​
Sweep Thresholds

You can also configure sweep thresholds globally per token.
Thresholds determine the minimum balance required before an automatic sweep is triggered across eligible wallets.

​
Wallet-as-a-Service

Wallet-as-a-Service supports automated collection rules configured through the platform automation system. To configure auto collection:
  1. Navigate to: Wallet-as-a-Service → Automation
  2. Create an auto collection rule per coin
  3. Configure source wallets, destination wallet, and collection frequency
Collection rules are applied across supported chains for the selected asset.

​
Supported Frequencies

FrequencyDescription
Real TimeTriggered immediately when deposits are detected in eligible wallets.

Current Limitation

Sweeping funds to external wallets is not currently supported. Auto-sweep destinations must be managed within the OpenXSwitch wallet infrastructure.