> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vestrapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Splits

> Add a service in the dashboard and divide it across sub-accounts by percentage, with unique split titles and optional manual settlement.

A split configuration tells Vestrapay how to divide whatever amount is allocated to one service. It is a list of splits. Each split picks a sub-account from your pool, gives it a percentage share and gives it a title. The shares on one service always add up to exactly 100%.

Splits are the standing half of the model. They describe the arrangement for a service. The amount that flows into a service on a particular payment is decided separately, when your server initialises the payment. See [Distribution](https://docs.vestrapay.com/services/distribution.md) for that half.

## Before you start

You need sub-accounts in your pool for every account that should receive a share. Add them on the **Accounts** page first. See [Sub-accounts](https://docs.vestrapay.com/services/subaccounts.md).

Your team role needs full access to the **Services** area to add or change services, and read access to view them.

## The Services page

Choose **Services** in the sidebar. The page is titled "Services" and describes itself as "Split transaction money between multiple bank accounts." Your services are listed here, and the page is where you add a service, edit one, and enable or disable it.

## Add a service

Adding a service is a two-step dialog. The first step names the service. The second step divides it.

**1. Choose Add a service**

On the **Services** page, select **Add a service**. The **Add new service** dialog opens.

**2. Define the service**

The first step is **Define service**.

| Field | What to enter |
| - | - |
| Service title | A name for the revenue stream, such as "Tuition". Service titles must be unique. |
| Description | Optional. A note for your own team. |

Choose **Continue to splits**.

**3. Configure the split**

The second step is **Split configuration**. Select **Add new split** for each destination.

| Field | What to enter |
| - | - |
| Split title | A label for this share, such as "FEDERAL GOVT". It appears as a tag on the settlement the split produces. |
| Select a sub-account | The destination account, chosen from your pool. |
| Share % | The percentage of the service that this split receives. |

Keep adding splits until the shares total 100%.

**4. Create the service**

Choose **Create service**. The service now appears on the **Services** page, with its service key.

If you leave the splits empty, the dashboard tells you "All revenue settles to your primary account". That is a valid choice for a service that you want to track by name but not divide.

> [!NOTE]
>
> The **service key** is generated from the title when you create the service, and it is shown on the service. Your payments use the key, not the title, to refer to the service. Agree it with your developers before you launch. See [Distribution](https://docs.vestrapay.com/services/distribution.md).

## Edit a service

To change a service, choose the pencil icon on it. The **Edit service details** dialog opens, with the same two parts as when you added it: the service details, and the split configuration.

* Change the title or description, then choose **Save changes**.
* Add, edit or remove splits, then save. The dashboard confirms with "Split configuration saved".

When you save, the full list of splits you can see is what is stored. A split you remove from the list is removed from the service, and the shares must again total 100% before the dashboard accepts the save.

Editing does not affect payments that have already been initialised. See [Payments in flight](#payments-in-flight) below.

## The rules

The configuration is checked as a whole. If any rule is broken, nothing is saved and the dashboard tells you what is wrong.

1. **Shares total exactly 100%.** Under or over is rejected. Decimals are allowed, so 33.33, 33.33 and 33.34 is a valid three-way division. Each share is between 0.01 and 100, with up to two decimal places.
2. **Split titles are unique within the service.** The comparison ignores case and surrounding spaces. Every split needs a title, up to 60 characters.
3. **A service has between one and ten splits.**
4. **The primary settlement account cannot be used.** Whatever the splits leave unallocated already settles to it.
5. **Each sub-account must be in your pool.** You can only choose accounts you have added under **Accounts**.
6. **One account may back several splits in the same service**, each under its own title. Settlement pays that account once, with the legs summed. Every split on the same account must use the same manual settlement choice, and the same destination account when manual settlement is on.
7. **A sub-account can be used by any number of services.** Choosing it in a split never copies or creates an account.

### Why one account can back several splits

Sometimes a single bank account is owed money for more than one reason. A regulator might receive both a licence fee share and a levy share into the same account, and you want to label and report them separately. Giving the account two splits with two titles keeps the books clear and still results in one payout. Because the account is the same, both splits must agree on manual settlement.

## Manual settlement and Treasury Single Accounts

Most splits are paid automatically to the sub-account's bank account. Some arrangements need a different route, such as a government revenue account paid by a manual process. For those, turn on **Requires manual settlement (TSA)** on the split and enter a destination account.

* **Destination account** is a 10-digit account number. It is paid instead of the sub-account. It is required whenever manual settlement is on, and must be exactly ten digits.
* The destination's bank is shown as a **CBN** chip. There is no name enquiry for it, so check the number carefully yourself.
* Manual legs are paid and confirmed by Vestrapay's operations team rather than automatically. See [Settlements](https://docs.vestrapay.com/settlements/overview.md).
* In settlement views and exports, the account number of a manual or TSA destination is shown as TSA rather than the real number.

If the option is not available to you, contact [tech@vestrapay.com](mailto:tech@vestrapay.com).

## Enable or disable a service

On the **Services** page you can disable a service without losing its configuration. The dashboard asks you to confirm in a dialog. While a service is disabled, new payments and new payment links cannot name it. Payments that do not name it are unaffected. Enable it again to resume. The default service cannot be disabled.

## Payments in flight

The split is resolved when a payment is **initialised**, and the result travels with that payment. If you change a service afterwards, payments already initialised still credit the accounts they were created with. Payments initialised after the change use the new configuration. The one exception is an account that cannot be credited at the moment the payment succeeds: its share falls back to your primary account. Collections already recorded are never restated.

## Partners and splits

Partner users are given access to the splits you choose. If you restructure a service, review the partners attached to it afterwards so that they still see what you intend. See [Partners](https://docs.vestrapay.com/partners/overview.md).

## Using the service in a payment

Splits do nothing until a payment names the service. When your server initialises a payment, it puts the service key in the distribution, with the amount you want allocated to it:

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "amount": "1000.00",
  "email": "customer@email.com",
  "distribution": { "tuition": 600 }
}
```

If Tuition is split 85% and 15% between two accounts, the 600 is divided into 510.00 and 90.00. The other 400.00 goes to your primary settlement account. The worked example, the rules and how verify reports the result are on [Distribution](https://docs.vestrapay.com/services/distribution.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.