TAtalon
Loyalty cards

List card's transactions (Management API)

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Retrieve the transaction logs for the given loyalty card within the specified card-based loyalty program with filtering options applied.

[!note] For most use cases, especially real-time integrations, use the Integration API endpoint: List card's transactions.

If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.

get/v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs

Request

Path parameters

loyaltyProgramIdinteger required

Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.

loyaltyCardIdstring required

Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.

Important: The loyalty card ID requires URL encoding if it contains special characters. For example, you must encode NewCard2026% as NewCard2026%25.

Query parameters

startDatestring date-time

Date and time from which results are returned. Results are filtered by transaction creation date.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.
endDatestring date-time

Date and time by which results are returned. Results are filtered by transaction creation date.

[!note] Note

  • This must be an RFC3339 timestamp string.
  • You can include a time component in your string, for example, T23:59:59 to specify the end of the day. The time zone setting considered is UTC. If you do not include a time component, a default time value of T00:00:00 (midnight) in UTC is considered.
pageSizeinteger

The number of items in the response.

skipinteger

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

subledgerIdstring

The ID of the subledger by which we filter the data.

customerSessionIDsstring[]

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.

transactionUUIDsstring[]

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.

Response

OK

hasMoreboolean required

true means there is more data in the source collection to request..

Example response

{
  "hasMore": true,
  "data": [
    {
      "transactionUUID": "ce59f12a-f53b-4014-a745-636d93f2bd3f",
      "created": "2022-01-02T15:04:05Z07:00",
      "programId": 324,
      "cardIdentifier": "summer-loyalty-card-0543",
      "applicationId": 322,
      "sessionId": 233,
      "customerSessionId": "05c2da0d-48fa-4aa1-b629-898f58f1584d",
      "type": "addition",
      "name": "Reward 10% points of a purchase's current total",
      "startDate": "2022-01-02T15:04:05Z07:00",
      "expiryDate": "2022-08-02T15:04:05Z07:00",
      "subledgerId": "sub-123",
      "amount": 10.25,
      "id": 123
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.