Skip to main content
POST
https://api.econpay.com.br
/
balance
/
list
curl --request POST \
  --url https://api.econpay.com.br/balance/list \
  --header 'Authorization: Bearer SEU_TOKEN_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "companyIds": [1, 2, 3]
  }'

{
  "available": 150000,
  "future": 250000,
  "retention": 50000
}

​
Descrição

Retorna os saldos disponíveis, futuros e retidos dos estabelecimentos especificados.

​
Headers

​
Authorization
string
required
Bearer token JWT obtido no login

​
Request Body

​
companyIds
array
required
Array de IDs dos estabelecimentos para consultar saldos

​
Response

​
available
number
Saldo disponível para saque (em centavos)
​
future
number
Saldo futuro a receber (em centavos)
​
retention
number
Saldo retido (em centavos)
curl --request POST \
  --url https://api.econpay.com.br/balance/list \
  --header 'Authorization: Bearer SEU_TOKEN_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "companyIds": [1, 2, 3]
  }'

{
  "available": 150000,
  "future": 250000,
  "retention": 50000
}

​
Tipos de Saldo

​
Saldo Disponível

Valor que pode ser sacado imediatamente. Inclui transações já liquidadas e liberadas.

​
Saldo Futuro

Valor a receber de transações aprovadas mas ainda não liquidadas (aguardando prazo de liquidação).

​
Saldo Retido

Valor retido conforme configuração de retenção do estabelecimento (garantia, reserva técnica, etc).

​
Exemplo Completo

async function checkBalance(companyIds) {
  const response = await fetch('https://api.econpay.com.br/balance/list', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ companyIds })
  });
  
  const balances = await response.json();
  
  return {
    available: balances.available / 100,
    future: balances.future / 100,
    retention: balances.retention / 100,
    total: (balances.available + balances.future) / 100
  };
}

const balance = await checkBalance([1]);
console.log(`Disponível: R$ ${balance.available.toFixed(2)}`);
console.log(`A receber: R$ ${balance.future.toFixed(2)}`);
console.log(`Retido: R$ ${balance.retention.toFixed(2)}`);
console.log(`Total: R$ ${balance.total.toFixed(2)}`);

​
Próximos Passos

Listar Transações

Ver transações que compõem o saldo

Criar Pagamento

Processar novo pagamento