Create split configurations

You can define split instructions to apply automatically for payments processed through your user's store by creating a split configuration, 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, 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.

Step 1: Create a split configuration

To create a split configuration, make a POST /merchants/{merchantId}/splitConfigurations request, specifying your merchantId in the path.

In the body of the request, include the following fields:

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 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 the balance account specified for the split configuration in the store (see Step 2).
• The commission (in the default currency) is set at EUR 0.10 + 1%.
• An additional commission is set at EUR 0.05 + 0.5%, booked to a specific balance account.

The response returns the following resources:

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

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

Step 2: Update store with the split configuration

To apply the split configuration's rules to payments processed through your user's store, make a PATCH /stores/{storeId} request.

In the body, include the splitConfiguration object with the following parameters:

• splitConfigurationId: The unique identifier of the split configuration.
• 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 to all payments made through a store.

The response contains the full store details, including the split configuration 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.