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
includeInternalbooleanOptional
Include balances tied to internal definitions.

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
balance definition ID
constraintTypestring

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

durationUnitstring

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

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

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error