AFCore/com.advantahealth.api.activeperks.model/ActivePerksEcode

ActivePerksEcode

data class ActivePerksEcode(val ecodeId: Int, val description: String?, val logoUrl: String?, val cashbackPercentage: Double, val isRangeEcode: Boolean, val minimumAmount: Double?, val maximumAmount: Double?, val fixedDenominations: List<Double>)

Digital gift card (ecode) purchase options of a merchant.

Constructors

ActivePerksEcode

constructor(ecodeId: Int, description: String?, logoUrl: String?, cashbackPercentage: Double, isRangeEcode: Boolean, minimumAmount: Double?, maximumAmount: Double?, fixedDenominations: List<Double>)

Properties

cashbackPercentage

val cashbackPercentage: Double

Cashback percentage as a number.

val description: String?

Product description.

val ecodeId: Int

Server id of the ecode product - required for checkout.

fixedDenominations

val fixedDenominations: List<Double>

Allowed fixed amounts; empty for range ecodes.

val isRangeEcode: Boolean

true when the member picks a free amount between minimumAmount and maximumAmount; false when only fixedDenominations are offered.

val logoUrl: String?

Product logo URL.

val maximumAmount: Double?

Highest allowed amount of a range ecode; null for a fixed-denomination ecode, which has no bounds.

val minimumAmount: Double?

Lowest allowed amount of a range ecode; null for a fixed-denomination ecode, which has no bounds.

Functions

fun ActivePerksEcode.validateAmount(amount: Double): AmountValidation

Validates amount against what this ecode actually sells.