Skip to main content
Each address you issue can consolidate its balance into your master wallet on the same chain automatically, once it crosses a floor you choose. This endpoint reads and sets that floor, per chain and per token. The network itself also has its own on/off switch, set from Dashboard → Wallets → Settings → Auto-sweep. This endpoint’s auto_sweep field reports the two combined: whichever is more restrictive wins. Turning the network switch off pauses sweeping on that chain no matter what you set here.

Endpoint

GET needs the wallets:read scope. PATCH needs wallets:write.

Reading your configuration

One entry per token, for every chain with an active master wallet on your account.
boolean
required
Whether this chain and token will actually sweep: chain_auto_sweep AND auto_sweep_configured both true.
boolean
required
What you’ve set for this token, on its own.
boolean
required
The network-level switch from your dashboard. Read-only here — change it from Dashboard → Wallets → Settings.
number
The floor you set, in the token’s units. null if you haven’t set one, in which case default_min applies.
number
required
The floor that actually applies: your configured_min, or default_min if you haven’t set one, never below minimum_allowed.
number
required
Applied when you haven’t configured a floor. Cents-level on Base and the other low-fee chains; higher on Ethereum, where moving small amounts can cost more than they’re worth.
number
required
The lowest floor you’re allowed to set on this chain. A PATCH asking for less than this is clamped up to it, not rejected.

Changing your configuration

string
required
The chain to configure. Needs an active master wallet on that chain already.
string
required
USDC or USDT.
number
The floor, in the token’s units. Below minimum_allowed for the chain, it’s raised to that instead of being refused. Omit to leave your current setting as it is.
boolean
Turn sweeping for this token on or off. Omit to leave your current setting as it is. At least one of min_amount or auto_sweep is required.
Returns the same shape as one entry above, under sweep_config.

Errors