Default icon

Manage split configuration profiles

Learn how to update or remove a split configuration profile.

After a split configuration profile is applied to your user's store, all payments that are processed through the store and meet the conditions of at least one rule in the profile, are automatically split according to the instructions of the rule with the highest priority condition.

If you need to add or remove a rule, or change the conditions and split instructions of an existing rule, you can do so at any time in your Customer Area or using the Management API.

You can modify the following details of a split configuration profile:

Before you begin

  • If you are using the Management API, make sure that:
    • Your credential has the Management API - SplitConfiguration read and write role.
    • You have the IDs of the resources you want to update (split configuration profile, rule, or split logic) at hand. You can use the GET /merchants/{merchantId}/splitConfigurations endpoint to retrieve this information.
  • If you want to manage split configuration profiles in your Customer Area, you must have the Manage new split configuration settings role.

Add a rule

You can define new rules to automatically split transactions, even after the split configuration profile has been created and applied to a store.

To add a rule to an existing split configuration profile, make a POST /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} request, specifying the merchantId and splitConfigurationId in the path.

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

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.

The following example shows how you can add a new rule to existing profile.

The response returns the full details of the updated split configuration profile, including the ruleId of the new rule in the rules array.

Delete a rule

All split configuration profiles must contain at least one rule. Therefore, deleting the only rule in the profile is not possible. If you want to remove a rule but keep the profile, make sure the profile contains at least one other rule. Otherwise, delete the whole profile.

To delete a rule, make a DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} request, specifying the merchantId, splitConfigurationId, and ruleId in the path.

The response returns the full details of the updated split configuration profile, including all remaining rules.

Change the rule conditions

You can update the conditions that determine whether the payment is split automatically, by modifying the rule in the profile. For more information on these conditions, see Rule conditions.

To change the conditions of a rule, make a PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId} request, specifying the following parameters:

Path parameters Required Description
merchantId -white_check_mark- The unique identifier of your merchant account.
splitConfigurationId -white_check_mark- The unique identifier of the split configuration profile you want to update.
ruleId -white_check_mark- The unique identifier of the rule whose conditions you want to update.

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

Parameter Required Description
currency -white_check_mark- You must define whether the rule applies to a specific currency, or all currencies.
paymentMethod -white_check_mark- 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 only to payments initiated by credit cards, debit cards, or both.
shopperInteraction -white_check_mark- You must define whether the rule applies to a specific sales channel, or all channels.

You must send all conditions in the request, not only the ones you want to update.

The following example shows how you can change the conditions that define whether the payment is split according to the instructions defined in the split configuration profile.

The response returns the full details of the updated split configuration profile, including the rule with the updated conditions.

Change the split instructions

You can change the way a transaction is split between the balance accounts of your platform by modifying the split instructions of the rule.

To change the split logic used in a rule, make a PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId} request, specifying the following path parameters:

Path parameters Required Description
merchantId -white_check_mark- The unique identifier of your merchant account.
splitConfigurationId -white_check_mark- The unique identifier of the split configuration profile you want to update.
ruleId -white_check_mark- The unique identifier of the rule whose split logic you want to update.
splitLogicId -white_check_mark- The unique identifier of the split logic object you want to update.

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

Parameter Required Description
commission -white_check_mark- You must define the commission fee for the payments. This can be a fixed amount, a percentage, or both.
paymentFee
or another transaction fee type
-white_check_mark- You must define to which balance account to book the transaction fees associated with the payment.
chargeback You can 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 You can define to which balance account to book the fees incurred by chargebacks.
refund You can 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 You can define to which balance account to book the fees incurred by the refund.
additionalCommission You can define an additional fee as a commission for your user, booked directly to your user's balance account.
remainder You can define to which balance account to book the amount left over after currency conversion.
surcharge You can define to which balance account to book surcharges.
tip You can define to which balance account to book the gratuity.

You must send all split instructions in the request, not only the ones you want to update.

To book the transaction fees associated with the payment to different balance accounts, you must include at least one of 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.

The following example shows how you can change the way payments are split if they meet the conditions of the split configuration rule. The previous split instruction was to apply an additional commission of a fixed amount of EUR 0.01 + 0.1%, and here we show how to change that into a commission of a fixed amount of EUR 1.00.

The response returns the whole profile, including the new splitLogic object that contains the updated instructions.

Change the profile description

You can only update the description of a split configuration profile by using the Management API.

To update the description of a profile, make a PATCH /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} request, specifying the merchantId and splitConfigurationId in the path, and the new description in the body.

The response returns the whole profile, including the updated description.

Delete a profile

To delete a split configuration profile, make a DELETE /merchants/{merchantId}/splitConfigurations/{splitConfigurationId} request, specifying the merchantId and splitConfigurationId in the path.

The response contains all details of the delete profile.