Use cases and transfer patterns

Balance API use cases built from balanced transfers

Your backend owns each product decision. XferAPI executes the balanced accounting movement for issuance, spending, settlement, expiry, and reversal.

Built for app-defined value

One balance API, three common product models

Use the same ledger and transfer primitives for reward points, product usage credits, or in-app currency. Your application keeps control of the business rules.

Rewards and loyalty

Points API

Issue, redeem, schedule, and expire points while keeping every balance change tied to a traceable business transfer.

Explore the points API
AI and SaaS products

Usage credits API

Keep metering and pricing in your product, then record the resulting credit grants, charges, shared pools, and expiry.

Explore usage credits
Games and digital products

Virtual currency API

Run coins, gems, and other app-defined value with multi-account transfers, platform flows, history, and reversal.

Explore virtual currency

Transfer patterns

Compose each product event from balanced entries

Choose the business event first, then keep its accounting identity and retry behavior explicit.

01

Choose the business event

Grant, purchase, refund, settlement, or another event in your product.

02

Build balanced entries

Match source and destination totals independently for every asset in the movement.

03

Retry uncertainty exactly

Resend the same ID, scene, and payload directly; do not read first.

04

Replace a terminal ID

After insufficient_balance or execution-time amount_out_of_range, use a new transfer ID.

rate_limit_exceeded, quota_exceeded, and billing_suspended keep the original request retryable after backoff or remediation. transfer_already_reversed means the pair is closed, and idempotency_conflict means it is bound to another payload; use a new ID for the request you are trying to submit.

Issue app value

Platform account → user

Fund an account from a configured platform account entry point. Use the business grant ID as the transfer ID.

See the relevant guide

Split a spend

Buyer → seller + fee

Debit one account and credit several destinations in one request while keeping each asset total balanced.

See the relevant guide

Schedule or expire a grant

Time-aware destination

Set start_at, expire_at, or both on destination value. Availability changes at the Unix-second boundary.

See the relevant guide

Reverse an operation

Whole transfer

Identify the original transfer by ID and scene. XferAPI applies inverse balance changes and marks its records as reversed.

See the relevant guide

Validate a flow against the API contract

The API reference documents required fields, status values, balance views, and error responses.

Read API reference