To make sure that the pay-in, settlement, and payout processes run smoothly for all users' transactions, you must book the funds and fees to the correct balance accounts. This means that in each individual payment, capture, and refund request that you send on behalf of your users, you have to include instructions on how to split the funds between your user's balance accounts and your marketplace's liable balance account.
If you do not provide any split instructions in a split configuration profile or through and API request, the whole transaction amount and fees are booked to your user's balance account.
Requirements
Take into account the following requirements, limitations, and preparations to start processing payments.
Requirement | Description |
---|---|
Integration type | You must have an Adyen online payments integration and a checkout UI. |
API credentials | You must have credentials for the following APIs: |
Webhooks | Ensure that your server can receive and accept standard webhooks. Subscribe to any of the following webhooks: |
Capabilities | Make sure that your account holders have the following capabilities:
|
Setup steps | When you build your online payments integration, choose between the following server-side flows:
|
When to provide split instructions
You can provide instructions to split payments and chargebacks when you make calls to the following endpoints:
- /payments or /sessions to authorize a payment.
- /payments/{paymentPspReference}/amountUpdates to update the authorized payment amount.
- /payments/{paymentPspReference}/captures to capture a payment.
Splitting payments at capture is only possible for payment methods that support separate captures.
You can provide instructions to split refunds when you make calls to the following endpoint:
- /payments/{paymentPspReference}/refunds to refund a payment.
This means that for every authorization, capture, or refund request that occurs in your marketplace, you can determine how to book the funds from that transaction.
How to split a transaction
When you process transactions for your users, you can split the funds and book them to any number of balance accounts in your marketplace.
Send split instructions
You can provide instructions to split payments, refunds, and chargebacks.
Split types
When you send an API request for a transaction, you must define split instructions for each split of the full transaction amount using the splits
array. In each set of split instructions within the array, you must use the type
field to define the purpose of that split.
Certain split types also require you to define other values in the split instructions. For example, when you want to book the split amount to your user's balance account (type
is BalanceAccount), you must specify the ID of that balance account using the account
parameter.
The following table shows the possible split type
values you can send in your request, and whether you must send another parameter (account
, amount
, or reference
) in the split instruction. If you do not specify an account
in your split instructions, the split amount is booked to your liable balance account.
Split type | Description | Required additional parameters | Recommended additional parameters | |
---|---|---|---|---|
BalanceAccount | Books a part of the transaction to your user's balance account. You must specify the account and the amount in your request. |
account amount reference |
||
Commission | Books your marketplace's commission to your liable balance account. | amount |
reference |
|
Interchange | Books the fee paid to the issuer to the specified account . |
account reference |
||
SchemeFee | Books the scheme fee to the specified account . |
account reference |
||
AcquiringFees | Books the aggregated amount of the interchange and scheme fees to the specified account . |
account reference |
||
AdyenCommission | Books the transaction fee due to Adyen under blended rates to the specified account . |
account reference |
||
AdyenMarkup | Books the transaction fee due to Adyen under Interchange ++ pricing to the specified account . |
account reference |
||
AdyenFees | Books the aggregated amount of Adyen's commission and markup to the specified balance account. | account reference |
||
PaymentFee | Books the aggregated amount of all the transaction fees to the specified account . |
account reference |
||
VAT | Books the value-added tax (VAT) incurred on a payment to the specified account , allowing you to book this tax separately from the sale amount. |
amount |
account reference |
|
Remainder | Books the amount left over after currency conversion to the specified account . |
account reference |
||
TopUp | Books the funds from a top-up, paid by your user, to the specified account . |
account amount |
reference |