Consultar Saldo (Balance)

Consulta o saldo disponível de uma empresa. Valores monetários são sempre em centavos (R$ 25,00 → 2500).

💡 Dica Importante

Normalmente você já tem o companyId no retorno de /api/v1/transactions/create. Use esse mesmo valor nas chamadas de balance e withdraw.

Endpoint

GET/api/Balance/balance/{companyId}?currency=BRL

Base URL: https://www.dfpay.app

Headers

Header	Tipo	Descrição
`Accept`	Obrigatório	application/json
`X-Client-Id`	Obrigatório	Client ID do aplicativo
`X-API-Key`	Obrigatório	Secret Key (Company)

Path Parameters

Parâmetro	Tipo	Descrição
`companyId`	integerObrigatório	ID da empresa (obtido do retorno de create transaction)

Query Parameters

Parâmetro	Tipo	Descrição
`currency`	stringObrigatório	Moeda padrão: BRL

Exemplo de Requisição (cURL)

curl -X GET 'https://www.dfpay.app/api/Balance/balance/1?currency=BRL' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33' \
  -H 'X-API-Key: y7M96h1M6aHI-pqKtE4a8cZGStRZ4hOLbt6UX_DyvPPdra8ettG8WM5Q3VEsXXyptSooRm042pCMlKpPDxMsig'

Resposta de Sucesso (200 OK)

Exemplo real de resposta:

{
  "id": 1,
  "companyId": 1,
  "currency": "BRL",
  "enBalanceStatus": "Released",
  "accBalance": 5.00,
  "accBalanceCredit": 0.00,
  "accBalanceCreditAwaiting": 0.00
}

Campos da Resposta

Campo	Descrição
`accBalance`	Saldo disponível para saque (em reais)
`enBalanceStatus`	Status do saldo (Released = disponível)
`accBalanceCredit`	Saldo em créditos
`accBalanceCreditAwaiting`	Saldo em créditos aguardando liberação

Possíveis Erros

Código	Descrição
404	Not Found - Não há saldo cadastrado para esse companyId/moeda
403	Forbidden - Sem permissão (se usar JWT sem acesso à empresa)
500	Internal Server Error - Erro interno do servidor

Exemplos práticos

JavaScript / Node.js

const companyId = 1; // Do retorno de create transaction
const currency = 'BRL';

const response = await fetch(
  `https://www.dfpay.app/api/Balance/balance/${companyId}?currency=${currency}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'y7M96h1M6aHI-pqKtE4a8cZGStRZ4hOLbt6UX_DyvPPdra8ettG8WM5Q3VEsXXyptSooRm042pCMlKpPDxMsig'
    }
  }
);

const balance = await response.json();
console.log('Saldo disponível:', balance.accBalance);