A valid request URL is required to generate request examplesPurchase a reward with points
Purchases a reward on behalf of the program member by spending points from the member’s loyalty card (the card is resolved from the reward cost’s card definition).
Requires an ACTIVE program and an ACTIVE reward within their configured validity windows, an ACTIVE member, the reward to be assigned to the program with available stock, a matching reward cost for the customer’s context, and sufficient points within the configured spending limits.
Modes:
TRANSACTION(default): creates aPENDINGreward transaction (and an underlying card transaction) processed asynchronously. Returns HTTP202.DRY_RUN: simulates the purchase without creating any transaction. Returns HTTP200with aSIMULATEDtransaction payload.
A valid request URL is required to generate request examplesAuthorizations
Path Parameters
Unique loyalty program identifier (format: lprg_ followed by hexadecimal characters).
Program member ID (format lmbr_[a-f0-9]+).
^lmbr_[a-f0-9]+$Body
Request body for purchasing a reward with points.
Unique identifier of the reward to purchase (format lrew_...).
Purchase mode. TRANSACTION creates a PENDING reward transaction processed asynchronously (HTTP 202). DRY_RUN only simulates the purchase and returns the calculation result (HTTP 200); no transaction is created. Defaults to TRANSACTION when omitted.
TRANSACTION, DRY_RUN Response
Dry run result (mode DRY_RUN). No transaction was created; the returned transaction has status SIMULATED and no id.
Result of a reward purchase request in dry-run mode.
The simulated reward transaction.
Show child attributes
Show child attributes
Result status. Always DRY_RUN for the dry-run mode.
DRY_RUN Human-readable result message. DRY_RUN mode: "Dry run mode. No transaction was created. This is only a simulation.".
Was this page helpful?