Balance
Retrieve the balance
Settled USDC held for you in the ZyloPay settlement contract on the key's network, read from the chain.
GET
/v1/balancescope balance:readWithdraw it to your settlement wallet from the dashboard.
Headers
ZyloPay-VersionstringPin the request to an API version (2026-09-28). Defaults to the version the API key was created with.
Returns
HTTP 200 with the balance object.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request (invalid_request_error / idempotency_error). |
401 | Missing, invalid, expired or revoked API key (authentication_error). |
403 | The key lacks the scope, the IP is not allowed, or the account is disabled (permission_error). |
429 | Rate limit reached for this key (rate_limit_error); see Retry-After. |
500 | Internal error (api_error). Retry with the same Idempotency-Key. |
Branch on error.code. Every code is listed in error codes.
Example request
curl https://zylopay-api.fly.dev/api/v1/balance \
-H "Authorization: Bearer $ZYLOPAY_SECRET_KEY"Example response
{
"object": "balance",
"livemode": false,
"available": [
{
"amount": 125000000,
"currency": "usdc"
}
],
"network": "testnet",
"as_of": "2026-09-28T15:12:00.000Z"
}