Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Programs

Pay for an order 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>

Pays for an order using points from the specified member loyalty card. The payment amount and points to spend are calculated from the card definition's pay-with-points exchange ratio formula, capped by the card balance and the optional payment_limit.

Requires an ACTIVE program, an ACTIVE member, and a card definition with pay-with-points enabled and a configured exchange ratio formula.

Modes:

  • TRANSACTION (default) — creates a PENDING order transaction (and an underlying card transaction) processed asynchronously. Returns HTTP 202.
  • DRY_RUN — simulates the payment without creating any transaction. Returns HTTP 200 with a SIMULATED transaction payload.
post/v2/loyalties/programs/{programId}/members/{memberId}/orders/payments

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

card_idstring required

Identifier of the member's loyalty card to spend points from (format lcrd_...).

mode'TRANSACTION' | 'DRY_RUN'

Payment mode. TRANSACTION creates a PENDING order transaction processed asynchronously (HTTP 202). DRY_RUN only simulates the payment and returns the calculation result (HTTP 200); no transaction is created. Defaults to TRANSACTION when omitted or null.

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: "Pay with points transaction created". DRY_RUN mode: "Dry run mode. No transaction was created. This is only a simulation.".