Automatically split payments in stores

When processing payments through stores, you can configure the store to automatically apply your billing logic for your commission fees. This means that you no longer need to send split instructions in every payment or capture request.

For Adyen to automatically apply split instructions, you'll need to:

1. Create a split configuration that contains commission fees and transaction conditions.
2. Create or update the store to add the split configuration and the account to which the split amount must be sent.

How split configuration works

A split configuration contains one or more rules that define commission fees and conditions when the fee applies. You create and manage split configurations in your Customer Area.

Each rule in a split configuration must have:

• Commission fees. The fee can be a fixed amount, a percentage, or both.
• Conditions for the rule. You must define a value for each of the following conditions.
  • Channel: The sales channel. This can be a specific channel (such as ecommerce) or any sales channel.
  • Currency: Can be specific or any currency.
  • Payment method: Can be specific, based on the funding source or any payment method available to the store.

A transaction must meet all conditions before the rule can be applied. When a transaction meets all conditions, Adyen applies the corresponding commission fee. We recommend that you include a catchall rule (set all conditions to any), because if none of the rules apply to the transaction, then all the funds will go to the liable account.

Adyen evaluates the rules in the split configuration for all the transactions processed through the store. If you need to change the commission fees for specific transactions, you can send split instructions in the payment or capture API request. Any split instruction that you send through the API overrides the automatic split.

Rule hierarchy

If a split configuration has multiple rules and more than one rule applies to the transaction, Adyen applies the fee from the rule with the highest priority. The rules are prioritized based on the following hierarchy:

1. Currency
2. Payment method
3. Funding source (debit or credit)
4. Channel

Examples

Let's take for example the following split configuration rules.

Scenario 1
An ecommerce transaction in EUR, using American Express.

The transaction meets the conditions for rules 1, 2, 4 and 5, but rule 5 has the highest priority because it matches the specific currency (EUR) and funding source (credit). Adyen splits the transaction and sends EUR 1.50 + 1% to your liable account.

Scenario 2

An ecommerce transaction in EUR, using Visa.

The transaction meets the conditions for all the rules, but rule 3 has the highest priority because of the combination of specific currency (EUR) and payment method (Visa). Rule 3 has higher priority than rule 2 with the specific currency (EUR) and channel (ecommerce). Adyen splits the transaction and sends EUR 2.00 + 1% to your liable account.

Requirements

1. Check if you have an integration that uses stores. Stores are currently available only for point of sale and partner platforms integrations.
2. Contact our Support Team to enable split configuration for your platform.
3. Make sure that you have the Manage split configuration settings role for your Customer Area user.

Step 1: Create a split configuration

Now that you know how split configurations work, you can create and manage split configurations in your Customer Area. To access the page, make sure your Customer Area user has the Manage split configuration settings role.

1. Log in to your Customer Area and switch to your merchant account.
2. Go to Platform > Split configuration.
3. Select the Add configuration profile button.
4. Specify a name for the configuration.
5. Select the Create button.

The new configuration will have a UUID under the configuration name. Take note of this because you'll use this later to create or update the store.

To add rules to a split configuration:

1. Go to Platform > Split configuration.
2. Find the specific profile and select the + button to see the configuration panel.
3. Select the Add rule button.
4. Configure the Channel, Scheme (payment method), Currency, Fixed Fee, and Variable Fee. Select the values from the dropdown list.
5. Select the Create button.

The combination of Channel, Scheme, and Currency must be unique for each rule.

Step 2: Create or update the store

Make a POST /updateAccountHolder request to add the split configuration. In your request, include the following in the storeDetails array:

• splitConfigurationUUID: The UUID of the split configuration from your Customer Area.
• virtualAccount: The account holder's accountCode to which the split amount will be sent.

The following example shows how to update an account holder to create a store with a split configuration.

If the store already exists, you can update the store entry to add the split configuration.

Requests using /updateAccountHolder are processed asynchronously. You'll receive a response to your API request, but you must rely on the ACCOUNT_HOLDER_UPDATED notification webhook to know the final result of your request.

After the store is successfully created or updated, Adyen starts evaluating every transaction processed in the store and applies the split configuration rules.

See also