Saldo e extrato
Saiba quanto você pode usar agora e confira, lançamento por lançamento e em centavos, tudo o que mexeu no saldo disponível da conta.
Veja o disponível e o que está bloqueado.
Listar o extratoPercorra os lançamentos por cursor e filtre por período, end-to-end, valor ou pessoa.
Leia o saldo
| Campo | O que é |
|---|---|
available | O que pode sair por saque, pagamento de copia e cola ou devolução. Use para decidir se uma saída cabe. |
blocked | Está na conta, mas não pode ser usado. Os campos blockedBy… dizem o que o prende. |
O extrato não tem uma linha por operação.
O saque de 10000 com tarifa de 250 gera, no pedido, uma linha de -10250; se ele falhar, o valor volta numa linha positiva. Já a cobrança de 1500 entra numa linha de 1395, sem a tarifa. Por isso a soma de amount fecha com available, e balance traz esse número.
Concilie com os webhooks
Saldo e extrato não têm evento próprio. Para saber que o saldo mudou, use os eventos da operação que gerou a linha, listados na tabela de eventos. No saque, por exemplo, o disponível cai em WITHDRAW_CREATED, com a reserva, e volta em WITHDRAW_FAILED.
O endToEndId da linha é o mesmo dos eventos que o trazem, como PAYMENT_PAID e WITHDRAW_COMPLETED, o que permite casar os dois lados. Recomendamos o webhook como canal de aviso e o extrato como fonte da conciliação.