Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-101025471.3 MB

69be73b5cff0

Programs

Purchase 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 a PENDING reward transaction (and an underlying card transaction) processed asynchronously. Returns HTTP 202.
  • DRY_RUN: simulates the purchase without creating any transaction. Returns HTTP 200 with a SIMULATED transaction payload.
post/v2/loyalties/programs/{programId}/members/{memberId}/rewards/purchases

Request body

reward_idstring required

Unique identifier of the reward to purchase (format lrew_...).

mode'TRANSACTION' | 'DRY_RUN'

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.

Response

Dry run result (mode DRY_RUN). No transaction was created; the returned transaction has status SIMULATED and no id.

status'DRY_RUN' required

Result status. Always DRY_RUN for the dry-run mode.

messagestring required

Human-readable result message. DRY_RUN mode: "Dry run mode. No transaction was created. This is only a simulation.".