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:
Your credential has the Management API - SplitConfiguration read and writerole.
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:
Select the split configuration profile to which you want to add a new rule.
Select + Add rule.
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.
Shopper interaction: Apply the split logic to transactions made through a specific sales channel, or all channels.
Payment method: Apply the split logic to transactions made through a specific payment method, or all payment methods associated with the store.
Currency: Apply the split logic to transactions made in a specific currency, or any currency.
Funding source: Apply the split logic to payments initiated by credit cards, debit cards, or both.
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 platform's liable balance account or your user's balance account.
Commission: Define how to book your platform's commission fee for payments. It can be a fixed amount, a percentage, or both.
Payment fee: Select the balance account to which you want to book the transaction fees incurred by the payment.
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.
Tip: Select the balance account to which you want to book potential gratuities.
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 Add rule.
The new rule is added to the split configuration profile.
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.
Transaction fees
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:
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:
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.
Refunds and chargebacks
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.
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).
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).
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 remove a rule from a split configuration profile:
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 in a split configuration profile:
Select the split configuration profile whose rule conditions you want to change.
Select Edit rule.
Set the new payment conditions for the split configuration profile.
The split logic of the rule will apply to all payments that meet all of the conditions set here.
Shopper interaction: Apply the split logic to transactions made through a specific sales channel, or all channels.
Payment method: Apply the split logic to transactions made through a specific payment method, or all payment methods associated with the store.
Currency: Apply the split logic to transactions made in a specific currency, or any currency.
Funding source: Apply the split logic to payments initiated by credit cards, debit cards, or both.
Select Save changes.
All subsequent transactions will be evaluated based on the new rule conditions.
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 applied to transactions:
Select the split configuration profile whose rule you want to change.
Select Edit logic.
Configure the new split logic to apply to all transactions that meet the rule conditions.
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.
Payment fee: Select the balance account to which you want to book the transaction fees incurred by the transaction.
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.
Tip: Select the balance account to which you want to book potential gratuities.
Surcharge: Select the balance account to which you want to book the surcharges.
Select Save changes.
All subsequent transactions and associated fees will be booked according to the new split logic.
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).
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).
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.
Transaction fees
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:
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.