Child Address Update Rule

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. Either fija or aave.
rewardType	string	Conditional	Required whenever isReward is true. Must be regulated for fija and defi for aave.
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.

PATCH /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}

Child Address Update Rule

cURL

curl --request PATCH \
  --url https://api.blockradar.co/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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"
  }
}
'

200

{
  "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
}

Authorizations

x-api-key · string · header · required

Path Parameters

walletId · string · required

Example:

"{{walletId}}"

addressId · string · required

Example:

"534e0480-f444-40c0-bc2e-2ef17bf7999e"

id · string · required

Example:

"55869cbe-fa3a-44d2-a7e3-d65c08355e4d"

Body

application/json

destination · object · required

Show child attributes

source · object · required

Show child attributes

type · enum<string>

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.

Available options: withdraw, swap, gateway, earn

Example:

"swap"

isActive · boolean

Resets to true when omitted.

Example:

true

isGateway · boolean

Must be true when the rule's type is gateway.

Example:

false

isReward · boolean

Must be true when the rule's type is earn. Mainnet only, and cannot be combined with isGateway.

Example:

false

rewardProvider · enum<string>

Required whenever isReward is true.

Available options: fija, aave

Example:

"aave"

rewardType · enum<string>

Must be regulated for fija and defi for aave.

Available options: regulated, defi

Example:

"defi"

useTransactionAmount · boolean

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

deductionPercentage · string

Percentage withheld from the settled amount before execution. Resets to "0" when omitted.

Example:

"0"

name · string

Example:

"Swap from USDT to OP USDC"

order · enum<string>

Resets to RECOMMENDED when omitted.

Available options: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE

Example:

"FASTEST"

slippageTolerance · string

Resets to "0" when omitted.

Example:

"5"

Response

200 - application/json

200

data · object

Show child attributes

message · string

Example:

"Auto settlement rule updated successfully"

statusCode · number

Example:

200