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

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

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

balanceAvailabilityDurationValueinteger

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

balanceExpirationDatedatetime

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
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
Rounding strategy for credit transactions.
balanceOptionDebitRoundingstring
Rounding strategy for debit transactions.
createdAtdatetime
Timestamp of balance definition creation.
deletedAtstring

Timestamp of balance definition deletion (nullable).

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

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

updatedAtstring
Timestamp of the last update.

Errors

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