Manage split configuration profiles

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		Define whether the rule applies to a specific currency, or all currencies.
paymentMethod		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		Define whether the rule applies to a specific sales channel, or all channels.
splitLogic		Define the split logic that is applied if the rule conditions are met.
splitLogic.commission		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.

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.

To add a rule to an existing split configuration profile:

1. Log in to your Customer Area.
2. Switch to the appropriate merchant account.
3. Go to Platform > Split configuration.
4. Select the split configuration profile to which you want to add a new rule.
5. Select + Add rule.
6. 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.
   4. Funding source: Apply the split logic to payments initiated by credit cards, debit cards, or both.
7. Select Next: Split logic.
8. 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.
   1. Commission: Define how to book your platform's commission fee for payments. It can be a fixed amount, a percentage, or both.
   2. Payment fee: Select the balance account to which you want to book the transaction fees incurred by the payment.
   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.
9. (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.
10. Select Add rule.

The new rule is added to the split configuration 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.

To remove a rule from a split configuration profile:

1. Log in to your Customer Area.
2. Switch to the appropriate merchant account.
3. Go to Platform > Split configuration.
4. Select the split configuration profile from which you want to delete a rule.
5. In the Actions column of the rule you want to delete, select the delete icon .

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		The unique identifier of your merchant account.
splitConfigurationId		The unique identifier of the split configuration profile you want to update.
ruleId		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		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 only to payments initiated by credit cards, debit cards, or both.
shopperInteraction		You must define whether the rule applies to a specific sales channel, or all channels.

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.

To change the conditions of a rule in a split configuration profile:

1. Log in to your Customer Area.
2. Switch to the appropriate merchant account.
3. Go to Platform > Split configuration.
4. Select the split configuration profile whose rule conditions you want to change.
5. Select Edit rule.
6. 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.
   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.
   4. Funding source: Apply the split logic to payments initiated by credit cards, debit cards, or both.
7. Select Save changes.

All subsequent transactions will be evaluated based on the new rule conditions.

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		The unique identifier of your merchant account.
splitConfigurationId		The unique identifier of the split configuration profile you want to update.
ruleId		The unique identifier of the rule whose split logic you want to update.
splitLogicId		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		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		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.

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.

To change the split logic applied to transactions:

1. Log in to your Customer Area.
2. Switch to the appropriate merchant account.
3. Go to Platform > Split configuration.
4. Select the split configuration profile whose rule you want to change.
5. Select Edit logic.
6. Configure the new split logic to apply to all transactions that meet the rule conditions.
   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.
7. Select Save changes.

All subsequent transactions and associated fees will be booked according to the new split logic.

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.

To delete a split configuration profile:

1. Log in to your Customer Area.
2. Switch to the appropriate merchant account.
3. Go to Platform > Split configuration.
4. Select the delete icon next to ID of the split configuration profile you want to delete.