IncentiveRuleRequest

@Serializable
data class IncentiveRuleRequest(val externalId: String, val incentiveType: IncentiveTypeModel, val transactionType: TransactionTypeModel? = null, val description: String, val scope: IncentiveScopeModel, val value: IncentiveValueModel, val merchants: IncentiveMerchantsModel? = null, val expirationRules: ExpirationRulesModel? = null)

Incentive rule.

Constructors

Link copied to clipboard
constructor(externalId: String, incentiveType: IncentiveTypeModel, transactionType: TransactionTypeModel? = null, description: String, scope: IncentiveScopeModel, value: IncentiveValueModel, merchants: IncentiveMerchantsModel? = null, expirationRules: ExpirationRulesModel? = null)

Properties

Link copied to clipboard
@SerialName(value = "description")
val description: String

Description of the incentive rule.

Link copied to clipboard
@SerialName(value = "expiration_rules")
val expirationRules: ExpirationRulesModel? = null

Rules to expire the rule.

Link copied to clipboard
@SerialName(value = "external_id")
val externalId: String

External identifier in your platform.

Link copied to clipboard
@SerialName(value = "incentive_type")
val incentiveType: IncentiveTypeModel

Incentive type.

Link copied to clipboard
@SerialName(value = "merchants")
val merchants: IncentiveMerchantsModel? = null

Merchants to which the incentive rule apply.

Link copied to clipboard
@SerialName(value = "scope")
val scope: IncentiveScopeModel

Scope to which entities this rule apply.

Link copied to clipboard
@SerialName(value = "transaction_type")
val transactionType: TransactionTypeModel? = null

Transaction type.

Link copied to clipboard
@SerialName(value = "value")
val value: IncentiveValueModel

Value of incentive to be applied on the total amount of the transaction.