Loyalty Point Transaction

A single loyalty point transaction (debit or credit of redeemable points to the user).

idstringrequired

Unique identifier of the loyalty point transaction.

profileIdstringrequired

Loyalty profile ID (recipient of the transaction).

loyaltyPoint object

Identifies the loyalty point type and the amount credited or debited in this transaction (always positive).

idstringrequired

Loyalty point type identifier (same ID as in Get Loyalty Points).

amountintegerrequired

Amount of loyalty points credited or debited (always positive; use transaction source to indicate credit or debit).

Possible values: > 0

namestringrequired

Display name (e.g. Redeemable Points).

sourceLoyalty Point Transaction Source (string)required

Source of the transaction (e.g. credit, debit, quest-completed, widget).

createdAtstring<date-time>required

When the transaction was created.
Represents RFC 3339, section 5.6 date-time.

userQuestIdstringnullable

ID of the user quest that triggered this transaction. Omitted when the transaction is not quest-related.

transactedByIdstringnullable

ID of the profile or system that triggered the transaction (e.g. admin profile).

attributes object[]required

Provider-specific attributes as key-value pairs (e.g. empty array when none).

Array [

keystringrequired

Attribute name.

valuestringrequired

Attribute value for the key.

]

Loyalty Point Transaction

{
  "id": "string",
  "profileId": "string",
  "loyaltyPoint": {
    "id": "string",
    "amount": 0,
    "name": "string"
  },
  "source": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "userQuestId": "string",
  "transactedById": "string",
  "attributes": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}