younifyd
Menu

Redeem Reward

Redeem Reward

POST/v1/loyalties/members/{memberId}/redemption

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the Redeem Reward action (under Loyalties).
  3. Fill in the fields below, then reference the result from later steps as {{redeemReward.response.data}}.

Request

Path parameters

memberIdstringrequired

Unique loyalty card assigned to a particular customer.

Request body

Enter the body as JSON in the step's Body field.

rewardobject

Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward if the reward is a pay with points reward.

idstring

Unique reward ID assigned by Voucherify. The reward must be assigned to the campaign in order for the user to be able to use the reward.

pointsinteger

The number of loyalty points that the user wants to spend in order to fulfill the order. The number of points cannot be higher than the current balance on the loyalty card.

orderany

Order object that is **required** when redeeming a pay with points reward.

metadataobject

A set of key/value pairs that you can send in the request body to check against vouchers requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the [Create Validation Rules](/api-reference/validation-rules/create-validation-rules) endpoint or with the [Validation Rule Builder](/personalize/create-validation-rules) in the the Dashboard.

json
{
  "reward": {
    "id": "rew_eSi4eYJk7o3tOycvweicR2z7",
    "points": 0
  },
  "order": null,
  "metadata": {}
}

Response

Returns 200 with a any. Read it in later steps with {{redeemReward.response.data.<field>}}.

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.