A Redemption defines the status of a Reward delivery (user eligibility, reward selected, authentication settings, notification channels..)
| Name | Description | Example |
|---|
| id | Redemption identifier | ZN7RS-9RNLY |
| url | Redemption URL | https://redemptipon-sandbox.ifeelgoods.com/#/ZN7RS-9RNLY |
| state | Redemption state. See Redemption states section. | booked, pending, redeemed, denied, failed, canceled |
| order_id | Unique ID. See the FAQ for more information about order_id. | order-0000001-01-01 |
| testing | Test redemptions can be created using this parameter | |
| activation_datetime | Redemption creation date | 2018-12-13T16:38:14Z |
| expiration_datetime | Redemption expiration date (when the redemption is in pending state, it may have a date after which it is no longer redeemable) | 2018-12-13T16:38:14Z |
| redeemed_datetime | Redemption redeem date | 2018-12-13T16:38:14Z |
| updated_datetime | Redemption last update | 2018-12-13T16:38:14Z |
| client.id | Advertiser ID (in Ifeelgoods Platform) | |
| client_discount | Advertiser discount for this reward | |
| reward_format.usages | Codes format. See the FAQ for more information. | Possible values are ["primary"], ["primary", "security"], ["url"] and ["security_url", "security_url_code"]. |
| reward_format.barcode_type | Barcode format (when available) | none, c128, qrcode |
| reward_codes.codes | Array of codes. See the FAQ for more information. | |
| reward_codes.expiration_datetime | Code expiration date | 2018-12-13T16:38:14Z |
| promotion.id | | |
| promotion.status | | enabled, disabled, paused, completed |
| promotion.state | | pending, ready, ended |
| cancelable | | true, false |
| reward.sku | | |
| reward.name | | |
| reward.status | | enabled, disabled, paused |
| reward.state | | invalid_reward, no_allocation, ready |
| value.amount | | |
| value.currency | | |
| user.id | | |
| authentication_systems | | |
| activation_notification_channels | | |
| notification_channels | | |
| Status | Description |
|---|
| 🟠 | booked | A redemption object has been created and a reward code has been booked for 30 minutes (a booked redemption must be validated with redeem or activate actions, see Recommended API Usages). |
| 🟠 | pending | A redemption object has been created, no reward code is created at this step. |
| 🟢 | redeemed | A reward code has been generated and attached to the redemption. |
| 🔴 | denied | The redemption has been rejected due to rules applied on the promotion (eg: country restriction) or because user's email domain name is in our deny-list (we regularly update our deny-list with a list of trash-inbox or fake-email tools). |
| 🔴 | failed | The redemption terminate in failed state when an error occurred during code generation. |
| ⚫ | canceled | A booked, pending, denied or failed redemption can be canceled with the cancel action. |
