Loyalty Transaction Object
Loyalty transaction.
Properties
ONE OF:
idstringformat GUID
Transaction ID.
accountIdstringformat GUID
Account ID.
createdDatestringRead-onlyformat date-time
Date and time the transaction was created.
amountinteger
The number of points earned, adjusted, redeemed, or expired in the transaction.
- EARN: Number of points earned by the customer taking an action. Example: 20
- REDEEM: The number of points redeemed by the customer for a reward. Example: -50
- ADJUST: The number of points refunded for a previously redeemed reward. Examples: 20, -30
- REFUND: The number of points refunded for a previously redeemed reward. Example: 60
- EXPIRE: The number of points that expired due to customer inactivity for a configured period. Example: -70
transactionTypestring
6 enum supported values:
UNKNOWNEARNREDEEMADJUSTREFUNDEXPIRE
Transaction types.
- EARN: Number of points earned by the customer taking an action. See Earn points for more information.
- REDEEM: The number of points redeemed by the customer for a reward.
- ADJUST: The number of points refunded for a previously redeemed reward. See Adjust Points for more information.
- REFUND: The number of points refunded for a previously redeemed reward.
- EXPIRE: The number of points that expired due to customer inactivity for a configured period.
descriptionstringmaxLength 100
Transaction description.
idempotencyKeystringmaxLength 128
Unique identifier, generated by the client. Used to recognize repeated attempts of the same request. Only present when manually adding points using the Earn Points endpoint.
ONE OF:
earnInfoobject
Information on points earned.
redeemInfoobject
Information on points redeemed.
adjustInfoobject
Information on points adjusted.
refundInfoobject
Information on points refunded.
expireInfoobject
Information on points expired.
Was this helpful?
Yes
No