> 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/payout-servisi/1.-bakiye.md).

# 1. Bakiye

## Bakiye Kontrol

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

Yukarıda verilmiş olan adrese istek atmanız yeterli olacaktır. Test ortamı ve Gerçek ortam için 'Base Address' istediğiniz gibi kullanabilirsiniz.

{% hint style="info" %}
Önemli: **Payout - Bakiye Kontrol** servisini kullanabilmeniz için 'Header' alanında '**apikeyprivate**' ve '**apiclientprivate**' parametrelerini göndermeniz gerekmektedir.\
\
[<mark style="color:green;">**PaymentAPI Adresi**</mark>](/ortam.md)
{% endhint %}

**Gerekli header ve istek parametreleri:**

<details>

<summary>Parametreler ve Açıklamaları</summary>

<table><thead><tr><th width="243">Parametre</th><th width="106.33333333333331">Tip</th><th width="97">Zorunlu</th><th>Açıklama</th></tr></thead><tbody><tr><td>apikeyprivate</td><td>string</td><td>Evet</td><td>Üye işyeri panelinden temin etmiş olduğunuz Private Key.</td></tr><tr><td>apiclientprivate</td><td>string</td><td>Evet</td><td>Üye işyeri panelinden temin etmiş olduğunuz Private Client.</td></tr><tr><td>payoutconnectionid</td><td>int</td><td>Evet</td><td>Bağlı sağlayıcı kimlik (Id) bilgisi</td></tr></tbody></table>

</details>

**Servisten dönen parametreler şu şekildedir:**

<details>

<summary>Parametre Açıklamaları</summary>

<table><thead><tr><th width="202">Parametre</th><th width="90.33333333333331">Tip</th><th>Açılama</th></tr></thead><tbody><tr><td>ErrorCodeType</td><td>int</td><td>intHata kodunun tipini/kategorisini belirtir</td></tr><tr><td>ErrorMessage</td><td>string</td><td>İşlem başarısız olursa hata mesajı; başarılıysa <code>null</code></td></tr><tr><td>ErrorCode</td><td>int</td><td>İşlem sonuç kodu. İşlem başarılı ise '0' değerini döner.</td></tr><tr><td>Result</td><td>bool</td><td>True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner</td></tr><tr><td>Message</td><td>string</td><td>İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.</td></tr><tr><td>Body</td><td>object</td><td>Asıl işlem sonucunu taşıyan gövde.</td></tr><tr><td><mark style="color:orange;">Body</mark> > Balances</td><td>object</td><td>Hesaba ait bakiye bilgilerini içeren liste</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > TotalBalance</td><td>decimal</td><td>Hesaptaki toplam bakiye</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > LockedBalance</td><td>decimal</td><td>Bloke/kilitli bakiye (kullanılamayan tutar)</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > AvailableBalance</td><td>decimal</td><td>Kullanılabilir bakiye </td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark>  > AccountNumber</td><td>string</td><td>Hesap numarası</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > IBAN</td><td>string</td><td>Hesabın IBAN numarası</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > BranchCode</td><td>string</td><td>Hesabın bağlı olduğu banka şube kodu</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > BranchName</td><td>string</td><td>Şube adı</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > CurrencyCode</td><td>string</td><td>Para birimi kodu</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > OpeningDate</td><td>datetime</td><td>Hesabın açılış tarihi</td></tr><tr><td><mark style="color:orange;">Body</mark> > <mark style="color:orange;">Balances</mark> > LastTransactionDate</td><td>datetime</td><td>Hesaptaki son işlem tarihi</td></tr><tr><td>ProviderDump</td><td>object</td><td>Provider'dan dönen ham/işlenmemiş veri</td></tr><tr><td>ProviderHttpStatus</td><td>int</td><td>Provider'a yapılan çağrının HTTP durum kodu</td></tr><tr><td>ProviderConnectedId</td><td>int</td><td>Merchant'a bağlı provider hesabının</td></tr><tr><td>ProviderId</td><td>int</td><td>Ödeme sağlayıcısının sistem genelindeki ID'si</td></tr><tr><td>ProviderKey</td><td>string</td><td>Ödeme sağlayıcısının anahtar/isim değeri</td></tr><tr><td>CurrencyId</td><td>int</td><td>Para birimi ID'si</td></tr></tbody></table>

</details>

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

```json5
{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Balances": [
            {
                "TotalBalance": 10000.00,
                "LockedBalance": 0.0,
                "AvailableBalance": 10000.00,
                "AccountNumber": "000000",
                "IBAN": "TR000000000000000000000000",
                "BranchCode": "000",
                "BranchName": "",
                "CurrencyCode": "YTL",
                "OpeningDate": "2024-01-01T00:00:00",
                "LastTransactionDate": "2026-01-01T00:00:00"
            }
        ],
        "ProviderDump": null,
        "ProviderHttpStatus": 200,
        "ProviderConnectedId": 123,
        "ProviderId": 5,
        "ProviderKey": "ProviderKey",
        "CurrencyId": 1
    }
}
```

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