ManagementSplit configuration merchant level

Update the split logic

PATCH
/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}

Changes the split logic specified in the path.

To make this request, your API credential must have the following role:

  • Management API - SplitConfiguration read and write

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

splitConfigurationId*string

The unique identifier of the split configuration.

ruleId*string

The unique identifier of the split configuration rule.

splitLogicId*string

The unique identifier of the split configuration split.

Request Body

application/json

acquiringFees?string

Deducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
additionalCommission?

Defines whether to book an additional commission for payments to your user's balance account. The commission amount can be defined as a fixed amount (specified in minor units), a percentage (specified in basis points), or both.

adyenCommission?string

Deducts the transaction fee due to Adyen under blended rates from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
adyenFees?string

Deducts the fees due to Adyen (markup or commission) from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
adyenMarkup?string

Deducts the transaction fee due to Adyen under Interchange ++ pricing from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
chargeback?string

Specifies how and from which balance account(s) to deduct the chargeback amount.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
  • "deductAccordingToSplitRatio"
chargebackCostAllocation?string

Deducts the chargeback costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
commission*

Defines your platform's commission for the processed payments as a fixed amount (specified in minor units), a percentage (specified in basis points), or both. The commission is booked to your platform's liable balance account.

interchange?string

Deducts the interchange fee from specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
paymentFee?string

Deducts all transaction fees incurred by the payment from the specified balance account. The transaction fees include the acquiring fees (interchange and scheme fee), and the fees due to Adyen (markup or commission). You can book any and all these fees to different balance account by specifying other transaction fee parameters in your split configuration profile:

If you don't include at least one transaction fee type in the splitLogic object, Adyen updates the payment request with the paymentFee parameter, booking all transaction fees to your platform's liable balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
refund?string

Specifies how and from which balance account(s) to deduct the refund amount.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
  • "deductAccordingToSplitRatio"
refundCostAllocation?string

Deducts the refund costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
remainder?string

Books the amount left over after currency conversion to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount.

Value in

  • "addToLiableAccount"
  • "addToOneBalanceAccount"
schemeFee?string

Deducts the scheme fee from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Value in

  • "deductFromLiableAccount"
  • "deductFromOneBalanceAccount"
surcharge?string

Books the surcharge amount to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount

Value in

  • "addToLiableAccount"
  • "addToOneBalanceAccount"
tip?string

Books the tips (gratuity) to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount.

Value in

  • "addToLiableAccount"
  • "addToOneBalanceAccount"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/splitConfigurations/string/rules/string/splitLogic/string" \  -H "Content-Type: application/json" \  -d '{    "additionalCommission": {      "fixedAmount": 100,      "variablePercentage": 0,      "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"    },    "chargeback": "deductFromLiableAccount",    "commission": {      "fixedAmount": 100,      "variablePercentage": 100    },    "paymentFee": "deductFromLiableAccount",    "remainder": "addToLiableAccount",    "tip": "addToLiableAccount"  }'

Example response after updating the split logic

{  "description": "Your description for the split configuration",  "rules": [    {      "currency": "ANY",      "fundingSource": "ANY",      "paymentMethod": "ANY",      "ruleId": "SCRL4224P22322585HPCX384JW65VW",      "shopperInteraction": "ANY",      "splitLogic": {        "additionalCommission": {          "fixedAmount": 10,          "variablePercentage": 50,          "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"        },        "chargeback": "deductFromLiableAccount",        "commission": {          "fixedAmount": 10,          "variablePercentage": 100        },        "splitLogicId": "SCLG4224P22322585HPCX384JX52M2",        "paymentFee": "deductFromLiableAccount",        "remainder": "addToOneBalanceAccount",        "tip": "addToOneBalanceAccount"      }    },    {      "currency": "EUR",      "fundingSource": "ANY",      "paymentMethod": "visa",      "ruleId": "SCRL4224P22322585HPCX5V4KV6L2R",      "shopperInteraction": "ANY",      "splitLogic": {        "additionalCommission": {          "fixedAmount": 100,          "variablePercentage": 0,          "balanceAccountId": "BA3227C223222H5HQ2XX77VVH"        },        "chargeback": "deductFromLiableAccount",        "commission": {          "fixedAmount": 100,          "variablePercentage": 100        },        "splitLogicId": "SCLG4224P22322585HPCX5V4KW26C9",        "paymentFee": "deductFromLiableAccount",        "remainder": "addToLiableAccount",        "tip": "addToLiableAccount"      }    }  ],  "splitConfigurationId": "SCNF4224P22322585HPCX384JV6JGX"}