6. Hesap'a

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

Hesap'a

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

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 - Account 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.
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.
MerchantUniqueCode	string	Evet	PayOut işleminin takibi için tanımlayacağınız tekil kod (aynı ay içerisinde aynı kodları kullanamazsınız)
ReceiverTitle	string	Evet	Alıcı adı-soyad veya ünvan
ReceiverAccount	string	Evet	Alıcı Hesap
ReceiverBranchCode	int	Hayır	Alıcının banka hesabının bağlı olduğu şube kodu.
ReceiverIdentity	string	Evet/Hayır	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
PayoutType	PayoutType	Hayır	PayOut işleminin tipini belirten enum değeri

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

Json

{
    "PayoutProviderKey": "ProviderKey",
    "MerchantGroupCode": "GroupCode123",
    "MerchantUniqueCode": "ASDJHISOFIFJDJAJF23423",
    "ReceiverTitle": "Receiver Title",
    "ReceiverAccount": "1234567890",
    "ReceiverBranchCode": 725
    "ReceiverIdentity": "11111111110",
    "SenderTitle": null,
    "SenderIban": null,
    "SenderAccountNo": null,
    "IsCreditCard": false,
    "Description": "Description",
    "Amount": 10,
    "CurrencyId": 1,
    "CallbackSupport": true,
    "CallbackAddress": "https://example.com/callback",
    "PayoutType": 1
}

C#

GO

Java

PHP

Python

Ruby

TypeScript

Curl

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ı
Body > Error	object	İşlem başarısız olduğunda dolan hata detay nesnesi; başarılıysa alanları boş döner.
Body > Error > ProviderErrorCode	string	Sağlayıcıdan (banka/ödeme kuruluşu) dönen hata kodu.
Body > Error > ProviderErrorMessage	string	Sağlayıcıdan dönen hata açıklaması.

Json

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Result": false,
        "PayoutTransactionId": 123456,
        "MerchantUniqueCode": "00000000-0000-0000-0000-000000000000",
        "UniqueCode": "11111111-1111-1111-1111-111111111111",
        "Amount": 100.00,
        "Error": {
            "ProviderErrorCode": "ERR001",
            "ProviderErrorMessage": "Sample provider error message"
        }
    }
}