LoyaltyBalance

Create balance definition

Creates balance definition and returns information

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

Request

Create Balance Definition Payload
namestringRequired<=128 characters
Name of the balance definition.
unitenumRequired
Unit of balance measurement.
balanceAvailabilityDurationModifierenumOptional
Defines when the balance expires within the selected duration.
Allowed values:
balanceAvailabilityDurationUnitenumOptional
Unit of time for balance validity.
Allowed values:
balanceAvailabilityDurationValueintegerOptional
Number of time units before the balance expires.
balanceExpirationDatedateOptional

Fixed expiration date (dd/mm format) as an alternative to duration-based expiry.

balanceOptionAmountOvertakingStrategyenumOptional
Defines whether partial credit is allowed when reaching max balance.
Allowed values:
balanceOptionCreditRoundingenumOptional
Defines rounding strategy for credit transactions.
Allowed values:
balanceOptionDebitRoundingenumOptional
Defines rounding strategy for debit transactions.
Allowed values:
descriptionstringOptional<=256 characters
Short description of the balance definition.
imageRefstringOptional
URL of an optional image reference.
maxAmountdoubleOptional
Maximum allowable balance amount.
maxCreditAmountLimitdoubleOptional
Maximum credit allowed per operation.
maxDebitAmountLimitdoubleOptional
Maximum debit allowed per operation.
metaobjectOptional
Additional metadata for the balance definition.
minAmountdoubleOptional
Minimum allowable balance amount.

Response

Successful creation of balance definition
balanceAvailabilityDurationModifierenum or null

startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year

Allowed values:
balanceAvailabilityDurationUnitstring or null

Unit of time for the balance’s availability (e.g., day/week/month/year).

balanceAvailabilityDurationValueinteger or null

Number of days/weeks/month/year for balance expiry

balanceExpirationDatedatetime or null

Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used.

balanceOptionAmountOvertakingStrategystring or null
Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit.
balanceOptionCreditRoundingstring or null
Rounding strategy for credit transactions.
balanceOptionDebitRoundingstring or null
Rounding strategy for debit transactions.
createdAtdatetime or null
Timestamp of balance definition creation.
deletedAtstring or null

Timestamp of balance definition deletion (nullable).

descriptionstring or null
Short description of the balance definition.
idstring or null
Unique identifier for the balance definition.
imageRefstring or null
Optional image reference URL.
maxAmountdouble or null
Maximum allowable balance.
maxCreditAmountLimitdouble or null
Max credit allowed per operation.
maxDebitAmountLimitdouble or null
Max debit allowed per operation.
metamap from strings to any or null
Additional metadata for the balance definition.
minAmountdouble or null
Minimum allowable balance.
namestring or null
Name of the balance definition.
unitstring or null

Unit of balance (e.g., points, currency).

updatedAtstring or null
Timestamp of the last update.

Errors