Skip to main content
GET
Consultar saldo
Exige uma chave de API com o escopo balance:read. Para o extrato contábil completo (cada entrada de crédito e débito), veja “Extrato completo” logo abaixo.

Extrato completo

Para o histórico detalhado, use a sua sessão do painel (login) em vez da chave de API:
O extrato completo (/v1/ledger/statement) e o resumo do painel (/v1/dashboard/summary) exigem login de sessão — não estão disponíveis para chaves de API, que são pensadas para automação de cobrança, não para acesso administrativo à conta.

Authorizations

Authorization
string
header
required

Chave de API criada em Integrações → Chaves de API no painel.

Response

Saldo da conta

currency
string
required
Allowed value: "BRL"
availableCents
integer
required

Saldo livre para saque.

reservedCents
integer
required

Valor reservado por saques em análise.

blockedCents
integer
required

Valor bloqueado pela equipe da ZynPay.