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
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.

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.
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 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 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.
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 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 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
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.

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

The response returns the full details of the updated split configuration profile, including the updated rule 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.
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 your platform's commission fee for the payments. This can be a fixed amount (specified in minor units), a percentage (specified in basis points), or both.
paymentFee		You must define from which the 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 can specify when you update your user's store.
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.
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 can specify when you update your user's store. deductAccordingToSplitRatio: splits the disputed amount between the balance accounts of the original payment, according to same split ratio.
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 can specify when you update your user's store.
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 can specify when you update your user's store.
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 can specify when you update your user's store.

The following example shows how you can change the way payments are split if they meet the conditions of the split configuration rule.

The response returns the full details of the updated split configuration, including the new splitLogic object containing the updated logic to apply.

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 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, 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 icon.

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

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 icon next to ID of the split configuration profile you want to delete.