Automate asset settlements and conversions across blockchain networks
Component | Description | Example |
---|---|---|
Rule Name | Descriptive name for your settlement rule | ”Swap from USDC to Optimism USDC” |
Order | Execution priority preference | FASTEST, CHEAPEST, RECOMMENDED, NO_SLIPPAGE |
Slippage Tolerance | Maximum acceptable price deviation (%) | 5 |
Source Assets | Array of assets to auto-settle | [“USDC”, “USDT”] |
Source Min/Max Amount | Control deposit size that triggers settlement | Min: 1,000 |
Destination Blockchain | Target blockchain network | optimism, base, ethereum |
Destination Asset | Target asset for conversion | USDC, USDT, cNGN, DAI |
Destination Address | Specific address to receive converted assets | 0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22 |
Is Gateway | Enable gateway functionality for the rule | false |
Event | Description |
---|---|
swap.success | Auto-settlement swap was successfully executed |
swap.failed | Auto-settlement swap failed to execute |
Field | Description |
---|---|
metadata.swapAutoSettlement.rule | Complete auto-settlement rule payload that triggered this swap |
metadata.swapAutoSettlement.settleAmount | Amount that was settled according to the rule |
metadata.transactionId | Internal transaction ID for tracking |
metadata.swapAutoSettlement
is present, the swap was triggered by an auto-settlement rule. The rule
field contains the complete rule configuration, not just an ID.Field | Description |
---|---|
toAmount | Final amount received after swap (accounting for fees and slippage) |
rate | Exchange rate used for the swap |
toAsset | Destination asset details (USDT in this example) |
toBlockchain | Destination blockchain network (Optimism in this example) |
toWallet | Destination wallet that received the converted assets |
assetSwept | Whether the original assets were swept after conversion |
Endpoint | Method | Description | API Reference |
---|---|---|---|
/v1/wallets/{walletId}/auto-settlements/rules | GET | List all settlement rules for master wallet | Get All Rules |
/v1/wallets/{walletId}/auto-settlements/rules | POST | Create new settlement rule for master wallet | Create Rule |
/v1/wallets/{walletId}/auto-settlements/rules/{id} | GET | Get specific master wallet rule details | Get Rule |
/v1/wallets/{walletId}/auto-settlements/rules/{id} | PATCH | Update existing master wallet rule | Update Rule |
/v1/wallets/{walletId}/auto-settlements/rules/{id} | DELETE | Delete master wallet settlement rule | Delete Rule |
/v1/wallets/{walletId}/auto-settlements | GET | Get master wallet settlement history | Get Settlement |
/v1/wallets/{walletId}/auto-settlements | PATCH | Update master wallet settlement settings | Update Settlement |
Endpoint | Method | Description | API Reference |
---|---|---|---|
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules | GET | List all settlement rules for specific address | Get All Rules |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules | POST | Create new settlement rule for specific address | Create Rule |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} | GET | Get specific address rule details | Get Rule |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} | PATCH | Update existing address rule | Update Rule |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} | DELETE | Delete address settlement rule | Delete Rule |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements | GET | Get address settlement history | Get Settlement |
/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements | PATCH | Update address settlement settings | Update Settlement |
Parameter | Type | Required | Description |
---|---|---|---|
name | string | Yes | Rule name for identification |
order | string | Yes | Execution priority (FASTEST/CHEAPEST/RECOMMENDED/NO_SLIPPAGE) |
slippageTolerance | number | Yes | Maximum acceptable slippage (%) |
isGateway | boolean | false | Enable gateway functionality for the rule |
source.assets | array | Yes | Array of source assets to auto-settle |
source.minAmount | string | No | Minimum amount to trigger settlement |
source.maxAmount | string | No | Maximum amount per settlement |
destination.blockchain | string | Yes | Target blockchain network |
destination.asset | string | Yes | Target asset for conversion |
destination.address | string | Yes | Destination address to receive converted assets |