Redemption.md

Voucherify.Model.Redemption

This is an object representing a redemption for POST v1/redemptions and POST /client/v1/redemptions.

Properties

Name	Type	Description	Notes
Id	string	Unique redemption ID.	[optional]
Object	string	The type of the object represented by the JSON	[optional]
Date	DateTimeOffset?	Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.	[optional]
CustomerId	string	Unique customer ID of the redeeming customer.	[optional]
TrackingId	string	Hashed customer source ID.	[optional]
Metadata	Object	The metadata object stores all custom attributes assigned to the redemption.	[optional]
Amount	int?	For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction.	[optional]
VarRedemption	string	Unique redemption ID of the parent redemption.	[optional]
Result	string	Redemption result.	[optional]
Status	string	Redemption status.	[optional]
Session	RedemptionSession		[optional]
RelatedRedemptions	RedemptionRelatedRedemptions		[optional]
FailureCode	string	If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.	[optional]
FailureMessage	string	If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.	[optional]
Order	RedemptionOrder		[optional]
Channel	RedemptionChannel		[optional]
Customer	SimpleCustomer		[optional]
RelatedObjectType	string	Defines the related object.	[optional]
RelatedObjectId	string	Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.	[optional]
PromotionTier	PromotionTier		[optional]
Reward	RedemptionRewardResult		[optional]
Gift	RedemptionGift		[optional]
LoyaltyCard	RedemptionLoyaltyCard		[optional]
Voucher	RedemptionVoucher		[optional]

[Back to Model list] [Back to API list] [Back to README]