This is an object representing a redemption for POST v1/redemptions
and POST /client/v1/redemptions
.
Name | Type | Description | Notes |
---|---|---|---|
id | str | Unique redemption ID. | [optional] |
object | str | The type of the object represented by the JSON | [optional] [default to 'redemption'] |
var_date | datetime | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
customer_id | str | Unique customer ID of the redeeming customer. | [optional] |
tracking_id | str | 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] |
redemption | str | Unique redemption ID of the parent redemption. | [optional] |
result | str | Redemption result. | [optional] |
status | str | Redemption status. | [optional] |
related_redemptions | RedemptionRelatedRedemptions | [optional] | |
failure_code | str | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. | [optional] |
failure_message | str | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. | [optional] |
order | OrderCalculated | [optional] | |
channel | RedemptionChannel | [optional] | |
customer | SimpleCustomer | [optional] | |
related_object_type | str | Defines the related object. | [optional] |
related_object_id | str | Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher. | [optional] |
promotion_tier | PromotionTier | [optional] | |
reward | RedemptionRewardResult | [optional] | |
gift | RedemptionGift | [optional] | |
loyalty_card | RedemptionLoyaltyCard | [optional] | |
voucher | RedemptionVoucher | [optional] |