Check Balance
API Documentation · Zypher Global
Introduction
Authentication
Sandbox
PIX charge (BRL)
SPEI charge (MXN)
USDT charge
PIX withdrawal (key)
BR Code withdrawal
SPEI withdrawal (MXN)
USDT withdrawal
Splits (pass-through)
Check Balance
Convert Currency
Query Transactions
Webhooks
Error handling
GET /balance · permission balance
Returns the balance per currency for the authenticated account. Use it before triggering a withdrawal to confirm there is liquidity. Only currencies enabled in the system are returned.
Response
{
"ok": true,
"balances": {
"BRL": { "available": 1530.75, "blocked": 200.00 },
"MXN": { "available": 0.00, "blocked": 0.00 },
"USDT": { "available": 42.500000, "blocked": 0.000000 }
},
"blocked_currencies": ["BRL"],
"updated_at": "2026-07-24 12:00:00"
}
Fields
available— SPENDABLE amount. It is the only number you should use to decide a payment.blocked— HELD amount (e.g., by an open MED). Informational, explains why the available dropped; do NOT add it to available.blocked_currencies— currencies where holds are tracked. Today onlyBRL: for MXN/USDT theblockedis 0 by design, not because "nothing is held".
Never treat available + blocked as total spendable balance, the held amount cannot be withdrawn.
Was this page helpful?
