> ## Documentation Index > Fetch the complete documentation index at: https://docs.blockradar.co/llms.txt > Use this file to discover all available pages before exploring further. # 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. | ## OpenAPI ````yaml post /v1/wallets/{walletId}/auto-settlements/rules openapi: 3.0.3 info: title: Blockradar Documentation description: >- The OpenAPI specification of the Blockradar 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.blockradar.co security: - apiKey: [] tags: - name: Rewards description: >- Non-custodial yield (Earn) on stablecoins via regulated (Fija) and DeFi (Aave) strategies. Deposit, withdraw, preview fees, and read positions and earnings at the business, wallet, and sub-address level. Amounts are returned net of the platform fee, which applies only to interest earned. - 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 - Gateway wallet integration - 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: Withdraw Fiat - 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: Liquidity Pool - name: Virtual Accounts description: >- Virtual Accounts API provides endpoints for managing virtual bank accounts linked to master wallets or child addresses. This API enables businesses to: - Create virtual accounts for customers to receive payments - Retrieve virtual account details - Activate/deactivate virtual accounts **Virtual Account Types:** Virtual accounts support different types with varying behaviors: 1. **AUTO_FUNDING** (Default): - Automatically mints stablecoin when fiat payments are received - Transfers the stablecoin to the linked wallet/address immediately - Best for real-time payment processing **How It Works - Auto-Funding Flow (AUTO_FUNDING type only):** When a customer sends fiat currency to a virtual account with type AUTO_FUNDING: 1. **Payment Receipt**: The payment is received in the virtual account 2. **Automatic Minting**: The system automatically mints the stablecoin equivalent 3. **Blockchain Transfer**: The minted stablecoin is transferred to the virtual account's linked wallet or address **Note**: The auto-funding flow only applies to virtual accounts with type `AUTO_FUNDING`. Other types have different processing behaviors. ## Prerequisites Before creating virtual accounts, ensure: - **Compliance requirements must be completed** (see [Compliance Requirements](http://localhost:3000/essentials/virtual-accounts#compliance-requirements) section below) - **Virtual accounts feature must be enabled** for your business (reach out to [support@blockradar.co](https://mailto:support@blockradar.co) or use live chat on the dashboard to enable the feature after compliance approval) - **Only available on MAINNET environment** (not available on testnet) - **Master Wallet must support stablecoin asset** - Your account plan must include stablecoin access (upgrade from Dashboard → Settings → Subscription if needed) **Supported Currency:** - Fiat: NGN (Nigerian Naira) - Stablecoin: cNGN - minted automatically on blockchain (for AUTO_FUNDING type) - 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 - Gateway vs non-gateway wallets Gateway rules are required for testnet wallets and must have matching source/destination assets. - 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: Gateway description: >- The Gateway feature enables you to programmatically deposit USDC into a unified, chain-abstracted balance and instantly mint USDC on any supported blockchain, streamlining crosschain transfers and eliminating manual bridging steps and rebalancing complexities. - name: Payment Links description: >- The Payment Pages API provides a quick and secure way to collect payment for servcies. - 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 Blockradar API. To see full list and instructions [https://docs.blockradar.co/essentials/webhooks](https://docs.blockradar.co/essentials/webhooks) ## - name: Deposit - name: Withdraw1 - name: Swap1 - name: Gateway1 paths: /v1/wallets/{walletId}/auto-settlements/rules: parameters: - name: walletId in: path required: true schema: type: string example: '{{walletId}}' post: tags: - Auto Settlements summary: Master Wallet Create Rule description: >+ 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. | operationId: masterWalletCreateRule requestBody: content: application/json: schema: type: object properties: destination: type: object properties: {} isActive: type: boolean example: true isGateway: type: boolean example: true name: type: string example: Swap from USDC to Gateway 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: Master Wallet Create Rule: value: destination: {} isActive: true isGateway: true name: Swap from USDC to Gateway order: FASTEST slippageTolerance: '5' source: assets: - USDC maxAmount: '1000' minAmount: '1' responses: '200': description: Regular 200 / Gateway 200 content: application/json: schema: type: object properties: data: type: object properties: destination: type: object properties: address: type: string example: '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22' asset: type: string example: USDC blockchain: type: string example: optimism id: type: string example: f2030948-fdb4-4d55-aba6-1e784ddb2e00 isActive: type: boolean example: true isGateway: 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 - USDT blockchain: type: string example: base maxAmount: type: string example: '1000' minAmount: type: string example: '1' message: type: string example: Auto settlement rule created successfully statusCode: type: number example: 201 examples: Gateway 200: value: 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 Regular 200: value: 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 components: securitySchemes: apiKey: type: apiKey name: x-api-key in: header ````