Get Loyalty Card Points

List card's unused loyalty points

GET/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Loyalty Card Points action (under integration).
Fill in the fields below, then reference the result from later steps as {{getLoyaltyCardPoints.response.data}}.

Request

Path parameters

loyaltyProgramIdinteger (int64)required

Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.

loyaltyCardIdstringrequired

Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. **Important**: The loyalty card ID requires [URL encoding](https://www.w3schools.com/tags//ref_urlencode.asp) if it contains special characters. For example, you must encode `NewCard2026%` as `NewCard2026%25`.

Query parameters

statusstring

Filter points based on their status.

One ofactivependingexpiredDefault "active"

subledgerIdarray<string>

Filter results by one or more subledger IDs. Must be exact match.

customerSessionIDsarray<string>

Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.

transactionUUIDsarray<string>

Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.

pageSizeinteger (int64)

The number of items in the response.

Default 50

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.

One ofstartDateexpiryDate

Response

Returns 200 with an object. Read it in later steps with {{getLoyaltyCardPoints.response.data.<field>}}.

hasMoreboolean

dataarray<object>

idinteger (int64)required

ID of the transaction that adds loyalty points.

transactionUUIDstringrequired

Unique identifier of the transaction in the UUID format.

createdstring (date-time)required

Date and time the loyalty card points were added.

programIdinteger (int64)required

ID of the loyalty program.

customerProfileIDstring

Integration ID of the customer profile linked to the card.

customerSessionIdstring

ID of the customer session where points were added.

namestringrequired

Name or reason of the transaction that adds loyalty points.

startDatestringrequired

When points become active. Possible values: - `immediate`: Points are active immediately. - `timestamp value`: Points become active at a given date and time.

expiryDatestringrequired

Date when points expire. Possible values are: - `unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date and time.

subledgerIdstringrequired

ID of the subledger.

amountnumberrequired

Amount of loyalty points added in the transaction.

validityDurationstring

The duration for which the points remain active, relative to the activation date. **Note**: This only applies to points for which `awaitsActivation` is `true` and `expiryDate` is not set.

json

{
  "hasMore": true,
  "data": [
    {
      "expiryDate": "2022-08-02T15:04:05Z07:00",
      "transactionUUID": "ce59f12a-f53b-4014-a745-636d93f2bd3f",
      "amount": 10.25,
      "customerProfileID": "URNGV8294NV",
      "created": {},
      "subledgerId": "sub-123",
      "name": "Reward 10% points of a purchase's current total",
      "validityDuration": "30D",
      "customerSessionId": "05c2da0d-48fa-4aa1-b629-898f58f1584d",
      "id": 123,
      "programId": 324,
      "startDate": "2022-01-02T15:04:05Z07:00"
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?