Auto Settlements API - Blockradar

The Auto Settlements API lets you define rules that automatically convert incoming assets and route them to a destination wallet. Use this to eliminate manual treasury operations and ensure funds are always held in your preferred asset.

What you can do

Enable or disable auto-settlement on a wallet or address
Create, update, and delete settlement rules
Define conversion targets, destination wallets, and trigger thresholds per rule
Pick a settlement flow per rule: withdraw, swap, gateway, or earn
Scope a master-wallet rule to specific child addresses instead of all of them
Copy a set of rules onto other master wallets in one call

Settlement types

Every rule resolves to one of four flows. Set it explicitly with type; rules saved before this field existed keep their inferred behavior.

Type	What the rule does
`withdraw`	Transfers the source asset out as-is to `destination.address` on the same blockchain
`swap`	Converts to a different asset and/or a different blockchain
`gateway`	Deposits USDC into Circle’s Gateway unified balance (`isGateway: true`)
`earn`	Deposits into an Earn position with Fija or Aave (`isReward: true`, mainnet only)

Endpoints

Method	Endpoint	Description
`GET`	`/wallets/{walletId}/auto-settlements`	Get auto-settlement config (master wallet)
`PATCH`	`/wallets/{walletId}/auto-settlements`	Update auto-settlement config
`GET`	`/wallets/{walletId}/auto-settlements/rules`	List all rules
`GET`	`/wallets/{walletId}/auto-settlements/rules/{ruleId}`	Get a single rule
`POST`	`/wallets/{walletId}/auto-settlements/rules`	Create a rule
`POST`	`/wallets/{walletId}/auto-settlements/rules/copy`	Copy rules onto other master wallets
`PATCH`	`/wallets/{walletId}/auto-settlements/rules/{ruleId}`	Update a rule
`DELETE`	`/wallets/{walletId}/auto-settlements/rules/{ruleId}`	Delete a rule
`GET`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements`	Get config (child address)
`PATCH`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements`	Update config (child address)
`GET`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules`	List rules (child address)
`POST`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules`	Create rule (child address)
`PATCH`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{ruleId}`	Update rule (child address)
`DELETE`	`/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{ruleId}`	Delete rule (child address)

Full API Reference

View all auto-settlement endpoints in the API Reference tab.