Saldo

Consultar Saldo

Saldo atual e histórico agregado por período da conta titular.

Objetivo

Posição financeira da conta agora e visão agregada entre duas datas.

Para movimentos linha a linha use Extrato.

Pré-requisito: Login da conta. Scope baas.balances.read.

Regras

  • Consultar (/balances): posição no momento da chamada (valores em centavos na resposta típica). Três campos: balance (disponível), blocked_balance (bloqueado) e reserved_balance (reservado).
  • Consultar por período (/balances/period): snapshots diários entre start_date e end_date (YYYY-MM-DD). Útil para gráficos, não substitui extrato nem conciliação contábil.
  • Saldo pontual não prova transação individual.

Contrato HTTP: Consultar saldo.

Endpoints

Consultar

MétodoGET
Path/api/v2/baas/balances

Contrato: Consultar saldo.

Autenticação

Bearer da conta, HMAC. Corpo [] na assinatura.

Regras de negócio

  • Três posições: balance (disponível para cash-out e pagamentos), blocked_balance (MED, Pix automático, boleto em processo, etc.) e reserved_balance (retenção contratual sobre Pix cash-in). Reservado não é o mesmo que bloqueado. A reserva reduz o disponível e não entra em cash-out até a devolução operacional (fora desta API).

Consultar por período

MétodoGET
Path/api/v2/baas/balances/period

Contrato: Saldo por período.

Query

start_date, end_date obrigatórios (YYYY-MM-DD).

Regras de negócio

  • Agregado no intervalo; omitir datas tende a 400.

2025 © Nuvende - CNPJ 38.297.374/0001-93