> ## Documentation Index > Fetch the complete documentation index at: https://docs.yiksipay.com/llms.txt > Use this file to discover all available pages before exploring further. # Child Address Create Rule > 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. ## 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. | ## OpenAPI ````yaml post /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules openapi: 3.0.3 info: title: Yiksi Pay Documentation description: >- The OpenAPI specification of the Yiksi Pay API that enables fintechs and developers to seamlessly integrate stablecoin deposits and payments into their products. version: 1.0.0 contact: {} servers: - url: https://api.yiksipay.com security: - apiKey: [] tags: - name: Wallet description: >- Wallet Management System Comprehensive wallet management API for multi-blockchain operations. This system handles wallet creation, configuration, balance monitoring, and integration with various blockchain networks. Core Functionality: - Multi-blockchain wallet creation and management - Balance monitoring and asset tracking - Auto-settlement rule configuration - Address generation and management - Transaction monitoring and processing - name: Addresses description: >- Address Management System Comprehensive blockchain address management API for operations. This system handles address creation, validation, monitoring, and management across multiple blockchain networks. Core Functionality: - Multi-blockchain address generation - Address validation and verification - Balance monitoring and tracking - Transaction history management - Address labeling and organization - Integration with wallet systems - Real-time address monitoring - name: Asset - name: Transactions - name: Withdraw description: >- The Withdraw feature allows you to programmatically withdraw stablecoins from your master wallet with ease - name: Signing description: >- Typed data signing service for secure transaction authorization. Supports all EIP-712 standards including EIP-3009 (TransferWithAuthorization) and EIP-2612 (Permit). - name: Swap description: >- The Swap feature enables users to exchange one stabelcoin asset for another across different blockchains. This feature provides a seamless way to convert between different stablecoins while maintaining security and compliance standards. - name: Auto Settlements description: >- Creates a new auto settlement rule for a wallet. Auto settlement automatically transfers/swap assets based on configured rules when certain conditions are met. Rules can be configured for: - Source blockchain and assets - Destination blockchain and asset - Amount ranges (min/max) - Slippage tolerance - name: Smart Contract description: >- This API provides endpoints for interacting with smart contracts on the blockchain. It allows for reading contract data, executing contract functions, and estimating network fees. - name: Beneficiaries description: >- This API allows you to create beneficiaries with automatic settlements to your external wallets on a periodic basis. Example frequencies: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY - name: AML description: >- The AML (Anti Money Laundering) API provides a quick way for you to check if an address is blacklisted or sanctioned - name: Asset Recovery description: >- Enables the recovery (salvage) of both native blockchain assets and tokens from a specified sender address to a recipient address. This feature supports emergency fund recovery and asset consolidation operations. - name: Miscellaneous description: >- The Miscellaneous API are supporting APIs that can be used to provide more details to other APIs. - name: Asset1 - name: Blockchain - name: Webhooks description: >- Webhooks allow you to set up a notification system that can be used to receive updates on certain requests made to the Yiksi Pay API. To see full list and instructions [https://docs.yiksipay.com/essentials/webhooks](https://docs.yiksipay.com/essentials/webhooks) ## - name: Deposit - name: Withdraw1 - name: Swap1 paths: /v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules: parameters: - name: walletId in: path required: true schema: type: string example: '{{walletId}}' - name: addressId in: path required: true schema: type: string example: 534e0480-f444-40c0-bc2e-2ef17bf7999e post: tags: - Auto Settlements summary: Child Address Create Rule description: > 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. ## 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. | operationId: childAddressCreateRule requestBody: content: application/json: schema: type: object properties: destination: type: object properties: {} isActive: type: boolean example: true name: type: string example: Swap from USDC to Optimism USDC order: type: string example: FASTEST slippageTolerance: type: string example: '5' source: type: object properties: assets: type: array items: type: string example: USDC example: - USDC maxAmount: type: string example: '1000' minAmount: type: string example: '1' examples: Child Address Create Rule: value: destination: {} isActive: true name: Swap from USDC to Optimism USDC order: FASTEST slippageTolerance: '5' source: assets: - USDC maxAmount: '1000' minAmount: '1' responses: '200': description: 200 OK content: application/json: schema: type: object properties: data: type: object properties: createdAt: type: string example: '2025-08-26T17:28:38.273Z' destination: type: object properties: address: type: string example: '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22' asset: type: string example: USDC blockchain: type: string example: optimism id: type: string example: 48c52f4a-c0bf-45c9-a322-1fef00f00431 isActive: type: boolean example: true name: type: string example: Swap from USDT to Optimism USDC order: type: string example: FASTEST slippageTolerance: type: string example: '5' source: type: object properties: assets: type: array items: type: string example: USDT example: - USDT blockchain: type: string example: base maxAmount: type: string example: '1000' minAmount: type: string example: '1' updatedAt: type: string example: '2025-08-26T17:28:38.273Z' message: type: string example: Auto settlement rule created successfully statusCode: type: number example: 200 examples: Regular 200: value: data: createdAt: '2025-08-26T17:28:38.273Z' destination: address: '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22' asset: USDC blockchain: optimism id: 48c52f4a-c0bf-45c9-a322-1fef00f00431 isActive: true name: Swap from USDT to Optimism USDC order: FASTEST slippageTolerance: '5' source: assets: - USDT blockchain: base maxAmount: '1000' minAmount: '1' updatedAt: '2025-08-26T17:28:38.273Z' message: Auto settlement rule created successfully statusCode: 200 components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header ````