Create split configuration profiles

Create a split configuration profile for all payments processed through your user's store.

You can define split instructions to apply automatically for payments processed through your user's store by creating a split configuration profile, then applying it to the store.

Before you begin

Contact our Support Team to enable split configurations for your platform.

Before you create a split configuration profile, make sure that:

You have created a store for your user and that you have its id at hand.
Your Management API credential has the Management API - SplitConfiguration read and write role.
If you want to create and manage split configuration profiles in your Customer Area, contact our Support Team to request the Manage new split configuration settings role for your admin user. The admin user can afterwards grant this role to other users.

Step 1: Create a split configuration profile

You can create a split configuration profile either by using the Management API, or in your Customer Area. When you create the profile, you must create its first rule at the same time.

To create a split configuration profile, make a POST /merchants/{merchantId}/splitConfigurations request, specifying your merchantId in the path. In the body of the request, send the description and rules fields.

In the rules array, include the following parameters for each rule:

Parameter	Required	Description
shopperInteraction		You must define whether the rule applies to a specific sales channel, or all channels.
currency		You must define whether the rule applies to a specific currency, or all currencies.
paymentMethod		You must define whether the rule applies to a specific payment method, or all payment methods associated with the store.
fundingSource		You can define whether the rule applies to only credit or debit, or all transactions.
splitLogic.commission		You must define the commission fee for the payments. This can be a fixed amount (specified in minor units), a percentage (specified in basis points), or both.
splitLogic.paymentFee		You must define from which balance account to deduct the transaction fees. Possible values: deductFromLiableAccount: deducts the transaction fees from your platform's liable balance account. deductFromOneBalanceAccount: deducts the transaction fees from one of your user's balance accounts, which you specify when you update your user's store.
splitLogic.chargeback		You can define the chargeback logic. Possible values: deductFromLiableAccount: books the entire disputed amount against your platform's liable balance account. deductFromOneBalanceAccount: books the entire disputed amount from one of your user's balance accounts, which you specify when you update your user's store. deductAccordingToSplitRatio: splits the disputed amount between the balance accounts in the original payment, using the same split ratio used in the original payment.
splitLogic.additionalCommission		You can define an additional fee as a commission for your user. This can be a fixed amount (specified in minor units), a percentage (specified in basis points), or both. The specified amount and/or percentage is booked directly to your user's balance account.
splitLogic.remainder		You can define the logic to apply when booking the leftover amount (after currency conversion). Possible values: addToLiableAccount: books the remainder against your platform's liable balance account. addToOneBalanceAccount: books the remainder against one of your user's balance accounts, which you specify when you update your user's store.
splitLogic.surcharge		You can define the logic to apply when booking surcharges. Possible values: addToLiableAccount: books the surcharge amount to your platform's liable balance account. addToOneBalanceAccount: books the surcharge amount to one of your user's balance accounts, which you specify when you update your user's store.
splitLogic.tip		You can define the logic to apply when booking tips. Possible values: addToLiableAccount: books the tip to your platform's liable balance account. addToOneBalanceAccount: books the tip to one of your user's balance accounts, which you specify when you update your user's store.

In the following example, we create a split configuration profile that splits all payments processed through the store automatically, according to the following split logic:

The transaction fees and chargebacks are deducted from your liable balance account.
Tips and the remainder amount (left over after currency conversion) are booked to your user's balance account. This balance account is specified when applying the profile to your user's store (see Step 2).
Your platform's commission (in the default currency) is set at EUR 0.10 + 1%, booked to your liable balance account.
An additional commission is set at EUR 0.05 + 0.5%, booked to your user's balance account.

The response returns the following resources:

splitConfigurationId: The unique identifier of the split configuration profile.
ruleId: The unique identifier of the split configuration rule.
splitLogicId: The unique identifier of the split logic that is applied when the predefined conditions are met.

You will need these IDs when you want to change the details of the split configuration profile.

To create a split configuration profile:

Log in to your Customer Area.
Switch to the appropriate merchant account.
Go to Platform > Split configuration.
Select Create configuration profile.
Enter a description.
Set the payment conditions for the split configuration profile.
The split logic defined in the rule will apply to all payments that meet all of the conditions set in this step.
1. Shopper interaction: Apply the split logic to transactions made through a specific sales channel, or all channels.
2. Payment method: Apply the split logic to transactions made through a specific payment method, or all payment methods associated with the store.
3. Currency: Apply the split logic to transactions made in a specific currency, or any currency.
Select Next: Split logic.
Configure the split logic to apply to all transactions that meet the previously defined conditions. These split items can be booked either to your liable balance account or your user's balance account.
1. Commission: Define how to book your platform's commission fee for payments. It can be a fixed amount, a percentage of the payment, or both.
2. Payment fee: Select the balance account to which you want to book the transaction fees incurred by the transaction.
3. Chargeback: Select the balance account to which you want to book a potential chargeback. It can be your liable balance account, your user's balance account, or you can split the chargeback amount between balance accounts, according to the split ratio of the original payment.
4. Tip: Select the balance account to which you want to book potential gratuities.
5. Surcharge: Select the balance account to which you want to book the surcharges.
(Optional) Configure an additional commission.
You can define an additional fee as a commission for your user. This can be a fixed amount (specified in minor units), a percentage (specified in basis points), or both. The specified amount and/or percentage is booked directly to your user's balance account.
Select Create profile.

The new configuration profile will have a UUID next to its description in the Split configuration profiles list. Take note of this, because you'll need use it later to apply the profile to your user's store.

After a split configuration profile is created, you can add multiple rules to it.

Step 2: Create or update store with the split configuration profile

To apply the split configuration profile's rules to payments processed through your user's store, you have two options:

Option 1: Update an existing store with the split configuration profile, by making a PATCH /stores/{storeId} request. Use this option if you previously created a store for your user, and now want to apply a split configuration profile to this store.
Option 2: Create a new store with the split configuration profile, by making a POST /stores request. Use this option when your user does not have an existing store.

In the body of either request, include the splitConfiguration object with the following parameters:

splitConfigurationId: The unique identifier of the split configuration profile.
balanceAccountId: The unique identifier of the balance account to which the split amount must be booked, depending on the defined splitLogic.

The following example shows how you can apply a split configuration profile to all payments made through an existing store.

The response contains the full store details, including the split configuration profile information.

After the store is successfully updated, Adyen starts evaluating every transaction processed through the store and applies the split logic of the rule with the highest priority condition the transaction meets.

Next steps

Manage split configuration profiles

Update or delete split configuration profiles.