> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/payengine-api-v2.5/payouts/balance.md).

# Get Balance

<mark style="color:blue;">`GET`</mark> `https://<Platform-host>/api/payouts/:partnerId/balance`

**Path Parameters**

| Name                                          | Type   | Description |
| --------------------------------------------- | ------ | ----------- |
| partner\_id<mark style="color:red;">\*</mark> | string | Partner ID  |

#### Query Parameters

<table><thead><tr><th width="349">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id</td><td>string</td><td>Merchant ID</td></tr><tr><td>currency_code</td><td>string</td><td>Currency code using <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format. e.g. USD</td></tr></tbody></table>

**Response Body**

{% tabs %}
{% tab title="200 " %}
{% tabs %}
{% tab title="Field Definitions" %}

<table><thead><tr><th width="217">Field Name</th><th width="85">Type</th><th width="347">Description</th></tr></thead><tbody><tr><td>data</td><td>array</td><td>List of merchants and their available balances</td></tr><tr><td>data[i].merchant_id</td><td>string</td><td>Merchant ID</td></tr><tr><td>data[i].merchantname</td><td>string</td><td>Merchant Name</td></tr><tr><td>data[i].currency_code</td><td>string</td><td>Currency code using <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO 4217</a> format. e.g. USD</td></tr><tr><td>data[i].balance</td><td>string</td><td>Current Available Balance</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Sample Request" %}

```bash
curl --location --request GET '<API_HOST>/api/payouts/2be66e67-88a7-4e04-985d-0a1cfb0a648c/USD/balance' \

--header 'Authorization: Basic <API_KEY>'
```

{% endtab %}

{% tab title="Sample Response" %}

<pre class="language-json"><code class="lang-json"><strong> {
</strong><strong>     "data": 
</strong>    [
        {
          "merchant_id":"1cc7b594-b80f-4227-a0fa-299c4c6ce8ab",
          "merchant_name":"Test Merchant 1"
          "currency_code":"USD",
          "balance":"7500.50"
        },
        {
         "merchant_id":"1ab6b433-d60f-1227-a0fa-181c3c6de5cb",
          "merchant_name":"Test Merchant 2"
          "currency_code":"USD",
          "balance":"2700.50"
        }
     ]
 }
</code></pre>

{% endtab %}
{% endtabs %}