Returns the details of a transaction rule.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.
Show more Show lessThe transaction rule.
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.
Your description for the transaction rule, maximum 300 characters.
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.
The type and unique identifier of the resource to which the rule applies.
The time interval when the rule conditions apply.
The day of month, used when the duration.unit is months. If not provided, by default, this is set to 1, the first day of the month.
The day of week, used when the duration.unit is weeks. If not provided, by default, this is set to monday.
Possible values: sunday, monday, tuesday, wednesday, thursday, friday.
The duration, which you can specify in hours, days, weeks, or months. The maximum duration is 90 days or an equivalent in other units. Required when the type is rolling or sliding.
The unit of time. You can only use minutes and hours if the interval.type is sliding.
Possible values: minutes, hours, days, weeks, or months
The time of day, in hh:mm:ss format, used when the duration.unit is hours. If not provided, by default, this is set to 00:00:00.
The time zone. For example, Europe/Amsterdam. By default, this is set to UTC.
The type of interval during which the rule conditions and limits apply, and how often counters are reset.
Possible values:
duration. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals. For example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 UTC.duration that you specify.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.
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.
Contains one or more objects that define the rule conditions. Each object must have a value and an operation which determines how the values must be evaluated.
For example, a countries object can have a list of country codes ["US", "CA"] in the value field and anyMatch in the operation field.
The total number of tokens that a card can have across different kinds of digital wallets on the user's phones, watches, or other wearables.
Supported operations: equals, notEquals, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan.
List of card brand variants and the operation.
Supported operations: anyMatch, noneMatch.
List of card brand variants.
Possible values:
mc, mccredit, mccommercialcredit_b2b, mcdebit, mcbusinessdebit, mcbusinessworlddebit, mcprepaid, mcmaestro
visa, visacredit, visadebit, visaprepaid.
You can specify a rule for a generic variant. For example, to create a rule for all Mastercard payment instruments, use mc. The rule is applied to all payment instruments under mc, such as mcbusinessdebit and mcdebit.
List of countries and the operation.
Supported operations: anyMatch, noneMatch.
List of two-character ISO 3166-1 alpha-2 country codes.
List of week days and the operation. Supported operations: anyMatch, noneMatch.
Compares the currency of the payment against the currency of the payment instrument, and specifies the operation.
Supported operations: equals, notEquals.
List of point-of-sale entry modes and the operation..
Supported operations: anyMatch, noneMatch.
Indicates whether transaction is an international transaction and specifies the operation.
Supported operations: equals, notEquals.
The number of transactions and the operation.
Supported operations: equals, notEquals, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan.
List of merchant category codes (MCCs) and the operation.
Supported operations: anyMatch, noneMatch.
List of names that will be compared to the merchant name according to the matching type.
Supported operations: anyMatch, noneMatch.
List of merchant ID and acquirer ID pairs, and the operation.
Supported operations: anyMatch, noneMatch.
List of merchant ID and acquirer ID pairs.
List of processing types and the operation.
Supported operations: anyMatch, noneMatch.
A start and end time in a time-only ISO-8601 extended offset format. Supported operations: equals, notEquals.
The total amount and the operation.
Supported operations: equals, notEquals, greaterThanOrEqualTo, greaterThan, lessThanOrEqualTo, lessThan.
The amount value and currency.
The amount of the transaction, in minor units.
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.
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.
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.
The type of rule, which defines if a rule blocks transactions based on individual characteristics or accumulates data.
Possible values: