Skip to main content

Loyalty Point

A loyalty point entity.

idstringrequired

Loyalty point ID (UUID). Same identifier used in the balance and reward-transactions APIs.

namestringrequired

Display name of the loyalty point (e.g. Redeemable Points, Member Points).

attributes object[]required

Key-value attributes for the loyalty point (e.g. overall, redeemable, type). Returns empty array when none are for the entity.

  • Array [
  • keystring

    Attribute name (e.g. overall, redeemable, type).

    valuestring

    Attribute value for the key.

  • ]
  • balanceintegerrequired

    Current balance for this loyalty point for the profile.

    Loyalty Point
    {
    "id": "string",
    "name": "string",
    "attributes": [
    {
    "key": "string",
    "value": "string"
    }
    ],
    "balance": 0
    }