Pay for order with points

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:

• ACTIVE program;
• ACTIVE member;
• Card definition with pay-with-points enabled and a configured exchange ratio formula;
• Existing order in Voucherify with order id or order source_id.

Modes:

• TRANSACTION (default): Creates a PENDING order transaction (and an underlying card transaction) processed asynchronously. Returns HTTP 202. Sending a request for the same order id or source_id creates a new transaction each time.
• 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

cURL

Card balance type

curl --request POST \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/members/{memberId}/orders/payments \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "payment_limit": {
    "type": "CARD_BALANCE"
  },
  "mode": "TRANSACTION",
  "card_id": "lcrd_128f962dbd8c4ba5e1",
  "order": {
    "id": "ord_12b4cdf5f30c158825"
  }
}
'

200

Dry run: Point limit

{
  "transaction": {
    "program_id": "lprg_128f58429f4c4bf7b2",
    "member_id": "lmbr_128f962dbc8c4ba5dc",
    "card_id": "lcrd_128f962dbd8c4ba5e1",
    "card_definition_id": "lcdef_128f4a88414c4bed69",
    "card_transaction_id": null,
    "order_id": "ord_12b4cdf5f30c158825",
    "status": "SIMULATED",
    "type": "PAY_WITH_POINTS",
    "details": {
      "reason": "Points spent on order payment",
      "rejection": null,
      "metadata": {
        "points_limit": 150
      },
      "payment": {
        "amount": 150,
        "points_spent": 150,
        "exchange_ratio": 1
      }
    },
    "updated_at": null,
    "object": "order_transaction"
  },
  "status": "DRY_RUN",
  "message": "Dry run mode. No transaction was created. This is only a simulation."
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Identifies the loyalty program (lprg_ followed by hexadecimal characters).

Pattern: ^lprg_[a-f0-9]+$

memberId · string · required

Identifies the program member (lmbr_[a-f0-9]+).

Pattern: ^lmbr_[a-f0-9]+$

Body

application/json

Request body for paying for an order with points.

card_id · string · required

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

order · object · required

Reference to the order being paid. The order must already exist in the Voucherify system. At least one of id or source_id must be provided.

Show child attributes

payment_limit · object

Optional payment limit. When omitted, the default CARD_BALANCE limit is applied (spend up to the card balance).

Option 1

Option 2

Option 3

Show child attributes

mode · enum<string> | null

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.

Available options: TRANSACTION, DRY_RUN

Response

200

application/json

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

Result of a pay-with-points request.

transaction · object

An order transaction representing a pay-with-points SIMULATED payment.

Show child attributes

status · enum<string>

Result status. DRY_RUN for dry-run mode.

Available options: DRY_RUN

message · string

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