Balance

Returns the balance of the account right now. total is disponivel plus emLiquidacao plus the parts of bloqueado plus reserva.

GET /v2/ex/saldo

Scope: ex.saldo.read.

GET /v2/ex/saldo
→ 200
{
  "disponivel": "300.00",
  "saqueMaximo": "299.60",
  "emLiquidacao": "0.00",
  "bloqueado": { "med": "0.00", "judicial": "0.00", "chargeback": "0.00", "cautelar": "0.00" },
  "reserva": "0.00",
  "aReceber": "0.00",
  "aRecuperar": "0.00",
  "total": "300.00"
}

Field	Type	Description
`disponivel`	string	What can fund a payout right now. A payout reserves the amount plus the fee.
`saqueMaximo`	string	The largest payout the `disponivel` covers right now, with the payout fee on top, that fits in one Pix: in an account with a maximum amount per payout Pix, it does not go above it. It is not present with `data`, nor when the fee could not be calculated or the account the payout goes out through could not be read.
`tetoPorPix`	string	The maximum amount of one payout Pix in the account, when it is what limits the `saqueMaximo`: the `disponivel` covers more than one Pix, and the rest goes out in other payouts. It is not present when the maximum amount did not limit.
`emLiquidacao`	string	In transfer between institutions, when the account changes institutions. Payouts and refunds in progress do not appear here: they leave the `disponivel` and the `total` when they are created and come back if they are not completed.
`bloqueado.med`	string	On hold because of a dispute in progress. `GET /v2/ex/bloqueios` lists each hold.
`bloqueado.judicial`	string	On hold by court order.
`bloqueado.cautelar`	string	On hold for up to 72 hours for risk analysis.
`bloqueado.chargeback`	string	On hold because of a card dispute. Zero on Pix-only accounts.
`reserva`	string	Guarantee held for a period, returned to the available balance when it expires.
`aReceber`	string	Card and boleto receivables not yet settled. Outside the `total`.
`aRecuperar`	string	What you owe us. Outside the `total`.

Parameter	Type	Description
`subconta`	string	The balance of a sub-account. The response echoes `subconta`.
`data`	string	The closing balance of a closed day, `AAAA-MM-DD`.

To withdraw everything, use saqueMaximo in the valor of the payout: that amount fits in the balance, and one cent more responds 422 saldo_insuficiente. In an account with a maximum amount per payout Pix, when the balance covers that maximum plus the fee, the saqueMaximo is that maximum, the response brings tetoPorPix with the same amount, one cent more responds 422 valor_acima_do_maximo, and the rest goes out in another payout. The payout limits (see Limits) apply separately: a payout above them responds 422 limite_excedido. The calculation follows your fee, fixed, percentage or both. The payee receives the exact amount, and the fee comes out of the balance. If the balance changes before the payout and it responds 422, read the balance again. The Withdraw all button in the dashboard's Pix sending flow does not read this field: there, a sending above the maximum amount of each Pix goes out as several equal Pix, each with its own fee, and the button fills in the largest total that fits that way. This API does not split the payout.

Errors #

Status	`title`	When
400	`data_invalida`	`data` outside `AAAA-MM-DD`.
422	`dia_nao_encerrado`	`data` is the current day or a future day.
403	`subconta_de_outro`	The credential belongs to a sub-account and asked for another one.
404	`nao_encontrado`	The `subconta` does not exist in this account.