Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Programs

Purchase a reward with points

<Warning>

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Purchases a reward on behalf of the program member, spending points from the member's loyalty card (the card is resolved from the reward cost's card definition).

Requires an ACTIVE program, an ACTIVE member, an ACTIVE reward 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

Path parameters

programIdstring required

Unique loyalty program identifier (format: lprg_ followed by hexadecimal characters).

memberIdstring required

Program member ID (format lmbr_[a-f0-9]+).

Request body

reward_idstring required

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'TRANSACTION_CREATED' | 'DRY_RUN'

Result status. TRANSACTION_CREATED for TRANSACTION mode, DRY_RUN for dry-run mode.

messagestring

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