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, commission, transaction fees, and remainder.
To split the payment amount at the time of payment, add a splits array to your POST /payments or POST /sessions request. For each split 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.value | |
The value of the split amount. You do not need to specify this field when type is PaymentFee, since this is not known at the time of payment. |
| amount.currency | Required in case of a currency conversion. The currency of the split amount. | |
| reference | Your unique identifier for that specific transaction split. While this field is only required in the API if type is BalanceAccount, we strongly recommend sending a reference for all other types. You can use the reference to reconcile the split and the associated payment in the transaction overview and in the reports. Without a reference, the amounts are merged and you will be unable to reconcile the split. |
|
| description | Your description for that specific transaction split, which is returned in our reporting. | |
| type | |
Split type:
|
You can send split data regardless of your PCI compliance level.
If you do not know the split amount at the time of payment, you can skip providing this at payment and provide split data at capture instead. Split data provided at capture overrides any split data provided with the initial payment request.
We recommend that you always provide split information at the time of payment, rather than at capture. Since certain payment methods do not support delayed captures, the funds may not be booked correctly unless split data is provided in the payment request.
Here is an example of how you can split the payment amount at the time of payment, when a customer pays for goods worth EUR 400.00.
- EUR 396.00 goes to the seller's balance account (BA00000000000000000000001) as payment for the goods.
- EUR 4.00 goes to your liable balance account as your platform's commission.
- The transaction fees are booked against the seller's balance account (BA00000000000000000000001). This will be deducted from the sale amount.