Transactions

Redeem banked rewards

View as Markdown

Redeems count banked reward(s) without recording a sale — the counter decreases and a redemption transaction is written. Check availableRewards on the customer’s loyalty state first: redeeming more than the customer has banked returns 422. 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.
countdoubleRequired

Number of banked rewards to redeem. Rejected with 422 when it exceeds the customer’s available rewards.

Response

The redemption 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