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",
"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. |
emLiquidacao |
string | Saiu do disponível e ainda não chegou ao destino. |
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 prazo. Zero em contas só Pix. |
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. |
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. |