Balance API Docs

Customer Records

Dashboard routes for customer records, summaries, exports, checkpoints, and verification packages.

These routes are dashboard (JWT-authenticated) customer record endpoints.

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

Required header:

bash
-H "Authorization: Bearer YOUR_JWT_TOKEN"

Optional environment scope:

bash
-H "X-Environment: sandbox"

Valid values: sandbox or production.

List Customer Records

bash
curl "https://balance-api.pacspace.io/dashboard/customers?page=1&limit=25&search=cust_" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Customer Summary

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

Returns aggregate totals, including counts, balances, and verification metrics.

Customer Detail

bash
curl "https://balance-api.pacspace.io/dashboard/customers/cust_123?deltaPage=1&deltaLimit=20&status=verified" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Supported filters include status, reason, startDate, endDate, search, sortBy, and sortOrder.

Export Customer Activity (CSV)

bash
curl "https://balance-api.pacspace.io/dashboard/customers/cust_123/export?status=verified" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -o customer-record.csv

Generate Receipt

bash
curl "https://balance-api.pacspace.io/dashboard/customers/cust_123/receipt?period=2026-04" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Deprecated alias still available:

GET /dashboard/customers/:customerId/invoice-proof

Checkpoints

Create Checkpoint

bash
curl -X POST https://balance-api.pacspace.io/dashboard/customers/cust_123/checkpoint \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "2026-04"
  }'

List Checkpoints

bash
curl "https://balance-api.pacspace.io/dashboard/customers/cust_123/checkpoints?period=2026-04&limit=50" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

List Checkpoint Fingerprint Candidates

bash
curl "https://balance-api.pacspace.io/dashboard/customers/cust_123/checkpoint-fingerprints?period=2026-04" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Legacy aliases:

  • GET /dashboard/customers/:customerId/checkpoints/fingerprints
  • GET /dashboard/customers/:customerId/fingerprints

Verification Package

Create a shareable verification package for spot-check workflows.

bash
curl -X POST https://balance-api.pacspace.io/dashboard/customers/cust_123/verification-package \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "2026-04",
    "sampleSize": 10
  }'

Batch Checkpoint Export

Export checkpoints across customers in CSV or JSON.

bash
curl "https://balance-api.pacspace.io/dashboard/customers/batch-checkpoints/export?period=2026-04&format=csv" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -o checkpoints.csv

Endpoints Summary

EndpointMethodDescription
/dashboard/customersGETList customer records
/dashboard/customers/summaryGETAggregate customer summary
/dashboard/customers/batch-checkpoints/exportGETExport checkpoint data across customers
/dashboard/customers/:customerIdGETCustomer detail and activity
/dashboard/customers/:customerId/exportGETExport customer activity CSV
/dashboard/customers/:customerId/receiptGETGenerate receipt
/dashboard/customers/:customerId/invoice-proofGETDeprecated alias of receipt
/dashboard/customers/:customerId/checkpointPOSTCreate customer checkpoint
/dashboard/customers/:customerId/checkpointsGETList checkpoints
/dashboard/customers/:customerId/checkpoint-fingerprintsGETList fingerprint candidates
/dashboard/customers/:customerId/checkpoints/fingerprintsGETDeprecated alias
/dashboard/customers/:customerId/fingerprintsGETDeprecated alias
/dashboard/customers/:customerId/verification-packagePOSTCreate verification package

Previous

Team Management

Next

API Key Management