# 1. Balance

## Balance Check

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

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 service, you need to send the '**apikeyprivate**' and '**apiclientprivate**' parameters in the 'Header' field.

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

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

<table><thead><tr><th width="212">Parameter</th><th width="106.33333333333331">Type</th><th width="137">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>payoutconnectionid</td><td>int</td><td>Yes</td><td>Connected provider identity (Id) information</td></tr></tbody></table>

**The response 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 balance information (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 message for the error, 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 %}