LoyaltyBalance

Create balance limits

Creates balance limit and sends the created UUID along with the data

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
bdidstringRequiredformat: "uuid"
Balance Definition Id

Request

Balance Definition Payload
constraintTypeenumRequired
Defines whether the limit applies to transaction count or amount.
Allowed values:
durationUnitenumRequired
Unit of time for which the limit is applicable.
Allowed values:
durationValueintegerRequired
Number of time units for the balance limit.
transactionTypeenumRequired
Specifies whether the limit applies to credit or debit transactions.
Allowed values:
valueintegerRequired
Maximum allowed value for the specified constraint type.
slidingSchedulebooleanOptional
Determines if the limit resets on a rolling schedule.

Response

Successful creation of balance limit
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