Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 3.41 KB

RedemptionsRollbackCreateResponseBody.md

File metadata and controls

73 lines (49 loc) · 3.41 KB

RedemptionsRollbackCreateResponseBody

Response body schema for POST v1/redemptions/{redemptionId}/rollback.

Properties

Name Type Description
id String Unique identifier of the redemption rollback.
_object ObjectEnum The type of the object represented by the JSON
date OffsetDateTime Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
customerId String Unique customer ID of the redeeming customer.
trackingId String Hashed customer source ID.
metadata Object The metadata object stores all custom attributes assigned to the redemption.
amount Integer For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer.
redemption String Unique redemption ID of the parent redemption.
reason String System generated cause for the redemption being invalid in the context of the provided parameters.
result ResultEnum Redemption result.
status StatusEnum Redemption status.
relatedRedemptions RedemptionsRollbackCreateResponseBodyRelatedRedemptions
failureCode String If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed.
failureMessage String If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.
order OrderCalculated
channel RedemptionsRollbackCreateResponseBodyChannel
customer SimpleCustomer
relatedObjectType RelatedObjectTypeEnum Defines the related object.
relatedObjectId String Unique identifier of the related object. It is assigned by Voucherify, i.e. `v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno` for a voucher.
voucher Voucher
promotionTier PromotionTier
reward RedemptionRewardResult
gift RedemptionsRollbackCreateResponseBodyGift
loyaltyCard RedemptionsRollbackCreateResponseBodyLoyaltyCard

Enum: ObjectEnum

Name Value
REDEMPTION_ROLLBACK "redemption_rollback"

Enum: ResultEnum

Name Value
SUCCESS "SUCCESS"
FAILURE "FAILURE"

Enum: StatusEnum

Name Value
SUCCEEDED "SUCCEEDED"
FAILED "FAILED"

Enum: RelatedObjectTypeEnum

Name Value
VOUCHER "voucher"
PROMOTION_TIER "promotion_tier"
REDEMPTION "redemption"