Default icon

Create split configuration profiles

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

You can create a split configuration profile to automatically evaluate and split transactions processed through your user's store. The rules you set in the profile define how and/or to which balance account to book the following:

  • The payment amount and all types of transaction fees associated with the payment
  • Your platform's commission and additional commission to your user's balance account
  • The refund amount and associated fees
  • The chargeback amount and associated fees
  • The leftover amount after currency conversion
  • Surcharges
  • Gratuity (tips)

You can associate the split configuration profile you create with one of your user's balance accounts when you link the profile to a store. All amounts and fees that you want to book to your user are booked to the same balance account. The split instructions that you don't include in the profile or API request are booked to your platform's liable balance account by default.

To split transactions automatically:

  1. Create a split configuration profile in your Customer Area, or using the Management API.
  2. Link the profile to your user's store when you create or update the store using the Management API.

Before you begin

Contact our Support Team to enable split configuration profiles for your platform.

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

  • You created a store for your user and that you have its id at hand.
  • If you want to create and manage split configuration profiles through API calls, your Management API credential must have 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 field and rules array.

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

Parameter Required Description
currency -white_check_mark- Define whether the rule applies to a specific currency, or all currencies.
paymentMethod -white_check_mark- Define whether the rule applies to a specific payment method, or all payment methods associated with the store.
fundingSource Define whether the rule applies only to payments initiated by credit cards, debit cards, or both.
shopperInteraction -white_check_mark- Define whether the rule applies to a specific sales channel, or all channels.
splitLogic -white_check_mark- Define the split logic that is applied if the rule conditions are met.
splitLogic.commission -white_check_mark- Define your platform's commission for the payments. This can be a fixed amount, a percentage, or both.
splitLogic.additionalCommission Define an additional fee as a commission for your user, booked directly to your user's balance account. This can be a fixed amount, a percentage, or both.

Based on which optional parameters you include in the splitLogic object, you can define to which balance account to book:

  • The different types of transaction fees associated with the payment.
  • Potential refunds, chargebacks, and their associated fees.
  • The amount left over after currency conversion for online payments.
  • The tips and surcharges for in-person payments.

You can define any or all of these parameters in the splitLogic object of the split configuration profile.

To book the transaction fees associated with the payment to different balance accounts, you must include at least one the following parameters in the splitLogic object:

Parameter Required Description
paymentFee Define to which balance account to book the aggregated amount of all transaction fees associated with the payment.
adyenFees Define to which balance account to book the aggregated amount of Adyen's Commission and Markup for the payment.
adyenCommission Define to which balance account to book the Adyen's commission for the payment.
adyenMarkup Define to which balance account to book the Adyen's markup for the payment.
acquiringFees Define to which balance account to book the aggregated amount of the Interchange and Scheme fees associated with the payment.
interchange Define to which balance account to book the Interchange associated with the payment.
schemeFee Define to which balance account to book the Scheme fees associated with the payment.

For example, to create a split configuration profile that books the Interchange and Scheme fees to the user's balance account, and every other fee to your platform's liable balance account, send the following request:

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 instructions that are 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 define the split instructions for potential refunds, chargebacks, and the fees incurred by them, you can include the following parameters in the splitLogic object.

Parameter Required Description
refund Define the refund logic.
You can book the entire refund amount to your platform's liable balance account, your user's balance account, or split the refund amount between the balance accounts specified in the original payment (with the same split ratio).
refundCostAllocation Define to which balance account to book the fees incurred by the refund.
chargeback Define the chargeback logic.
You can book the entire disputed amount to your platform's liable balance account, your user's balance account, or split the disputed amount between the balance accounts specified in the original payment (with the same split ratio).
chargebackCostAllocation Define to which balance account to book the fees incurred by chargebacks.

In the following example, we create a split configuration profile that books:

  • The refund amount to your user's balance account.
  • The fees incurred by refunds to your liable balance account.
  • The chargeback amount according to the original payment's split ratio.
  • The fees incurred by chargebacks to your liable 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 instructions that are 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 define to which balance account to book the leftover amount after currency conversion, include the remainder parameter in the splitLogic object.

In the following example, we book the leftover amount 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 instructions that are applied when the predefined conditions are met.

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

Surcharges can only be configured for payments initiated in Australia and New Zealand.

To define the split instructions for potential tips and surcharges, you can include the following parameters in the splitLogic object:

Parameter Required Description
surcharge Define to which balance account to book surcharges.
tip Define to which balance account to book the gratuity.

In the following example, we create a split configuration profile that books both the tip and surcharge 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 instructions that are applied when the predefined conditions are met.

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

Example: Create a split configuration profile

In the following example, we create a split configuration profile with a catch-all rule that splits all payments processed through the store automatically:

  • All transaction fees and chargeback amounts and fees are deducted from your liable balance account.
  • The refund amount is deducted according to the original payment's split ratio (divided between your liable balance account and your user's balance account).
  • The fees associated with the refund are booked to your user's balance account.
  • Tips and the remainder amount (left over after currency conversion) are booked to your user's balance account.
  • 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 conditions of the rule are met.

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

You must link the split configuration profile to user's store using the Management API. You have two options:

  • 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.
  • Update an existing store with the split configuration profile, by making a PATCH /stores/{storeId} request. Use this option if you have already created a store for your user and want to apply a split configuration profile to this 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 amounts and fees must be booked, depending on the defined splitLogic.

The following example shows how you can apply a split configuration profile to all payments processed 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 instructions of the rule with the highest priority condition.

Next steps