Adjust credit balance

Set an end-user's credit balance to a specific target amount. Useful for synchronising balances, applying refunds, or correcting discrepancies.

The API calculates the delta automatically (delta = target_balance - current_balance) and applies a single positive or negative adjustment.

Idempotency: Each reference_id can only be applied once. Submitting the same reference again returns { "adjusted": false, "reason": "already_applied" }.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 0

The exact balance the end-user should have after this adjustment. Must be 0 or greater.

string
required

Unique identifier for this adjustment operation. Used for idempotency.

string
Defaults to Balance adjustment

Optional label attached to the ledger entry.

Headers
string
required
^[a-zA-Z0-9_\-~]+$

A stable, unique identifier for the end-user making the request. Accepts alphanumeric characters, dashes (-), underscores (_), and tildes (~). This maps the request to the correct credit balance and output history.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json