Pricing Templates
Log in Sign up
Integrations / Adyen Management / ...

POST /merchants/{merchantId}/splitConfigurations

Creates a split configuration for the merchant account specified in the path.

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

Servers

Path parameters

Name Type Required Description
merchantId String Yes

The unique identifier of the merchant account.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
rules[] Array Yes

Array of rules that define the split configuration behavior.
rules[].paymentMethod String Yes

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.
rules[].shopperInteraction String Yes

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.

Possible values:

  • "ContAuth"
  • "Ecommerce"
  • "POS"
  • "Moto"
  • "ANY"
rules[].ruleId String No

The unique identifier of the split configuration rule.
rules[].fundingSource String No

The funding source condition of the payment method (only for cards).

Possible values: credit, debit, or ANY.

Possible values:

  • "credit"
  • "ANY"
  • "debit"
rules[].splitLogic Object Yes

Contains the split logic that is applied if the rule conditions are met.
rules[].splitLogic.additionalCommission Object No

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.
rules[].splitLogic.additionalCommission.fixedAmount Integer No

A fixed commission fee, in minor units.
rules[].splitLogic.additionalCommission.variablePercentage Integer No

A variable commission fee, in basis points.
rules[].splitLogic.additionalCommission.balanceAccountId String No

Unique identifier of the balance account to which the additional commission is booked.
rules[].splitLogic.remainder String No

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

Possible values: addToLiableAccount, addToOneBalanceAccount.

Possible values:

  • "addToLiableAccount"
  • "addToOneBalanceAccount"
rules[].splitLogic.splitLogicId String No

Unique identifier of the collection of split instructions that are applied when the rule conditions are met.
rules[].splitLogic.refund String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio

Possible values:

  • "deductAccordingToSplitRatio"
  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.chargebackCostAllocation String No

Deducts the chargeback costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.adyenCommission String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.commission Object Yes

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.
rules[].splitLogic.commission.fixedAmount Integer No

A fixed commission fee, in minor units.
rules[].splitLogic.commission.variablePercentage Integer No

A variable commission fee, in basis points.
rules[].splitLogic.tip String No

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

Possible values: addToLiableAccount, addToOneBalanceAccount.

Possible values:

  • "addToLiableAccount"
  • "addToOneBalanceAccount"
rules[].splitLogic.interchange String No

Deducts the interchange fee from specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.schemeFee String No

Deducts the scheme fee from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.acquiringFees String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.paymentFee String No

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.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.refundCostAllocation String No

Deducts the refund costs from the specified balance account.

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.adyenMarkup String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.chargeback String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount, deductAccordingToSplitRatio.

Possible values:

  • "deductAccordingToSplitRatio"
  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].splitLogic.surcharge String No

Books the surcharge amount to the specified balance account.

Possible values: addToLiableAccount, addToOneBalanceAccount

Possible values:

  • "addToLiableAccount"
  • "addToOneBalanceAccount"
rules[].splitLogic.adyenFees String No

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

Possible values: deductFromLiableAccount, deductFromOneBalanceAccount.

Possible values:

  • "deductFromOneBalanceAccount"
  • "deductFromLiableAccount"
rules[].currency String Yes

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

Your description for the split configuration.
splitConfigurationId String No

Unique identifier of the split configuration.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2024 SimWorkflow
Terms of Service Privacy Policy