Ortak Ödeme Sayfası
Ortak Ödeme Sayfası Servisi İstek Modeli;
Metod | API URL | Parametreler |
---|---|---|
POST | https://base-url/api/pay/CommonPaymentDealer | JSON File |
Ortak Ödeme Sayfası Servisi İşlem Akışı;
Ortak ödeme sayfası modelini kullanarak başarılı bir tahsilat gerçekleştirmek için aşağıda maddeler halinde açıklanan işlemleri takip ederek entegrasyonunuzu tamamlamanız gerekmektedir.
1. Adım:
Üye işyeri kullanıcı, sepet, ödeme tutar bilgilerini ödemenin sonucunun bildirilmesini istediği kendi web adresi(BACK_URL) bilgisi ile birlikte EsnekPos güvenli ödeme sayfası servisine yukarıda belirtilmiş olan istek modelini kullanarak ödeme isteğini gönderir ve ödeme işlemini başlatmış olur.
Güvenli ve sorunsuz bir şekilde işlemlerin gerçekleşebilmesi ve fraud işlemlerin önlenebilmesi için tüm parametrelerin eksiksiz bir şekilde gönderilmesi gerekmektedir.
Servise gönderilmesi gereken parametreler şu şekildedir;
Ortak Ödeme Sayfası Servisi İstek Mesajı Parametreleri
Parametre | Tip | Zorunlu | Açıklama |
---|---|---|---|
MERCHANT | string | Evet | Üye iş yerine özel oluşturulan eşsiz kimlik bilgisidir. |
MERCHANT_KEY | string | Evet | Üye iş yerine özel oluşturulan anahtar bilgisidir. |
ORDER_REF_NUMBER | string | Evet | Üye iş yeri tarafından verilecek referans numarası bilgisidir. Ödeme işlemleri bu referans numarası ile takip edilebilir. Maksimum 24 karakter kullanılabilir. |
ORDER_AMOUNT | string | Evet | Ödeme işlemine ait işlem tutarı bilgisidir. |
PRICES_CURRENCY | string | Evet | Ödeme işleminin gerçekleştirileceği para birimi bilgisidir. Şu an için sadece “TRY, USD, EUR, GBP” gönderilebilir. |
BACK_URL | string | Evet | İşlem sonuç cevabının sistem tarafından döndürüleceği adres bilgisidir. İşlem cevabı üye iş yeri tarafından bu adresten okunacaktır. İşlem sonucu form post olarak gönderilir. |
LOCALE | string | Evet | Ödeme sayfasının dil seçenek bilgisidir. Türkçe için "tr", İngilizce için "en" olarak gönderilmelidir. |
FIRST_NAME | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) adı bilgisidir. |
LAST_NAME | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) soyadı bilgisidir. |
string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) mail bilgisidir. | |
PHONE | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) telefon bilgisidir. |
CITY | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) şehir bilgisidir. |
STATE | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) ilçe bilgisidir. |
ADDRESS | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) adres bilgisidir. |
Product
Parametre | Tip | Zorunlu | Açıklama |
---|---|---|---|
PRODUCT_ID | string | Evet | Ürüne üye işyeri tarafından verilen ID bilgisidir. |
PRODUCT_NAME | string | Evet | Ürünün ad bilgisidir. |
PRODUCT_CATEGORY | string | Evet | Ürünün kategori bilgisidir. |
PRODUCT_DESCRIPTION | string | Evet | Ürünün açıklama bilgisidir. |
PRODUCT_AMOUNT | string | Evet | Ürünün tutar bilgisidir. |
Servise gönderilecek örnek bir JSON dosyası şu şekildedir;
2. Adım:
EsnekPos bilgileri değerlendirerek üye iş yerine cevap mesajını gönderir.(Cevap mesajı içerisinde URL_3DS alanı bulunur.)
Güvenli Ödeme Sayfası Servisi Cevap Mesajı Parametreleri
Parametre | Tip | Zorunlu | Açıklama |
---|---|---|---|
ORDER_REF_NUMBER | string | Evet | Üye iş yeri tarafından ödeme isteğinde, isteğe ait verilen referans numarası bilgisidir. |
STATUS | string | Evet | Ödeme işlemi sonucu durum bilgisidir. |
RETURN_CODE | string | Evet | Ödeme işlemi sonucu durumu kod bilgisidir. |
RETURN_MESSAGE | string | Evet | Ödeme işlemi sonucu durum mesaj bilgisidir. |
RETURN_MESSAGE_TR | string | Evet | Ödeme işlemi sonucu durum mesajı için Türkçe açıklama bilgisidir. |
ERROR_CODE | string | Evet | Başarısız ödeme işlemi sonucu hata kod bilgisidir. Banka hata kodları da bu parametre içerisinde dönüş yapılır. |
DATE | string | Evet | Ödeme işlemi için işlem tarihi bilgisidir. |
URL_3DS | string | Evet | Üye iş yerinin kullanıcıyı yönlendireceği 3D Doğrulama Sayfası URL Adresi |
REFNO | string | Evet | Ödeme işlemine ait EsnekPos sistemi tarafından verilen referans numarası bilgisi |
HASH | string | Evet | Ödeme işlemine ait EsnekPos sistemi tarafından oluşturulan hash bilgisi |
CUSTOMER_NAME | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) ad soyad bilgisidir. |
CUSTOMER_MAIL | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) mail bilgisidir. |
CUSTOMER_PHONE | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) telefon bilgisidir. |
CUSTOMER_ADDRESS | string | Evet | İşlemi gerçekleştiren kullanıcının(müşterinin) adres bilgisidir. |
CUSTOMER_CC_NUMBER | string | Evet | Ödeme işleminin gerçekleştirileceği karta ait 16 haneli kart numarası bilgisidir. Kart bilgisi şifrelenmiş şekilde paylaşılır. |
CUSTOMER_CC_NAME | string | Evet | Ödeme işleminin gerçekleştirileceği kart sahibinin ad ve soyadı bilgisidir. |
IS_NOT_3D_PAYMENT | boolean | Evet | Ödeme işleminin 3D gerçekleşip gerçekleşmediği bilgisidir. |
VIRTUAL_POS_VALUES | string | Evet | Ödeme işlemine ait sanalpos açıklamaları bilgisidir. |
RETURN_MESSAGE_3D | string | Evet | Bankadan alınan 3D ödeme işlemine ait cevap mesajı bilgisidir. |
Güvenli Ödeme Sayfası Servisi Cevap Mesajı Parametreleri
Ortak Ödeme Sayfası işlem cevap mesajında STATUS
parametresinin değeri SUCCESS ve RETURN_CODE
parametresinin değeri 0 olarak dönmesi Ortak Ödeme Sayfası işleminin kabul edildiğini ifade etmektedir. Bundan sonraki aşamada ödeme yapacak kullanıcıdan kart bilgileri ve taksit bilgileri alınarak ödeme yapılacaktır.
3. Adım:
Üye işyeri aldığı cevabı değerlendirerek ödeme kabul edildi ise EsnekPos'un vermiş olduğu URL_3DS adresine müşteriyi yönlendirir.
4. Adım:
EsnekPos kullanıcıdan kredi kartı bilgilerini ve taksit bilgilerini kendi sunucularında kendi güvenlik önlemlerini kullanarak alır ve ödeme sürecini ilerletir.
5. Adım:
EsnekPos 3D doğrulama işlemlerini sonuçlandırır, ödemenin sonucunu üye işyerinin 1. adımda bildirmiş olduğu BACK_URL adresine FORM POST metodu ile bildirir.
Üye işyerine gönderilen FORM POST mesajında STATUS
parametresinin değeri SUCCESS ve RETURN_CODE
parametresinin değeri 0 olarak dönmesi 3D Ödeme işleminin sorunsuz bir şekilde gerçekleştiğini ifade etmektedir.
Ödeme durumundan emin olmak için PROCCESS_QUERY methodu ile sorgulama yapmanız ve PROCCESS_QUERY methodunun cevabını dikkate almanız gerekmektedir.
Bu sorguyu client-side tarafında değil server to server olacak şekilde kurgulamanız gerekmektedir müşteri tarayıcısında yaptığınız bu PROCCESS_QUERY methodunun görünmemesi ve takip edilememesi gerekmektedir.
Last updated