Documentation
IntroCreateBalanceHooksErrors

Get Balance

Returns a company's available balance. Note that the balance fields in this response are in reais (BRL), not cents.

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

Response (200 OK)

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

Response Fields

companyId
number

Company ID

currency
string

Currency (BRL)

enBalanceStatus
string

Balance status (Released, Pending)

accBalance
number

Available balance in reais

accBalanceCredit
number

Available credit

accBalanceCreditAwaiting
number

Credit awaiting release

JavaScript Example

JavaScript
const companyId = 1;
const currency = 'BRL';
const response = await fetch(
  `https://baanko.app/api/Balance/balance/${companyId}?currency=${currency}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'your-secret-api-key'
    }
  }
);
const balance = await response.json();
console.log('Available balance:', balance.accBalance);