Description
The Reward Events CSV is a list of events that impact the status of Catch Rewards.
Reward Event Types
There are several different event types that can occur that will impact Catch rewards. The current list of possible types are described below. This list may expand or contract in the future.
| Event Type | Description |
|---|---|
| granted | A new reward was granted to a user. |
| redeemed | A reward was redeemed. |
| canceled | A reward that was previously earned is canceled and is no longer available for use. This is usually because the purchase on which the reward was earned has been refunded. |
| transfer_sent | A reward was transferred by a user (e.g. gifted to another user) This will also result in a “transfer_received” event when the receiver of the transfer obtains the reward. |
| transfer_received | A reward that was transferred from one user is received by another. |
| unredeemed | Rewards that were applied to a purchase are returned to a user. Usually this is after the purchase on which the reward was redeemed is then refunded. |
| settled_after_redemption | A reward that was redeemed but then ‘unearned’ upon a return of the original purchase on which the reward was initially earned. |
| settled_after_transfer | A reward is granted, transferred to a new owner, then canceled. The reward was transferred, not redeemed, so the cancellation has no impact on redeemed rewards. We do not revoke the rewards because they have a new owner, so the user refund is reduced as payment for the transferred rewards. There will be an increase in outstanding rewards proportional to the decrease in outstanding rewards on the corresponding canceled event. There will be a corresponding “transferred_reward_refund_reduction” transaction adjustment. |
| expired | A reward expires, becoming ineligible for use. |
Columns
| Column Name | Description |
|---|---|
| Reward Event ID | Catch’s unique internal identifier for the event |
| Timestamp | The timestamp when the reward event occurred |
| Reward ID | Catch’s unique internal identifier for the reward on which the event occurred |
| Event Type | The type of reward event. This value will be one of the values from the “Reward Event Types” section above. |
| Triggering Transaction Type | The type of transaction that triggered the reward event Note: This field will not be populated for all event types as not all events are triggered by a transaction. For example, “expired” events are triggered based on the passage of time and won’t have an associated transaction trigger. |
| Triggering Transaction ID | Catch’s unique internal identifier for the transaction that triggered the reward event Note: This field will not be populated for all event types as not all events are triggered by a transaction. For example, “expired” events are triggered based on the passage of time and won’t have an associated transaction trigger. |
| Catch User ID | Catch’s unique internal identifier for the user that made the transaction |
| Change in Outstanding Rewards | The impact this event had on the merchant’s outstanding rewards balance. A positive value indicates an increase in outstanding rewards. |
| Net Redeemed Rewards | The impact this event had on the amount of merchant funded rewards that have been redeemed. A negative value indicates an increase in rewards redeemed, a positive value indicates that rewards were un-redeemed. The sign is selected to indicate the impact of the redeemed rewards on the Net Transaction Amount of the reference transaction. |
| Reward Expiration Timestamp | The timestamp after which Catch will expire the reward. Only reported when it is created or updated. |