DlcServiceCustomerAccountLoyalty

Contains all properties related to a customer's loyalty account.

banked_currency
Type: integer

This property is populated only for punchh loyalty program with the program_type "points_convert_to_currency". It represents the current amount of banked currency the user has available."
banked_currency_expiring_on
Type: string

This property is not currently supported but will be in future iterations.
expiring_banked_currency
Type: integer

This property is populated only for the punchh loyalty program with the program_type of points_convert_to_currency. In case a business has expiring banked_currency configured in the dashboard, the banked currency will be expired in a FIFO pattern. This returns the value of the banked_currency that will expire. A "null" value indicates that the business is not configured to support expiring_banked_currency.
loyalty_code
Type: string

This is not supported by punchh loyalty.
point_balance
Type: integer

It indicates the current point balance of the user.
referral_code
Type: string

This is not supported by punchh loyalty at the moment.
referral_path
Type: string

This property is populated for only the punchh loyalty program. It is the invite URL that should be shared with referred users. For MENU, the referral feature must be enabled within the Management Center. For punchh, it is automatically generated for each user.
total_points_accrued
Type: integer

It indicates the lifetime amount of points earned by the customer.
unbanked_points
Type: integer

This property is populated only for punchh loyalty program with the program_type "points_convert_to_currency". In case of businesses where banking of points is enabled, this value represents the number of points which the user has and have not banked yet. For example, if a business configuration requires 100 points to be banked to $10, and an end-user has accumulated 55 points, this value will be 55. When the end-user earns another 45 points, they will be banked to $10 and this value will then become 0.
user_as_barcode
Type: string

It indicates what the barcode content should be for the user's loyalty card.
user_as_qrcode
Type: string

It indicates what the QR code content should be for the user's loyalty card.
user_code_type
Type: string

Possible values: "barcode", "qrcode" and "". It is used to determine whether to display a barcode or QR code for the user's loyalty card.

Examples

{
  "point_balance": 0,
  "banked_currency": 0,
  "total_points_accrued": 0,
  "unbanked_points": 0,
  "user_as_qrcode": "PUNCHHBAhJIiszMDYyMjM3MjY6ZHJhZ29zLm5pY3VsZXNjdUBwYXJ0ZWNoLmNvbQY6BkVG--72f598cc66aed0002f126b9fb6a99f3f24107b31PUNCHH",
  "user_as_barcode": "",
  "user_code_type": "qrcode",
  "loyalty_code": "P3WODP7WA",
  "referral_code": "DrescuNi2721",
  "referral_path": "https://engagement.punchh.com/whitelabel/DevIntPointsUnlock/invite?invite_code=DrescuNi2721",
  "expiring_banked_currency": 0,
  "banked_currency_expiring_on": ""
}

DlcServiceLoyaltyPromotionsDiscounts

WebhookConfigs