CreateBalanceDefinitionPayload.md

CreateBalanceDefinitionPayload

Properties

Name	Type	Description	Notes
balanceAvailabilityDurationModifier	BalanceAvailabilityDurationModifierEnum	Defines when the balance expires within the selected duration.	[optional]
balanceAvailabilityDurationUnit	BalanceAvailabilityDurationUnitEnum	Unit of time for balance validity.	[optional]
balanceAvailabilityDurationValue	Integer	Number of time units before the balance expires.	[optional]
balanceExpirationDate	[LocalDate]	Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry.	[optional]
balanceOptionAmountOvertakingStrategy	BalanceOptionAmountOvertakingStrategyEnum	Defines whether partial credit is allowed when reaching max balance.	[optional]
balanceOptionCreditRounding	BalanceOptionCreditRoundingEnum	Defines rounding strategy for credit transactions.	[optional]
balanceOptionDebitRounding	BalanceOptionDebitRoundingEnum	Defines rounding strategy for debit transactions.	[optional]
description	String	Short description of the balance definition.	[optional]
imageRef	String	URL of an optional image reference.	[optional]
maxAmount	BigDecimal	Maximum allowable balance amount.	[optional]
maxCreditAmountLimit	BigDecimal	Maximum credit allowed per operation.	[optional]
maxDebitAmountLimit	BigDecimal	Maximum debit allowed per operation.	[optional]
meta	Object	Additional metadata for the balance definition.	[optional]
minAmount	BigDecimal	Minimum allowable balance amount.	[optional]
name	String	Name of the balance definition.
unit	UnitEnum	Unit of balance measurement.

Enum: BalanceAvailabilityDurationModifierEnum

Name	Value
NOMODIFICATION	"noModification"
STARTOFPERIOD	"startOfPeriod"
ENDOFPERIOD	"endOfPeriod"

Enum: BalanceAvailabilityDurationUnitEnum

Name	Value
DAY	"day"
WEEK	"week"
MONTH	"month"
YEAR	"year"

Enum: BalanceOptionAmountOvertakingStrategyEnum

Name	Value
STRICT	"strict"
PARTIAL	"partial"

Enum: BalanceOptionCreditRoundingEnum

Name	Value
LOWER	"lower"
UPPER	"upper"
NATURAL	"natural"

Enum: BalanceOptionDebitRoundingEnum

Name	Value
LOWER	"lower"
UPPER	"upper"
NATURAL	"natural"

Enum: UnitEnum

Name	Value
POINTS	"POINTS"
EUR	"EUR"
USD	"USD"
MXN	"MXN"
GBP	"GBP"
INR	"INR"
CAD	"CAD"
SGD	"SGD"
RON	"RON"
JPY	"JPY"
MYR	"MYR"
CLP	"CLP"
PEN	"PEN"
MAD	"MAD"
AUD	"AUD"
CHF	"CHF"
BRL	"BRL"