10. Ön Kontrol

Bağlı APM sağlayıcılarıyla bir ödeme başlatmadan önce, ilgili işlemin gerçekleştirilmeye uygun olup olmadığını kontrol etmek için kullanabileceğiniz bir servistir.

İşlem Uygunluk Kontrolü

POST {{Base Adres}}/api/paywall/apm/availability/check

Önemli: APM Availability Check 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
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.
Channel	string	Hayır	İlgili APM sağlayıcısının, kanal bilgisine göre farklı format/işlem davranışı desteklemesi durumunda kullanılır.
ClientIp	string	Hayır	Ödemeyi başlatan müşterinin IP adresidir.
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. Örnek: CardNumber bekleyen bir sağlayıcı için Paywall API'si CardNumber parametresini zorunlu tutar
Provider:Parameters	Dynamic	Evet/Hayır	Sağlayıcının ödemenin gerçekleşmesi anında beklediği dinamik bilgiler olması durumunda bu parametrelerle ilgili bilgiler dışardan alınır ve sağlayıcılarla paylaşılır. Örnek mağaza kodu, mağaza kimliği gibi bilgileri sağlayıcının beklemesi durumunda bu bilgiler Paywall API'si tarafından kontrol edilir ve zorunlu tutulur.

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)
Token	string	Hayır	İlgili APM sağlayıcısının, sisteme önceden giriş yapmış kullanıcılar için ayrı bir ödeme akışı desteklemesi durumunda kullanılır.

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

JSON

{
    "ApmKey": "TestProvider",
    "ApmConnectionId": 2043,
    "CurrencyId": 1,
    "Amount": 1,
    "Description": "Test availability check",
    "Channel": "Mobile-Test",
    "ClientIp" : "203.0.113.1",
    "Payer": {
        "Fullname": "Test Test",
        "CardNumber": null,
        "CardId": null,
        "Phone": "[phone]",
        "Email": null,
        "UserIdentity": "111111111111111",
        "ConsumerIdentity": "19942931242",
        "Birthday": null,
        "CardAlias": "Ali",
        "Token": null
    },
    "Provider": null
}

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

{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "IsValid": true,
        "ConversationId": "caad955c-9ea8-48ab-a606-9edb4465f9ba",
        "PaymentReferenceId": "3753b20be46e4d769137ce13e308b331",
        "Errors": [],
        "Deeplink": null,
        "WalletBalance": 53
    }
}