Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 2.51 KB

Redemption.md

File metadata and controls

30 lines (27 loc) · 2.51 KB

VoucherifySdk::Redemption

Properties

Name Type Description Notes
id String Unique redemption ID. [optional]
object String The type of the object represented by the JSON [optional][default to 'redemption']
date Time Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. [optional]
customer_id String Unique customer ID of the redeeming customer. [optional]
tracking_id String Hashed customer source ID. [optional]
metadata Object The metadata object stores all custom attributes assigned to the redemption. [optional]
amount Integer 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 String Unique redemption ID of the parent redemption. [optional]
result String Redemption result. [optional]
status String Redemption status. [optional]
related_redemptions RedemptionRelatedRedemptions [optional]
failure_code String If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. [optional]
failure_message String 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 String Defines the related object. [optional]
related_object_id String 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]