# Split

A collection of endpoints for spliting a transaction and managing the splits

## Methods

| Method | HTTP | Path | Summary |
|---|---|---|---|
| `add_subaccount` | `POST` | `/split/{id}/subaccount/add` | Add Subaccount to Split |
| `create` | `POST` | `/split` | Create Split |
| `fetch` | `GET` | `/split/{id}` | Fetch Split |
| `list` | `GET` | `/split` | List Splits |
| `remove_subaccount` | `POST` | `/split/{id}/subaccount/remove` | Remove Subaccount from split |
| `update` | `PUT` | `/split/{id}` | Update Split |

---

## `add_subaccount`

**HTTP:** `POST`  
**Path:** `/split/{id}/subaccount/add`

```ruby
paystack.split.add_subaccount(id, { ... })
```

### Path Parameters

| Name | Required |
|---|---|
| `id` | true |

### Body Fields

| Name | Required |
|---|---|
| `subaccount` | false |
| `share` | false |

## `create`

**HTTP:** `POST`  
**Path:** `/split`

```ruby
paystack.split.create({ ... })
```

### Body Fields

| Name | Required |
|---|---|
| `name` | true |
| `type` | true |
| `subaccounts` | true |
| `currency` | true |
| `bearer_type` | false |
| `bearer_subaccount` | false |

## `fetch`

**HTTP:** `GET`  
**Path:** `/split/{id}`

```ruby
paystack.split.fetch(id)
```

### Path Parameters

| Name | Required |
|---|---|
| `id` | true |

## `list`

**HTTP:** `GET`  
**Path:** `/split`

```ruby
paystack.split.list({ ... })
```

### Query Fields

| Name | Required |
|---|---|
| `subaccount_code` | false |
| `name` | false |
| `active` | false |
| `per_page` | false |
| `page` | false |
| `from` | false |
| `to` | false |

## `remove_subaccount`

**HTTP:** `POST`  
**Path:** `/split/{id}/subaccount/remove`

```ruby
paystack.split.remove_subaccount(id, { ... })
```

### Path Parameters

| Name | Required |
|---|---|
| `id` | true |

### Body Fields

| Name | Required |
|---|---|
| `subaccount` | false |
| `share` | false |

## `update`

**HTTP:** `PUT`  
**Path:** `/split/{id}`

```ruby
paystack.split.update(id, { ... })
```

### Path Parameters

| Name | Required |
|---|---|
| `id` | true |

### Body Fields

| Name | Required |
|---|---|
| `name` | false |
| `active` | false |
| `bearer_type` | false |
| `bearer_subaccount` | false |