Master Wallet Create Rule

curl --request POST \
  --url https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "gateway",
  "destination": {},
  "isActive": true,
  "isGateway": true,
  "name": "Swap from USDC to Gateway",
  "order": "FASTEST",
  "slippageTolerance": "5",
  "source": {
    "assets": [
      "USDC"
    ],
    "maxAmount": "1000",
    "minAmount": "1"
  }
}
'

import requests

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

payload = {
    "type": "gateway",
    "destination": {},
    "isActive": True,
    "isGateway": True,
    "name": "Swap from USDC to Gateway",
    "order": "FASTEST",
    "slippageTolerance": "5",
    "source": {
        "assets": ["USDC"],
        "maxAmount": "1000",
        "minAmount": "1"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'gateway',
    destination: {},
    isActive: true,
    isGateway: true,
    name: 'Swap from USDC to Gateway',
    order: 'FASTEST',
    slippageTolerance: '5',
    source: {assets: ['USDC'], maxAmount: '1000', minAmount: '1'}
  })
};

fetch('https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'gateway',
    'destination' => [
        
    ],
    'isActive' => true,
    'isGateway' => true,
    'name' => 'Swap from USDC to Gateway',
    'order' => 'FASTEST',
    'slippageTolerance' => '5',
    'source' => [
        'assets' => [
                'USDC'
        ],
        '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"

	payload := strings.NewReader("{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\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")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}"

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

{
  "type": "swap",
  "data": {
    "destination": {
      "address": "0x77777777Dcc4d5A8B6E418Fd04D8997ef11000eE",
      "asset": "USDC",
      "blockchain": "base"
    },
    "id": "586db9b9-a6d8-4185-af72-395f21254eaf",
    "isActive": true,
    "isGateway": true,
    "name": "Swap from USDC to Gateway",
    "order": "FASTEST",
    "slippageTolerance": "5",
    "source": {
      "assets": [
        "USDC"
      ],
      "blockchain": "base",
      "maxAmount": "1000",
      "minAmount": "1"
    }
  },
  "message": "Auto settlement rule created successfully",
  "statusCode": 201
}

Master Wallet Create Rule

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

Request Body Parameters

Parameter	Type	Required	Description
type	string	No	The settlement rule type: `withdraw`, `swap`, `gateway`, or `earn`. Recommended on every create; rules saved without it keep the legacy inferred behavior. `withdraw` settles each deposited source asset as-is to `destination.address` on the source blockchain (address required).
name	string	Yes	The name of the auto-settlement rule. A descriptive title reflecting its purpose.
order	string	Yes	The order in which this rule should be processed. Possible values: `FASTEST`, `CHEAPEST`, `RECOMMENDED`, `NO_SLIPPAGE`.
slippageTolerance	string	Yes	The acceptable slippage tolerance (as a percentage). Example: `"5"` = 5% tolerance.
isGateway	boolean	Yes	Indicates whether the rule involves a gateway. `true` if processed through a gateway.
source	object	Yes	Details about the source of the settlement.
├─ assets	array of strings	Yes	List of asset types involved (e.g., `["USDC"]`).
├─ minAmount	string	Yes	The minimum amount required for settlement (e.g., `"1"`).
├─ maxAmount	string	Yes	The maximum amount that can be settled (e.g., `"1000"`).
destination	object	Yes	Details about the destination of the settlement.
├─ blockchain	string	No	The blockchain network for the destination.
├─ asset	string	No	The asset type to which the settlement is directed.
├─ address	string	No	The address where the settlement will be sent.

POST

wallets

{walletId}

auto-settlements

rules

Master Wallet Create Rule

curl --request POST \
  --url https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "gateway",
  "destination": {},
  "isActive": true,
  "isGateway": true,
  "name": "Swap from USDC to Gateway",
  "order": "FASTEST",
  "slippageTolerance": "5",
  "source": {
    "assets": [
      "USDC"
    ],
    "maxAmount": "1000",
    "minAmount": "1"
  }
}
'

import requests

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

payload = {
    "type": "gateway",
    "destination": {},
    "isActive": True,
    "isGateway": True,
    "name": "Swap from USDC to Gateway",
    "order": "FASTEST",
    "slippageTolerance": "5",
    "source": {
        "assets": ["USDC"],
        "maxAmount": "1000",
        "minAmount": "1"
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'gateway',
    destination: {},
    isActive: true,
    isGateway: true,
    name: 'Swap from USDC to Gateway',
    order: 'FASTEST',
    slippageTolerance: '5',
    source: {assets: ['USDC'], maxAmount: '1000', minAmount: '1'}
  })
};

fetch('https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'gateway',
    'destination' => [
        
    ],
    'isActive' => true,
    'isGateway' => true,
    'name' => 'Swap from USDC to Gateway',
    'order' => 'FASTEST',
    'slippageTolerance' => '5',
    'source' => [
        'assets' => [
                'USDC'
        ],
        '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"

	payload := strings.NewReader("{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.blockradar.co/v1/wallets/{walletId}/auto-settlements/rules")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\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")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"gateway\",\n  \"destination\": {},\n  \"isActive\": true,\n  \"isGateway\": true,\n  \"name\": \"Swap from USDC to Gateway\",\n  \"order\": \"FASTEST\",\n  \"slippageTolerance\": \"5\",\n  \"source\": {\n    \"assets\": [\n      \"USDC\"\n    ],\n    \"maxAmount\": \"1000\",\n    \"minAmount\": \"1\"\n  }\n}"

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

{
  "type": "swap",
  "data": {
    "destination": {
      "address": "0x77777777Dcc4d5A8B6E418Fd04D8997ef11000eE",
      "asset": "USDC",
      "blockchain": "base"
    },
    "id": "586db9b9-a6d8-4185-af72-395f21254eaf",
    "isActive": true,
    "isGateway": true,
    "name": "Swap from USDC to Gateway",
    "order": "FASTEST",
    "slippageTolerance": "5",
    "source": {
      "assets": [
        "USDC"
      ],
      "blockchain": "base",
      "maxAmount": "1000",
      "minAmount": "1"
    }
  },
  "message": "Auto settlement rule created successfully",
  "statusCode": 201
}

Authorizations

x-api-key

string

header

required

Path Parameters

walletId

string

required

Example:

"{{walletId}}"

Body

application/json

type

enum<string>

Settlement rule type. Recommended on every create; rules saved without it keep the legacy inferred behavior.

Available options:

withdraw,

swap,

gateway,

earn

Example:

"swap"

destination

object

isActive

boolean

Example:

true

isGateway

boolean

Example:

true

name

string

Example:

"Swap from USDC to Gateway"

order

string

Example:

"FASTEST"

slippageTolerance

string

Example:

"5"

source

object

Show child attributes

Response

200 - application/json

Regular 200 / Gateway 200

data

object

Show child attributes

message

string

Example:

"Auto settlement rule created successfully"

statusCode

number

Example:

201

Get Started

Wallets

Receive Payments

Send Payments

Convert & Manage

Compliance & Recovery

Integrations

Master Wallet Create Rule

Request Body Parameters

Authorizations

Path Parameters

Body

Response