For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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
Query parameters
versionenumOptionalDefaults to draft
Version
Allowed values:
Response
Successful retrieval of balance definition
idstringformat: "uuid"
Unique identifier for the balance definition.
namestring
Name of the balance definition.
descriptionstring
Short description of the balance definition.
imageRefstringformat: "uri"
Optional image reference URL.
metamap from strings to any
Additional metadata for the balance definition.
unitenum
Unit of balance measurement.
minAmountdouble
Minimum allowable balance.
maxAmountdouble
Maximum allowable balance.
maxCreditAmountLimitdouble
Maximum credit allowed per operation.
maxDebitAmountLimitdouble
Maximum debit allowed per operation.
balanceOptionAmountOvertakingStrategyenum
Partial enables partial credit of balance if maximum balance limit is reached. Strict enables rejection of a transaction if it will breach the max balance limit.
Allowed values:
balanceOptionCreditRoundingenum
Rounding strategy for credit transactions.
Allowed values:
balanceOptionDebitRoundingenum
Rounding strategy for debit transactions.
Allowed values:
balanceAvailabilityDurationValueinteger
Number of time units before the balance expires.
balanceAvailabilityDurationUnitenum
Unit of time for the balance availability duration.
Allowed values:
balanceAvailabilityDurationModifierenum
Modifier for balance availability duration. startOfPeriod causes expiry at the start of the period, endOfPeriod at the end. noModification uses the exact duration from the credit date.
Allowed values:
balanceExpirationDatestring
Fixed expiration date in dd/mm format. The balance expires when this date next appears in the calendar. Only one of balanceExpirationDate or balance availability duration fields can be used.
createdAtdatetime
Timestamp of balance definition creation.
updatedAtdatetime
Timestamp of the last update.
deletedAtdatetime
Timestamp of balance definition deletion (nullable).
