LoyaltyBalance

Get Transaction History API

Returns transaction history

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program Id

Query parameters

limitintegerOptionalDefaults to 20
Limit the number of records returned
offsetintegerOptionalDefaults to 0
Skip a number of records
sort_fieldenumOptionalDefaults to created_at
Field to sort by
Allowed values:
sortenumOptionalDefaults to desc
Sort order, either asc or desc
Allowed values:
contact_idintegerRequiredDefaults to 0
Contact ID
balance_definition_idstringRequiredformat: "uuid"
Balance Definition ID
filterslist of stringsOptional
Filters to apply

Response

Successful retrieval of transaction history
balanceDefinitionIdstring or null
Unique identifier of the associated balance definition.
contactIdinteger or null
Unique identifier of the contact related to the transactions.
countinteger or null
Total number of transactions in the history.
loyaltyProgramIdstring or null
Unique identifier of the associated loyalty program.
transactionHistorylist of objects or null
List of past transactions associated with the balance.

Errors