1. Oluştur

Ortak ödeme sayfası oluşturma akışı, müşterilerinize ait kart bilgilerini kendi siteniz/uygulamanız üzerinden almak istemediğinizde tercih edebileceğiniz bir yöntemdir

Ortak Ödeme Sayfası Oluştur

POST {{BaseAddress}}/api/paywall/checkout/generate

Önemli: Ödeme başlatma servisini kullanabilmeniz için 'Header' alanında 'apikeypublic' ve 'apiclientpublic' parametrelerini göndermeniz gerekmektedir. PaymentAPI Adresi

Ortak ödeme sayfasına ExpireDateTime tanımlanmadığı durumda, ortak ödeme sayfaları varsayılan olarak 10 dakika süre boyunca geçerli olur

Gerekli header ve istek parametreleri:

Zorunlu header parametreleri

Parametre	Tip	Zorunlu	Açıklama
apikeypublic	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Public Key.
apiclientpublic	string	Evet	Üye işyeri panelinden temin etmiş olduğunuz Public Client.

İstek gövdesi parametreleri

Parametre	Tip	Zorunlu	Açıklama
UniqueCode	string	Evet	Ödeme'nin sizin tarafınızdaki takip/sipariş/sepet kodu
Amount	decimal	Evet	Ürün/Hizmet tutarı
LanguageId	int	Hayır	Ortak ödeme sayfasının dil ayarını kullanıcı segmentinize göre değiştirebilirsiniz. Bkz: Dil Seçenekleri
CurrencyId	int	Evet	Para birimi https://paywall.gitbook.io/tr/sistem-verileri/para-birimleri
CallbackSupport	bool	Evet	Başarılı ödeme sonuçları bir adrese geribildirim olarak POST atılır
CallbackAddress	string	Hayır	Başarılı ödeme sonuçlarının geribildirim atılacağı adres
InstallmentSupport	bool	Evet	Taksit seçenekleri ekranda görünsün mü?
InstallmentDynamic	bool	Hayır	Taksit seçenekleri aktif sağlayıcılarınız arasındaki aktif taksitleriniz kullanılarak listelenebilir. Bu listeleme kullanıcının girdiği kart ailesi bağlı olarak yapılacaktır.
SuccessBackUrl	string	Evet	Başarılı ödeme sonucunda yönlendirilecek sayfa
FailBackUrl	string	Evet	Başarısız ödeme sonucunda yönlendirilecek sayfa
Force3D	bool	Evet	Ortak ödeme sayfasında kullanıcı "Güvenli Ödeme" için zorlansın mı?
ShowProduct	bool	Evet	Ödemeye konu olan ürünler ortak ödeme sayfasında listelensin mi?
ExpireDateTime	datetime	Hayır	Ortak ödeme sayfasının yaşam süresi. Sizin tarafınızdan da belirlenebilir, belirlenmediği taktirde 10 dakika olarak belirlenir
Products	List<Products>	Evet	Ödemeye konu olan ürün bilgileri (İzin verilmesi durumunda ortak ödeme sayfasında listelenir)
Customer	Customer	Evet	Ödemeye konu olan müşteri bilgileri (Ortak ödeme sayfasında görüntülenmez. Raporlamalarda kullanılır)
CardWallSupport	bool	Hayır	Ortak ödeme sayfasında kayıtlı kart desteğini aktif etmek için kullanabilirsiniz.
CardWallRelationalId1	string	Hayır	Kart'ın ilişkilendirilmesi istenen unique bilgi
CardWallRelationalId2	string	hayır	Kart'ın ilişkilendirilmesi istenen unique ikinci bilgi (listeleme anında tüm bilgiler gönderilmelidir)
CardWallRelationalId3	string	Hayır	Kart'ın ilişkilendirilmesi istenen unique üçüncü bilgi (listeleme anında tüm bilgiler gönderilmelidir)
PayWatchSupport	bool	Hayır	Ödemeler PayWatch ile izlensin mi? (Sadece 'Başladı' durumunda olanlar)
PayWatchMin	short	Evet (Koşullu)	PayWatch ödeme işleminin kaç dakika sonrasında çalışsın? Minimum: 5 | Maksimum: 20
PayWatchCallbackAddress	string	Hayır	Dolu gönderilmesi durumunda PayWatch'ın tespit ettiği ödemedeki değişiklik sonrasında belirtilen adrese geri bildirim atılır
MasterpassSupport	bool	Hayır	Ortak ödeme sayfasında Masterpass desteğinin aktif olması için ilgili parametreyi true göndermeniz gerekmektedir. Not: Bu parametrenin true gönderilmesiyle birlikte Paywall panelinde Sanal Pos sağlayıcılar sayfasındaki Masterpass eklentisini de aktif etmeniz gerekmektedir.
UseMasterpassAlternative	bool	Hayır	Ortak ödeme sayfasında Masterpass'de kayıtlı olmayan, manuel girilen ve kullanıcı tarafından Masterpass'de kayıt edilmek istenmeyen kartlı işlemler için Masterpass harici Paywall panelinde bağlantı kurulmuş Sanal Pos sağlayıcıları kullanılması isteniyorsa, bu parametre true olarak gönderilmelidir
RouteGroupKey	string	Evet/Hayır	RouteGroup ile ödeme alınması istenmesi durumda bu parametreyle ilgili RouteGroup'un anahtar bilgisi iletilmelidir
SupportCampaign	bool	Hayır	Ortak ödeme sayfasında kullanılan kart bilgisine verilen kampanyaların listelenebilmesi için ilgili parametre true gönderilmelidir. Not: Kampanya sorgusunun yapılabilmesi için Paywall panelinde bağlı olan sanal pos sağlayıcılarından en az 1 tanesi Kampanyalı Pos olarak işaretlenmelidir
SupportReward *Yakında	bool	Hayır	Ortak ödeme sayfasında ilgili kart bilgileri için Para Puan kullanılabilmesi için parametrenin true olarak gönderilmesi gerekmektedir
ProviderBased	bool	Evet	Ödemenin belirli bir sanal POS sağlayıcısı üzerinden yürütülmesi gerektiğinde true gönderilir; bu durumda ProviderKey ile hedef sağlayıcı seçilir.
ProviderKey	string	Evet/Hayır	ProviderBased = true iken zorunludur: Panelde tanımlı sağlayıcının anahtar değeri. ProviderBased = false ise genelde boş bırakılır.
ProviderCondition	object	Hayır	Sağlayıcı seçiminde ek koşullar. Örneğin içindeki InstallmentReceiverAddressSupport: belirli taksit sayısı için koşul tanımlamak üzere kullanılabilir; kullanılmıyorsa null gönderilebilir.
ReceiverAddressSupport	bool	Evet	Ortak ödeme sayfasında alıcı adresi alanlarının gösterilip gösterilmeyeceğini belirler.
ReceiverInfoSupport	bool	Evet	Ortak ödeme sayfasında alıcı bilgileri (teslimat/tahsilat tarafı vb.) alanlarının gösterilip gösterilmeyeceğini belirler.
RegionId	short	Hayır	Bölge seçimi kullanılacaksa ilgili bölge kimliği. Gönderilmezse varsayılan davranış kullanılır.
InterestConfirmationPopup	bool	Evet	Kullanıcıya komisyon/faiz (taksit maliyeti) ile ilgili onay penceresinin gösterilip gösterilmeyeceğini belirler.
SkipInterest	bool	Evet	true ise faiz/komisyon ile ilgili akışta belirli durumlarda atlama davranışı devreye girer; detay koşulu SkipInterestCondition ile verilebilir.
SkipInterestCondition	object	Hayır	SkipInterest ile birlikte kullanılır. İçindeki Installment (byte, nullable): Hangi taksit seçeneği için atlama geçerli olacaksa burada belirtilir; kullanılmıyorsa null.
DesignVersion	int	Hayır	Ödeme sayfasının hangi tasarım versiyonunu kullanacağını belirler. 1 eski versiyon, 2 güncel versiyondur.

Products parametreleri

Parametre	Tip	Zorunlu	Açıklama
ProductId	string	Evet	Ürününüzün sisteminizdeki kimliği
ProductImage	string	Hayır	Ürününüzün görseline ait url
ProductName	string	Evet	Ürününüzün adı
ProductCategory	string	Evet	Ürününüzün kategorisi
ProductDescription	string	Evet	Ürününüzün açıklaması
ProductAmount	decimal	Evet	Ürününüzün tutarı
MemberId	int	Hayır	MarketPlace modeli için zorunludur. Alt üye işyerinin Paywall sistemindeki MemberId bilgisiyle doldurulmalıdır.
MemberEarningCalculated	bool	Hayır	Pazaryeri kapsamında, alt şirketin hak edişini siz hesapladıysanız bu parametreyi true göndermelisiniz
MemberEarning	decimal	Hayır	Pazaryeri kapsamında, alt şirketin hak edişini siz hesapladıysanız bu parametreyi hak ediş değerini Paywall'a bildirmelisiniz
MemberCustomCommission	bool	Hayır	Pazaryeri kapsamında, alt şirkete bu satış özelinde komisyon belirtmek isterseniz kullanılan parametredir
MemberCommission	decimal	Hayır	Pazaryeri kapsamında, alt şirkete bu satış özelinde komisyon belirtmek isterdiğinizde, komisyon değerinin gönderildiği parametredir

Customer parametreleri

Parametre	Tip	Zorunlu	Açıklama
FullName	string	Evet	Müşteri ad/soyad
Phone	string	Evet	Müşteri telefon numarası Not: Masterpass için zorunludur
Email	string	Evet	Müşteri E-Posta
Country	string	Hayır	Ülke
City	string	Hayır	Şehir
Address	decimal	Hayır	Açık Adres
IdentityNumber	string	Hayır	Bireysel Müşteri
TaxNumber	string	Hayır	Kurumsal Müşteri
CustomerId	string	Evet/Hayır	Ödeyici kullanıcının sisteminizdeki Id bilgisiyle doldurmanız gerekmektedir Not: Masterpass için zorunludur

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

JSON

{
    "UniqueCode": "{{$guid}}",
    "Amount": 10.0,
    "CurrencyId": 1,
    "LanguageId": 1,
    "CallbackSupport": true,
    "PayWatchSupport": true,
    "CallbackAddress": "https://yourwebservice.com/callback",
    "PayWatchMin": 5,
    "PayWatchCallbackAddress": "https://yourwebservice.com/callback/paywatch",
    "SuccessBackUrl": "https://yourwebservice.com/callback/success",
    "FailBackUrl": "https://yourwebservice.com/callback/unsuccessful",
    "Force3D": false,
    "InstallmentSupport": true,
    "InstallmentDynamic": true,
    "CardWallSupport": false,
    "CardWallRelationalId1": "user-id",
    "CardWallRelationalId2": null,
    "CardWallRelationalId3": null,
    "ShowProduct": true,
    "ReceiverInfoSupport": false,
    "ReceiverAddressSupport": false,
    "RegionId": null,
    "ProviderBased": false,
    "ProviderKey": "",
    "ProviderCondition": {
      "Installment": null
    },
    "InterestConfirmationPopup": true,
    "SkipInterest": false,
    "SkipInterestCondition": null,
    "Customer": {
        "FullName":"{{$randomFirstName}}",
        "Phone":"905123456789", // Must for Masterpass
        "Email":"{{$randomEmail}}",
        "Country":"{{$randomCountry}}",
        "City":"{{$randomCity}}",
        "Address":"{{$randomStreetAddress}}",
        "IdentityNumber":"2523123412",
        "TaxNumber":"456345456",
        "CustomerId": "72845" // Must for Masterpass (Payer's userid in your system)
    },
    "Products": [
      {
       "MemberId": 12345,
       "MemberEarningCalculated": true,
       "MemberEarning": 96.39,
       "MemberCustomCommission": true,
       "MemberCommission": 2.61,
       "ProductId": "1",
       "ProductImage": "https://yourwebsite.com/photoimage",
       "ProductName": "1",
       "ProductCategory": "1",
       "ProductDescription": null,
       "ProductAmount": 10
      }
    ],
    "ExpireDateTime": null,
    "RouteGroupKey": "route-999",
    "MasterpassSupport": true, // If payment page will support Masterpass
    "UseMasterpassAlternative": true, // If payment page will support altervative providers than Masterpass
    "SupportCampaign": true,
    "SupportReward": false // Soon,
    "DesignVersion": 2 // Determines the design: 1 = legacy, 2 = latest
  }

Servisten dönen parametreler şu şekildedir:

Parametreler ve açıklamaları

Parametre	Tip	Açıklama
ErrorCode	int	Hata 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	string	Link parametresi altında ödeme linkini döner

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 13284456,
        "Guid": "a2319b22-b442-4b9d-bc87-b800be680761",
        "UniqueCode": "OAEASG54455565256792",
        "Amount": 25.0,
        "Link": "https://dev-checkout.itspaywall.com/checkout/?CheckoutId=a2319b22-b442-4b9d-bc87-b800be680761"
    }
}