Consultar o saldo
Devolve o saldo decomposto em baldes, em centavos inteiros, mais o teto do que pode ser pedido para saque agora.
Autenticação
A sessão do painel autentica esta rota, e ela é lida de forma autoritativa: não há parâmetro em que o chamador aponte para outra conta.
Esta rota não exige escopo nomeado — o que não quer dizer que ela seja aberta: sem a credencial acima ela recusa.
Exige sessão de vendedor. Tudo aqui é escopado pela sessão: não há parâmetro em que o chamador aponte para outra conta.
Parâmetros
Consulta
| Nome | Tipo | Descrição |
|---|---|---|
currency | um de: `BRL`, `USD`, `EUR` | A moeda do saldo. |
Respostas
200 · sucesso
{
"available": {
"amountCents": 129900,
"currency": "BRL"
},
"byDispatch": [
{
"available": {
"amountCents": 129900,
"currency": "BRL"
},
"debt": {
"amountCents": 129900,
"currency": "BRL"
},
"dispatch": 1,
"dispatchLabel": "exemplo",
"disputed": {
"amountCents": 129900,
"currency": "BRL"
},
"held": {
"amountCents": 129900,
"currency": "BRL"
},
"nextReleaseAt": "2026-01-15T12:00:00.000Z",
"pending": {
"amountCents": 129900,
"currency": "BRL"
},
"releaseDates": [
"2026-01-15T12:00:00.000Z"
],
"reserve": {
"amountCents": 129900,
"currency": "BRL"
}
}
],
"currency": "BRL",
"debt": {
"amountCents": 129900,
"currency": "BRL"
},
"debtTotal": {
"amountCents": 129900,
"currency": "BRL"
},
"disputed": {
"amountCents": 129900,
"currency": "BRL"
},
"held": {
"balance": {
"amountCents": 129900,
"currency": "BRL"
},
"reasons": [
"fraud_review"
]
},
"pending": {
"balance": {
"amountCents": 129900,
"currency": "BRL"
},
"nextReleaseAt": "2026-01-15T12:00:00.000Z",
"releaseDates": [
"2026-01-15T12:00:00.000Z"
]
},
"reserve": {
"amountCents": 129900,
"currency": "BRL"
},
"withdrawable": {
"amountCents": 129900,
"currency": "BRL"
}
}Saldo por balde. available é o que já liberou; pending é o que ainda vai liberar, e pending.releaseDates diz QUANDO. Esse prazo de LIBERAÇÃO não é a velocidade de EXECUÇÃO de um saque: um saldo já disponível é pago logo depois do pedido, enquanto um saldo pendente só entra no disponível na data que este campo publica. held é o retido, com o motivo ao lado; disputed é o que está em disputa; debt é a dívida em aberto, e é ela que explica a lacuna entre available e withdrawable. Cada entrada de byDispatch é um ENVIO, identificado por posição e rótulo. A origem do dinheiro não é nomeada nesta superfície. reserve é o que está preso a um saque já pedido, e também sai da conta entre available e withdrawable.