> 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/getting-started-1/conventions.md).

# conventions

## Request format

Every partner endpoint is `POST {BASE}/partner/v1/<name>` with a JSON or form body. Two endpoints use GET: `/partner/v1/wallets` and `/partner/v1/profile`.

In a form body, send list fields such as `splits` and `items` as a JSON string.

## Answers

Every answer has one envelope:

```json
{ "success": true, "message": "", "data": { } }
{ "success": false, "message": "Invalid client credentials", "data": null }
```

Check `success` first. When it is `false`, `message` says why.

## Retries and idempotency

Networks fail. Every money call takes a key. Sending the same key again never moves money twice.

| Call                                                                                                           | Key                     | Same key again                                    |
| -------------------------------------------------------------------------------------------------------------- | ----------------------- | ------------------------------------------------- |
| `create-order`, `create-payment-request`, `create-mandate`, `create-hold`, `create-payout`, `create-bulk-send` | `reference` per app     | Returns the same record. Other terms are refused. |
| `charge-mandate`                                                                                               | `reference` per mandate | Returns the earlier charge                        |
| `refund-order`                                                                                                 | `reference`             | Changes nothing                                   |
| `create-bulk-send` items                                                                                       | item `ref`              | Paid once                                         |
| `release-splits`                                                                                               | none                    | Released splits stay as they are                  |

## Common errors

| Message                                     | Meaning and fix                                                                                         |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| Invalid client credentials                  | Wrong `client_id` or `client_secret`, or the app is not Published.                                      |
| Access token required, or missing scope     | Send `X-Biti-Token`. Reconnect the customer with the scope.                                             |
| Choose the wallet to connect                | The customer has several wallets. They must pick one in Biti.                                           |
| Reference already used with different terms | Use a new `reference` for a new payment.                                                                |
| Not enough balance                          | The customer, or your Payout Wallet for payouts, cannot cover amount plus fee. Show the top-up methods. |
| Over the mandate limit                      | Use `mode: request` instead, or ask for a higher limit.                                                 |
| Order expired or declined                   | Create a new order or request.                                                                          |


---

# 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/getting-started-1/conventions.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.
