Split payments automatically
If you have a platform setup, you can automatically direct funds and book fees to predefined balance accounts.
When accepting an online payment, you can split the payment amount between the balance accounts in your platform. This allows you to separately book the sale amount, your platform's commission, transaction fees, and remainder.
Send the split data in your payment request
To split the payment amount at the time of payment, add a splits array to your POST /payments or POST /sessions request.
For each item in the array, specify the following fields:
| Parameter | Required | Description |
|---|---|---|
| account |  |
The account that will receive (or be charged) the split amount. This is the balanceAccountId of one of your user's balance accounts. You do not need to specify this field when type is Commission. |
| amount.currency | Required for currency conversion | The currency of the split amount. |
| amount.value | |
The value of the split amount. You do not need to specify this field for transaction fees, because they are not known at the time of payment. |
| type | |
Defines the part of the payment you want to book to the specified account.Possible values:
|
| reference | Required if type is BalanceAccount |
Your unique identifier for the specific transaction split. You need this for reconciliation, as explained under Best practices. |
| description | Your description for the specific transaction split, which is returned in our reporting. |
Here is an example of how you can split the payment amount at the time of payment, when a customer pays EUR 400.00.
- EUR 396.00 is booked to your user's balance account as payment for the goods or service.
- EUR 4.00 is booked to your liable balance account as your platform's commission.
- All transaction fees are booked to your user's balance account, deducted from the sale amount.
In the response, note that your reference from the request is returned as the merchantReference. You need this information for reconciliation, as explained under Best practices.
Best practices
We strongly recommend sending a reference for all split types. You can use the reference to reconcile the split amounts in the transaction overview and in the reports. Without a reference, the split amounts are aggregated in a single entry and you will be unable to reconcile the transactions.
If you do not know the split amounts at the time of payment, you can provide split data at capture instead. Split data provided at capture overrides any split data provided with the initial payment request. However, we recommend that you provide the split information at the time of payment, rather than at capture. Because some payment methods do not support delayed captures, the funds may not be booked correctly unless the split data is provided in the payment request.