> For the complete documentation index, see [llms.txt](https://developer.paywall.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.paywall.one/payment-orchestration-integration-document/payout-service/2.-balance-main-account.md).

# 2. Balance/Main Account

## Balance Check (Main Account)

<mark style="color:blue;">`GET`</mark> `{{Base Address}}/api/paywall/payout/balance/main`

Simply sending a request to the provided address above will suffice. You can use the 'Base Address' as you wish for both the testing environment and the production environment.

{% hint style="info" %}
**Important**: In order to use the Payout - Balance Check (Main Account) service, you need to send the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

\
[<mark style="color:green;">**PaymentAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

\
**The header information that needs to be sent to the service is as follows:**

<table><thead><tr><th width="182">Parameter</th><th width="106.33333333333331">Type</th><th width="146"> Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Yes</td><td>The Private Key obtained from the merchant panel.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Yes</td><td>The Private Client obtained from the merchant panel.</td></tr><tr><td>currencyid</td><td>int</td><td>Yes</td><td><p>Provider currency</p><p><br>Bkz: <a href="/pages/bahfUMz1dqpN1ZCnpVtM">Currency</a> </p></td></tr></tbody></table>

**The response returned from the service:**

<table><thead><tr><th width="156">Parameter</th><th width="83.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Body</td><td>object</td><td>JSON containing details about the payment (optional).</td></tr><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns '0' if the operation is successful.</td></tr><tr><td>Result</td><td>bool</td><td>It returns a true or false value. If the operation is successful, it returns 'true'.</td></tr><tr><td>Message</td><td>string</td><td>If the operation is unsuccessful, this is the specified error message, providing language support according to the locale parameter.</td></tr></tbody></table>

{% tabs %}
{% tab title="JSON" %}
{% code overflow="wrap" lineNumbers="true" %}

```json5
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Balances": [
            {
                "TotalBalance": 249961.82,
                "LockedBalance": 0.0,
                "AvailableBalance": 249961.82
            }
        ],
        "ProviderDump": "{PROVIDERJSONDUMP}",
        "ProviderHttpStatus": 200,
        "ProviderConnectedId": 17,
        "ProviderId": 2,
        "ProviderKey": "ProviderKey",
        "CurrencyId": 1
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# 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 dynamically by asking a question.

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

```
GET https://developer.paywall.one/payment-orchestration-integration-document/payout-service/2.-balance-main-account.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.