Add adjustment by gift card ID.

Positive amount tops up, negative redeems. Redemptions that would take the balance below zero are rejected; the balance check and decrement are a single atomic operation, so two simultaneous redemptions on the same card can't both succeed and overdraw. UniqueAdjustmentId is an idempotency key: a repeat call with the same value is rejected and should be treated as positive confirmation the first call succeeded. Balance is synced to connected sales channels.

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

The adjustment to record.

Add-adjustment-by-ID request.

string
required
length ≥ 1

Gift card identifier.

double

Signed amount. Positive tops up, negative redeems. Redemptions below zero are rejected.

string | null

Optional note.

date-time
required

UTC timestamp the adjustment occurred.

string
required
length ≥ 1

Idempotency key. Retries with the same value are rejected.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

UniqueAdjustmentId, redemption exceeds balance, or the card is a voucher (vouchers are redeemed in full, not adjusted).

x-api-key.

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