For the complete documentation index, see llms.txt. This page is also available as Markdown.

1. Bakiye

Paywall'un desteklediği PayOut sağlayıcıları üzerinden kendi erişim bilgilerinizle Paywall'a yetki verip bakiye kontrol işlemlerinizi yapabilirsiniz.

Bakiye Kontrol

GET {{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.

Önemli: Payout - Bakiye Kontrol servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentAPI Adresi

Gerekli header ve istek parametreleri:

Parametreler ve Açıklamaları
Parametre
Tip
Zorunlu
Açıklama

apikeyprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Key.

apiclientprivate

string

Evet

Üye işyeri panelinden temin etmiş olduğunuz Private Client.

payoutconnectionid

int

Evet

Bağlı sağlayıcı kimlik (Id) bilgisi

Servisten dönen parametreler şu şekildedir:

Parametre Açıklamaları
Parametre
Tip
Açılama

ErrorCodeType

int

intHata kodunun tipini/kategorisini belirtir

ErrorMessage

string

İşlem başarısız olursa hata mesajı; başarılıysa null

ErrorCode

int

İşlem sonuç kodu. İşlem başarılı ise '0' değerini döner.

Result

bool

True ya da false değeri döner. İşlem başarılı iste 'true' değerini döner

Message

string

İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.

Body

object

Asıl işlem sonucunu taşıyan gövde.

Body > Balances

object

Hesaba ait bakiye bilgilerini içeren liste

Body > Balances > TotalBalance

decimal

Hesaptaki toplam bakiye

Body > Balances > LockedBalance

decimal

Bloke/kilitli bakiye (kullanılamayan tutar)

Body > Balances > AvailableBalance

decimal

Kullanılabilir bakiye

Body > Balances > AccountNumber

string

Hesap numarası

Body > Balances > IBAN

string

Hesabın IBAN numarası

Body > Balances > BranchCode

string

Hesabın bağlı olduğu banka şube kodu

Body > Balances > BranchName

string

Şube adı

Body > Balances > CurrencyCode

string

Para birimi kodu

Body > Balances > OpeningDate

datetime

Hesabın açılış tarihi

Body > Balances > LastTransactionDate

datetime

Hesaptaki son işlem tarihi

ProviderDump

object

Provider'dan dönen ham/işlenmemiş veri

ProviderHttpStatus

int

Provider'a yapılan çağrının HTTP durum kodu

ProviderConnectedId

int

Merchant'a bağlı provider hesabının

ProviderId

int

Ödeme sağlayıcısının sistem genelindeki ID'si

ProviderKey

string

Ödeme sağlayıcısının anahtar/isim değeri

CurrencyId

int

Para birimi ID'si

{
    "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
    }
}

Last updated