> 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/readme.md).

# README

Use the Biti Partner API to connect your app or server to Biti wallets. You can sign in customers, take one-time and recurring payments, hold deposits, refund, split an order between stores and drivers, pay many people at once, read your statement and receive webhooks.

The example partner in these docs is **Diyaar**, a marketplace that sells food and rooms and pays stores and drivers.

{% hint style="info" %}
The base URL `https://api.biti.so` is a placeholder. Use the URL that Biti gives you.
{% endhint %}

## What you can do

| Goal                                         | Where to read                                                    |
| -------------------------------------------- | ---------------------------------------------------------------- |
| Make your first call                         | [Quickstart](https://docs.biti.so/getting-started/quickstart.md) |
| Connect a customer wallet                    | [Connect a customer](https://docs.biti.so/connect.md)            |
| Ask a customer to pay                        | [Payment requests](https://docs.biti.so/payment-requests.md)     |
| Take a checkout payment                      | [Orders and checkout](https://docs.biti.so/orders-checkout.md)   |
| Charge a customer every month                | [Auto-pay](https://docs.biti.so/auto-pay.md)                     |
| Reserve a deposit                            | [Deposit holds](https://docs.biti.so/deposit-holds.md)           |
| Share one payment between stores and drivers | [Order splits](https://docs.biti.so/order-splits.md)             |
| Pay up to 100 people in one call             | [Bulk send](https://docs.biti.so/guides/bulk-send.md)            |
| Look up every endpoint                       | [API reference](https://docs.biti.so/api-reference/connect.md)   |
| Receive events                               | [Webhooks](https://docs.biti.so/webhooks.md)                     |

## Base URL and format

Every endpoint is `{BASE}/partner/v1/<name>`. Send a JSON body. Every answer has the same envelope:

```json
{ "success": true, "message": "", "data": { } }
```

See [Conventions](https://docs.biti.so/getting-started/conventions.md) for errors and retries.


---

# 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/readme.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.
