---
title: "POST /transactions/redeem"
method: POST
path: "/transactions/redeem"
---

# POST /transactions/redeem

`POST /transactions/redeem`

## Request body

- RedeemPointsRequestBody
  - `member_id` string, required — Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in Zinrelo.
  - `reward_id` string, required — Unique ID that identifies a reward in Zinrelo. This is the ID of the reward against which the redemption transaction has to be recorded.
  - `transaction_attributes` string, json — <p>Every activity has a two predefined transaction attributes - reason and tags. While redeeming points for an activity, data can be passed in these attributes.</strong></p> <p>For example:</p> <p><code class="c-mrkdwn__code" data-stringify-type="code">{</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"reason" : "redeem", </code><br /><code class="c-mrkdwn__code" data-stringify-type="code">"tags" : ["purchasenmade","redeemingpoints"]</code><br /><code class="c-mrkdwn__code" data-stringify-type="code">} </code></p> <p>Custom attributes: In addition to the predefined attributes, you can define custom attributes for each activity and pass data in those attributes.&nbsp;</p> <p>The custom attribute should be created in advance. To create custom attributes for your store, reach out to your account manager at support@zinrelo.com.</p>
  - `points_to_be_redeemed` integer — REQUIRED: only for flexible redemption. The number of points to be redeemed.
  - `status` string — Pass the redemption status—approved or pending. If no entry is passed, the transaction will be redeemed, and its status will be approved.

## Response `200`

200

- RedeemPointsDataObject
  - `data` RedeemPointsResponseObject
    - `status` string — The redemption status- approved or pending.
    - `transaction_attributes` RedeemPointsTransactionAttributesObject — By utilizing transaction attributes, you can define attributes for transactions. You can leverage these attributes for personalization and reporting purposes. For more details, refer- https://help.zinrelo.com/docs/custom-attributes
      - `reason` string — The reason for making transaction.
      - `source_of_redemption` string — The source of the redemption, which could be from various channels like API, store, etc.
      - `tags` string[] — The tags assigned for the transaction.
    - `last_modified_date` string — The recent date on which the reward configuration was updated.
    - `additional_data` RedeemPointsAdditionalDataObject
      - `points_to_be_redeemed` integer — This denotes the total number of points deducted upon redemption. It's configured through the "Points to be deducted" setting on the reward setting page within the admin console.
    - `approver_details` RedeemPointsApproverDetailsObject
      - `approver_name` string — The person or source who approves the transaction.
      - `approver_id` string — The unique ID associated with the approver.
    - `approved_date` string — The date on which the reward was approved.
    - `reward_info` RedeemPointsRewardInfoObject
      - `reward_name` string — The name of the reward stored in Zinrelo.
      - `points_status` string — The status of the points- 'redemption_pending' or 'redemption_cancelled.'
      - `coupon_code` string — The coupon code used for redemption.
      - `reward_link` string — The link to flexi reward. Instead of asking members to choose from a fixed set of rewards, loyalty points can be used as a currency and members can redeem any number of points they have from their account for a corresponding discount on their transactions.
      - `reward_id` string — The unique reward ID assigned by Zinrelo.
      - `points` integer — The number of points redeemed by the member.
    - `member_id` string — The unique identifier of the member defined by an Admin.
    - `created_date` string — The date on which the reward was created.
    - `transaction_type` string — This field specifies the transaction type. In the case of the redeem API, it will always be designated as "redeem."
    - `id` string — The internal ID generated by Zinrelo.
  - `success` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/revisions/c12d3d379897/schema)