Add adjustment by gift card code.

Positive amount tops up, negative redeems. UniqueAdjustmentId is an idempotency key. 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-code request.

string
required
length ≥ 1

Redeemable code of the gift card.

double

Signed amount. Positive tops up, negative redeems.

string | null

Optional note.

date-time
required

UTC timestamp the adjustment occurred (use the point-of-sale time, not "now").

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.

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