Loyalty Transaction Object


Loyalty transaction.

Properties
accountIdstringformat GUID

Account ID.


amountinteger

The number of points earned, adjusted, redeemed, or expired in the transaction.

  • EARN: Number of points earned by a customer taking an action.
  • REDEEM: The number of points redeemed by a customer for a reward.
  • ADJUST: The number of points adjusted to a customer's balance.
  • 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.

createdDatestringRead-onlyformat date-time

Date and time the transaction was created.


descriptionstringmaxLength 100

Transaction description.


idstringformat GUID

Transaction ID.


idempotencyKeystringmaxLength 128

Unique identifier, generated by the client. Used to recognize repeated attempts of the same request. Only present when manually adding points with Earn Points.


transactionTypestring

Type of transaction.


One Of

adjustInfoAdjustInfo

Information on points adjusted.


earnInfoEarnInfo

Information on points earned.


expireInfoExpireInfo

Information on points expired.


redeemInfoRedeemInfo

Information on points redeemed.


refundInfoRefundInfo

Information on points refunded.

Did this help?