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
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 /v1/wallets/{walletId}/auto-settlements/rules

Try it

Master Wallet Create Rule

cURL

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 '
{
  "destination": {},
  "isActive": true,
  "isGateway": true,
  "name": "Swap from USDC to Gateway",
  "order": "FASTEST",
  "slippageTolerance": "5",
  "source": {
    "assets": [
      "USDC"
    ],
    "maxAmount": "1000",
    "minAmount": "1"
  }
}
'

200

Gateway 200

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

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

source. assets · string[]

Example:

["USDC"]

source. maxAmount · string

Example:

"1000"

source. minAmount · string

Example:

"1"

Response

200 - application/json

Regular 200 / Gateway 200

data · object

Show child attributes

data. destination · object

Show child attributes

data.destination. address · string

Example:

"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22"

data.destination. asset · string

Example:

"USDC"

data.destination. blockchain · string

Example:

"optimism"

data. id · string

Example:

"f2030948-fdb4-4d55-aba6-1e784ddb2e00"

data. isActive · boolean

Example:

true

data. isGateway · boolean

Example:

true

data. name · string

Example:

"Swap from USDC to Optimism USDC"

data. order · string

Example:

"FASTEST"

data. slippageTolerance · string

Example:

"5"

data. source · object

Show child attributes

data.source. assets · string[]

Example:

["USDC", "USDT"]

data.source. blockchain · string

Example:

"base"

data.source. maxAmount · string

Example:

"1000"

data.source. minAmount · string

Example:

"1"

message · string

Example:

"Auto settlement rule created successfully"

statusCode · number

Example:

201