Consultar Saldo

Documentação da API · Zypher Global

Gerar credenciais

GET /balance · permissão balance

Devolve o saldo por moeda da conta autenticada. Use antes de disparar um saque pra confirmar que há liquidez. Só retornam as moedas habilitadas no sistema.

Resposta
{
  "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"
}

Campos

  • available — valor GASTÁVEL. É o único número que você deve usar pra decidir um pagamento.
  • blocked — valor RETIDO (ex.: por MED em aberto). Informativo, explica por que o disponível caiu; NÃO some com o available.
  • blocked_currencies — moedas onde a retenção é monitorada. Hoje só BRL: em MXN/USDT o blocked vem 0 por estrutura, não por "nada retido".
Nunca trate available + blocked como saldo total pra pagamento, o retido não é sacável.
Esta página foi útil?