Consultar Saldo

Consulte o saldo disponível e pendente da sua conta ActivePayments.

GET/v1/balance

Retorna o saldo disponível e pendente da conta

Campos da Resposta

Campo	Tipo	Descrição
`available`	number	Saldo disponível para saque (já compensado)
`pending`	number	Saldo pendente de compensação (pagamentos recentes)
`currency`	string	Moeda da conta (sempre "BRL")

Tipos de Saldo

Saldo Disponível

Valor que já pode ser sacado ou transferido. Corresponde a pagamentos já compensados após o período de retenção.

Saldo Pendente

Pagamentos recebidos que ainda estão no período de compensação. Serão liberados automaticamente após a confirmação.

Período de CompensaçãoPagamentos PIX geralmente são compensados instantaneamente, mas podem haver retenções em casos específicos por análise de risco.

Casos de Uso

Dashboard de vendas: Exiba o saldo atual do comerciante
Validação de saque: Verifique se há saldo suficiente antes de solicitar um saque
Relatórios: Registre snapshots do saldo para análise financeira
Alertas: Notifique quando o saldo atingir certos valores

Próximo passoConfigure Webhooks para receber notificações em tempo real.

cURL
curl -X GET "https://api.ActivePayments.com.br/api/v1/balance" \
  -H "Authorization: ApiKey ActivePayments_pk_xxx:ActivePayments_sk_xxx"

Node.js (fetch)
const response = await fetch('https://api.ActivePayments.com.br/api/v1/balance', {
  headers: {
    'Authorization': `ApiKey ${publicKey}:${secret}`,
  },
});

const { data } = await response.json();

console.log(`Saldo disponível: R$ ${data.available.toFixed(2)}`);
console.log(`Saldo pendente: R$ ${data.pending.toFixed(2)}`);
console.log(`Total: R$ ${(data.available + data.pending).toFixed(2)}`);

Response 200 OK
{
  "success": true,
  "data": {
    "available": 15420.50,
    "pending": 1250.00,
    "currency": "BRL"
  }
}