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.

| 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

Master Wallet Create Rule

cURL

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

200

{
  "data": {
    "destination": {
      "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
      "asset": "USDC",
      "blockchain": "optimism"
    },
    "id": "f2030948-fdb4-4d55-aba6-1e784ddb2e00",
    "isActive": true,
    "name": "Swap from USDC to Optimism USDC",
    "order": "FASTEST",
    "slippageTolerance": "5",
    "source": {
      "assets": [
        "USDC",
        "USDT"
      ],
      "blockchain": "base",
      "maxAmount": "1000",
      "minAmount": "1"
    }
  },
  "message": "Auto settlement rule created successfully",
  "statusCode": 201
}

授权

x-api-key · string · header · 必填

路径参数

walletId · string · 必填

示例:

"{{walletId}}"

请求体

application/json

destination · object

isActive · boolean

示例:

true

name · string

示例:

"Swap from USDC to Optimism USDC"

order · string

示例:

"FASTEST"

slippageTolerance · string

示例:

"5"

source · object

Show child attributes

响应

200 - application/json

200 OK

data · object

Show child attributes

message · string

示例:

"Auto settlement rule created successfully"

statusCode · number

示例:

201