This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.
Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become "0", useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes "0", and source.maxAmount becomes "-1". Read the rule first, change the fields you need, and send the whole object back.
inheritance is ignored here — it only applies to master-wallet rules.
Request Body Parameters
Parameter
Type
Required
Description
type
string
No
The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule’s current behavior.
name
string
No
The name of the auto-settlement rule. A descriptive title reflecting its purpose.
isActive
boolean
No
Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted.
order
string
No
Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted.
slippageTolerance
string
No
The acceptable slippage tolerance (as a percentage). Example: "5" = 5% tolerance; "-1" for unlimited. Resets to "0" when omitted.
isGateway
boolean
No
Route the settlement through Circle’s Gateway. Must be true when the rule’s type is gateway.
isReward
boolean
No
Settle into an Earn position. Must be true when the rule’s type is earn. Mainnet only, and cannot be combined with isGateway.
rewardProvider
string
Conditional
Required whenever isReward is true. One of aave or compound.
rewardType
string
No
Strategy class (defi). Optional — defaults from the resolved product.
useTransactionAmount
boolean
No
false settles the address’s current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted.
deductionPercentage
string
No
Percentage withheld from the settled amount before execution, e.g. "2.5". Resets to "0" when omitted.
source
object
Yes
Details about the source of the settlement.
├─ assets
array of strings
Yes
List of asset symbols this rule settles (e.g., ["USDT"]).
├─ minAmount
string
No
The minimum amount required for settlement (e.g., "1"). Resets to "0" when omitted.
├─ maxAmount
string
No
The maximum amount that can be settled (e.g., "1000"). Resets to "-1" when omitted.
├─ blockchain
string
No
The blockchain network used for the settlement.
destination
object
Yes
Details about the destination of the settlement.
├─ asset
string
Yes
The asset the settlement is directed to.
├─ address
string
Conditional
The address the settlement is sent to. Required once the rule’s type is withdraw.
├─ blockchain
string
Yes
The blockchain network for the destination. Must equal the source blockchain once the rule’s type is withdraw.
Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Blockradar","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/blockradar/fWg7SGpNBqmitg8P/logo/light.png?fit=max\u0026auto=format\u0026n=fWg7SGpNBqmitg8P\u0026q=85\u0026s=32dafe22efea13faac14c1c4af5f9fa3","dark":"https://mintcdn.com/blockradar/fWg7SGpNBqmitg8P/logo/dark.png?fit=max\u0026auto=format\u0026n=fWg7SGpNBqmitg8P\u0026q=85\u0026s=d5283823d1dbc70ba0a71321c6790d3f"},"favicon":"https://mintcdn.com/blockradar/pWmNem5D_2FL-GuR/favicon.svg?fit=max\u0026auto=format\u0026n=pWmNem5D_2FL-GuR\u0026q=85\u0026s=541d691d2a4884397ad3b6f9c46c3156","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.blockradar.co"}},"footer":{"socials":{"x":"https://x.com/BlockradarHQ","github":"https://github.com/blockradar","linkedin":"https://www.linkedin.com/company/blockradar"}},"integrations":{"clarity":{"projectId":"w916yxac3p"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","href":"en/introduction/why-blockradar"},{"language":"es","href":"es/introduction/why-blockradar"},{"language":"pt","href":"pt/introduction/why-blockradar"},{"language":"fr","href":"fr/introduction/why-blockradar"},{"language":"zh","href":"zh/introduction/why-blockradar"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blockradar","hasAudioNarration":false,"actualSubdomain":"blockradar","customDomains":["docs.blockradar.co"],"gitSource":{"type":"github","owner":"blockradar","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad8cb0f59ed261dd46f1268","collectionId":"e3e660f1-ab4d-4841-b3b4-619d038336c3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad8cb0f59ed261dd46f1268"},"entitlements":{},"buildId":"6adb54fb767ad18566b5639a","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"es","tag":"API","count":188},{"language":"fr","tag":"Référence API","count":188},{"language":"pt","tag":"API","count":188},{"language":"zh","tag":"API 参考","count":188},{"language":"default","tag":"API 参考","count":169},{"language":"en","tag":"API","count":167},{"language":"en","tag":"Docs","count":62},{"language":"es","tag":"Documentación","count":60},{"language":"fr","tag":"Documentation","count":60},{"language":"pt","tag":"Documentação","count":60},{"language":"zh","tag":"文档","count":60},{"language":"en","tag":"Get Started","count":34},{"language":"es","tag":"Comenzar","count":33},{"language":"fr","tag":"Démarrage","count":33},{"language":"pt","tag":"Começar","count":33},{"language":"zh","tag":"开始使用","count":33},{"language":"es","tag":"Virtual Accounts","count":27},{"language":"fr","tag":"Virtual Accounts","count":27},{"language":"pt","tag":"Virtual Accounts","count":27},{"language":"zh","tag":"Virtual Accounts","count":27},{"language":"en","tag":"v2","count":25},{"language":"es","tag":"v2","count":25},{"language":"fr","tag":"v2","count":25},{"language":"pt","tag":"v2","count":25},{"language":"zh","tag":"v2","count":25},{"language":"en","tag":"API Overview","count":21},{"language":"es","tag":"v1","count":21},{"language":"fr","tag":"v1","count":21},{"language":"pt","tag":"v1","count":21},{"language":"zh","tag":"v1","count":21},{"language":"default","tag":"API","count":21},{"language":"default","tag":"v1","count":21},{"language":"es","tag":"API Overview","count":20},{"language":"fr","tag":"API Overview","count":20},{"language":"pt","tag":"API Overview","count":20},{"language":"zh","tag":"API Overview","count":20},{"language":"es","tag":"Withdraw Fiat","count":19},{"language":"fr","tag":"Withdraw Fiat","count":19},{"language":"pt","tag":"Withdraw Fiat","count":19},{"language":"zh","tag":"Withdraw Fiat","count":19},{"language":"en","tag":"Auto Settlements","count":15},{"language":"en","tag":"Virtual Accounts","count":15},{"language":"es","tag":"Auto Settlements","count":15},{"language":"fr","tag":"Auto Settlements","count":15},{"language":"pt","tag":"Auto Settlements","count":15},{"language":"zh","tag":"Auto Settlements","count":15},{"language":"default","tag":"Auto Settlements","count":15},{"language":"default","tag":"Virtual Accounts V2","count":15},{"language":"en","tag":"Deposit Fiat","count":14},{"language":"es","tag":"Deposit Fiat","count":14},{"language":"fr","tag":"Deposit Fiat","count":14},{"language":"pt","tag":"Deposit Fiat","count":14},{"language":"zh","tag":"Deposit Fiat","count":14},{"language":"default","tag":"Deposit Fiat","count":14},{"language":"en","tag":"Gateway","count":13},{"language":"default","tag":"Gateway","count":13},{"language":"en","tag":"Wallets","count":12},{"language":"default","tag":"Virtual Accounts","count":12},{"language":"default","tag":"Addresses","count":11},{"language":"default","tag":"Rewards","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#sidebar li[data-title]>button[aria-label^=Toggle]{align-items:center}#sidebar li[data-title]>button[aria-label^=Toggle]>svg:last-child{margin-left:auto}table td,table th{word-break:normal;overflow-wrap:normal;hyphens:none}table th{white-space:nowrap}"}],"page":{"pagePath":"en/api-reference/auto-settlements/child-address-update-rule","slug":"/en/api-reference/auto-settlements/child-address-update-rule","pageMetadata":{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Update Rule","description":"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.\n\n**Send the complete rule, not just the fields you are changing.** Unlike the master-wallet update, this endpoint validates the body as a whole rule: `source` and `destination` are mandatory, and any optional field you leave out is reset to its default rather than kept — `order` becomes `RECOMMENDED`, `slippageTolerance` and `deductionPercentage` become `\"0\"`, `useTransactionAmount` becomes `false`, `isActive` becomes `true`, `source.minAmount` becomes `\"0\"`, and `source.maxAmount` becomes `\"-1\"`. Read the rule first, change the fields you need, and send the whole object back.\n\n`inheritance` is ignored here — it only applies to master-wallet rules.\n\n## Request Body Parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| type | string | No | The settlement rule type: `withdraw`, `swap`, `gateway`, or `earn`. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule's current behavior. |\n| name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. |\n| isActive | boolean | No | Indicates whether the rule is currently active. `true` = enabled, `false` = disabled. Resets to `true` when omitted. |\n| order | string | No | Routing preference for the swap leg. Possible values: `FASTEST`, `CHEAPEST`, `RECOMMENDED`, `NO_SLIPPAGE`. Resets to `RECOMMENDED` when omitted. |\n| slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: `\"5\"` = 5% tolerance; `\"-1\"` for unlimited. Resets to `\"0\"` when omitted. |\n| isGateway | boolean | No | Route the settlement through Circle's Gateway. Must be `true` when the rule's `type` is `gateway`. |\n| isReward | boolean | No | Settle into an Earn position. Must be `true` when the rule's `type` is `earn`. Mainnet only, and cannot be combined with `isGateway`. |\n| rewardProvider | string | Conditional | Required whenever `isReward` is `true`. One of `aave` or `compound`. |\n| rewardType | string | No | Strategy class (`defi`). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. |\n| useTransactionAmount | boolean | No | `false` settles the address's current balance of the source asset; `true` settles only the triggering deposit amount. Resets to `false` when omitted. |\n| deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. `\"2.5\"`. Resets to `\"0\"` when omitted. |\n| source | object | Yes | Details about the source of the settlement. |\n| ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., `[\"USDT\"]`). |\n| ├─ minAmount | string | No | The minimum amount required for settlement (e.g., `\"1\"`). Resets to `\"0\"` when omitted. |\n| ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., `\"1000\"`). Resets to `\"-1\"` when omitted. |\n| ├─ blockchain | string | No | The blockchain network used for the settlement. |\n| destination | object | Yes | Details about the destination of the settlement. |\n| ├─ asset | string | Yes | The asset the settlement is directed to. |\n| ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule's type is `withdraw`. |\n| ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule's type is `withdraw`. |\n","href":"/en/api-reference/auto-settlements/child-address-update-rule"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n p: \"p\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Send the complete rule, not just the fields you are changing.\"\n }), \" Unlike the master-wallet update, this endpoint validates the body as a whole rule: \", _jsx(_components.code, {\n children: \"source\"\n }), \" and \", _jsx(_components.code, {\n children: \"destination\"\n }), \" are mandatory, and any optional field you leave out is reset to its default rather than kept — \", _jsx(_components.code, {\n children: \"order\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"RECOMMENDED\"\n }), \", \", _jsx(_components.code, {\n children: \"slippageTolerance\"\n }), \" and \", _jsx(_components.code, {\n children: \"deductionPercentage\"\n }), \" become \", _jsx(_components.code, {\n children: \"\\\"0\\\"\"\n }), \", \", _jsx(_components.code, {\n children: \"useTransactionAmount\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"false\"\n }), \", \", _jsx(_components.code, {\n children: \"isActive\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"true\"\n }), \", \", _jsx(_components.code, {\n children: \"source.minAmount\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"\\\"0\\\"\"\n }), \", and \", _jsx(_components.code, {\n children: \"source.maxAmount\"\n }), \" becomes \", _jsx(_components.code, {\n children: \"\\\"-1\\\"\"\n }), \". Read the rule first, change the fields you need, and send the whole object back.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"inheritance\"\n }), \" is ignored here — it only applies to master-wallet rules.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Request Body Parameters\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Parameter\"\n }), _jsx(_components.th, {\n children: \"Type\"\n }), _jsx(_components.th, {\n children: \"Required\"\n }), _jsx(_components.th, {\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"type\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"The settlement rule type: \", _jsx(_components.code, {\n children: \"withdraw\"\n }), \", \", _jsx(_components.code, {\n children: \"swap\"\n }), \", \", _jsx(_components.code, {\n children: \"gateway\"\n }), \", or \", _jsx(_components.code, {\n children: \"earn\"\n }), \". Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule’s current behavior.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"name\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsx(_components.td, {\n children: \"The name of the auto-settlement rule. A descriptive title reflecting its purpose.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"isActive\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Indicates whether the rule is currently active. \", _jsx(_components.code, {\n children: \"true\"\n }), \" = enabled, \", _jsx(_components.code, {\n children: \"false\"\n }), \" = disabled. Resets to \", _jsx(_components.code, {\n children: \"true\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"order\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Routing preference for the swap leg. Possible values: \", _jsx(_components.code, {\n children: \"FASTEST\"\n }), \", \", _jsx(_components.code, {\n children: \"CHEAPEST\"\n }), \", \", _jsx(_components.code, {\n children: \"RECOMMENDED\"\n }), \", \", _jsx(_components.code, {\n children: \"NO_SLIPPAGE\"\n }), \". Resets to \", _jsx(_components.code, {\n children: \"RECOMMENDED\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"slippageTolerance\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"The acceptable slippage tolerance (as a percentage). Example: \", _jsx(_components.code, {\n children: \"\\\"5\\\"\"\n }), \" = 5% tolerance; \", _jsx(_components.code, {\n children: \"\\\"-1\\\"\"\n }), \" for unlimited. Resets to \", _jsx(_components.code, {\n children: \"\\\"0\\\"\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"isGateway\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Route the settlement through Circle’s Gateway. Must be \", _jsx(_components.code, {\n children: \"true\"\n }), \" when the rule’s \", _jsx(_components.code, {\n children: \"type\"\n }), \" is \", _jsx(_components.code, {\n children: \"gateway\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"isReward\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Settle into an Earn position. Must be \", _jsx(_components.code, {\n children: \"true\"\n }), \" when the rule’s \", _jsx(_components.code, {\n children: \"type\"\n }), \" is \", _jsx(_components.code, {\n children: \"earn\"\n }), \". Mainnet only, and cannot be combined with \", _jsx(_components.code, {\n children: \"isGateway\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"rewardProvider\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Conditional\"\n }), _jsxs(_components.td, {\n children: [\"Required whenever \", _jsx(_components.code, {\n children: \"isReward\"\n }), \" is \", _jsx(_components.code, {\n children: \"true\"\n }), \". One of \", _jsx(_components.code, {\n children: \"aave\"\n }), \" or \", _jsx(_components.code, {\n children: \"compound\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"rewardType\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Strategy class (\", _jsx(_components.code, {\n children: \"defi\"\n }), \"). Optional — defaults from the resolved product.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"useTransactionAmount\"\n }), _jsx(_components.td, {\n children: \"boolean\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [_jsx(_components.code, {\n children: \"false\"\n }), \" settles the address’s current balance of the source asset; \", _jsx(_components.code, {\n children: \"true\"\n }), \" settles only the triggering deposit amount. Resets to \", _jsx(_components.code, {\n children: \"false\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"deductionPercentage\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"Percentage withheld from the settled amount before execution, e.g. \", _jsx(_components.code, {\n children: \"\\\"2.5\\\"\"\n }), \". Resets to \", _jsx(_components.code, {\n children: \"\\\"0\\\"\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"source\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n }), _jsx(_components.td, {\n children: \"Details about the source of the settlement.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ assets\"\n }), _jsx(_components.td, {\n children: \"array of strings\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n }), _jsxs(_components.td, {\n children: [\"List of asset symbols this rule settles (e.g., \", _jsx(_components.code, {\n children: \"[\\\"USDT\\\"]\"\n }), \").\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ minAmount\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"The minimum amount required for settlement (e.g., \", _jsx(_components.code, {\n children: \"\\\"1\\\"\"\n }), \"). Resets to \", _jsx(_components.code, {\n children: \"\\\"0\\\"\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ maxAmount\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsxs(_components.td, {\n children: [\"The maximum amount that can be settled (e.g., \", _jsx(_components.code, {\n children: \"\\\"1000\\\"\"\n }), \"). Resets to \", _jsx(_components.code, {\n children: \"\\\"-1\\\"\"\n }), \" when omitted.\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ blockchain\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"No\"\n }), _jsx(_components.td, {\n children: \"The blockchain network used for the settlement.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"destination\"\n }), _jsx(_components.td, {\n children: \"object\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n }), _jsx(_components.td, {\n children: \"Details about the destination of the settlement.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ asset\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n }), _jsx(_components.td, {\n children: \"The asset the settlement is directed to.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ address\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Conditional\"\n }), _jsxs(_components.td, {\n children: [\"The address the settlement is sent to. Required once the rule’s type is \", _jsx(_components.code, {\n children: \"withdraw\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: \"├─ blockchain\"\n }), _jsx(_components.td, {\n children: \"string\"\n }), _jsx(_components.td, {\n children: \"Yes\"\n }), _jsxs(_components.td, {\n children: [\"The blockchain network for the destination. Must equal the source blockchain once the rule’s type is \", _jsx(_components.code, {\n children: \"withdraw\"\n }), \".\"]\n })]\n })]\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Update Rule","description":"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.\n\n**Send the complete rule, not just the fields you are changing.** Unlike the master-wallet update, this endpoint validates the body as a whole rule: `source` and `destination` are mandatory, and any optional field you leave out is reset to its default rather than kept — `order` becomes `RECOMMENDED`, `slippageTolerance` and `deductionPercentage` become `\"0\"`, `useTransactionAmount` becomes `false`, `isActive` becomes `true`, `source.minAmount` becomes `\"0\"`, and `source.maxAmount` becomes `\"-1\"`. Read the rule first, change the fields you need, and send the whole object back.\n\n`inheritance` is ignored here — it only applies to master-wallet rules.\n\n## Request Body Parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| type | string | No | The settlement rule type: `withdraw`, `swap`, `gateway`, or `earn`. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule's current behavior. |\n| name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. |\n| isActive | boolean | No | Indicates whether the rule is currently active. `true` = enabled, `false` = disabled. Resets to `true` when omitted. |\n| order | string | No | Routing preference for the swap leg. Possible values: `FASTEST`, `CHEAPEST`, `RECOMMENDED`, `NO_SLIPPAGE`. Resets to `RECOMMENDED` when omitted. |\n| slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: `\"5\"` = 5% tolerance; `\"-1\"` for unlimited. Resets to `\"0\"` when omitted. |\n| isGateway | boolean | No | Route the settlement through Circle's Gateway. Must be `true` when the rule's `type` is `gateway`. |\n| isReward | boolean | No | Settle into an Earn position. Must be `true` when the rule's `type` is `earn`. Mainnet only, and cannot be combined with `isGateway`. |\n| rewardProvider | string | Conditional | Required whenever `isReward` is `true`. One of `aave` or `compound`. |\n| rewardType | string | No | Strategy class (`defi`). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. |\n| useTransactionAmount | boolean | No | `false` settles the address's current balance of the source asset; `true` settles only the triggering deposit amount. Resets to `false` when omitted. |\n| deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. `\"2.5\"`. Resets to `\"0\"` when omitted. |\n| source | object | Yes | Details about the source of the settlement. |\n| ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., `[\"USDT\"]`). |\n| ├─ minAmount | string | No | The minimum amount required for settlement (e.g., `\"1\"`). Resets to `\"0\"` when omitted. |\n| ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., `\"1000\"`). Resets to `\"-1\"` when omitted. |\n| ├─ blockchain | string | No | The blockchain network used for the settlement. |\n| destination | object | Yes | Details about the destination of the settlement. |\n| ├─ asset | string | Yes | The asset the settlement is directed to. |\n| ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule's type is `withdraw`. |\n| ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule's type is `withdraw`. |\n","href":"/en/api-reference/auto-settlements/child-address-update-rule"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/blockradar/1e452ad7777997b4/scripts/patch-openapi.js"],"openApiReferenceData":{"operation":{"tags":["Auto Settlements"],"summary":"Child Address Update Rule","description":"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.\n\n**Send the complete rule, not just the fields you are changing.** Unlike the master-wallet update, this endpoint validates the body as a whole rule: `source` and `destination` are mandatory, and any optional field you leave out is reset to its default rather than kept — `order` becomes `RECOMMENDED`, `slippageTolerance` and `deductionPercentage` become `\"0\"`, `useTransactionAmount` becomes `false`, `isActive` becomes `true`, `source.minAmount` becomes `\"0\"`, and `source.maxAmount` becomes `\"-1\"`. Read the rule first, change the fields you need, and send the whole object back.\n\n`inheritance` is ignored here — it only applies to master-wallet rules.\n\n## Request Body Parameters\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| type | string | No | The settlement rule type: `withdraw`, `swap`, `gateway`, or `earn`. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule's current behavior. |\n| name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. |\n| isActive | boolean | No | Indicates whether the rule is currently active. `true` = enabled, `false` = disabled. Resets to `true` when omitted. |\n| order | string | No | Routing preference for the swap leg. Possible values: `FASTEST`, `CHEAPEST`, `RECOMMENDED`, `NO_SLIPPAGE`. Resets to `RECOMMENDED` when omitted. |\n| slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: `\"5\"` = 5% tolerance; `\"-1\"` for unlimited. Resets to `\"0\"` when omitted. |\n| isGateway | boolean | No | Route the settlement through Circle's Gateway. Must be `true` when the rule's `type` is `gateway`. |\n| isReward | boolean | No | Settle into an Earn position. Must be `true` when the rule's `type` is `earn`. Mainnet only, and cannot be combined with `isGateway`. |\n| rewardProvider | string | Conditional | Required whenever `isReward` is `true`. One of `aave` or `compound`. |\n| rewardType | string | No | Strategy class (`defi`). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. |\n| useTransactionAmount | boolean | No | `false` settles the address's current balance of the source asset; `true` settles only the triggering deposit amount. Resets to `false` when omitted. |\n| deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. `\"2.5\"`. Resets to `\"0\"` when omitted. |\n| source | object | Yes | Details about the source of the settlement. |\n| ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., `[\"USDT\"]`). |\n| ├─ minAmount | string | No | The minimum amount required for settlement (e.g., `\"1\"`). Resets to `\"0\"` when omitted. |\n| ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., `\"1000\"`). Resets to `\"-1\"` when omitted. |\n| ├─ blockchain | string | No | The blockchain network used for the settlement. |\n| destination | object | Yes | Details about the destination of the settlement. |\n| ├─ asset | string | Yes | The asset the settlement is directed to. |\n| ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule's type is `withdraw`. |\n| ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule's type is `withdraw`. |\n","operationId":"childAddressUpdateRule","requestBody":"d514201e-b8f8-48f2-930e-16952c4a067a","responses":{"200":"11be91b5-a455-40e6-9f13-4a88cc835774"},"method":"patch","type":"path","servers":["5cc11ce8-32a8-469f-a6f3-15596a5cb294"],"security":["d8f3dd9c-8fc6-48ba-8401-20ab29d7120e"],"path":"/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","baseUrlOptions":["https://api.blockradar.co"],"title":"Child Address Update Rule","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6fa9c51d-f27f-448d-86e5-a1f677b8da2b":{"name":"walletId","in":"path","required":true,"schema":{"type":"string","example":"{{walletId}}","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"3c3843f1-3763-400d-b005-7ad6c303d337":{"name":"addressId","in":"path","required":true,"schema":{"type":"string","example":"534e0480-f444-40c0-bc2e-2ef17bf7999e","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"726e1fd1-df43-476d-85ba-a0ab0fe35143":{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"55869cbe-fa3a-44d2-a7e3-d65c08355e4d","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["source","destination"],"properties":{"destination":{"type":"object","required":["blockchain","asset"],"properties":{"asset":{"type":"string","example":"USDC","isRequired":true,"uniqueKey":"destination.asset","typeLabel":"string"},"blockchain":{"type":"string","example":"optimism","isRequired":true,"uniqueKey":"destination.blockchain","typeLabel":"string"},"address":{"type":"string","example":"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22","uniqueKey":"destination.address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"destination","typeLabel":"object"},"source":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"string","example":"USDT","uniqueKey":"source.assets.items.[INDEX]","typeLabel":"string"},"example":["USDT"],"uniqueKey":"source.assets","typeLabel":"string[]"},"blockchain":{"type":"string","example":"base","uniqueKey":"source.blockchain","typeLabel":"string"},"maxAmount":{"type":"string","example":"1000","uniqueKey":"source.maxAmount","typeLabel":"string"},"minAmount":{"type":"string","example":"1","uniqueKey":"source.minAmount","typeLabel":"string"}},"isRequired":true,"uniqueKey":"source","typeLabel":"object"},"productKey":{"type":"string","description":"Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset.","uniqueKey":"productKey","typeLabel":"string"},"type":{"type":"string","enum":["withdraw","swap","gateway","earn"],"description":"Settlement rule type. Sending it on an update migrates a legacy rule onto the explicit type system; omit it to keep the rule's current behavior.","example":"swap","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"isActive":{"type":"boolean","description":"Resets to true when omitted.","example":true,"uniqueKey":"isActive","typeLabel":"boolean"},"isGateway":{"type":"boolean","description":"Must be true when the rule's type is gateway.","example":false,"uniqueKey":"isGateway","typeLabel":"boolean"},"isReward":{"type":"boolean","description":"Must be true when the rule's type is earn. Mainnet only, and cannot be combined with isGateway.","example":false,"uniqueKey":"isReward","typeLabel":"boolean"},"rewardProvider":{"type":"string","enum":["aave","compound"],"description":"Required whenever isReward is true.","example":"aave","uniqueKey":"rewardProvider","typeLabel":"enum\u003cstring>"},"rewardType":{"type":"string","enum":["defi"],"description":"Only defi is currently offered.","example":"defi","uniqueKey":"rewardType","typeLabel":"enum\u003cstring>"},"useTransactionAmount":{"type":"boolean","description":"false settles the address's current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted.","example":false,"uniqueKey":"useTransactionAmount","typeLabel":"boolean"},"deductionPercentage":{"type":"string","description":"Percentage withheld from the settled amount before execution. Resets to \"0\" when omitted.","example":"0","uniqueKey":"deductionPercentage","typeLabel":"string"},"name":{"type":"string","example":"Swap from USDT to OP USDC","uniqueKey":"name","typeLabel":"string"},"order":{"type":"string","enum":["FASTEST","CHEAPEST","RECOMMENDED","NO_SLIPPAGE"],"description":"Resets to RECOMMENDED when omitted.","example":"FASTEST","uniqueKey":"order","typeLabel":"enum\u003cstring>"},"slippageTolerance":{"type":"string","description":"Resets to \"0\" when omitted.","example":"5","uniqueKey":"slippageTolerance","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Child Address Update Rule":{"title":"Child Address Update Rule","value":{"type":"swap","destination":{"address":"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22","asset":"USDC","blockchain":"optimism"},"isActive":true,"name":"Swap from USDT to OP USDC","order":"FASTEST","slippageTolerance":"5","source":{"assets":["USDT"],"blockchain":"base","maxAmount":"1000","minAmount":"1"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"11be91b5-a455-40e6-9f13-4a88cc835774":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","enum":["withdraw","swap","gateway","earn"],"description":"Present on rules saved with an explicit type. Absent on legacy rules, whose behavior is inferred.","example":"swap","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"isGateway":{"type":"boolean","example":false,"uniqueKey":"data.isGateway","typeLabel":"boolean"},"isReward":{"type":"boolean","example":false,"uniqueKey":"data.isReward","typeLabel":"boolean"},"rewardProvider":{"type":"string","enum":["aave","compound"],"description":"Present on earn rules only.","example":"aave","uniqueKey":"data.rewardProvider","typeLabel":"enum\u003cstring>"},"rewardType":{"type":"string","enum":["defi"],"description":"Present on earn rules only.","example":"defi","uniqueKey":"data.rewardType","typeLabel":"enum\u003cstring>"},"useTransactionAmount":{"type":"boolean","example":false,"uniqueKey":"data.useTransactionAmount","typeLabel":"boolean"},"deductionPercentage":{"type":"string","example":"0","uniqueKey":"data.deductionPercentage","typeLabel":"string"},"createdAt":{"type":"string","example":"2025-08-26T17:28:38.273Z","uniqueKey":"data.createdAt","typeLabel":"string"},"destination":{"type":"object","properties":{"address":{"type":"string","example":"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22","uniqueKey":"data.destination.address","typeLabel":"string"},"asset":{"type":"string","example":"USDC","uniqueKey":"data.destination.asset","typeLabel":"string"},"blockchain":{"type":"string","example":"optimism","uniqueKey":"data.destination.blockchain","typeLabel":"string"}},"uniqueKey":"data.destination","typeLabel":"object"},"id":{"type":"string","example":"48c52f4a-c0bf-45c9-a322-1fef00f00431","uniqueKey":"data.id","typeLabel":"string"},"isActive":{"type":"boolean","example":true,"uniqueKey":"data.isActive","typeLabel":"boolean"},"name":{"type":"string","example":"Swap from USDT to OP USDC","uniqueKey":"data.name","typeLabel":"string"},"order":{"type":"string","example":"FASTEST","uniqueKey":"data.order","typeLabel":"string"},"slippageTolerance":{"type":"string","example":"5","uniqueKey":"data.slippageTolerance","typeLabel":"string"},"source":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"string","example":"USDT","uniqueKey":"data.source.assets.items.[INDEX]","typeLabel":"string"},"example":["USDT"],"uniqueKey":"data.source.assets","typeLabel":"string[]"},"blockchain":{"type":"string","example":"base","uniqueKey":"data.source.blockchain","typeLabel":"string"},"maxAmount":{"type":"string","example":"1000","uniqueKey":"data.source.maxAmount","typeLabel":"string"},"minAmount":{"type":"string","example":"1","uniqueKey":"data.source.minAmount","typeLabel":"string"}},"uniqueKey":"data.source","typeLabel":"object"},"updatedAt":{"type":"string","example":"2025-08-26T17:32:08.108Z","uniqueKey":"data.updatedAt","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","example":"Auto settlement rule updated successfully","uniqueKey":"message","typeLabel":"string"},"statusCode":{"type":"number","example":200,"uniqueKey":"statusCode","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"200":{"title":"200","value":{"data":{"type":"swap","createdAt":"2025-08-26T17:28:38.273Z","destination":{"address":"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22","asset":"USDC","blockchain":"optimism"},"id":"48c52f4a-c0bf-45c9-a322-1fef00f00431","isActive":true,"name":"Swap from USDT to OP USDC","order":"FASTEST","slippageTolerance":"5","source":{"assets":["USDT"],"blockchain":"base","maxAmount":"1000","minAmount":"1"},"updatedAt":"2025-08-26T17:32:08.108Z"},"message":"Auto settlement rule updated successfully","statusCode":200}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d8f3dd9c-8fc6-48ba-8401-20ab29d7120e":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"5cc11ce8-32a8-469f-a6f3-15596a5cb294":{"url":"https://api.blockradar.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yml"},"subdomain":"blockradar","siteName":"Blockradar","title":"Child Address Update Rule - Blockradar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/api-reference/auto-settlements/child-address-update-rule","matchLevel":0},"es":{"href":"/es/api-reference/auto-settlements/child-address-update-rule","matchLevel":1},"pt":{"href":"/pt/api-reference/auto-settlements/child-address-update-rule","matchLevel":1},"fr":{"href":"/fr/api-reference/auto-settlements/child-address-update-rule","matchLevel":1},"zh":{"href":"/zh/api-reference/auto-settlements/child-address-update-rule","matchLevel":1}}},"lastModified":"2026-09-17T15:52:03.232Z","originalFileLocation":"en/api-reference/auto-settlements/child-address-update-rule.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process. Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become \u0026quot;0\u0026quot;, useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes \u0026quot;0\u0026quot;, and source.maxAmount becomes \u0026quot;-1\u0026quot;. Read the rule first, change the fields you need, and send the whole object back. inheritance is ignored here — it only applies to master-wallet rules. ## Request Body Parameters | Parameter | Type | Required | Description | |---|---|---|---| | type | string | No | The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule\u0026#x27;s current behavior. | | name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. | | isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted. | | order | string | No | Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted. | | slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: \u0026quot;5\u0026quot; = 5% tolerance; \u0026quot;-1\u0026quot; for unlimited. Resets to \u0026quot;0\u0026quot; when omitted. | | isGateway | boolean | No | Route the settlement through Circle\u0026#x27;s Gateway. Must be true when the rule\u0026#x27;s type is gateway. | | isReward | boolean | No | Settle into an Earn position. Must be true when the rule\u0026#x27;s type is earn. Mainnet only, and cannot be combined with isGateway. | | rewardProvider | string | Conditional | Required whenever isReward is true. One of aave or compound. | | rewardType | string | No | Strategy class (defi). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. | | useTransactionAmount | boolean | No | false settles the address\u0026#x27;s current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted. | | deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. \u0026quot;2.5\u0026quot;. Resets to \u0026quot;0\u0026quot; when omitted. | | source | object | Yes | Details about the source of the settlement. | | ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., [\u0026quot;USDT\u0026quot;]). | | ├─ minAmount | string | No | The minimum amount required for settlement (e.g., \u0026quot;1\u0026quot;). Resets to \u0026quot;0\u0026quot; when omitted. | | ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., \u0026quot;1000\u0026quot;). Resets to \u0026quot;-1\u0026quot; when omitted. | | ├─ blockchain | string | No | The blockchain network used for the settlement. | | destination | object | Yes | Details about the destination of the settlement. | | ├─ asset | string | Yes | The asset the settlement is directed to. | | ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule\u0026#x27;s type is withdraw. | | ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule\u0026#x27;s type is withdraw. |\">\u003cmeta data-mint-head name=\"application-name\" content=\"Blockradar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Child Address Update Rule - Blockradar\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process. Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become \u0026quot;0\u0026quot;, useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes \u0026quot;0\u0026quot;, and source.maxAmount becomes \u0026quot;-1\u0026quot;. Read the rule first, change the fields you need, and send the whole object back. inheritance is ignored here — it only applies to master-wallet rules. ## Request Body Parameters | Parameter | Type | Required | Description | |---|---|---|---| | type | string | No | The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule\u0026#x27;s current behavior. | | name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. | | isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted. | | order | string | No | Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted. | | slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: \u0026quot;5\u0026quot; = 5% tolerance; \u0026quot;-1\u0026quot; for unlimited. Resets to \u0026quot;0\u0026quot; when omitted. | | isGateway | boolean | No | Route the settlement through Circle\u0026#x27;s Gateway. Must be true when the rule\u0026#x27;s type is gateway. | | isReward | boolean | No | Settle into an Earn position. Must be true when the rule\u0026#x27;s type is earn. Mainnet only, and cannot be combined with isGateway. | | rewardProvider | string | Conditional | Required whenever isReward is true. One of aave or compound. | | rewardType | string | No | Strategy class (defi). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. | | useTransactionAmount | boolean | No | false settles the address\u0026#x27;s current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted. | | deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. \u0026quot;2.5\u0026quot;. Resets to \u0026quot;0\u0026quot; when omitted. | | source | object | Yes | Details about the source of the settlement. | | ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., [\u0026quot;USDT\u0026quot;]). | | ├─ minAmount | string | No | The minimum amount required for settlement (e.g., \u0026quot;1\u0026quot;). Resets to \u0026quot;0\u0026quot; when omitted. | | ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., \u0026quot;1000\u0026quot;). Resets to \u0026quot;-1\u0026quot; when omitted. | | ├─ blockchain | string | No | The blockchain network used for the settlement. | | destination | object | Yes | Details about the destination of the settlement. | | ├─ asset | string | Yes | The asset the settlement is directed to. | | ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule\u0026#x27;s type is withdraw. | | ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule\u0026#x27;s type is withdraw. |\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Blockradar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blockradar.mintlify.app/_mintlify/api/og/v2?division=Auto+Settlements\u0026amp;title=Child+Address+Update+Rule\u0026amp;description=This+endpoint+allows+you+to+update+an+existing+auto-settlement+rule+for+a+specific+address.+By+providing+the+necessary+parameters+in+the+request+body%2C+you+can+m\u0026amp;theme=78f02e85afe6a1c022d0e4e9\u0026amp;signature=2ddb198fddfa9e7bafb276dd022bf999c9690f5ca24b5932f147d6a6473dd3aa\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Child Address Update Rule - Blockradar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process. Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become \u0026quot;0\u0026quot;, useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes \u0026quot;0\u0026quot;, and source.maxAmount becomes \u0026quot;-1\u0026quot;. Read the rule first, change the fields you need, and send the whole object back. inheritance is ignored here — it only applies to master-wallet rules. ## Request Body Parameters | Parameter | Type | Required | Description | |---|---|---|---| | type | string | No | The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule\u0026#x27;s current behavior. | | name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. | | isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted. | | order | string | No | Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted. | | slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: \u0026quot;5\u0026quot; = 5% tolerance; \u0026quot;-1\u0026quot; for unlimited. Resets to \u0026quot;0\u0026quot; when omitted. | | isGateway | boolean | No | Route the settlement through Circle\u0026#x27;s Gateway. Must be true when the rule\u0026#x27;s type is gateway. | | isReward | boolean | No | Settle into an Earn position. Must be true when the rule\u0026#x27;s type is earn. Mainnet only, and cannot be combined with isGateway. | | rewardProvider | string | Conditional | Required whenever isReward is true. One of aave or compound. | | rewardType | string | No | Strategy class (defi). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. | | useTransactionAmount | boolean | No | false settles the address\u0026#x27;s current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted. | | deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. \u0026quot;2.5\u0026quot;. Resets to \u0026quot;0\u0026quot; when omitted. | | source | object | Yes | Details about the source of the settlement. | | ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., [\u0026quot;USDT\u0026quot;]). | | ├─ minAmount | string | No | The minimum amount required for settlement (e.g., \u0026quot;1\u0026quot;). Resets to \u0026quot;0\u0026quot; when omitted. | | ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., \u0026quot;1000\u0026quot;). Resets to \u0026quot;-1\u0026quot; when omitted. | | ├─ blockchain | string | No | The blockchain network used for the settlement. | | destination | object | Yes | Details about the destination of the settlement. | | ├─ asset | string | Yes | The asset the settlement is directed to. | | ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule\u0026#x27;s type is withdraw. | | ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule\u0026#x27;s type is withdraw. |\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blockradar.mintlify.app/_mintlify/api/og/v2?division=Auto+Settlements\u0026amp;title=Child+Address+Update+Rule\u0026amp;description=This+endpoint+allows+you+to+update+an+existing+auto-settlement+rule+for+a+specific+address.+By+providing+the+necessary+parameters+in+the+request+body%2C+you+can+m\u0026amp;theme=78f02e85afe6a1c022d0e4e9\u0026amp;signature=2ddb198fddfa9e7bafb276dd022bf999c9690f5ca24b5932f147d6a6473dd3aa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/blockradar/0DqStYyDz-lsxOVV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Blockradar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/auto-settlements/child-address-update-rule.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.blockradar.co/es/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt\" href=\"https://docs.blockradar.co/pt/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.blockradar.co/fr/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.blockradar.co/zh/api-reference/auto-settlements/child-address-update-rule\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.blockradar.co/#organization\",\"name\":\"Blockradar\",\"url\":\"https://docs.blockradar.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/blockradar/fWg7SGpNBqmitg8P/logo/light.png?fit=max\u0026auto=format\u0026n=fWg7SGpNBqmitg8P\u0026q=85\u0026s=32dafe22efea13faac14c1c4af5f9fa3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.blockradar.co#website\",\"name\":\"Blockradar\",\"url\":\"https://docs.blockradar.co\",\"publisher\":{\"@id\":\"https://docs.blockradar.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule#webpage\",\"url\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\",\"name\":\"Child Address Update Rule\",\"description\":\"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process. Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become \\\"0\\\", useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes \\\"0\\\", and source.maxAmount becomes \\\"-1\\\". Read the rule first, change the fields you need, and send the whole object back. inheritance is ignored here — it only applies to master-wallet rules. ## Request Body Parameters | Parameter | Type | Required | Description | |---|---|---|---| | type | string | No | The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule's current behavior. | | name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. | | isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted. | | order | string | No | Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted. | | slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: \\\"5\\\" = 5% tolerance; \\\"-1\\\" for unlimited. Resets to \\\"0\\\" when omitted. | | isGateway | boolean | No | Route the settlement through Circle's Gateway. Must be true when the rule's type is gateway. | | isReward | boolean | No | Settle into an Earn position. Must be true when the rule's type is earn. Mainnet only, and cannot be combined with isGateway. | | rewardProvider | string | Conditional | Required whenever isReward is true. One of aave or compound. | | rewardType | string | No | Strategy class (defi). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. | | useTransactionAmount | boolean | No | false settles the address's current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted. | | deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. \\\"2.5\\\". Resets to \\\"0\\\" when omitted. | | source | object | Yes | Details about the source of the settlement. | | ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., [\\\"USDT\\\"]). | | ├─ minAmount | string | No | The minimum amount required for settlement (e.g., \\\"1\\\"). Resets to \\\"0\\\" when omitted. | | ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., \\\"1000\\\"). Resets to \\\"-1\\\" when omitted. | | ├─ blockchain | string | No | The blockchain network used for the settlement. | | destination | object | Yes | Details about the destination of the settlement. | | ├─ asset | string | Yes | The asset the settlement is directed to. | | ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule's type is withdraw. | | ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule's type is withdraw. |\",\"dateModified\":\"2026-09-17T15:52:03.232Z\",\"isPartOf\":{\"@id\":\"https://docs.blockradar.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Auto Settlements\",\"item\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/master-wallet\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Child Address Update Rule\",\"item\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule#apireference\",\"headline\":\"Child Address Update Rule\",\"name\":\"Child Address Update Rule\",\"description\":\"This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process. Send the complete rule, not just the fields you are changing. Unlike the master-wallet update, this endpoint validates the body as a whole rule: source and destination are mandatory, and any optional field you leave out is reset to its default rather than kept — order becomes RECOMMENDED, slippageTolerance and deductionPercentage become \\\"0\\\", useTransactionAmount becomes false, isActive becomes true, source.minAmount becomes \\\"0\\\", and source.maxAmount becomes \\\"-1\\\". Read the rule first, change the fields you need, and send the whole object back. inheritance is ignored here — it only applies to master-wallet rules. ## Request Body Parameters | Parameter | Type | Required | Description | |---|---|---|---| | type | string | No | The settlement rule type: withdraw, swap, gateway, or earn. Sending it on an update migrates a legacy rule onto the explicit type system and applies the type validations; omit it to keep the rule's current behavior. | | name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. | | isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. Resets to true when omitted. | | order | string | No | Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE. Resets to RECOMMENDED when omitted. | | slippageTolerance | string | No | The acceptable slippage tolerance (as a percentage). Example: \\\"5\\\" = 5% tolerance; \\\"-1\\\" for unlimited. Resets to \\\"0\\\" when omitted. | | isGateway | boolean | No | Route the settlement through Circle's Gateway. Must be true when the rule's type is gateway. | | isReward | boolean | No | Settle into an Earn position. Must be true when the rule's type is earn. Mainnet only, and cannot be combined with isGateway. | | rewardProvider | string | Conditional | Required whenever isReward is true. One of aave or compound. | | rewardType | string | No | Strategy class (defi). Optional — defaults from the resolved product. | | productKey | string | No | Pins a specific earn product for the rule. Only needed when a provider offers more than one product for a source asset; the updated rule must then have exactly one source asset. | | useTransactionAmount | boolean | No | false settles the address's current balance of the source asset; true settles only the triggering deposit amount. Resets to false when omitted. | | deductionPercentage | string | No | Percentage withheld from the settled amount before execution, e.g. \\\"2.5\\\". Resets to \\\"0\\\" when omitted. | | source | object | Yes | Details about the source of the settlement. | | ├─ assets | array of strings | Yes | List of asset symbols this rule settles (e.g., [\\\"USDT\\\"]). | | ├─ minAmount | string | No | The minimum amount required for settlement (e.g., \\\"1\\\"). Resets to \\\"0\\\" when omitted. | | ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., \\\"1000\\\"). Resets to \\\"-1\\\" when omitted. | | ├─ blockchain | string | No | The blockchain network used for the settlement. | | destination | object | Yes | Details about the destination of the settlement. | | ├─ asset | string | Yes | The asset the settlement is directed to. | | ├─ address | string | Conditional | The address the settlement is sent to. Required once the rule's type is withdraw. | | ├─ blockchain | string | Yes | The blockchain network for the destination. Must equal the source blockchain once the rule's type is withdraw. |\",\"url\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule\",\"mainEntityOfPage\":{\"@id\":\"https://docs.blockradar.co/en/api-reference/auto-settlements/child-address-update-rule#webpage\"},\"dateModified\":\"2026-09-17T15:52:03.232Z\",\"publisher\":{\"@id\":\"https://docs.blockradar.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.blockradar.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Blockradar\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Blockradar","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/en/introduction/why-blockradar"}]},{"tab":"Security","pages":[{"title":"Security","href":"/en/security/introduction"}]},{"tab":"API","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","icon":"circle","href":"/en/api-reference/introduction"},{"title":"Authentication","icon":"lock","href":"/en/api-reference/authentication"},{"title":"Errors","icon":"exclamation","href":"/en/api-reference/errors"}]},{"group":"Wallet","pages":[{"openapi":"get /v1/wallets/{walletId}","title":"Get Wallet","href":"/en/api-reference/wallet/get-wallet"},{"openapi":"patch /v1/wallets/{walletId}","title":"Update wallet","href":"/en/api-reference/wallet/update-wallet"},{"openapi":"get /v1/wallets/{walletId}/balance","title":"Get Balance","href":"/en/api-reference/wallet/get-balance"},{"openapi":"get /v1/wallets/{walletId}/balances","title":"Get Balances","href":"/en/api-reference/wallet/get-balances"},{"openapi":"post /v1/wallets/{id}/rescan/blocks","title":"Deposit Finder","href":"/en/api-reference/wallet/deposit-finder"},{"openapi":"post /v1/wallets/{walletId}/sweep/assets","title":"Trigger Sweep Assets","href":"/en/api-reference/wallet/trigger-sweep-assets"},{"openapi":"get /v1/wallets/{walletId}/webhooks","title":"Webhooks Logs","href":"/en/api-reference/wallet/webhooks-logs"}]},{"group":"Addresses","pages":[{"openapi":"get /v1/wallets/{walletId}/addresses","title":"Get Addresses","href":"/en/api-reference/addresses/get-addresses"},{"openapi":"post /v1/wallets/{walletId}/addresses","title":"Generate Address","href":"/en/api-reference/addresses/generate-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}","title":"Get Address","href":"/en/api-reference/addresses/get-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}","title":"Update Address","href":"/en/api-reference/addresses/update-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/whitelist","title":"Whitelist address","href":"/en/api-reference/addresses/whitelist-address"},{"openapi":"delete /v1/wallets/{walletId}/addresses/whitelist/{addressId}","title":"Unwhitelist address","href":"/en/api-reference/addresses/unwhitelist-address"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balance","title":"Get Balance","href":"/en/api-reference/addresses/get-balance"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/balances","title":"Get Balances","href":"/en/api-reference/addresses/get-balances"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions","title":"Get transactions","href":"/en/api-reference/addresses/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/transactions/{id}","title":"Get transaction","href":"/en/api-reference/addresses/get-transaction"},{"openapi":"get /v1/addresses/validate","title":"Validate Address","href":"/en/api-reference/addresses/validate-address"}]},{"group":"Customer","pages":[{"title":"Create Customer","openapi":"post /v1/customers","href":"/en/api-reference/customer/create"},{"title":"List Customers","openapi":"get /v1/customers","href":"/en/api-reference/customer/list"},{"title":"Get Customer","openapi":"get /v1/customers/{customerId}","href":"/en/api-reference/customer/get"},{"title":"Update Customer","openapi":"patch /v1/customers/{customerId}","href":"/en/api-reference/customer/update"},{"group":"Onboarding","pages":[{"openapi":"post /v1/customers/{customerId}/onboarding-requests","title":"Create Customer Onboarding Request","href":"/en/api-reference/customer-onboarding/create-request"},{"openapi":"get /v1/customers/{customerId}/onboarding-requests","title":"List Customer Onboarding Requests","href":"/en/api-reference/customer-onboarding/list-requests"},{"openapi":"get /v1/customers/{customerId}/onboarding-requests/{caseId}","title":"Get Customer Onboarding Request","href":"/en/api-reference/customer-onboarding/get-request"},{"openapi":"post /v1/customers/{customerId}/onboarding-requests/{caseId}/submit","title":"Submit Customer Onboarding Requirements","href":"/en/api-reference/customer-onboarding/submit-request"},{"openapi":"post /v1/onboarding/cases/{caseId}/uploads/prepare","title":"Prepare Customer Onboarding Uploads","href":"/en/api-reference/customer-onboarding/prepare-uploads"},{"openapi":"post /v1/onboarding/cases/{caseId}/uploads/{uploadId}","title":"Upload Prepared Customer Document","href":"/en/api-reference/customer-onboarding/upload-prepared-document"},{"openapi":"get /v1/onboarding/cases/{caseId}/confirmation-requirements","title":"Get Customer Onboarding Confirmation Requirements","href":"/en/api-reference/customer-onboarding/get-confirmation-requirements"},{"openapi":"post /v1/onboarding/cases/{caseId}/confirmation","title":"Submit Customer Onboarding Confirmation","href":"/en/api-reference/customer-onboarding/submit-confirmation"}]}]},{"group":"Asset","pages":[{"openapi":"get /v1/wallets/{walletId}/assets","title":"Get Wallet Assets","href":"/en/api-reference/asset/get-wallet-assets"},{"openapi":"post /v1/wallets/{walletId}/assets","title":"Add Asset to Wallet","href":"/en/api-reference/asset/add-asset-to-wallet"},{"openapi":"delete /v1/wallets/{walletId}/assets/{assetId}","title":"Remove Asset from Wallet","href":"/en/api-reference/asset/remove-asset-from-wallet"},{"openapi":"patch /v1/wallets/{walletId}/assets/{assetId}","title":"Update Wallet Asset","href":"/en/api-reference/asset/update-wallet-asset"}]},{"group":"Transactions","pages":[{"openapi":"get /v1/wallets/{walletId}/transactions","title":"Get Transactions","href":"/en/api-reference/transactions/get-transactions"},{"openapi":"get /v1/wallets/{walletId}/transactions/{id}","title":"Get transaction","href":"/en/api-reference/transactions/get-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/webhooks/resend","title":"Resend Webhook","href":"/en/api-reference/transactions/resend-webhook"},{"openapi":"get /v1/wallets/{walletId}/transactions/{transactionsId}/webhooks","title":"Webhook Logs","href":"/en/api-reference/transactions/webhook-logs"},{"openapi":"post /v1/wallets/{walletId}/transactions/sweep/assets","title":"Trigger Asset Sweep","href":"/en/api-reference/transactions/trigger-asset-sweep"},{"openapi":"post /v1/wallets/{walletId}/transactions/retry","title":"Retry Transaction","href":"/en/api-reference/transactions/retry-transaction"},{"openapi":"post /v1/wallets/{walletId}/transactions/cancel","title":"Cancel Transaction","href":"/en/api-reference/transactions/cancel-transaction"}]},{"group":"Withdraw","pages":[{"openapi":"post /v1/wallets/{walletId}/withdraw","title":"Master Wallet","href":"/en/api-reference/withdraw/master-wallet"},{"openapi":"post /v1/wallets/{walletId}/withdraw/sign","title":"Master Wallet Sign-Only","href":"/en/api-reference/withdraw/master-wallet-sign-only"},{"openapi":"post /v1/wallets/{walletId}/withdraw/network-fee","title":"Master Wallet Network Fee","href":"/en/api-reference/withdraw/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw","title":"Child Address","href":"/en/api-reference/withdraw/child-address"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/sign","title":"Child Address Sign-Only","href":"/en/api-reference/withdraw/child-address-sign-only"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/network-fee","title":"Child Address Network Fee","href":"/en/api-reference/withdraw/child-address-network-fee"}]},{"group":"Withdraw Fiat","pages":[{"group":"v2","tag":"Recommended","expanded":true,"pages":[{"openapi":"get /v2/wallets/{id}/withdraw/fiat/assets","title":"Get Supported Assets","href":"/en/api-reference/withdraw-fiat/get-supported-assets-v2"},{"openapi":"get /v2/wallets/{id}/withdraw/fiat/currencies","title":"Get Supported Currencies","href":"/en/api-reference/withdraw-fiat/get-supported-currencies-v2"},{"openapi":"get /v2/wallets/{id}/withdraw/fiat/rates","title":"Get Exchange Rates","href":"/en/api-reference/withdraw-fiat/get-exchange-rates-v2"},{"openapi":"get /v2/wallets/{id}/withdraw/fiat/payment-methods","title":"Get Payment Methods","href":"/en/api-reference/withdraw-fiat/get-payment-methods-v2"},{"openapi":"get /v2/wallets/{id}/withdraw/fiat/payment-method-requirements","title":"Get Payment Method Requirements","href":"/en/api-reference/withdraw-fiat/payment-method-requirements-v2"},{"openapi":"post /v2/wallets/{id}/withdraw/fiat/payment-method/resolve","title":"Resolve Payment Method Requirements","href":"/en/api-reference/withdraw-fiat/resolve-payment-method-v2"},{"openapi":"post /v2/wallets/{id}/withdraw/fiat/quote","title":"Master Wallet Get Quote","href":"/en/api-reference/withdraw-fiat/master-wallet-get-quote-v2"},{"openapi":"post /v2/wallets/{id}/withdraw/fiat/execute","title":"Master Wallet Execute","href":"/en/api-reference/withdraw-fiat/master-wallet-execute-v2"},{"openapi":"post /v2/wallets/{walletId}/addresses/{addressId}/withdraw/fiat/quote","title":"Child Address Get Quote","href":"/en/api-reference/withdraw-fiat/child-address-get-quote-v2"},{"openapi":"post /v2/wallets/{walletId}/addresses/{addressId}/withdraw/fiat/execute","title":"Child Address Execute","href":"/en/api-reference/withdraw-fiat/child-address-execute-v2"}]},{"group":"v1","expanded":false,"pages":[{"title":"Get Supported Assets","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/withdraw/fiat/assets","href":"/api-reference/withdraw-fiat/get-supported-assets"},{"title":"Get Currencies","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/withdraw/fiat/currencies","href":"/api-reference/withdraw-fiat/get-currencies"},{"title":"Get Exchange Rates","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/withdraw/fiat/rates","href":"/api-reference/withdraw-fiat/get-exchange-rates"},{"title":"Get Institutions","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/withdraw/fiat/institutions","href":"/api-reference/withdraw-fiat/get-institutions"},{"title":"Verify Institution Account","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/withdraw/fiat/institution-account-verification","href":"/api-reference/withdraw-fiat/verify-institution-account"},{"title":"Master Wallet Get Quote","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/withdraw/fiat/quote","href":"/api-reference/withdraw-fiat/master-wallet-get-quote"},{"title":"Master Wallet Execute","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/withdraw/fiat/execute","href":"/api-reference/withdraw-fiat/master-wallet-execute"},{"title":"Child Address Get Quote","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/fiat/quote","href":"/api-reference/withdraw-fiat/child-address-get-quote"},{"title":"Child Address Execute","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/addresses/{addressId}/withdraw/fiat/execute","href":"/api-reference/withdraw-fiat/child-address-execute"}]}]},{"group":"Signing","pages":[{"openapi":"post /v1/wallets/{id}/signing/typed-data","title":"Master Wallet Typed data","href":"/en/api-reference/signing/master-wallet-typed-data"},{"openapi":"post /v1/wallets/{id}/signing/message","title":"Master Wallet Message","href":"/en/api-reference/signing/master-wallet-message"},{"openapi":"post /v1/wallets/{id}/signing/transaction","title":"Master Wallet Sign Transaction","href":"/en/api-reference/signing/master-wallet-sign-transaction"},{"openapi":"post /v1/wallets/{id}/signing/broadcast","title":"Master Wallet Broadcast Transaction","href":"/en/api-reference/signing/master-wallet-broadcast-transaction"},{"openapi":"post /v1/wallets/{id}/addresses/{addressId}/signing/typed-data","title":"Child Address Typed data","href":"/en/api-reference/signing/child-address-typed-data"},{"openapi":"post /v1/wallets/{id}/addresses/{addressId}/signing/message","title":"Child Address Message","href":"/en/api-reference/signing/child-address-message"},{"openapi":"post /v1/wallets/{id}/addresses/{addressId}/signing/transaction","title":"Child Address Sign Transaction","href":"/en/api-reference/signing/child-address-sign-transaction"},{"openapi":"post /v1/wallets/{id}/addresses/{addressId}/signing/broadcast","title":"Child Address Broadcast Transaction","href":"/en/api-reference/signing/child-address-broadcast-transaction"}]},{"group":"Swap","pages":[{"openapi":"post /v1/wallets/{walletId}/swaps/quote","title":"Master Wallet Get Quote","href":"/en/api-reference/swap/master-wallet-get-quote"},{"openapi":"post /v1/wallets/{walletId}/swaps/execute","title":"Master Wallet Execute","href":"/en/api-reference/swap/master-wallet-execute"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/quote","title":"Child Address Get Quote","href":"/en/api-reference/swap/child-address-get-quote"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/swaps/execute","title":"Child Address Execute","href":"/en/api-reference/swap/child-address-execute"}]},{"group":"Liquidity Pool","pages":[{"openapi":"post /v1/rates","title":"Create Rate","href":"/en/api-reference/liquidity-pool/create-rate"},{"openapi":"get /v1/rates/check-pair","title":"Check Pair","href":"/en/api-reference/liquidity-pool/check-pair"},{"openapi":"get /v1/rates/market-benchmark","title":"Get Market Benchmark","href":"/en/api-reference/liquidity-pool/get-market-benchmark"},{"openapi":"get /v1/rates/treasury-balances","title":"Get Treasury Balances","href":"/en/api-reference/liquidity-pool/get-treasury-balances"},{"openapi":"get /v1/rates/{id}","title":"Get Rate","href":"/en/api-reference/liquidity-pool/get-rate"},{"openapi":"patch /v1/rates/{id}","title":"Update Rate","href":"/en/api-reference/liquidity-pool/update-rate"},{"openapi":"get /v1/rates/{id}/history","title":"Get Rate History","href":"/en/api-reference/liquidity-pool/get-rate-history"},{"openapi":"patch /v1/rates/{id}/deactivate","title":"Deactivate Rate","href":"/en/api-reference/liquidity-pool/deactivate-rate"},{"openapi":"patch /v1/rates/{id}/reactivate","title":"Reactivate Rate","href":"/en/api-reference/liquidity-pool/reactivate-rate"}]},{"group":"Virtual Accounts","pages":[{"group":"v2","tag":"Recommended","expanded":true,"pages":[{"openapi":"get /v2/wallets/{id}/virtual-accounts","title":"List Virtual Accounts","href":"/en/api-reference/virtual-accounts/master-wallet-get-all-v2"},{"openapi":"get /v2/wallets/{id}/virtual-accounts/{virtualAccountId}","title":"Get Virtual Account","href":"/en/api-reference/virtual-accounts/master-wallet-get-one-v2"},{"openapi":"get /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts","title":"Child Address List","href":"/en/api-reference/virtual-accounts/child-address-get-all-v2"},{"openapi":"get /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}","title":"Child Address Get","href":"/en/api-reference/virtual-accounts/child-address-get-one-v2"},{"openapi":"get /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}/transactions","title":"Child Address Transactions","href":"/en/api-reference/virtual-accounts/child-address-transactions-v2"},{"openapi":"get /v2/wallets/{id}/virtual-accounts/discovery","title":"Discover Options","href":"/en/api-reference/virtual-accounts/discovery-v2"},{"openapi":"get /v2/wallets/{id}/virtual-accounts/requirements","title":"Get Requirements","href":"/en/api-reference/virtual-accounts/requirements-v2"},{"openapi":"get /v2/wallets/{id}/virtual-accounts/{virtualAccountId}/destination/discovery","title":"Discover Destination Options","href":"/en/api-reference/virtual-accounts/destination-discovery-v2"},{"openapi":"patch /v2/wallets/{id}/virtual-accounts/{virtualAccountId}/destination","title":"Change Destination","href":"/en/api-reference/virtual-accounts/change-destination-v2"},{"openapi":"post /v2/wallets/{id}/virtual-accounts","title":"Master Wallet Account Create","href":"/en/api-reference/virtual-accounts/master-wallet-create-v2"},{"openapi":"post /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts","title":"Child Address Account Create","href":"/en/api-reference/virtual-accounts/child-address-create-v2"},{"openapi":"post /v2/wallets/{id}/virtual-accounts/{virtualAccountId}/regenerate","title":"Master Wallet Account Regenerate","href":"/en/api-reference/virtual-accounts/master-wallet-regenerate-v2"},{"openapi":"post /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}/regenerate","title":"Child Address Account Regenerate","href":"/en/api-reference/virtual-accounts/child-address-regenerate-v2"},{"openapi":"patch /v2/wallets/{id}/virtual-accounts/{virtualAccountId}","title":"Master Wallet Account Update","href":"/en/api-reference/virtual-accounts/master-wallet-update-v2"},{"openapi":"patch /v2/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}","title":"Child Address Account Update","href":"/en/api-reference/virtual-accounts/child-address-update-v2"}]},{"group":"v1","expanded":false,"pages":[{"title":"Master Wallet Get All","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{id}/virtual-accounts","href":"/api-reference/virtual-accounts/master-wallet-get-all"},{"title":"Master Wallet Get One","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{id}/virtual-accounts/{vId}","href":"/api-reference/virtual-accounts/master-wallet-get-one"},{"title":"Master Wallet Transactions","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{id}/virtual-accounts/{vId}/transactions","href":"/api-reference/virtual-accounts/master-wallet-transactions"},{"title":"Child Address Get All","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts","href":"/api-reference/virtual-accounts/child-address-get-all"},{"title":"Child Address Get One","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}","href":"/api-reference/virtual-accounts/child-address-get-one"},{"title":"Child Address Transactions","deprecated":null,"version":null,"openapi":"/openapi.yml get /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}/transactions","href":"/api-reference/virtual-accounts/child-address-transactions"},{"title":"Master Wallet Update","deprecated":null,"version":null,"openapi":"/openapi.yml patch /v1/wallets/{walletId}/virtual-accounts/{id}","href":"/api-reference/virtual-accounts/master-wallet-update"},{"title":"Child Address Update","deprecated":null,"version":null,"openapi":"/openapi.yml patch /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}","href":"/api-reference/virtual-accounts/child-address-update"},{"title":"Master Wallet Create","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{id}/virtual-accounts","href":"/api-reference/virtual-accounts/master-wallet-create"},{"title":"Master Wallet Regenerate","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{id}/virtual-accounts/{vId}/regenerate","href":"/api-reference/virtual-accounts/master-wallet-regenerate"},{"title":"Child Address Create","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts","href":"/api-reference/virtual-accounts/child-address-create"},{"title":"Child Address Regenerate","deprecated":null,"version":null,"openapi":"/openapi.yml post /v1/wallets/{walletId}/addresses/{addressId}/virtual-accounts/{virtualAccountId}/regenerate","href":"/api-reference/virtual-accounts/child-address-regenerate"}]}]},{"group":"Deposit Fiat","pages":[{"title":"Get Supported Assets","openapi":"get /v1/wallets/{id}/deposit/fiat/assets","href":"/en/api-reference/deposit-fiat/get-supported-assets"},{"title":"Get Supported Currencies","openapi":"get /v1/wallets/{id}/deposit/fiat/currencies","href":"/en/api-reference/deposit-fiat/get-supported-currencies"},{"title":"Get Supported Rails","openapi":"get /v1/wallets/{id}/deposit/fiat/rails","href":"/en/api-reference/deposit-fiat/get-supported-rails"},{"openapi":"post /v1/wallets/{id}/deposit/fiat/quote","title":"Master Wallet Get Quote","href":"/en/api-reference/deposit-fiat/master-wallet-get-quote"},{"openapi":"post /v1/wallets/{id}/deposit/fiat/payment-order-requirements/resolve","title":"Resolve Payment Order Requirements","href":"/en/api-reference/deposit-fiat/resolve-payment-order-requirements"},{"openapi":"post /v1/wallets/{id}/deposit/fiat/orders","title":"Master Wallet Create Payment Order","href":"/en/api-reference/deposit-fiat/master-wallet-create-payment-order"},{"title":"List Payment Orders","openapi":"get /v1/wallets/{id}/deposit/fiat/orders","href":"/en/api-reference/deposit-fiat/master-wallet-list-payment-orders"},{"title":"Get Payment Order","openapi":"get /v1/wallets/{id}/deposit/fiat/orders/{orderId}","href":"/en/api-reference/deposit-fiat/master-wallet-get-payment-order"},{"title":"Refresh Payment Order","openapi":"post /v1/wallets/{id}/deposit/fiat/orders/{orderId}/refresh","href":"/en/api-reference/deposit-fiat/master-wallet-refresh-payment-order"},{"title":"Cancel Payment Order","openapi":"post /v1/wallets/{id}/deposit/fiat/orders/{orderId}/cancel","href":"/en/api-reference/deposit-fiat/master-wallet-cancel-payment-order"},{"title":"Get Child Address Quote","openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/deposit/fiat/quote","href":"/en/api-reference/deposit-fiat/child-address-get-quote"},{"title":"Create Child Address Payment Order","openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/deposit/fiat/orders","href":"/en/api-reference/deposit-fiat/child-address-create-payment-order"},{"title":"List Child Address Payment Orders","openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/deposit/fiat/orders","href":"/en/api-reference/deposit-fiat/child-address-list-payment-orders"},{"title":"Webhooks","href":"/en/api-reference/deposit-fiat/payment-order-webhooks"}]},{"group":"Auto Settlements","pages":[{"openapi":"get /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet","href":"/en/api-reference/auto-settlements/master-wallet"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements","title":"Master Wallet Update","href":"/en/api-reference/auto-settlements/master-wallet-update"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Get Rules","href":"/en/api-reference/auto-settlements/master-wallet-get-rules"},{"openapi":"post /v1/wallets/{walletId}/auto-settlements/rules","title":"Master Wallet Create Rule","href":"/en/api-reference/auto-settlements/master-wallet-create-rule"},{"openapi":"get /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Get Rule","href":"/en/api-reference/auto-settlements/master-wallet-get-rule"},{"openapi":"delete /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Delete Rule","href":"/en/api-reference/auto-settlements/master-wallet-delete-rule"},{"openapi":"patch /v1/wallets/{walletId}/auto-settlements/rules/{id}","title":"Master Wallet Update Rule","href":"/en/api-reference/auto-settlements/master-wallet-update-rule"},{"openapi":"post /v1/wallets/{walletId}/auto-settlements/rules/copy","title":"Master Wallet Copy Rules","href":"/en/api-reference/auto-settlements/master-wallet-copy-rules"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address","href":"/en/api-reference/auto-settlements/child-address"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements","title":"Child Address Update","href":"/en/api-reference/auto-settlements/child-address-update"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Get Rules","href":"/en/api-reference/auto-settlements/child-address-get-rules"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules","title":"Child Address Create Rule","href":"/en/api-reference/auto-settlements/child-address-create-rule"},{"openapi":"get /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Get Rule","href":"/en/api-reference/auto-settlements/child-address-get-rule"},{"openapi":"delete /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Delete Rule","description":"This endpoint allows users to delete a specific auto settlement rule associated with a address. The rule is identified by the `id` parameter in the URL,\n\n#### Request Parameters\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| id | string | Yes | The unique identifier of the auto-settlement rule to be deleted. |","href":"/en/api-reference/auto-settlements/child-address-delete-rule"},{"openapi":"patch /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}","title":"Child Address Update Rule","href":"/en/api-reference/auto-settlements/child-address-update-rule"}]},{"group":"Smart Contract","pages":[{"openapi":"post /v1/wallets/{walletId}/contracts/read","title":"Master Wallet Read","description":"This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data,\n\n#### Request Body\n\nThe request body should be in raw format and include the following parameters:\n\n| Parameter | Type | Required | Description |\n|-------------|--------------|----------|-----------------------------------------------------------------------------|\n| address | string | Yes | The address of the contract. |\n| method | string | Yes | The method to be called on the contract. |\n| parameters | array | Yes | An array of parameters to pass to the method. |\n| abi | array | Yes | An array containing the ABI of the contract or method. |\n","href":"/en/api-reference/smart-contract/master-wallet-read"},{"openapi":"post /v1/wallets/{walletId}/contracts/write","title":"Master Wallet Write","href":"/en/api-reference/smart-contract/master-wallet-write"},{"openapi":"post /v1/wallets/{walletId}/contracts/write/sign","title":"Master Wallet Write Sign-Only","href":"/en/api-reference/smart-contract/master-wallet-write-sign-only"},{"openapi":"post /v1/wallets/{walletId}/contracts/network-fee","title":"Master Wallet Network Fee","href":"/en/api-reference/smart-contract/master-wallet-network-fee"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/read","title":"Child Address Read","href":"/en/api-reference/smart-contract/child-address-read"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write","title":"Child Address Write","href":"/en/api-reference/smart-contract/child-address-write"},{"openapi":"post /v1/wallets/{walletId}/addresses/{addressId}/contracts/write/sign","title":"Child Address Write Sign-Only","href":"/en/api-reference/smart-contract/child-address-write-sign-only"},{"openapi":"post /wallets/{walletId}/addresses/{addressId}/contracts/network-fee","title":"Child Address Network Fee","href":"/en/api-reference/smart-contract/child-address-network-fee"}]},{"group":"Gateway","pages":[{"openapi":"get /v1/gateway/wallets","title":"Get Supported Master Wallets","href":"/en/api-reference/gateway/get-supported-master-wallets"},{"openapi":"get /v1/gateway/Transactions","title":"Master Wallet Transactions","href":"/en/api-reference/gateway/master-wallet-transactions"},{"openapi":"get /v1/gateway/balance","title":"Master Wallet Get Balance","href":"/en/api-reference/gateway/master-wallet-get-balance"},{"openapi":"post /v1/gateway/deposit/{walletId}","title":"Master Wallet Deposit","href":"/en/api-reference/gateway/master-wallet-deposit"},{"openapi":"post /v1/gateway/deposit/{walletId}/network-fee","title":"Master Wallet Deposit Network Fee","href":"/en/api-reference/gateway/master-wallet-deposit-network-fee"},{"openapi":"post /v1/gateway/withdraw","title":"Master Wallet Withdraw","href":"/en/api-reference/gateway/master-wallet-withdraw"},{"openapi":"post /v1/gateway/withdraw/network-fee","title":"Master Wallet Withdraw Network Fee","href":"/en/api-reference/gateway/master-wallet-withdraw-network-fee"},{"openapi":"get /v1/addresses/{addressId}/gateway/transactions","title":"Child Address Transactions","href":"/en/api-reference/gateway/child-address-transactions"},{"openapi":"get /v1/addresses/{addressId}/gateway/balance","title":"Child Address Get Balance","href":"/en/api-reference/gateway/child-address-get-balance"},{"openapi":"post /v1/addresses/{addressId}/gateway/deposit/{walletId}","title":"Child Address Deposit","href":"/en/api-reference/gateway/child-address-deposit"},{"openapi":"post /v1/addresses/{addressId}/gateway/deposit/{walletId}/network-fee","title":"Child Address Deposit Network Fee","href":"/en/api-reference/gateway/child-address-deposit-network-fee"},{"openapi":"post /v1/addresses/{addressId}/gateway/withdraw","title":"Child Address Withdraw","href":"/en/api-reference/gateway/child-address-withdraw"},{"openapi":"post /v1/addresses/{addressId}/gateway/withdraw/network-fee","title":"Child Address Withdraw Network Fee","href":"/en/api-reference/gateway/child-address-withdraw-network-fee"}]},{"group":"Payment Links","pages":[{"openapi":"get /v1/payment_links","title":"Get All","href":"/en/api-reference/payment-links/get-all"},{"openapi":"post /v1/payment_links","title":"Create","href":"/en/api-reference/payment-links/create"},{"openapi":"get /v1/payment_links/{id}","title":"Get One","href":"/en/api-reference/payment-links/get-one"},{"openapi":"patch /v1/payment_links/{id}","title":"Update","href":"/en/api-reference/payment-links/update"},{"openapi":"get /v1/payment_links/{id}/transactions","title":"Get Transactions","href":"/en/api-reference/payment-links/get-transactions"}]},{"group":"AML","pages":[{"openapi":"get /v1/aml/lookup","title":"Lookup","href":"/en/api-reference/aml/lookup"}]},{"group":"Asset Recovery","pages":[{"openapi":"post /v1/wallets/{walletId}/salvage","title":"Execute","href":"/en/api-reference/asset-recovery/execute"},{"openapi":"post /v1/wallets/{walletId}/salvage/network-fee","title":"Network Fee","href":"/en/api-reference/asset-recovery/network-fee"}]},{"group":"Miscellaneous","pages":[{"openapi":"get /v1/assets","title":"Get Assets","href":"/en/api-reference/miscellaneous/get-assets"},{"openapi":"get /v1/assets/rates","title":"Get Rates","href":"/en/api-reference/miscellaneous/get-rates"},{"openapi":"get /v1/blockchains","title":"Get Blockchains","href":"/en/api-reference/miscellaneous/get-blockchains"}]},{"group":"Rewards","pages":[{"openapi":"get /v1/rewards","title":"Business Rewards","href":"/en/api-reference/rewards/business-rewards"},{"openapi":"get /v1/rewards/products","title":"Reward Products","href":"/en/api-reference/rewards/products"},{"openapi":"get /v1/rewards/supported-chains","title":"Supported Reward Chains","href":"/en/api-reference/rewards/supported-chains"},{"openapi":"get /v1/rewards/transactions","title":"Business Reward Transactions","href":"/en/api-reference/rewards/business-transactions"},{"openapi":"get /v1/wallets/{walletId}/rewards","title":"Wallet Rewards","href":"/en/api-reference/rewards/wallet-rewards"},{"openapi":"get /v1/wallets/{walletId}/rewards/assets","title":"Wallet Reward Assets","href":"/en/api-reference/rewards/wallet-reward-assets"},{"openapi":"post /v1/wallets/{walletId}/rewards/deposit","title":"Deposit","href":"/en/api-reference/rewards/deposit"},{"openapi":"post /v1/wallets/{walletId}/rewards/deposit/network-fee","title":"Deposit Network Fee","href":"/en/api-reference/rewards/deposit-network-fee"},{"openapi":"post /v1/wallets/{walletId}/rewards/withdraw","title":"Withdraw","href":"/en/api-reference/rewards/withdraw"},{"openapi":"post /v1/wallets/{walletId}/rewards/withdraw/network-fee","title":"Withdraw Network Fee","href":"/en/api-reference/rewards/withdraw-network-fee"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/en/api-changelog/introduction"}]}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/auto-settlements/child-address-update-rule"}]},{"language":"pt","pages":[{"title":"pt","href":"/pt/api-reference/auto-settlements/child-address-update-rule"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/auto-settlements/child-address-update-rule"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/auto-settlements/child-address-update-rule"}]}]},"title":"Child Address Update Rule - Blockradar","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}