LoyaltyBalance

Get Active Balances API

Returns Active Balances

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

limitintegerOptional1-500
Limit
offsetintegerOptional>=0
Offset
sort_fieldstringOptional
Sort Field
sortstringOptional
Sort Order
contact_idintegerRequired>=1
Contact ID
balance_definition_idstringRequiredformat: "uuid"
Balance Definition ID

Response

Successful retrieval of active balance
createdAtstring
Timestamp of when the balance limit was created.
updatedAtstring
Timestamp of the last update to the balance limit.
balanceDefinitionIdstring or null
balance definition ID
constraintTypestring or null

Defines the type of constraint (e.g., transaction-based or amount-based).

durationUnitstring or null

Time unit for the balance limit (day, week, month, year).

durationValueinteger or null
Number of time units the balance limit applies to.
idstring or null
Unique identifier for the balance limit.
slidingScheduleboolean or null
Indicates if the limit resets periodically based on a sliding schedule.
transactionTypestring or null
Specifies whether the limit applies to credit or debit transactions.
valueinteger or null
The maximum allowed value for the defined constraint.

Errors