A Redemption defines the status of a Reward delivery (user eligibility, reward selected, authentication settings, notification channels..)

Redemption object

NameDescriptionExample
idRedemption identifierZN7RS-9RNLY
urlRedemption URLhttps://redemptipon-sandbox.ifeelgoods.com/#/ZN7RS-9RNLY
stateRedemption state. See Redemption states section.booked, pending, redeemed, denied, failed, canceled
order_idUnique ID. See the FAQ for more information about order_id.order-0000001-01-01
testingTest redemptions can be created using this parameter
activation_datetimeRedemption creation date2018-12-13T16:38:14Z
expiration_datetimeRedemption 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_datetimeRedemption redeem date2018-12-13T16:38:14Z
updated_datetimeRedemption last update2018-12-13T16:38:14Z
client.idAdvertiser ID (in Ifeelgoods Platform)
client_discountAdvertiser discount for this reward
reward_format.usagesCodes format. See the FAQ for more information.Possible values are ["primary"], ["primary", "security"], ["url"] and ["security_url", "security_url_code"].
reward_format.barcode_typeBarcode format (when available)none, c128, qrcode
reward_codes.codesArray of codes. See the FAQ for more information.
reward_codes.expiration_datetimeCode expiration date2018-12-13T16:38:14Z
promotion.id
promotion.statusenabled, disabled, paused, completed
promotion.statepending, ready, ended
cancelabletrue, false
reward.sku
reward.name
reward.statusenabled, disabled, paused
reward.stateinvalid_reward, no_allocation, ready
value.amount
value.currency
user.id
authentication_systems
activation_notification_channels
notification_channels

Redemption states

StatusDescription
🟠bookedA 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).
🟠pendingA redemption object has been created, no reward code is created at this step.
🟢redeemedA reward code has been generated and attached to the redemption.
🔴deniedThe 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).
🔴failedThe redemption terminate in failed state when an error occurred during code generation.
canceledA booked, pending, denied or failed redemption can be canceled with the cancel action.