Master Wallet Update Rule

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

import requests

url = "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}"

payload = {
    "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"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}"

	payload := strings.NewReader("{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}"

response = http.request(request)
puts response.read_body

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

Auto Settlements

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

wallets

{walletId}

auto-settlements

rules

{id}

Master Wallet Update Rule

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

import requests

url = "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}"

payload = {
    "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"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}
  })
};

fetch('https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}"

	payload := strings.NewReader("{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"swap\",\n  \"destination\": {\n    \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n    \"asset\": \"USDC\",\n    \"blockchain\": \"optimism\"\n  },\n  \"isActive\": true,\n  \"name\": \"Swap from USDT to OP USDC\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDT\"\n    ],\n    \"blockchain\": \"base\",\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}"

response = http.request(request)
puts response.read_body

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

Autorizaciones

x-api-key

string

header

requerido

Parámetros de ruta

walletId

string

requerido

Ejemplo:

"{{walletId}}"

string

requerido

Ejemplo:

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

Cuerpo

application/json

productKey

string

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.

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.

Opciones disponibles:

withdraw,

swap,

gateway,

earn

Ejemplo:

"swap"

destination

object

Show child attributes

isActive

boolean

Ejemplo:

true

isGateway

boolean

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

Ejemplo:

false

isReward

boolean

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

Ejemplo:

false

rewardProvider

enum<string>

Required whenever the merged rule has isReward true.

Opciones disponibles:

aave,

compound

Ejemplo:

"aave"

rewardType

enum<string>

Only defi is currently offered.

Opciones disponibles:

defi

Ejemplo:

"defi"

useTransactionAmount

boolean

false settles the address's current balance of the source asset; true settles only the triggering deposit amount.

Ejemplo:

false

deductionPercentage

string

Percentage withheld from the settled amount before execution.

Ejemplo:

"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

Ejemplo:

"Swap from USDT to OP USDC"

order

enum<string>

Opciones disponibles:

FASTEST,

CHEAPEST,

RECOMMENDED,

NO_SLIPPAGE

Ejemplo:

"FASTEST"

slippageTolerance

string

Ejemplo:

"5"

source

object

Show child attributes

Respuesta

200 - application/json

200

data

object

Show child attributes

message

string

Ejemplo:

"Auto settlement rule updated successfully"

statusCode

number

Ejemplo:

200