Split transactions between balance accounts

When you process transactions on behalf of your users, you must determine where to book the funds.

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, the whole transaction is booked to your platform's liable balance account, including all associated fees.

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}/captures to capture a payment.

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.

For payments, you can provide specific instructions on booking:

• The sale amount for the goods or services
• Your marketplace's commission for the payment
• The fees incurred by the payment
• The leftover amount after currency conversion
• The amount paid by your user to top up their balance account

For refunds, you can provide specific instructions on booking:

• The sale amount of the refund
• Your marketplace's commission that is now refunded
• The fees incurred by the refund
• The leftover amount after currency conversion

For chargebacks, you can provide specific instructions on booking:

• The disputed amount of the chargeback
• The fees incurred by the chargeback

Your marketplace's commission is always booked to your liable balance account.

Send split instructions

You can provide instructions to split payments, refunds, and chargebacks.

Payments and refunds

When you split a payment or refund between multiple balance accounts, each split serves a different purpose. For example, a part of the transaction goes to your liable balance account as your marketplace's commission, and a part goes to your user's balance account as the sale amount.

When you send an API request for a payment or refund, you must define split instructions for each split of the full transaction amount. You can do this by including a splits array in your authorization, capture, or refund requests. Each object in the splits array represents one set of split instructions, and defines how to book a specific part of the transaction.

Within each object in the splits array, you must define certain values. The links in the following table show you which values you need to provide for each type of request you make.

For more information on making a payment, capture, or refund request with a splits array, see the following pages:

For more information on making a payment, capture, or refund request with a splits array, see the following pages:

• Split a payment at authorization
• Split a payment at capture
• Split refunds

Chargebacks

When you send an authorization or capture request for a payment, you can define instructions on how to book potential chargebacks on that payment. To do this, include a platformChargebackLogic object in your authorization or capture request.

The links in the following table show you which values you need to provide inside the object.

For more information on defining split instructions for chargebacks, see Split 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.