Create a split configuration profile

post/merchants/{merchantId}/splitConfigurations

API Version

Creates a split configuration profile to split payments automatically. After you associate it with a store in your merchant account, it splits the funds of all transactions processed through that store between your liable balance account and your user's balance account.

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

Path Parameters

Required

Optional

The unique identifier of the merchant account.

Request Parameters

Required

Optional

Max length: 300

Your description for the split configuration.

Array of rules that define the split configuration behavior.

The card region condition that determines whether the split logic applies to the transaction.

This condition is in pilot phase, and not yet available for all platforms.

Possible values:

domestic: The card issuer and the store where the transaction is processed are registered in the same country.
international: The card issuer and the store where the transaction is processed are registered in different countries or regions. Includes all interRegional and intraRegional transactions.
interRegional: The card issuer and the store where the transaction is processed are registered in different regions.
intraRegional: The card issuer and the store where the transaction is processed are registered in different countries, but in the same region.
ANY: Applies to all transactions, regardless of the processing and issuing country/region.

The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.

The funding source of the payment method.

Possible values:

credit
debit
prepaid
deferred_debit
charged
ANY

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

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

Contains the split logic that is applied if the rule conditions are met.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

Deducts the chargeback costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

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.

Deducts the interchange fee from specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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:

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 the paymentFee parameter, booking all transaction fees to your platform's liable balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio

Deducts the refund costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

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

Possible values: addToLiableAccount, addToOneBalanceAccount.

Deducts the scheme fee from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Books the surcharge amount to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount

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.
descriptionstring
Max length: 300
Your description for the split configuration.
rulesarray[object]
Array of rules that define the split configuration behavior.
cardRegionstring
The card region condition that determines whether the split logic applies to the transaction.

This condition is in pilot phase, and not yet available for all platforms.

Possible values:

domestic: The card issuer and the store where the transaction is processed are registered in the same country.

international: The card issuer and the store where the transaction is processed are registered in different countries or regions. Includes all interRegional and intraRegional transactions.

interRegional: The card issuer and the store where the transaction is processed are registered in different regions.

intraRegional: The card issuer and the store where the transaction is processed are registered in different countries, but in the same region.

ANY: Applies to all transactions, regardless of the processing and issuing country/region.

currencystring
The currency condition that defines whether the split logic applies. Its value must be a three-character ISO currency code.
fundingSourcestring
The funding source of the payment method.

Possible values:

credit

debit

prepaid

deferred_debit

charged

ANY

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

ruleIdstring
The unique identifier of the split configuration rule.
shopperInteractionstring
The 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.

splitLogicobject
Contains the split logic that is applied if the rule conditions are met.
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.
balanceAccountIdstring
Unique identifier of the balance account to which the additional commission is booked.
fixedAmountinteger
A fixed commission fee, in minor units.
variablePercentageinteger
A variable commission fee, in basis points.
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
commissionobject
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.
fixedAmountinteger
A fixed commission fee, in minor units.
variablePercentageinteger
A variable commission fee, in basis points.
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:

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 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.
splitLogicIdstring
Unique identifier of the collection of split instructions that are applied when the rule conditions are met.
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.
splitConfigurationIdstring
Unique identifier of the split configuration.
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A 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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

Create a split configuration profile

HTTP Responses

200 - OK

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error