2. Ödeme Başlat (Key)

Bağlı APM sağlayıcılarıyla ödeme başlatmak için kullanabileceğiniz bir metottur. Bu metod dışardan Key bilgisine ihtiyaç duymaktadır. Her sağlayıcının farklı Key bilgisi vardır. Listeye bakabilirsiniz

Ödeme Başlat (Key)

POST {{Base Adres}}/api/paywall/apm/pay/bykey

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

Servise gönderilmesi gereken (HEADERS) parametreler şu şekildedir :

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.

Servise gönderilmesi gereken (BODY) parametreler şu şekildedir :

Parametre	Tip	Zorunlu	Açıklama
ApmKey	string	Evet	APM sağlayıcısının Key bilgisi. Bkz: APM
CurrencyId	int	Evet	Ödeme'nin bağlatılmak istendiği para birimi Bkz: Para Birimleri
MerchantUniqueCode	string	Evet	Ödeme için oluşturduğunuz tekil numara
MerchantSuccessBackUrl	string	Evet	Ödemenizin başarılı sonucunun iletileceği adres. Post Body cevap alacaktır.
MerchantFailBackUrl	string	Evet	Ödemenizin başarılı sonucunun iletileceği adres. Post Body cevap alacaktır.
Amount	decimal	Evet	Ödeme tutarı * IsRecurring true olması durumunda bu değer, maksimum çekilecek tutarı ifade eder
Description	string	Evet	Ödeme'ye ait açıklama. Sağlayıcıya bağlı olarak bu açıklama ödeme ekranında görüntülenebilmektedir.
IsRecurring	bool	Hayır	APM sağlayıcısı ödeme talimatı almayı destekliyorsa, bu parametre true gönderilmelidir. Destekleyen Sağlayıcı: Masterpass
ExpireDay	int	Hayır	APM sağlayıcısının ilgili sayfasının/ödeme akışının son kullanma tarih desteği olması durumunda kullanılır. Gün sayısı bekler ve aktif günün üstüne o kadar gün ekler. Destekleyen Sağlayıcı: Masterpass
IsAutoCommit	bool	Hayır(true)	Default olarak “true” değeri geliyor, değiştirmek isterseniz "false" olarak değiştirilmelidir. True gönderildiğinde —> 3D işlemi sonrası ekrandaki ödeme işlemi tamamlanınca ödeme anında karttan tutar çekilir. False Gönderildiğinde —> Ödeme sonrası callback atılır sonrasında ayrıca commit emri verilmesi gereklidir.
Payer	Payer	Evet	Ödeme'nin gerçekleştirileceği ödeyici bilgilerinin barındığı nesnedir. Bu nesne altındaki parametrelerin zorunlulukları sağlayıcının beklediği parametreye göre farklılık gösterebilmektedir. Önerilen, tüm bilgilerin gönderilmesidir

Payer :

Parametre	Tip	Zorunlu	Açıklama
Fullname	string	Evet (Koşullu)	Ödeyici tam isim
CardNumber	string	Evet (Koşullu)	Ödeyici kart numarası (yemek kartı vb)
CardId	string	Evet (Koşullu)	Ödeyici kart kimlik numarası (kartın APM sağlayıcısında saklanması durumunda çalışır)
Phone	string	Evet (Koşullu)	Ödeyicinin telefon numarası
Email	string	Evet (Koşullu)	Ödeyicinin e-posta adresi
UserIdentity	string	Evet (Koşullu)	Ödeyicinin sisteminizdeki kimlik bilgisi (TCKN/VKN)
ConsumerIdentity	string	Evet (Koşullu)	Ödeyicinin sisteminizdeki kimlik bilgisi (UserId)
Birthday	DateTime	Hayır	Ödeyicinin doğum günü bilgisi
CardAlias	string	Evet (Koşullu)	Ödeyiciye ait kart bilgisinin etiketi (Masterpass)

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

JSON

{
    "ApmKey": "ProviderKey",
    "CurrencyId": 1,
    "MerchantUniqueCode": "TESTMERCHANTUNIQUECODE",
    "MerchantSuccessBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
    "MerchantFailBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
    "Amount": 1,
    "Description": "test",
    "IsRecurring": true,
    "ExpireDay": 10,
    "IsAutoCommit": true,
    "Payer": {
        "Fullname": "",
        "CardNumber": "",
        "CardId": "",
        "Phone": "",
        "Email": "",
        "UserIdentity": "",
        "ConsumerIdentity": "",
        "Birthday": null
    },
    "Products": [
        {
            "ProductId": "123",
            "ProductName": "Name",
            "ProductCategory": "Food",
            "ProductDescription": "Description of Product",
            "ProductAmount": 1
        }
    ]
}

Servisten dönen parametreler şu şekildedir:

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	nesne	İşlem hatalıysa, bu hataya dair detay nesne

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callbackapm?UniqueNumber=dd224827-8433-45f7-9454-97025e57fa9e",
        "Transaction": {
            "ApmTransactionId": 29,
            "UniqueCode": "dd224827-8433-45f7-9454-97025e57fa9e",
            "MerchantUniqueCode": "TESTMERCHANTUNIQUECODE",
            "Amount": 1.0
        }
    }
}