You can configure automatic split payments in your test environment, if you have a platform setup.
When processing payments through stores, you can configure the store to automatically apply your billing logic, for example, to your commission, the transaction fees, or chargebacks. This means that you don't need to send split instructions in every payment or capture request.
For Adyen to automatically apply the split instructions, you'll need to:
- Create a split configuration that contains the conditions that determine whether to split a payment, and the split logic itself.
You can create and manage your split configurations using the Management API.
- Update the store to apply the split configuration.
How split configuration works
Each split configuration consists of one or multiple rules. Each rule contains a set of conditions and split logic items.
The conditions define whether a transaction is split according to the split logic. If a transaction meets all the conditions, the split logic is applied.
|Shopper interaction||Defines whether the rule applies to a specific sales channel, or all channels.|
|Currency||Defines whether the rule applies to a specific currency, or all currencies.|
|Payment method||Defines whether the rule applies to a specific payment method (based on the funding source), or all payment methods associated with the store.|
|Funding source||Defines whether the rule applies to only credit or debit, or all transactions.|
The split logic determines how the transaction is split: the amounts booked to your liable balance account and to your user's balance accounts, and how they appear in the webhooks and reports.
|Commission||Defines the logic for booking the commission fee for payments. It can be a fixed amount (specified in minor units), a percentage (specified in basis points), or both.|
|Transaction fee||Defines the logic for booking transaction fees for payments. The fees can be booked either to your liable balance account or your user's balance account.|
|Additional commission||Defines the logic for booking an additional commission for payments to your user's balance account.|
|Chargeback||Defines the logic for booking the chargeback amount.|
|Remainder||Defines the logic for booking the leftover amount (after currency conversion).|
|Surcharge||Defines the logic for booking surcharges.|
|Tip||Defines the logic for booking tips.|
When a transaction meets all conditions of the rule, Adyen applies the corresponding split logic.
We recommend that you always include a catch-all rule (set all conditions to ANY) in your configuration, because if none of the rules apply to the transaction, then all funds are booked to your liable balance account.
Adyen evaluates the rules in the split configuration for all the transactions processed through the store. If you need to change the split information for specific transactions, you can send split instructions in the payment or capture request. Any split instruction that you send through APIs overrides the automatic split configuration.
If a split configuration has multiple rules and more than one rule applies to the transaction, Adyen applies the logic from the condition with the highest priority. The conditions are prioritized based on the following hierarchy:
- Payment method
- Funding source
- Shopper interaction
Let's view two scenarios based on the following split configuration rules:
|Currency||Payment method||Funding source||Shopper interaction||Commission|
|1||EUR||Any||Any||Any||EUR 3.00 + 1%|
|2||Any||Any||Any||Ecommerce||USD 2.50 + 1%|
|3||EUR||Visa||Any||Any||EUR 2.00 + 1%|
|4||EUR||Any||Any||Ecommerce||EUR 1.40 + 1%|
|5||EUR||Any||credit||Any||EUR 1.50 + 1%|
Scenario 1: Ecommerce payment in EUR using American Express
The transaction meets the conditions for rules 1, 2, 4 and 5, but rule 5 has the highest priority because it matches the specific currency (EUR) and funding source (credit). Adyen splits the transaction and sends EUR 1.50 + 1% to your liable balance account.
Scenario 2: Ecommerce payment in EUR using Visa
The transaction meets the conditions for all rules. Rule 3 has the highest priority because of the combination of the specific currency (EUR) and payment method (Visa). Rule 5 has the second highest priority, as it matches the currency and funding source (credit). The third highest priority is rule 4, because of the currency and channel (Ecommerce) match. Adyen splits the transaction and sends EUR 2.00 + 1% to your liable balance account.
When refunding a payment that was split according to the automatic split configuration rules, you can either deduct the same amounts from the same balance accounts as used in the original payment request, or provide new split data.
By default, if the refunded amount is equal to the amount of the authorisation, the refund uses the split data from the authorisation. However, if you want to change how the refund is split or refund the payment only partially, you must include the
splits array (with your preferred split logic and amounts) in the refund request. For instructions, see Refund online payments or Refund in-person payments.