Split transactions between balance accounts

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 you must define instructions about how to split the funds between your user's balance accounts and your platform's liable balance account. You can define these instructions in the following ways:

• Automatically split all transactions processed through your user's store by setting up split configuration profiles.
• Split transactions by defining instructions for each API request. The instructions you provide in your API requests override the instructions you defined in your split configuration profiles.

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.

Split specific transactions

If you want to define separate instructions for specific transactions in your platform, you can define the split instructions in your API requests. The instructions you provide in your API requests override any automatic split configuration profiles applied to your user's store.

The following information on this page explains the process of defining split instructions for specific transactions. Before sending an API request with split instructions, make sure you understand:

• When to provide split instructions
• How you can split a transaction
• How to send split instructions
• Which split types you can include in your request

When to provide split instructions

You can provide instructions to split payments when you make the following requests:

• An authorization request for a payment using Terminal API
• A capture request for a payment using Checkout API

You can provide instructions to split refunds when you make the following request:

• A refund request using Terminal API

This means that for every authorization, capture, or refund request that occurs in your platform, 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 platform.

Send split instructions

When you send an API request for a payment or refund, you must define split instructions for each split of the full transaction amount.

To define split instructions in your Terminal API requests:

1. Format the split instructions either as form-encoded key-value pairs, or as a JSON object converted to a Base64-encoded string.
2. Pass the formatted instructions in the saleToAcquirerData object of your authorization or refund request.

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

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 saleToAcquirerData object. In each set of split instructions within the object, 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.