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
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 |
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.