Get balance definition
Returns balance definition
Authentication
api-keystring
The API key should be passed in the request headers as api-key for authentication.
Path parameters
pid
Loyalty Program Id
bdid
Balance Definition Id
Query parameters
version
Version
Allowed values:
Response
Successful retrieval of balance definition
balanceAvailabilityDurationModifier
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:
balanceAvailabilityDurationUnit
Unit of time for the balance’s availability (e.g., day/week/month/year).
balanceAvailabilityDurationValue
Number of days/weeks/month/year for balance expiry
balanceExpirationDate
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.
balanceOptionAmountOvertakingStrategy
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.
balanceOptionCreditRounding
Rounding strategy for credit transactions.
balanceOptionDebitRounding
Rounding strategy for debit transactions.
createdAt
Timestamp of balance definition creation.
deletedAt
Timestamp of balance definition deletion (nullable).
description
Short description of the balance definition.
id
Unique identifier for the balance definition.
imageRef
Optional image reference URL.
maxAmount
Maximum allowable balance.
maxCreditAmountLimit
Max credit allowed per operation.
maxDebitAmountLimit
Max debit allowed per operation.
meta
Additional metadata for the balance definition.
minAmount
Minimum allowable balance.
name
Name of the balance definition.
unit
Unit of balance (e.g., points, currency).
updatedAt
Timestamp of the last update.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
