Quick Start Guide

This guide takes you from zero to a verified settlement delta in under 5 minutes. You'll create an account, get an API key, and make the three core API calls: emit, query, and verify.

Prerequisites#

• A terminal with curl installed (macOS, Linux, or WSL)
• An email address for registration

Step 1: Create Your Account#

Register for a PacSpace account. You'll receive a verification email.

curl -X POST https://balance-api.pacspace.io/dashboard/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "your-secure-password",
    "firstName": "Jane",
    "lastName": "Doe",
    "companyName": "Acme Inc"
  }'

Check your inbox and verify your email address before continuing.

Step 2: Get Your API Key#

First, log in to get a JWT token:

curl -X POST https://balance-api.pacspace.io/dashboard/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "you@example.com",
    "password": "your-secure-password"
  }'

Copy the accessToken from the response. Then create an API key:

curl -X POST https://balance-api.pacspace.io/dashboard/api-keys \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "quickstart-key"
  }'

The response includes your full API key in the format pk_test_PUBLIC.SECRET. Save it — the secret portion is only shown once.

Step 3: Activate Your Environment#

Provision a testnet environment so you can start emitting deltas:

curl -X POST https://balance-api.pacspace.io/dashboard/contracts/provision \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "environment": "testnet"
  }'

This creates the underlying infrastructure for your account. It typically completes in a few seconds.

Step 4: Emit Your First Delta#

Now use the Balance API with your API key. Record a credit delta for a customer:

curl -X POST https://balance-api.pacspace.io/api/v1/balance/delta \
  -H "X-Api-Key: pk_test_PUBLIC.SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "customer_001",
    "delta": 100.00,
    "reason": "initial-deposit",
    "referenceId": "txn-quickstart-001",
    "metadata": {
      "source": "quickstart-guide",
      "note": "First delta!"
    }
  }'

You'll receive a response confirming the delta was recorded, including a unique anchorId that serves as your immutable receipt.

Step 5: Query the Balance#

Derive the current running balance for your customer:

curl https://balance-api.pacspace.io/api/v1/balance/derive/customer_001 \
  -H "X-Api-Key: pk_test_PUBLIC.SECRET"

The response returns the derived balance computed from all recorded deltas — in this case, 100.00.

Step 6: Verify Agreement#

Compare your view of the balance against a counterparty's. In a real integration, each side submits their computed balance. For this test, both sides agree:

curl -X POST https://balance-api.pacspace.io/api/v1/balance/compare \
  -H "X-Api-Key: pk_test_PUBLIC.SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "yourBalance": 100.00,
    "theirBalance": 100.00,
    "startingBalance": 0
  }'

The response confirms whether the balances match. If they don't, PacSpace tells you the exact discrepancy.

That's It#

Three calls — emit, query, verify. That's the entire settlement flow.

From here you can:

• Learn about authentication — understand API key formats and JWT tokens
• Explore use cases — see what other developers are building
• Read the Balance API reference — full endpoint documentation
• Set up webhooks — get notified when deltas are confirmed
• Open the dashboard — manage keys, monitor usage, and configure billing