Skip to content

Dashboard API

Billing Overview

Check your balance, view billing entries, and monitor usage.

PacSpace uses a credit-based billing system. Credits are consumed when your data completes verification. Use these endpoints to check your balance and review transaction history.

All routes require a valid JWT in the Authorization header:

bash
-H "Authorization: Bearer YOUR_JWT_TOKEN"

Base URL: https://balance-api.pacspace.io


Get Balance

Retrieve your current credit balance, including reserved amounts.

bash
curl https://balance-api.pacspace.io/dashboard/credit/balances \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response 200 OK

json
{
  "statusCode": 200,
  "data": {
    "creditBalance": 95000,
    "availableBalance": 94200,
    "reserved": 800
  }
}

Balance Fields

FieldDescription
creditBalanceTotal credits in your account
availableBalanceCredits available to spend (creditBalance minus reserved)
reservedCredits temporarily held for in-progress verifications

How reservation works: When you submit data, credits are reserved upfront. Once verification completes, the actual cost is settled — any excess reservation is released back to your available balance.


Get Billing Entries

View your transaction history — credits added, consumed, and reserved.

bash
curl "https://balance-api.pacspace.io/dashboard/credit/entries?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response 200 OK

json
{
  "statusCode": 200,
  "data": {
    "items": [
      {
        "id": "entry_001",
        "type": "settlement",
        "amount": -150,
        "description": "Verification batch settled — 150 deltas",
        "balanceAfter": 94850,
        "createdAt": "2025-06-10T14:30:00.000Z"
      },
      {
        "id": "entry_002",
        "type": "reservation",
        "amount": -800,
        "description": "Credits reserved for pending verifications",
        "balanceAfter": 94200,
        "createdAt": "2025-06-10T14:25:00.000Z"
      },
      {
        "id": "entry_003",
        "type": "topup",
        "amount": 10000,
        "description": "Manual credit top-up",
        "balanceAfter": 95000,
        "createdAt": "2025-06-09T10:00:00.000Z"
      }
    ],
    "total": 47,
    "page": 1,
    "limit": 20
  }
}

Entry Types

TypeDescription
topupCredits added to your account
reservationCredits reserved for pending verifications
settlementFinal charge after verification completes
releaseReserved credits returned (overage from estimation)
refundCredits returned due to failed verification

Understanding Credit Flow

Here's how credits move through the system:

  1. Top up — Add credits to your account (via dashboard or sales)
  2. Reserve — When you submit data, estimated credits are held
  3. Settle — Once verification completes, actual costs are charged
  4. Release — If the estimate was higher than actual cost, the difference is released
Available Balance = Credit Balance - Reserved

Monitoring Usage

To keep track of your credit consumption in real time, set up a webhook for verification.completed events. Each event payload includes the credits consumed:

json
{
  "event": "verification.completed",
  "data": {
    "creditsConsumed": 12,
    "remainingBalance": 94838
  }
}

You can also check your balance anytime in the PacSpace Dashboard.


Endpoints Summary

EndpointMethodDescription
/dashboard/credit/balancesGETCurrent credit balance
/dashboard/credit/entriesGETTransaction history (paginated)
Was this page helpful?

Last updated February 11, 2026