curl --request PATCH \
--url https://api.agg.market/execution/balance-refill-policies/{policyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-app-id: <api-key>' \
--data '
{
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>"
}
'import requests
url = "https://api.agg.market/execution/balance-refill-policies/{policyId}"
payload = {
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>"
}
headers = {
"x-app-id": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-app-id': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
minimumRaw: '<string>',
refillAmountRaw: '<string>',
dailyCapRaw: '<string>',
maxFeeRaw: '<string>'
})
};
fetch('https://api.agg.market/execution/balance-refill-policies/{policyId}', 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.agg.market/execution/balance-refill-policies/{policyId}",
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([
'minimumRaw' => '<string>',
'refillAmountRaw' => '<string>',
'dailyCapRaw' => '<string>',
'maxFeeRaw' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-app-id: <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.agg.market/execution/balance-refill-policies/{policyId}"
payload := strings.NewReader("{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-app-id", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.agg.market/execution/balance-refill-policies/{policyId}")
.header("x-app-id", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agg.market/execution/balance-refill-policies/{policyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-app-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"targetChainId": 123,
"targetTokenAddress": "<string>",
"targetTokenSymbol": "USDC",
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>",
"status": "enabled",
"cooldownSeconds": 61,
"lastObservedRaw": "<string>",
"lastEvaluatedAt": "2023-11-07T05:31:56Z",
"nextEligibleAt": "2023-11-07T05:31:56Z",
"consentedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"latestAttempt": {
"id": "<string>",
"policyId": "<string>",
"status": "reserved",
"triggerBalanceRaw": "<string>",
"requestedDeliveryRaw": "<string>",
"sourceAmountRaw": "<string>",
"completedAmountRaw": "<string>",
"sourceChainId": 123,
"targetChainId": 123,
"feeRaw": "<string>",
"errorMessage": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Update or pause a managed balance refill policy
curl --request PATCH \
--url https://api.agg.market/execution/balance-refill-policies/{policyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-app-id: <api-key>' \
--data '
{
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>"
}
'import requests
url = "https://api.agg.market/execution/balance-refill-policies/{policyId}"
payload = {
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>"
}
headers = {
"x-app-id": "<api-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-app-id': '<api-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
minimumRaw: '<string>',
refillAmountRaw: '<string>',
dailyCapRaw: '<string>',
maxFeeRaw: '<string>'
})
};
fetch('https://api.agg.market/execution/balance-refill-policies/{policyId}', 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.agg.market/execution/balance-refill-policies/{policyId}",
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([
'minimumRaw' => '<string>',
'refillAmountRaw' => '<string>',
'dailyCapRaw' => '<string>',
'maxFeeRaw' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-app-id: <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.agg.market/execution/balance-refill-policies/{policyId}"
payload := strings.NewReader("{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-app-id", "<api-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.agg.market/execution/balance-refill-policies/{policyId}")
.header("x-app-id", "<api-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.agg.market/execution/balance-refill-policies/{policyId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-app-id"] = '<api-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"minimumRaw\": \"<string>\",\n \"refillAmountRaw\": \"<string>\",\n \"dailyCapRaw\": \"<string>\",\n \"maxFeeRaw\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"targetChainId": 123,
"targetTokenAddress": "<string>",
"targetTokenSymbol": "USDC",
"minimumRaw": "<string>",
"refillAmountRaw": "<string>",
"dailyCapRaw": "<string>",
"maxFeeRaw": "<string>",
"status": "enabled",
"cooldownSeconds": 61,
"lastObservedRaw": "<string>",
"lastEvaluatedAt": "2023-11-07T05:31:56Z",
"nextEligibleAt": "2023-11-07T05:31:56Z",
"consentedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"latestAttempt": {
"id": "<string>",
"policyId": "<string>",
"status": "reserved",
"triggerBalanceRaw": "<string>",
"requestedDeliveryRaw": "<string>",
"sourceAmountRaw": "<string>",
"completedAmountRaw": "<string>",
"sourceChainId": 123,
"targetChainId": 123,
"feeRaw": "<string>",
"errorMessage": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Your application ID. Required for all app-tier and user-tier routes.
JWT access token returned by POST /auth/verify. Required for user-tier routes.
Path Parameters
Body
Refill when the target-chain balance falls below this. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Amount to deliver per refill. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Most that can be refilled per day. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Most one refill may pay in transfer fees. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$enabled: refills run. paused: no refills until re-enabled.
enabled, paused Response
200
Policy id.
Chain kept topped up.
USDC contract on that chain.
Always USDC.
USDC Refill when the target-chain balance falls below this. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Amount to deliver per refill. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Most that can be refilled per day. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$Most one refill may pay in transfer fees. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[1-9][0-9]*$enabled: refills run. paused: no refills until re-enabled.
enabled, paused Minimum seconds between refills.
x >= 60Target-chain balance at the last check. USD in 6-decimal atomic units, as an integer string (1000000 = $1.00).
^[0-9]+$When the balance was last checked.
Earliest time the next refill may run.
When the user consented.
Creation time.
Time of the last change.
Most recent refill attempt, if any.
Show child attributes
Show child attributes