Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 4.12 KB

TransactionRule.md

File metadata and controls

51 lines (38 loc) · 4.12 KB

TransactionRule

Properties

Name Type Description Notes
description kotlin.String Your description for the transaction rule, maximum 300 characters.
entityKey TransactionRuleEntityKey
interval TransactionRuleInterval
reference kotlin.String Your reference for the transaction rule, maximum 150 characters.
ruleRestrictions TransactionRuleRestrictions
type inline The type of rule, which defines if a rule blocks transactions based on individual characteristics or accumulates data. Possible values: * blockList: decline a transaction when the conditions are met. * maxUsage: add the amount or number of transactions for the lifetime of a payment instrument, and then decline a transaction when the specified limits are met. * velocity: add the amount or number of transactions based on a specified time interval, and then decline a transaction when the specified limits are met.
aggregationLevel kotlin.String The level at which data must be accumulated, used in rules with `type` velocity or maxUsage. The level must be the same or lower in hierarchy than the `entityKey`. If not provided, by default, the rule will accumulate data at the paymentInstrument level. Possible values: paymentInstrument, paymentInstrumentGroup, balanceAccount, accountHolder, balancePlatform. [optional]
endDate kotlin.String The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, 2020-12-18T10:15:30+01:00. If not provided, the rule will be evaluated until the rule status is set to inactive. [optional]
id kotlin.String The unique identifier of the transaction rule. [optional]
outcomeType inline The outcome that will be applied when a transaction meets the conditions of the rule. If not provided, by default, this is set to hardBlock. Possible values: * hardBlock: the transaction is declined. * scoreBased: the transaction is assigned the `score` you specified. Adyen calculates the total score and if it exceeds 100, the transaction is declined. [optional]
requestType inline Indicates the type of request to which the rule applies. If not provided, by default, this is set to authorization. Possible values: authorization, authentication, tokenization, bankTransfer. [optional]
score kotlin.Int A positive or negative score applied to the transaction if it meets the conditions of the rule. Required when `outcomeType` is scoreBased. The value must be between -100 and 100. [optional]
startDate kotlin.String The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, 2020-12-18T10:15:30+01:00. If not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to active. [optional]
status inline The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created with an active status. Possible values: active, inactive. [optional]

Enum: type

Name Value
type allowList, blockList, maxUsage, velocity

Enum: outcomeType

Name Value
outcomeType enforceSCA, hardBlock, scoreBased

Enum: requestType

Name Value
requestType authentication, authorization, bankTransfer, tokenization

Enum: status

Name Value
status active, inactive