Saldo

Consulte o saldo disponível, em liquidação e reservado da sua empresa.

O objeto saldo

O saldo da empresa em centavos. Saques usam só availableCents; blockedCents é o valor reservado por saques em processamento.

Campos

objectstring
sempre "balance"
currencystring
sempre "BRL"
availableCentsinteger
Saldo livre para saque, em centavos.
settlingCentsinteger
Valores pagos ainda em liquidação, em centavos.
blockedCentsinteger
Valores reservados por saques em processamento, em centavos.

ExemploJSON

{
  "object": "balance",
  "currency": "BRL",
  "availableCents": 1284730,
  "settlingCents": 0,
  "blockedCents": 150000
}

Consultar o saldo

GET/v1/balances

Mostra o saldo da empresa separado em disponível, em liquidação e reservado.

Escopo: balance:read
Idempotency-Key: Não se aplica
Sucesso: 200

Resposta

Devolve o objeto saldo.

Exemplo de retorno, pelo contrato da rota. Não cria cobrança nem saque.

const response = await fetch("https://api.maxxipay.com/v1/balances", {
  headers: {
    Authorization: `Bearer ${process.env.MAXXIPAY_API_KEY}`,
  },
});

const balance = await response.json();

RespostaJSON200 OK

{
  "object": "balance",
  "currency": "BRL",
  "availableCents": 1284730,
  "settlingCents": 0,
  "blockedCents": 150000
}