This endpoint allows you to create a new auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can define the conditions and actions for the auto-settlement process.
| 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 | No | The acceptable slippage tolerance (as a percentage). Use "-1" for unlimited slippage (default). Example: "5" = 5% tolerance. |
| isGateway | boolean | No | 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 | No | The minimum amount required for settlement. Use "-1" for no minimum. Example: "1". |
| ├─ maxAmount | string | No | The maximum amount that can be settled. Use "-1" for unlimited. Example: "1000". |
| destination | object | Yes | Details about the destination of the settlement. |
| ├─ blockchain | string | Yes | The blockchain network for the destination. |
| ├─ asset | string | Yes | The asset type to which the settlement is directed. |
| ├─ address | string | No | The address where the settlement will be sent. If omitted, smart fallback logic applies: same-chain uses deposit address, EVM-to-EVM uses same address, cross-chain (non-EVM) uses destination master wallet. |
"{{walletId}}"
"534e0480-f444-40c0-bc2e-2ef17bf7999e"