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 | 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. |
"{{walletId}}"
"534e0480-f444-40c0-bc2e-2ef17bf7999e"
Regular 200 / Gateway 200
The response is of type object
.