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

5. Kayıtlı Üye Iban (Member)

Paywall'da kayıtlı olan alt üye işyerlerinize (Member) üye işyeri kimlik bilgisiyle para gönderimi yapabilirsiniz (MemberId)

Kayıtlı Üye Iban'ına

POST {{Base Address}}/api/paywall/payout/send/member

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 - Kayıtlı Üye servisini kullanabilmeniz için 'Header' alanında 'apikeyprivate' ve 'apiclientprivate' parametrelerini göndermeniz gerekmektedir. PaymentAPI Adresi

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri
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.

İstek gövdesi parametreleri
Parametre
Tip
Zorunlu
Açıklama

PayoutProviderKey

string

Evet

İşlemin hangi ödeme sağlayıcısı üzerinden yapılacağını belirten anahtar/tanımlayıcı değer.

MerchantUniqueCode

string

Evet

PayOut işleminin takibi için tanımlayacağınız tekil kod (aynı ay içerisinde aynı kodları kullanamazsınız)

MerchantGroupCode

string

Hayır

PayOut işleminin takibi için tanımlanan grup kodu. İlgili kod yardımıyla belli bir işlem altındaki gönderilere aynı grup kodu verilip raporlama yapılabilir.

MemberId

int

Evet

Paywall'da kayıtlı alt üye kimlik bilgisi. Paywall'a kayıt anında cevap içerisinde döner

Description

string

Evet

PayOut için alıcıya iletilecek açıklama

Amount

decimal

Evet

Alıcı kimlik bilgisi (TCKN - VKN)

SenderTitle

string

Hayır

Gönderici ad-soyad veya ünvan bilgisi (sağlayıcı tarafında gönderici bilgisi gösterimi gerektiğinde kullanılır)

SenderIban

string

Hayır

Gönderici IBAN bilgisi

SenderAccountNo

string

Hayır

Gönderici hesap numarası bilgisi

IsCreditCard

bool

Hayır

Alıcı hesabının kredi kartı olup olmadığını belirtir (kredi kartına ödeme senaryolarında kullanılır)

Description

string

Evet

PayOut için alıcıya iletilecek açıklama

Amount

decimal

Evet

PayOut tutarı

CurrencyId

int

Evet

Para birimi Bkz: Para birimi listesi

CallbackSupport

bool

Hayır

PayOut işleminin async olarak başarısız olması veya iade edilmesi gibi süreçlerde geri bildirim atılsın mı?

CallbackAddress

string

Evet (Koşullu)

Geri bildirim atılacak adres

Servise gönderilecek örnek bir JSON dosyası şu şekildedir :

{
    "PayoutProviderKey": "ProviderKey",
    "MerchantUniqueCode": "42222",
    "MerchantGroupCode": "GroupCode123",
    "MemberId": 209021,
    "Description": "test açıklaması",
    "Amount": 1,
    "CurrencyId": 1,
    "CallbackSupport": true,
    "CallbackAddress": "https://example.com/callback"
}

Servisten dönen parametreler şu şekildedir:

Parametreler ve 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 > Result

bool

Sonucu gösteren boolean değerdir.

Body >PayoutTransactionId

int

Sistemde oluşturulan PayOut işleminin benzersiz ID'si

Body > MerchantUniqueCode

string

İstek gövdesinde gönderdiğiniz, işlemi tanımlayan tekil kod

Body > UniqueCode

Guid

Sistem tarafından işlem için üretilen benzersiz kod

Body > Amount

decimal

PayOut işleminin tutarı

Last updated