> 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/get-balance-history.md).

# Get Balance History

## Balance History

<mark style="color:blue;">`GET`</mark> `https://<Platform-host>/api/payouts/:merchant_id/:currency_code/balancehistory`

**Path Parameters**

<table><thead><tr><th width="192">Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id<mark style="color:red;">*</mark></td><td>string</td><td>Merchant ID</td></tr><tr><td>currency_code<mark style="color:red;">*</mark></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>

#### Query Parameters

<table><thead><tr><th width="171">Name</th><th width="123">Type</th><th>Description</th></tr></thead><tbody><tr><td>event_from_date</td><td>date</td><td>Event - From Date (YYYY-MM-DD)</td></tr><tr><td>event_to_date</td><td>date</td><td>Event - To Date (YYYY-MM-DD)</td></tr><tr><td>event</td><td>string</td><td>Possible values: Settlement/Fee/Disbursement/Adjustment</td></tr></tbody></table>

**Response Body**

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

<table><thead><tr><th width="238">Field Name</th><th width="94">Type</th><th width="347">Description</th></tr></thead><tbody><tr><td>data</td><td>array</td><td><p>List of events resulting in changes to the available balance. By default (if event date range not specified), available balance history would be displayed for</p><p>last one month. Data to be returned in</p><p>the descending order of event date-time.</p></td></tr><tr><td>data[i].merchant_id</td><td>string</td><td>Merchant ID</td></tr><tr><td>data[i].event_date</td><td>date</td><td>Event Date (YYYY-MM-DD)</td></tr><tr><td>data[i].event</td><td>string</td><td><p>Event</p><p>(Settlement/Fee/Payout/</p><p>Adjustment)</p></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].opening_balance</td><td>string</td><td>Opening Available Balance (+ or -)</td></tr><tr><td>data[i].balance_change</td><td>string</td><td>Change to Available balance (+ or -)</td></tr><tr><td>data[i]closing.balance</td><td>string</td><td>Closing Available Balance (+ or -)</td></tr><tr><td>data[i].notes</td><td>string</td><td>This would be present in case of Event = Adjustment explaining the reason for adjustment</td></tr><tr><td>data[i].adjustment_user</td><td>string</td><td>name of the user responsible for making the adjustment</td></tr><tr><td>data[i].adjustment_user</td><td>string</td><td>name of the user responsible for making the adjustment</td></tr><tr><td>data[i].adjustment_user</td><td>string</td><td>name of the user responsible for making the adjustment</td></tr><tr><td>data[i].adjustment_user</td><td>string</td><td>name of the user responsible for making the adjustment</td></tr><tr><td>data[I].adjustment_user</td><td>string</td><td>name of the user responsible for making the adjustment</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

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

<pre class="language-bash"><code class="lang-bash">curl --location --request GET '&#x3C;API_HOST>/api/payouts/2be66e67-88a7-4e04-985d-0a1cfb0a648c/USD/balancehistory’ \

<strong>--header 'Authorization: Basic &#x3C;API_KEY>'
</strong></code></pre>

{% endtab %}

{% tab title="Sample Response" %}

<pre><code><strong>{
</strong><strong>     "data": 
</strong>    [
        {
          merchant_id:"2be66e67-88a7-4e04-985d-0a1cfb0a648c",
          event_date:"2024-12-02"
          event:"Adjustment"
          currency_code:"USD",
          opening_balance:"+1000",
          balance_change:"-300"
          closing_balance:"+700"
          notes:"Card Network Assessment Fee"
          adjustment_user:"Mark Brown"
        },
        {
          merchant_id:"2be66e67-88a7-4e04-985d-0a1cfb0a648c",
          event_date:"2024-12-01"
          currency_code:"USD",
          opening_balance:"+500",
          balance_change:"+500"
          closing_balance:"+1000"
          event:"Settlement"
          notes:""
          adjustment_user:""
        }
     ]
 }
</code></pre>

{% endtab %}
{% endtabs %}