Child Address Update Rule
curl --request PATCH \
--url https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"destination": {
"address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
"asset": "USDC",
"blockchain": "optimism"
},
"isActive": true,
"name": "Swap from USDT to OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": [
"USDT"
],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
}
}
'import requests
url = "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}"
payload = {
"destination": {
"address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
"asset": "USDC",
"blockchain": "optimism"
},
"isActive": True,
"name": "Swap from USDT to OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": ["USDT"],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: {
address: '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22',
asset: 'USDC',
blockchain: 'optimism'
},
isActive: true,
name: 'Swap from USDT to OP USDC',
order: 'FASTEST',
slippageTolerance: '5',
source: {assets: ['USDT'], blockchain: 'base', maxAmount: '1000', minAmount: '1'}
})
};
fetch('https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'destination' => [
'address' => '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22',
'asset' => 'USDC',
'blockchain' => 'optimism'
],
'isActive' => true,
'name' => 'Swap from USDT to OP USDC',
'order' => 'FASTEST',
'slippageTolerance' => '5',
'source' => [
'assets' => [
'USDT'
],
'blockchain' => 'base',
'maxAmount' => '1000',
'minAmount' => '1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}"
payload := strings.NewReader("{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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 OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": [
"USDT"
],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
},
"updatedAt": "2025-08-26T17:32:08.108Z"
},
"message": "Auto settlement rule updated successfully",
"statusCode": 200
}Liquidaciones Automáticas
Child Address Update Rule
This endpoint allows you to update an existing auto-settlement rule for a specific address. By providing the necessary parameters in the request body, you can modify the conditions and actions for the auto-settlement process.
Request Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | No | The name of the auto-settlement rule. A descriptive title reflecting its purpose. |
| isActive | boolean | No | Indicates whether the rule is currently active. true = enabled, false = disabled. |
| order | string | No | 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). Example: "5" = 5% tolerance. |
| source | object | No | Details about the source of the settlement. |
| ├─ assets | array of strings | No | List of asset types involved (e.g., ["USDT"]). |
| ├─ minAmount | string | No | The minimum amount required for settlement (e.g., "1"). |
| ├─ maxAmount | string | No | The maximum amount that can be settled (e.g., "1000"). |
| ├─ blockchain | string | No | The blockchain network used for the settlement. |
| destination | object | No | Details about the destination of the settlement. |
| ├─ asset | string | No | The asset type to which the settlement is directed. |
| ├─ address | string | No | The address where the settlement will be sent. |
| ├─ blockchain | string | No | The blockchain network for the destination. |
PATCH
/
v1
/
wallets
/
{walletId}
/
addresses
/
{addressId}
/
auto-settlements
/
rules
/
{id}
Child Address Update Rule
curl --request PATCH \
--url https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"destination": {
"address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
"asset": "USDC",
"blockchain": "optimism"
},
"isActive": true,
"name": "Swap from USDT to OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": [
"USDT"
],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
}
}
'import requests
url = "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}"
payload = {
"destination": {
"address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
"asset": "USDC",
"blockchain": "optimism"
},
"isActive": True,
"name": "Swap from USDT to OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": ["USDT"],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: {
address: '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22',
asset: 'USDC',
blockchain: 'optimism'
},
isActive: true,
name: 'Swap from USDT to OP USDC',
order: 'FASTEST',
slippageTolerance: '5',
source: {assets: ['USDT'], blockchain: 'base', maxAmount: '1000', minAmount: '1'}
})
};
fetch('https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'destination' => [
'address' => '0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22',
'asset' => 'USDC',
'blockchain' => 'optimism'
],
'isActive' => true,
'name' => 'Swap from USDT to OP USDC',
'order' => 'FASTEST',
'slippageTolerance' => '5',
'source' => [
'assets' => [
'USDT'
],
'blockchain' => 'base',
'maxAmount' => '1000',
'minAmount' => '1'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}"
payload := strings.NewReader("{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yiksipay.com/v1/wallets/{walletId}/addresses/{addressId}/auto-settlements/rules/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"address\": \"0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22\",\n \"asset\": \"USDC\",\n \"blockchain\": \"optimism\"\n },\n \"isActive\": true,\n \"name\": \"Swap from USDT to OP USDC\",\n \"order\": \"FASTEST\",\n \"slippageTolerance\": \"5\",\n \"source\": {\n \"assets\": [\n \"USDT\"\n ],\n \"blockchain\": \"base\",\n \"maxAmount\": \"1000\",\n \"minAmount\": \"1\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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 OP USDC",
"order": "FASTEST",
"slippageTolerance": "5",
"source": {
"assets": [
"USDT"
],
"blockchain": "base",
"maxAmount": "1000",
"minAmount": "1"
},
"updatedAt": "2025-08-26T17:32:08.108Z"
},
"message": "Auto settlement rule updated successfully",
"statusCode": 200
}Autorizaciones
Parámetros de ruta
Ejemplo:
"{{walletId}}"
Ejemplo:
"534e0480-f444-40c0-bc2e-2ef17bf7999e"
Ejemplo:
"55869cbe-fa3a-44d2-a7e3-d65c08355e4d"
Cuerpo
application/json