Creators · Treasury
Fetches balance.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the money resource group disabled get 403 resource_group_disabled. Authentication
This endpoint is enabled per workspace. Until it is, calls return 403 feature_not_available. Email support@pozy.ai to turn it on.
Example
curl -X GET "https://api.pozy.ai/v1/balance" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/balance", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/balance",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
availableCentsintegerpayoutLockedCentsintegerpayoutLocksarray of objecttopupIdstringrequiredamountCentsintegerrequiredchargedAtstring (date-time)requiredunlocksAtstring (date-time)required
pendingCentsintegerpendingReleasesarray of objecttopupIdstringrequiredamountCentsintegerrequiredavailableAtstring (date-time)required
pendingTopupCentsintegercurrencystringOne of
usd.recentTopupsarray of object11 child fields
idstringmethodstringOne of
card,bank_transfer.purposestringOne of
balance,payout_batch.payoutBatchobjectCan be null.
2 child fields
idstringcampaignIdstringCan be null.
feeCoveredByPozybooleanamountCentsintegerstripeFeeCentsintegerCan be null.
netCentsintegerCan be null.
statusstringOne of
pending,succeeded,failed,expired.createdAtstring (date-time)succeededAtstring (date-time)Can be null.
200 response
{
"availableCents": 1,
"payoutLockedCents": 1,
"payoutLocks": [
{
"topupId": "661baaf62e351f4bf7700103",
"amountCents": 1,
"chargedAt": "2026-10-02T09:00:00.000Z",
"unlocksAt": "2026-10-02T09:00:00.000Z"
}
],
"pendingCents": 1,
"pendingReleases": [
{
"topupId": "661baaf62e351f4bf7700103",
"amountCents": 1,
"availableAt": "2026-10-02T09:00:00.000Z"
}
],
"pendingTopupCents": 1,
"currency": "usd",
"recentTopups": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"method": "card",
"purpose": "balance",
"payoutBatch": {
"id": "6bfebd43ddc270f6d2c56fc5",
"campaignId": "65a3737dd8b11ea61f199e6e"
},
"feeCoveredByPozy": true,
"amountCents": 1,
"stripeFeeCents": 1,
"netCents": 1,
"status": "pending",
"createdAt": "2026-10-02T09:00:00.000Z",
"succeededAt": "2026-10-02T09:00:00.000Z"
}
]
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.