Documentation

Integrate the hosted balance API

The service key selects one ledger. Your backend sends business transfers and reads the resulting state over HTTPS.

Hosted service region: United States. Discuss regional or private deployment requirements.

First request

Issue 100 points to an account

The quickstart uses the default asset, action, scene, and top-up platform account created with a new ledger.

Understand the workspace, ledger, account, transfer, record, expiry, and reversal model before integrating.

Create a ledger-scoped key and issue the first balance with a hosted HTTP request.

Request bodies, status values, account views, record fields, and reversal behavior.

Call the API from curl, server-side JavaScript, Python, or any HTTP client.

See how the HTTP contract, durable interruption points, and final ledger invariants are tested.

Copy or open canonical llms.txt sources for AI assistants, answer engines, retrieval, and GEO workflows.

Transfer patterns for issuance, split spending, time-aware grants, and whole-transfer reversal.

Product boundaries, delivery models, permissions, balances, and recovery.

A service key belongs to one ledger. Do not send a ledger ID on public /v1 routes.

Treat transfer ID plus scene as one business operation and do not reuse the pair for another intent.

Retry the exact original request directly after a timeout or uncertain code; do not make a read request first.

After insufficient_balance or execution-time amount_out_of_range, fix the condition and use a new transfer ID.