Master Wallet Update Rule

This endpoint allows you to update an existing auto-settlement rule for a specific wallet. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.

This endpoint is a partial merge: send only the fields you want to change and every other field on the rule keeps its current value. Nested objects are replaced wholesale, so when you send source or destination include the complete object. The merged rule is then re-validated, which means an update can be rejected because of a field you did not send.

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.
order	string	No	Routing preference for the swap leg. Possible values: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE.
slippageTolerance	string	No	The acceptable slippage tolerance (as a percentage). Example: "5" = 5% tolerance; "-1" for unlimited.
isGateway	boolean	No	Route the settlement through Circle’s Gateway. Must be true when the rule’s type is gateway, and false (or absent) for every other type.
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 the merged rule has isReward: true. Either fija or aave.
rewardType	string	Conditional	Required whenever the merged rule has isReward: 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.
deductionPercentage	string	No	Percentage withheld from the settled amount before execution, e.g. "2.5".
inheritance	object	No	Controls which child addresses this master-wallet rule cascades to. Send the complete object to change it.
├─ mode	string	Yes	One of master_only, all_children, or selected_children.
├─ childAddressIds	array of strings	Conditional	Required and non-empty when mode is selected_children.
source	object	No	Details about the source of the settlement.
├─ assets	array of strings	No	List of asset symbols this rule settles (e.g., ["USDT"]).
├─ minAmount	string	No	The minimum amount required for settlement (e.g., "1").
├─ maxAmount	string	No	The maximum amount that can be settled (e.g., "1000"), or "-1" for unlimited.
├─ blockchain	string	No	The blockchain network used for the settlement.
destination	object	No	Details about the destination of the settlement.
├─ asset	string	No	The asset the settlement is directed to.
├─ address	string	No	The address the settlement is sent to. Required once the rule’s type is withdraw.
├─ blockchain	string	No	The blockchain network for the destination. Must equal the source blockchain once the rule’s type is withdraw.

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

Master Wallet Update Rule

cURL

curl --request PATCH \
  --url https://api.blockradar.co/v1/wallets/{walletId}/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-26T15:44:05.940Z",
    "destination": {
      "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
      "asset": "USDC",
      "blockchain": "optimism"
    },
    "id": "b1517045-6817-4bc5-8cd5-72fd2283b444",
    "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-26T15:58:49.876Z"
  },
  "message": "Auto settlement rule updated successfully",
  "statusCode": 200
}

Authorizations

x-api-key · string · header · required

Path Parameters

walletId · string · required

Example:

"{{walletId}}"

id · string · required

Example:

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

Body

application/json

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"

destination · object

Show child attributes

isActive · boolean

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 the merged rule has isReward 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.

Example:

false

deductionPercentage · string

Percentage withheld from the settled amount before execution.

Example:

"0"

inheritance · object

Controls which child addresses this master-wallet rule cascades to. Send the complete object to change it.

Show child attributes

name · string

Example:

"Swap from USDT to OP USDC"

order · enum<string>

Available options: FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE

Example:

"FASTEST"

slippageTolerance · string

Example:

"5"

source · object

Show child attributes

Response

200 - application/json

200

data · object

Show child attributes

message · string

Example:

"Auto settlement rule updated successfully"

statusCode · number

Example:

200