Create and manage rules

After you determine your business' requirements for evaluating and declining suspicious payout requests, you can use the Configuration API to create and manage transaction rules that automatically evaluate every external payout. This page explains how to:

• Create a transaction rule
• View existing transaction rules
• Override existing transaction rules
• Update a transaction rule
• Deactivate or activate a transaction rule

Requirements

Create a transaction rule

When you have defined your business logic and requirements, turn your requirements into a transaction rule. You can do this by using your Balance Platform Customer Area or by making an API request.

The following tabs explain both procedures.

View transaction rules

You can see the transaction rules that you created on the Balance Platform Customer Area or by making API requests.

Override an existing transaction rule

When you have multiple transaction rules, Adyen applies these rules based on the existing rule hierarchy. To override this hierarchy for a specific resource or entity, you can create a new rule for that entity that overrides an existing rule with a higher hierarchical ranking.

To create a transaction rule that overrides an existing rule for a specific entity:

1. Make a POST /transactionRules request. In addition to other parameters required to create a rule, specify the following:

   Parameter	Required	Description
   entityKey		An object that contains the ID and type of entity for which you want to override a rule.
   ruleRestrictions		The new rule restrictions you want to apply to the entity.
   overridesRule		The ID of the transaction rule you want to override for the entity.

   For example, you created a transaction rule to limit the number of transactions to a maximum of 50 transactions per month for all cards in your balance platform. Now, let's override this rule to allow a higher limit of 100 transactions per month for just one card.

2. Note the response, which contains the new transactionRule resource, identified by its unique id.

Skip a transaction rule

You can override a rule by skipping it entirely for specific entities. This means that the rule no longer applies to that entity. To skip a transaction rule for an entity:

1. Make a POST /transactionRules request. In addition to other parameters required to create a rule, specify the following:

   Parameter	Required	Description
   entityKey		An object that contains the ID and type of entity for which you want to skip a rule.
   ruleRestrictions		Leave this empty.
   type		The rule type. Set this to bypass.
   overridesRule		The ID of the transaction rule you want to skip for the entity.

   For example, you created a transaction rule to limit the number of transactions to a maximum of 50 transactions per month for all cards in your balance platform. Now, let's skip this rule for just one card, so that it has no maximum monthly transaction limit.

2. Note the response, which contains the new transactionRule resource, identified by its unique id.

Update a transaction rule

To update a transaction rule:

1. Make a PATCH /transactionRules/{id} request, specifying the id in the path.

   For example, to add the US to the previous transaction rule, send the request below:

2. The response returns the updated transaction rule, along with NL and US in the list of countries. If the location where the transaction is processed does not match either the NL or US, then the transaction is blocked.

Activate or deactivate a transaction rule

You can activate or deactivate transaction rules using the Balance Platform Customer Area or by making API requests.

See also

• Track transactions
• Use relayed authorisation