Skip to main content
GET

Descrição

Consulta seu saldo atual disponível para saque e o valor de qualquer saque pendente.

Headers

string
required
Bearer token com sua API Key

Response

boolean
Indica se a operação foi bem-sucedida
object
Informações do saldo

Observações

Saldo disponível vs Saldo sacável: O available representa o saldo total, mas o withdrawable é o que realmente pode ser sacado (desconta valores congelados por MEDs).
Breakdown por provider: A plataforma utiliza múltiplos providers (Cartwave e Woovi). O saldo é separado por provider, mas o available mostra o total consolidado.
MEDs ativos: Se você tiver contestações (MEDs) pendentes, parte do seu saldo estará em frozen e não disponível para saque. Consulte /v1/meds/summary para mais detalhes.
Saque pendente: Se pendingWithdrawal não for null, você já possui um saque em processamento. O valor já foi deduzido do seu saldo disponível.

Quando consultar o saldo

  • Antes de solicitar um saque
  • Após receber notificação de pagamento aprovado
  • Para exibir saldo em dashboard/painel
  • Para verificar se há saque em andamento