Rewards History

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

Redemption code to identify and link the rewards used in a specific transaction. This code is generated in the response of the Issue Variable Rewards endpoint - POST /api/v1/redeem/reward/issue.

Number of points to be redeemed.

Ratio of dollar value of reward to the points being redeemed. For example, a value of 0.5 indicates that 1 dollar redeemed consumed 2 points.

Reward status such as Active or Redeemed

Dollar amount to be redeemed. Maximum amount to be redeemed (or the reward limit) is configurable. When a member has $100 in their loyalty account and the store has a reward limit of $50, they can use two rewards certificates to redeem the amount fully.

For internal usage only.

External reference (ID or name) of the location where the rewards were redeemed.

Date of redemption (in UTC format)

Merchant ID. If configured, it is returned in the response.

Merchant name

Representative who issued the rewards.

Representative who redeemed the rewards.

Representative who cancelled the rewards.

Revenue generated from the items in a transaction that are configured as 'eligible' for earning points.

Reward expiration time

Activity timestamp (UTC format)