Get Pool Balance
curl --request GET \
--url https://api.example.com/api/v1/management/pool/balance \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/management/pool/balance"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.example.com/api/v1/management/pool/balance', 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.example.com/api/v1/management/pool/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/management/pool/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/management/pool/balance")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/management/pool/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"collated_balance": "<string>",
"pool_balance": "<string>",
"merchant_balance": "<string>",
"balance": "<string>",
"currency": "<string>",
"low_threshold": "<string>",
"is_low": true,
"remaining_before_alert": "<string>",
"auto_top_up_enabled": true
}Pool
Get Pool Balance
Returns the current USDC balance breakdown and low-balance alert status for your company, including central pool balance and collated merchant wallet balances.
GET
/
api
/
v1
/
management
/
pool
/
balance
Get Pool Balance
curl --request GET \
--url https://api.example.com/api/v1/management/pool/balance \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.example.com/api/v1/management/pool/balance"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.example.com/api/v1/management/pool/balance', 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.example.com/api/v1/management/pool/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <x-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"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/management/pool/balance"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/management/pool/balance")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/management/pool/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"collated_balance": "<string>",
"pool_balance": "<string>",
"merchant_balance": "<string>",
"balance": "<string>",
"currency": "<string>",
"low_threshold": "<string>",
"is_low": true,
"remaining_before_alert": "<string>",
"auto_top_up_enabled": true
}Headers
string
required
Your test or live SDK API key (
pk_test_... or pk_live_...).Response Fields
string
Total aggregated balance across the central treasury pool and all merchant Privy wallets under the company (in USDC).
string
Current balance in the company’s central deposit/treasury pool (in USDC).
string
Aggregate balance held across all merchant wallets owned by the company (in USDC).
string
Deprecated alias for
pool_balance maintained for backwards compatibility.string
Settlement currency code (
USDC).string
Minimum pool balance threshold before low-balance alerts trigger.
boolean
true if pool_balance is lower than low_threshold.string
Difference between
pool_balance and low_threshold.boolean
Indicates whether auto-top-up is enabled for the company pool.
Response Example
{
"collated_balance": "6250.750000",
"pool_balance": "5000.000000",
"merchant_balance": "1250.750000",
"balance": "5000.000000",
"currency": "USDC",
"low_threshold": "1000.000000",
"is_low": false,
"remaining_before_alert": "4000.000000",
"auto_top_up_enabled": false
}

