Saldo

Devolve o saldo da conta agora. total é disponivel mais emLiquidacao mais as parcelas de bloqueado mais reserva.

GET /v2/ex/saldo

Escopo: 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"
}

Campo	Tipo	Descrição
`disponivel`	string	O que atende saque agora. Um saque reserva o valor mais a tarifa.
`saqueMaximo`	string	O maior saque que o `disponivel` cobre agora, com a tarifa do saque por cima, e que cabe num Pix: na conta com valor máximo por Pix de saque, não passa dele. Não vem com `data`, nem quando a tarifa não pôde ser calculada ou a conta por onde o saque sai não pôde ser lida.
`tetoPorPix`	string	O valor máximo de um Pix de saque na conta, quando é ele que limita o `saqueMaximo`: o `disponivel` cobre mais que um Pix, e o resto sai em outros saques. Não vem quando o valor máximo não limitou.
`emLiquidacao`	string	Em transferência entre instituições, quando a conta troca de instituição. Saque e devolução em curso não aparecem aqui: saem do `disponivel` e do `total` ao serem criados e voltam se não se realizarem.
`bloqueado.med`	string	Retido por uma contestação em curso. `GET /v2/ex/bloqueios` lista cada retenção.
`bloqueado.judicial`	string	Retido por ordem judicial.
`bloqueado.cautelar`	string	Retido por até 72 horas por análise de risco.
`bloqueado.chargeback`	string	Retido por disputa de cartão. Zero em contas só Pix.
`reserva`	string	Garantia retida por um prazo, que volta ao disponível no vencimento.
`aReceber`	string	Recebível de cartão e boleto ainda não liquidado. Fora do `total`.
`aRecuperar`	string	O que você deve a nós. Fora do `total`.

Parâmetro	Tipo	Descrição
`subconta`	string	O saldo de uma sub-conta. A resposta ecoa `subconta`.
`data`	string	O saldo de fechamento de um dia encerrado, `AAAA-MM-DD`.

Para sacar tudo, use saqueMaximo no valor do saque: esse valor cabe no saldo, e um centavo a mais responde 422 saldo_insuficiente. Na conta com valor máximo por Pix de saque, quando o saldo cobre esse máximo mais a tarifa, o saqueMaximo é esse máximo, a resposta traz tetoPorPix com o mesmo valor, um centavo a mais responde 422 valor_acima_do_maximo, e o resto sai em outro saque. Os tetos de saque (ver Limites) valem à parte: um saque acima deles responde 422 limite_excedido. O cálculo segue a sua tarifa, fixa, percentual ou as duas. O favorecido recebe o valor exato, e a tarifa sai do saldo. Se o saldo mudar antes do saque e ele responder 422, consulte o saldo de novo. O botão Sacar tudo do envio de Pix no painel não lê este campo: lá o envio acima do valor máximo de cada Pix sai em vários Pix iguais, cada um com a sua tarifa, e o botão preenche o maior total que cabe assim. Esta API não divide o saque.

Erros #

Status	`title`	Quando
400	`data_invalida`	`data` fora de `AAAA-MM-DD`.
422	`dia_nao_encerrado`	`data` é o dia corrente ou futuro.
403	`subconta_de_outro`	A credencial é de uma sub-conta e pediu outra.
404	`nao_encontrado`	A `subconta` não existe nesta conta.