Delete a split configuration rule
Deletes the split configuration rule specified in the path.
To make this request, your API credential must have the following role:
- Management API - SplitConfiguration read and write
Path Parameters
The unique identifier of the split configuration.
The unique identifier of the merchant account.
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 lessdescriptionstringMax length: 300Your description for the split configuration.
rulesarray[object]Array of rules that define the split configuration behavior.
currencystringThe currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.
fundingSourcestringThe funding source condition of the payment method (only for cards).
Possible values: credit, debit, or ANY.
paymentMethodstringThe payment method condition that defines whether the split logic applies.
Possible values:
- Payment method variant: Apply the split logic for a specific payment method.
- ANY: Apply the split logic for all available payment methods.
ruleIdstringThe unique identifier of the split configuration rule.
shopperInteractionstringThe sales channel condition that defines whether the split logic applies.
Possible values:
- Ecommerce: Online transactions where the cardholder is present.
- ContAuth: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer).
- Moto: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone.
- POS: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal.
- ANY: All sales channels.
splitLogicobjectContains the split logic that is applied if the rule conditions are met.
acquiringFeesstringDeducts the acquiring fees (the aggregated amount of interchange and scheme fee) from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
additionalCommissionobjectDefines 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.
balanceAccountIdstringUnique identifier of the balance account to which the additional commission is booked.
fixedAmountintegerA fixed commission fee, in minor units.
variablePercentageintegerA variable commission fee, in basis points.
adyenCommissionstringDeducts the transaction fee due to Adyen under blended rates from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
adyenFeesstringDeducts the fees due to Adyen (markup or commission) from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
adyenMarkupstringDeducts the transaction fee due to Adyen under Interchange ++ pricing from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
chargebackstringSpecifies how and from which balance account(s) to deduct the chargeback amount.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.
chargebackCostAllocationstringDeducts the chargeback costs from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount
commissionobjectDefines 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.
fixedAmountintegerA fixed commission fee, in minor units.
variablePercentageintegerA variable commission fee, in basis points.
interchangestringDeducts the interchange fee from specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
paymentFeestringDeducts 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:
adyenCommission
: The transaction fee due to Adyen under blended rates.adyenMarkup
: The transaction fee due to Adyen under Interchange ++ pricing.schemeFee
: The fee paid to the card scheme for using their network.interchange
: The fee paid to the issuer for each payment transaction made with the card network.adyenFees
: The aggregated amount of Adyen's commission and markup.acquiringFees
: The aggregated amount of the interchange and scheme fees.
If you don't include at least one transaction fee type in the
splitLogic
object, Adyen updates the payment request with thepaymentFee
parameter, booking all transaction fees to your platform's liable balance account.Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
refundstringSpecifies how and from which balance account(s) to deduct the refund amount.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio
refundCostAllocationstringDeducts the refund costs from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount
remainderstringBooks the amount left over after currency conversion to the specified balance account.
Possible values: addToLiableAccount, addToOneBalanceAccount.
schemeFeestringDeducts the scheme fee from the specified balance account.
Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.
splitLogicIdstringUnique identifier of the collection of split instructions that are applied when the rule conditions are met.
surchargestringBooks the surcharge amount to the specified balance account.
Possible values: addToLiableAccount, addToOneBalanceAccount
tipstringBooks the tips (gratuity) to the specified balance account.
Possible values: addToLiableAccount, addToOneBalanceAccount.
splitConfigurationIdstringUnique identifier of the split configuration.
storesarray[string]List of stores to which the split configuration applies.
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 lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
Show moreShow lessdetailstringA human-readable explanation specific to this occurrence of the problem.
errorCodestringA code that identifies the problem type.
instancestringA unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]Detailed explanation of each validation error, when applicable.
messagestringDescription of the validation error.
namestringThe field that has an invalid value.
valuestringThe invalid value.
requestIdstringA unique reference for the request, essentially the same as
pspReference
.responseobjectJSON response payload.
statusintegerThe HTTP status code.
titlestringA short, human-readable summary of the problem type.
typestringA URI that identifies the problem type, pointing to human-readable documentation on this problem type.