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
Endpoint destination URL
https://management-test.adyen.com/v3/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}
Click to copy

Path Parameters

splitLogicIdstringRequired

The unique identifier of the split configuration split.

ruleIdstringRequired

The unique identifier of the split configuration rule.

splitConfigurationIdstringRequired

The unique identifier of the split configuration.

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

acquiringFeesstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

additionalCommissionobject

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.

adyenCommissionstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

adyenFeesstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

adyenMarkupstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

chargebackstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

chargebackCostAllocationstring

Deducts the chargeback costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

commissionobjectRequired

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.

interchangestring

Deducts the interchange fee from specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

paymentFeestring

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.

refundstring

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio

refundCostAllocationstring

Deducts the refund costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

remainderstring

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

Possible values: addToLiableAccount, addToOneBalanceAccount.

schemeFeestring

Deducts the scheme fee from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

surchargestring

Books the surcharge amount to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount

tipstring

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

Possible values: addToLiableAccount, addToOneBalanceAccount.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less