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 | \DateTime | 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 | 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 | string | Unique redemption ID of the parent redemption. | [optional] |
result | string | Redemption result. | [optional] |
status | string | Redemption status. | [optional] |
related_redemptions | \OpenAPI\Client\Model\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 | \OpenAPI\Client\Model\OrderCalculated | [optional] | |
channel | \OpenAPI\Client\Model\RedemptionChannel | [optional] | |
customer | \OpenAPI\Client\Model\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] |
voucher | \OpenAPI\Client\Model\RedemptionVoucher | [optional] | |
promotion_tier | \OpenAPI\Client\Model\PromotionTier | [optional] | |
reward | \OpenAPI\Client\Model\RedemptionRewardResult | [optional] | |
gift | \OpenAPI\Client\Model\RedemptionGift | [optional] | |
loyalty_card | \OpenAPI\Client\Model\RedemptionLoyaltyCard | [optional] |
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.