API Documentation

Harness the power of BalancYZ through our high-performance REST API.

Authentication

All API requests require a Bearer token generated within your Client Dashboard. Each token is scoped to a specific Collection.

curl -X GET https://balancyz.com/api/v1/balance \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Accept: application/json"
GET /v1/balance

Returns the current available balance for the authenticated client in configured base units.

Response Example
{
  "status": "success",
  "data": {
    "balance": 1500.50,
    "currency": "USD",
    "last_updated": "2026-02-23T10:15:00Z"
  }
}
GET /v1/transactions

Retreive a paginated list of all balance adjustments, including webhook-driven topups and manual debits.

Query Parameters
  • limit (integer) - Default 15
  • type (string) - "credit" or "debit"

Rate Limiting

By default, each API token is limited to 1,000 requests per minute. If you require higher throughput, please reach out to our support team for an Enterprise upgrade.