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

# wallet

Read the connected wallet and the top-up methods.

| Endpoint                                                                 | Purpose                   |
| ------------------------------------------------------------------------ | ------------------------- |
| [`POST /partner/v1/connected-wallet`](#post-partnerv1connected-wallet)   | Read the connected wallet |
| [`POST /partner/v1/get-topup-methods`](#post-partnerv1get-topup-methods) | Get top-up methods        |

## POST /partner/v1/connected-wallet

**Read the connected wallet**

{% hint style="info" %}
Auth: send the customer token in the `X-Biti-Token` header. Do not send `client_id` or `client_secret`.
{% endhint %}

Return label, currency, balance and status of the one wallet the customer connected. You can call it with GET or POST.

This endpoint also answers to GET.

**Errors:**

* Access token required, or the token has no `wallet.read` scope
* No wallet connected
* The wallet is not Active

### Parameters

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
|      |      |          |             |

### Request

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

```bash
curl -X POST "https://api.biti.so/partner/v1/connected-wallet" \
  -H "Content-Type: application/json" \
  -H "X-Biti-Token: YOUR_ACCESS_TOKEN" \
  -d '{}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/connected-wallet"
headers = {
    "Content-Type": "application/json",
    "X-Biti-Token": "YOUR_ACCESS_TOKEN",
}
payload = {}

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/connected-wallet", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Biti-Token": "YOUR_ACCESS_TOKEN"
  },
  body: JSON.stringify({}),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "wallet_label": "Main Wallet",
    "currency": "USD",
    "balance": 412.5,
    "status": "Active"
  }
}
```

***

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

**Get top-up methods**

{% hint style="info" %}
Auth: send the customer token in the `X-Biti-Token` header. Do not send `client_id` or `client_secret`.
{% endhint %}

Return the linked mobile money and bank accounts of the customer, with masked numbers. Use it to show a "Top up in Biti" button when the balance is too low. It reuses the `wallet.read` scope. You can call it with GET or POST.

This endpoint also answers to GET.

**Errors:**

* Access token required, or the token has no `wallet.read` scope
* No wallet connected
* The wallet is not Active

### Parameters

| Name | Type | Required | Description |
| ---- | ---- | -------- | ----------- |
|      |      |          |             |

### Request

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

```bash
curl -X POST "https://api.biti.so/partner/v1/get-topup-methods" \
  -H "Content-Type: application/json" \
  -H "X-Biti-Token: YOUR_ACCESS_TOKEN" \
  -d '{}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://api.biti.so/partner/v1/get-topup-methods"
headers = {
    "Content-Type": "application/json",
    "X-Biti-Token": "YOUR_ACCESS_TOKEN",
}
payload = {}

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-topup-methods", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Biti-Token": "YOUR_ACCESS_TOKEN"
  },
  body: JSON.stringify({}),
});
console.log(await response.json());
```

{% endtab %}
{% endtabs %}

### Response

```json
{
  "success": true,
  "message": "",
  "data": {
    "methods": [
      {
        "id": "LA-0012",
        "provider": "EVC Plus",
        "label": "My EVC",
        "masked_number": "61***456",
        "is_default": true
      }
    ],
    "topup_link": "biti://topup?wallet=**9126"
  }
}
```


---

# 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-1/wallet.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.
