Adjust a customer's balance

View as Markdown

Applies a manual correction outside the earn logic — a goodwill credit, an imported balance, or a compensating fix. Send exactly ONE non-zero delta: amountCents (cashback, in cents) or stampDelta (stamps); sending both or neither is a 400. A stamp credit that completes the card banks rewards per your program’s stamp goal. Idempotency-Key REQUIRED.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerIdstringRequired

Perkss customer id (UUID) — the id returned by customer create/list.

Headers

Idempotency-KeystringRequired

Required. A unique key (e.g. a UUIDv4) identifying this write. Retrying with the same key and payload within 24h replays the stored response instead of re-executing; the same key with a different payload is rejected with 409 IDEMPOTENCY.PAYLOAD_MISMATCH.

Request

This endpoint expects an object.
reasonstringRequired

Why this adjustment was made — required for the audit trail.

stampDeltadoubleOptional

Stamp correction (positive grants, negative removes). Mutually exclusive with amountCents; 0 is treated as omitted. A positive grant counts as a visit.

amountCentsdoubleOptional

Cashback balance correction in cents (positive credits, negative debits). Mutually exclusive with stampDelta; 0 is treated as omitted.

Response

The adjustment was recorded.
transactionIdstring
Id of the transaction this write recorded.
loyaltyobject or null

Post-write loyalty snapshot; null when the derived state is not yet readable.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error