Skip to content

Get Account History

/api/v1.0/LoyaltyVault/Account/{accountNumber}/LoyaltyPrograms/{loyaltyPointDefinitionId}/History

The API call returns the point history for a specific loyalty customer and loyalty program.

Request parameters

For the point history API call, the following additional parameter is added.

  • AccountNumber The loyalty vault account
  • LoyaltyPointDefinitionID The loyalty program ID is a compulsory parameter as the point history is returned for the specific loyalty program.

Response

[
  {
    "dateTime": "2024-12-10T09:43:30.697Z",
    "amount": 0,
    "transactionType": "Load",
    "expiresAt": "2024-12-10T09:43:30.697Z",
    "balance": 0,
    "comment": "string",
    "operatorId": "string",
    "shopId": "string",
    "posId": "string",
    "receiptNr": "string",
    "properties": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
]
  • DateTime Date and time when the point movement occurred.
  • Amount • The number of points earned (load) or redeemed or expired. • Redeemed and expired points have a negative value.
  • TransactionType The type of movement. Possible options:
    • Load Loading points
    • Convert converting balance into a voucher
    • Redeem redeeming balance
    • Expire balance expired
    • Transfer Balance transferred
    • RedeemVoucher Voucher redeemed (informational)
  • ExpiresAt • The ‘expiresAt’ value displays the date when the loyalty points earned on the specific transaction will expire. • This field will only be populated if the loyalty program expiry type is configured to expire loyalty points based on ‘date earned’. If the program is configured that the total balance will expire, then this field will be omitted. In the example below, the loyalty customer earned 123 points. The loyalty program is configured so that the points will expire 30 days later. *Balance The point balance after the movement.
  • Comment Additional information for the movement, for example, that the account has auto-expired.
  • Operator ID The POS operator. For the web store, this could be blank.
  • ShopId The store ID. For the web store, this could be blank.
  • PosId The terminal ID where the transaction was created or blank for the web store.
  • Receiptnr The sales receipt number / Online order number.
  • Properties, possible options:
    • voucherId The voucher ID for the movement
    • serialId Voucher serial ID (unique)
    • expiration Voucher expiration