Vorexy
IntroCriarSaldoHooksErros

Consultar Saldo

Consulta o saldo disponivel de uma empresa. Valores monetarios sao sempre em centavos (R$ 25,00 = 2500).

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
}

Campos da Resposta

companyId
number

ID da empresa

currency
string

Moeda (BRL)

enBalanceStatus
string

Status do saldo (Released, Pending)

accBalance
number

Saldo disponivel em reais

accBalanceCredit
number

Credito disponivel

accBalanceCreditAwaiting
number

Credito aguardando liberacao

Exemplo JavaScript

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