# Wallet Balance

{% hint style="danger" %}
**This documentation site has been deprecated as of September 8, 2025, and will no longer receive updates. Please refer to the new documentation site at** [**https://docs.squadco.com**](https://docs.squadco.com)**.**
{% endhint %}

{% hint style="warning" %}
**Authorization** Any request made without the authorization key will fail with a **`401`**` ``(Service Not Authorized)` response code.
{% endhint %}

{% hint style="info" %}
**Authorization** would be done via Headers using Keys gotten from your dashboard. 
{% endhint %}

**Example:**\
Authorization**:** Bearer sandbox\_sk\_94f2b798466408ef4d19e848ee1a4d1a3e93f104046f

## This endpoint allows you get your Squad Wallet Balance. Amount is in KOBO.

<mark style="color:blue;">`GET`</mark> `https://sandbox-api-d.squadco.com/merchant/balance`

#### Query Parameters

| Name                                           | Type   | Description                                                                                                          |
| ---------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| currency\_id<mark style="color:red;">\*</mark> | String | <p>It only takes the value "NGN".<br>(Please note that you can't get wallet balance for Dollar transactions)<br></p> |

{% tabs %}
{% tab title="200: OK Successful" %}

```
{
    "status": 200,
    "success": true,
    "message": "Success",
    "data": {
        "balance": "2367013",
        "currency_id": "NGN",
        "merchant_id": "SBN1EBZEQ8"
    }
}
```

{% endtab %}

{% tab title="401: Unauthorized No Authoirzation" %}

```
{
    "success": false,
    "message": "",
    "data": {}
}
```

{% endtab %}

{% tab title="403: Forbidden Wrong/Invalid API Key" %}

```

{
    "success": false,
    "message": "Merchant authentication failed",
    "data": {}
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://squadinc.gitbook.io/squad-api-documentation/wallet-balance.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.