Check Balance

Retrieve your current active balance.

Retrieve your current account balance. The balance is in PHP (Philippine Pesos).

Endpoint

GET/api/v1/balance

Request Headers

Headers

ParameterTypeRequiredDescription
X-Api-KeyStringYesYour API key. See Authentication.

Response

200OK
json
{
"success": true,
"data": {
  "balance": 24650
}
}

Example cURL

curl -s https://[kaybs-domain]/api/v1/balance \
  -H "X-Api-Key: ${KAYBS_API_KEY}"

Example (Node.js)

// Node 18+ (ESM)
const res = await fetch('https://[kaybs-domain]/api/v1/balance', {
  headers: { 'X-Api-Key': process.env.KAYBS_API_KEY },
});
const { data } = await res.json();
console.log(`Balance: ₱${data.balance.toLocaleString('en-PH')}`);

Your first call

GET /balance is the simplest way to prove your API key and IP whitelist work before you place a test order.

Performance Note

ETag Support

This endpoint supports the ETag header. If your balance has not changed since the last request, the server returns 304 Not Modified with zero body — saving bandwidth. Send the ETag value from the previous response as If-None-Match in your next request.

PreviousOrder HistoryNextWallet History