1. Ödeme Oluştur

Bağlı APM sağlayıcılarıyla ödeme başlatmak (QR Tabanlı) için kullanabileceğiniz bir yöntemdir. İlgili yöntem aracılığıyla kullanıcılara QR Kod gösterilerek ödemeler gerçekleştirilmektedir

Ödeme Başlat / QR Tabanlı

POST {{Base Adres}}/api/paywall/apm/pay/qr/generate

Önemli: APM Ödeme Başlatma (QR Tabanlı) 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	int	Evet (Koşullu)	APM sağlayıcısının Key bilgisi. Bkz: APM
ApmConnectionId	int	Evet (Koşullu)	APM listeleme servisiyle edinilen bağlantılara ait Id (kimlik) bilgisidir. Ödeme ekranınızı dinamik oluşturduğunuz senaryolarda bu parametreyle birlikte ilgili bağlantı üzerinden ödeme başlatabilirsiniz
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
Amount	decimal	Evet	Ödeme tutarı
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.
UserRedirectUrl	string	Hayır	Bazı cüzdan uygulamaları QR'ın okutulması ve ödemenin başarılı olması durumunda kullanıcıyı verilen bir adrese yönlendiriyorlar. Bu akış için verilen adres bilgisidir
MerchantSuccessBackUrl	string	Evet	Ödemenin başarılı sonucunun Post olarak bildirileceği adrestir
MerchantFailBackUrl	string	Evet	Ödemenin başarısız sonucunun Post olarak bildirileceği adrestir
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": "papara",
    "ApmConnectionId": null, // Eğer bağlantı kimlik Id'sini biliyorsanız
    "CurrencyId": 1,
    "MerchantUniqueCode": "55555454544333545435",
    "UserRedirectUrl": "https://merchantsite.com/?paymentId=13114141",
    "MerchantSuccessBackUrl": "https://merchantsite.com/callback/success",
    "MerchantFailBackUrl": "https://merchantsite.com/callback/fail",
    "Amount": 1,
    "Description": "PW test",
    "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
Body:FormatType	int	QR'ın hangi formatta olduğunu ifade eder Bkz: Formatlar

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "ApmKey": "ProviderKey",
        "ApmConnectionId": 62,
        "ApmTransactionId": 11676,
        "UniqueCode": "273162b1-ffae-45c6-9e22-724ca27f826a",
        "MerchantUniqueCode": "55555454544333545435",
        "Amount": 1.0,
        "QrDetail": {
            "FormatType": 1,
            "Content": "%BASE64CONTENT%"
        }
    }
}