> For the complete documentation index, see [llms.txt](https://docs.biti.so/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.biti.so/api-reference/bulk-send.md).

# bulk send

Pay up to 100 receivers in one call.

| Endpoint                                                                       | Purpose                       |
| ------------------------------------------------------------------------------ | ----------------------------- |
| [`POST /partner/v1/get-payout-methods`](#post-partnerv1get-payout-methods)     | List payout methods           |
| [`POST /partner/v1/quote-bulk-send`](#post-partnerv1quote-bulk-send)           | Quote a bulk send             |
| [`POST /partner/v1/create-bulk-send`](#post-partnerv1create-bulk-send)         | Create a bulk send            |
| [`POST /partner/v1/get-bulk-send-status`](#post-partnerv1get-bulk-send-status) | Get the status of a bulk send |

## POST /partner/v1/get-payout-methods

**List payout methods**

{% hint style="info" %}
Auth: send `client_id` and `client_secret` in the request body. Call it from your server only.
{% endhint %}

List the methods you can send to. The list always has `biti` and `merchant`. It also has each active mobile money provider that Biti can pay out to. Today the live mobile money method is `evcplus`.

**Errors:**

* Invalid client credentials

### Parameters

| Name            | Type   | Required | Description                      |
| --------------- | ------ | -------- | -------------------------------- |
| `client_id`     | string | yes      | Your client ID.                  |
| `client_secret` | string | yes      | Your client secret. Server only. |

### Request

{% tabs %}
{% tab title="curl" %}

```bash
curl -X POST "https://api.biti.so/partner/v1/get-payout-methods" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/get-payout-methods"
headers = {
    "Content-Type": "application/json",
}
payload = {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch("https://api.biti.so/partner/v1/get-payout-methods", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  }),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "methods": [
      {
        "method": "biti",
        "name": "Biti Wallet"
      },
      {
        "method": "merchant",
        "name": "Biti merchant"
      },
      {
        "method": "evcplus",
        "name": "EVC Plus",
        "country": "SO",
        "number_format": "61xxxxxxx"
      }
    ]
  }
}
```

***

## POST /partner/v1/quote-bulk-send

**Quote a bulk send**

{% hint style="info" %}
Auth: send `client_id` and `client_secret` in the request body. Call it from your server only.
{% endhint %}

Take the same body as `create-bulk-send`. Return the fees and whether you can afford the batch. This call moves no money.

`needs_approval` is `true` when the total is above the approval limit. The default limit is 1000 in the batch currency.

**Errors:**

* Invalid client credentials
* An item number does not match the provider format
* A repeated item `ref`

### Parameters

| Name            | Type              | Required | Description                                  |
| --------------- | ----------------- | -------- | -------------------------------------------- |
| `client_id`     | string            | yes      | Your client ID.                              |
| `client_secret` | string            | yes      | Your client secret. Server only.             |
| `reference`     | string            | yes      | Unique batch id.                             |
| `currency`      | string            | yes      | Currency of every item.                      |
| `items`         | array of BulkItem | yes      | List of items. See item fields.              |
| `label`         | string            | no       | Default `label` for items without their own. |
| `sms`           | string            | no       | Default `sms` for items without their own.   |

### Request

{% tabs %}
{% tab title="curl" %}

```bash
curl -X POST "https://api.biti.so/partner/v1/quote-bulk-send" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "reference": "PAYROLL-2026-11",
  "currency": "USD",
  "items": [
    {
      "ref": "drv-1",
      "method": "evcplus",
      "number": "615123456",
      "amount": 25
    }
  ]
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/quote-bulk-send"
headers = {
    "Content-Type": "application/json",
}
payload = {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "reference": "PAYROLL-2026-11",
    "currency": "USD",
    "items": [
        {
            "ref": "drv-1",
            "method": "evcplus",
            "number": "615123456",
            "amount": 25,
        },
    ],
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch("https://api.biti.so/partner/v1/quote-bulk-send", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "reference": "PAYROLL-2026-11",
    "currency": "USD",
    "items": [
      {
        "ref": "drv-1",
        "method": "evcplus",
        "number": "615123456",
        "amount": 25
      }
    ]
  }),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "total": 25,
    "fees": 0.25,
    "grand_total": 25.25,
    "balance": 1532.8,
    "can_afford": true,
    "needs_approval": false,
    "items": [
      {
        "ref": "drv-1",
        "fee": 0.25
      }
    ]
  }
}
```

***

## POST /partner/v1/create-bulk-send

**Create a bulk send**

{% hint style="info" %}
Auth: send `client_id` and `client_secret` in the request body. Call it from your server only.
{% endhint %}

Pay up to 100 receivers from your Payout Wallet in one call. Use it for payroll, supplier payments and prizes. The whole batch is refused if your Payout Wallet cannot cover the total plus all fees.

You pay the fees. Each receiver gets the exact `amount`. A total above the approval limit (default 1000 in the batch currency) gets the status `awaiting_approval`. Nothing moves until Biti approves the batch. See [Bulk send](#).

### Item fields

| Field    | Type   | Required | Description                                                                                                                            |
| -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `ref`    | string | Yes      | Unique in the batch.                                                                                                                   |
| `method` | string | Yes      | `biti` (wallet id or number), `merchant` (Biti merchant id) or a provider method such as `evcplus`.                                    |
| `number` | string | Yes      | The wallet, merchant id or phone number. A mobile number must match the provider format (see `number_format` in `get-payout-methods`). |
| `amount` | number | Yes      | More than 0, in the batch `currency`.                                                                                                  |
| `name`   | string | No       | Receiver name, for the `{name}` placeholder.                                                                                           |
| `label`  | string | No       | Up to 40 characters. The title the receiver sees in History.                                                                           |
| `sms`    | string | No       | Up to 160 characters. Sent after the item is done. Placeholders: `{amount}`, `{ref}`, `{name}`, `{app}`.                               |
| `note`   | string | No       | Up to 500 characters. Private: stored and returned to you, never shown to the receiver.                                                |

**Errors:**

* Invalid client credentials
* Your Payout Wallet cannot cover the total plus fees
* A repeated item `ref` in one batch
* The same `reference` with other items
* An item number does not match the provider format

### Parameters

| Name            | Type              | Required | Description                                                                       |
| --------------- | ----------------- | -------- | --------------------------------------------------------------------------------- |
| `client_id`     | string            | yes      | Your client ID.                                                                   |
| `client_secret` | string            | yes      | Your client secret. Server only.                                                  |
| `reference`     | string            | yes      | Unique batch id. The same `reference` with the same items returns the same batch. |
| `currency`      | string            | yes      | Currency of every item.                                                           |
| `items`         | array of BulkItem | yes      | List of up to 100 items. See item fields.                                         |
| `label`         | string            | no       | Default `label` for items without their own.                                      |
| `sms`           | string            | no       | Default `sms` for items without their own.                                        |

### Request

{% tabs %}
{% tab title="curl" %}

```bash
curl -X POST "https://api.biti.so/partner/v1/create-bulk-send" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "reference": "PAYROLL-2026-11",
  "currency": "USD",
  "label": "Diyaar payout",
  "items": [
    {
      "ref": "drv-1",
      "method": "evcplus",
      "number": "615123456",
      "amount": 25,
      "name": "Ahmed Ali",
      "label": "Driver pay, week 46",
      "sms": "Diyaar: {amount} driver pay. Thank you!",
      "note": "Includes 3 USD tip"
    },
    {
      "ref": "drv-2",
      "method": "biti",
      "number": "512345678@biti",
      "amount": 18.5
    },
    {
      "ref": "store-7",
      "method": "merchant",
      "number": "M-40021",
      "amount": 120,
      "label": "Store settlement 1 to 15 Nov"
    },
    {
      "ref": "drv-3",
      "method": "evcplus",
      "number": "619876543",
      "amount": 12,
      "name": "Hodan M."
    }
  ]
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/create-bulk-send"
headers = {
    "Content-Type": "application/json",
}
payload = {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "reference": "PAYROLL-2026-11",
    "currency": "USD",
    "label": "Diyaar payout",
    "items": [
        {
            "ref": "drv-1",
            "method": "evcplus",
            "number": "615123456",
            "amount": 25,
            "name": "Ahmed Ali",
            "label": "Driver pay, week 46",
            "sms": "Diyaar: {amount} driver pay. Thank you!",
            "note": "Includes 3 USD tip",
        },
        {
            "ref": "drv-2",
            "method": "biti",
            "number": "512345678@biti",
            "amount": 18.5,
        },
        {
            "ref": "store-7",
            "method": "merchant",
            "number": "M-40021",
            "amount": 120,
            "label": "Store settlement 1 to 15 Nov",
        },
        {
            "ref": "drv-3",
            "method": "evcplus",
            "number": "619876543",
            "amount": 12,
            "name": "Hodan M.",
        },
    ],
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch("https://api.biti.so/partner/v1/create-bulk-send", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "reference": "PAYROLL-2026-11",
    "currency": "USD",
    "label": "Diyaar payout",
    "items": [
      {
        "ref": "drv-1",
        "method": "evcplus",
        "number": "615123456",
        "amount": 25,
        "name": "Ahmed Ali",
        "label": "Driver pay, week 46",
        "sms": "Diyaar: {amount} driver pay. Thank you!",
        "note": "Includes 3 USD tip"
      },
      {
        "ref": "drv-2",
        "method": "biti",
        "number": "512345678@biti",
        "amount": 18.5
      },
      {
        "ref": "store-7",
        "method": "merchant",
        "number": "M-40021",
        "amount": 120,
        "label": "Store settlement 1 to 15 Nov"
      },
      {
        "ref": "drv-3",
        "method": "evcplus",
        "number": "619876543",
        "amount": 12,
        "name": "Hodan M."
      }
    ]
  }),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "batch_id": "MBS-00012",
    "reference": "PAYROLL-2026-11",
    "status": "processing",
    "currency": "USD",
    "total": 175.5,
    "fees": 1.76,
    "items": [
      {
        "ref": "drv-1",
        "status": "processing",
        "fee": 0.25
      },
      {
        "ref": "drv-2",
        "status": "done",
        "fee": 0.19,
        "transaction_id": "TX-...",
        "sms_status": "none"
      }
    ]
  }
}
```

***

## POST /partner/v1/get-bulk-send-status

**Get the status of a bulk send**

{% hint style="info" %}
Auth: send `client_id` and `client_secret` in the request body. Call it from your server only.
{% endhint %}

Return the batch and each item.

Batch status: `awaiting_approval`, `processing`, `completed` (every item ended) or `failed` (every item failed).

Item status: `queued`, `processing`, `done` or `failed`. A failed item has an `error`. `sms_status` is `none`, `sent` or `failed`.

**Errors:**

* Invalid client credentials
* Unknown batch

### Parameters

| Name            | Type   | Required | Description                             |
| --------------- | ------ | -------- | --------------------------------------- |
| `client_id`     | string | yes      | Your client ID.                         |
| `client_secret` | string | yes      | Your client secret. Server only.        |
| `batch_id`      | string | yes      | The `batch_id` from `create-bulk-send`. |

### Request

{% tabs %}
{% tab title="curl" %}

```bash
curl -X POST "https://api.biti.so/partner/v1/get-bulk-send-status" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "batch_id": "MBS-00012"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/get-bulk-send-status"
headers = {
    "Content-Type": "application/json",
}
payload = {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "batch_id": "MBS-00012",
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const response = await fetch("https://api.biti.so/partner/v1/get-bulk-send-status", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "batch_id": "MBS-00012"
  }),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "batch_id": "MBS-00012",
    "status": "completed",
    "items": [
      {
        "ref": "drv-1",
        "status": "done",
        "sms_status": "sent"
      },
      {
        "ref": "drv-3",
        "status": "failed",
        "error": "Number not registered"
      }
    ]
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.biti.so/api-reference/bulk-send.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
