Consultar Saldo (Balance)

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 (200 OK)json

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

Campos da Resposta

Campo	Tipo	Descricao
`accBalance`	number	Saldo disponivel para saque
`accBalanceCredit`	number	Saldo de credito
`accBalanceCreditAwaiting`	number	Saldo de credito aguardando liberacao
`enBalanceStatus`	string	Status do saldo (Released, Blocked, etc.)

Exemplo JavaScript

JavaScriptjavascript

const companyId = 1;
const currency = 'BRL';

const response = await fetch(
  `https://korvopay.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);

Exemplo cURL

cURLbash

curl -X GET "https://korvopay.com/api/Balance/balance/1?currency=BRL" \
  -H "Accept: application/json" \
  -H "X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33" \
  -H "X-API-Key: sua-api-key-secreta"