Redemption Details (Object)

Returns the details of a redemption done by a user

created_at
Type: string

Date/time when the redemption was created in the system
expiring_at
Type: string

Date/time when the redemption_tracking_code expires and the user cannot use it at the POS
location_id
Type: integer

ID of the location associated with the with the redemption (where the redemption code is generated). If no location ID is provided, then the ID for the default location is returned.
redeemable_description
Type: string

Description of the redeemable
redeemable_id
Type: integer

Unique ID of the redeemable
redeemable_name
Type: string

Name of the redeemable
redeemed_value
Type: string

For a business with banked currency, a currency value will be returned (e.g., 10 would mean $10).

For a business without banked currency, a points value will be returned (e.g., 10 would mean 10 points).
redemption_id
Type: integer

Unique ID of the redemption that has been created
redemption_image_url
Type: string

URL of the image displayed in the app to depict the redeemable
redemption_message
Type: string

A descriptive message that tells a user what the user has redeemed
redemption_status
Type: string
Status of the redemption. The values returned can be:
- redeemable: The redemption can be redeemed at the POS.
- expired: The redemption has expired and becomes unusable for the user.
- honored: The redemption has already been processed successfully and redeemed by the user at a POS.
- cancelled: The redemption can be voided by a user by approaching the POS if a redemption is done by mistake and the user wants to cancel it.
redemption_tracking_code
Type: string

Code that a user must submit at the POS to receive the redeemed reward
updated_at
Type: string

Date/time at which the redemption was updated in the system

Redeemable (Array Object)

Rewards (Array Object)