Başlangıç

Hedef Kitle

Bu doküman; ödeme servisi deneyimi olan, e-ticaret sitelerinde ve/ya dahili ödeme platformunun entegrasyonunu yapacak olan teknik personel için hazırlanmıştır. ERP sistemlerinde online ödeme için ZiraatPay kullanılmıştır.

Üye İş Yeri / Müşteri Destek Birimine Ulaşım

Ödeme işlemleri ya da bağlantınıza ilişkin sorunlar için +90 212 3190647 numaralı telefondan ya da info@ziraatpay.com.tr adresinden Üye İş Yeri / Müşteri Desteği ile bağlantıya geçebilirsiniz.

ZiraatPay nedir?

ZiraatPay, Asseco SEE Türkiye tarafından geliştirilmiş olan bir online ödeme çözümüdür. ZiraatPay Turkey. Hem üye iş yerleri hem de üye iş yerlerinden işlem yapan müşteriler için güvenli, esnek, kolay ve kullanışlı bir ödeme deneyimi sunar. Müşteriler (Kart Hamilleri) ödeme sayfalarında bulunan güvenli e-cüzdan ve esnek ödeme özelliklerinden faydalanırken, üye iş yerleri ödemeleri kredi kartı verilerine dokunmaksızın yönetir ve PCI DSS uygunluklarını korur; bu sayede dolandırıcılık riskleri ortadan kaldırılır ve mali açıdan hassas olan verilerin güvenli şekilde depolanması sağlanır.

Güvenlik

ZiraatPay sağlam ve güvenli bir iletişim protokolü üstüne inşa edilmiştir. ZiraatPay API, standart HTTP(s) Post istekleri ile birlikte gönderilen bir talimatlar dizisidir, bakınız HTTPS Post istekleri. Sunucu tarafında, Verisign tarafından sağlanan sertifika kullanılmaktadır. SSL şifrelemesi sayesinde sunucularımızın sizinle iletişim kurması ve verilerinizin şifrelenmiş şekilde iletilmesi garanti edilmektedir. İstemci SSL sertifikasına ihtiyaç duyulmamaktadır. Bir istek alındığında şifreleme seviyesi kontrol edilir. Doğrudan TLSv1.1 ve üstü desteklenir.

Desteklenen Diller

API desteği, HTTP Post yöntemlerini uygulayan tüm platformları ve dilleri desteklemektedir.

Cevap Mesajı Anlamlandırma

ZiraatPay cevaplarında varsayılan format JSON ’dur. ZiraatPay cevaplarını işleyebilmek için JSON ayrıştırma araçları kullanılabilir.

Test Ortamı

API test ortamı kullanıma açıktır ve bu dokümanda yer alan tüm API işlem türleri yanda verilen link kullanılarak test edilebilir. Tüm API istekleri HTTP POST yöntemi kullanılarak bu URL adresine gönderilecektir.

					https://test.ziraatpay.com.tr/ziraatpay/api/v2
				

Entegrasyon Ortamı

API entegrasyon ortamı kullanıma açıktır ve bu dokümanda yer alan tüm API işlem türleri yanda verilen link kullanılarak test edilebilir. Tüm API istekleri HTTP POST yöntemi kullanılarak bu URL adresine gönderilecektir.

					https://entegrasyon.ziraatpay.com.tr/ziraatpay/api/v2
				

İstek & Cevap (Request & Response)

ZiraatPay API İstekleri

ZiraatPay API ortamına bir istekte bulunmak için ilgili POST HTTP isteğinin ZiraatPay API Endpoint URL adresine gönderilmesi gerekir. API URL’e gönderilen her bir HTTP POST isteği, isteğin tipine bağlı olarak ilgili “parametre-değer” ikilisi olarak kodlanmalıdır.

ZiraatPay API Cevapları

ZiraatPay API Cevabı JSON veri formatı kullanır ve destekler. Her bir api cevabı, RESPONSECODE ve RESPONSEMSG parametrelerini içermektedir. İlgili işlemin başarılı sonuçlanıp sonuçlanmadığına göre, bu parametreler belli değerler içerecektir. Eğer hata söz konusu ise; (RESPONSECODE 00 değilse), ERROR ve ERRORCODE parametreleri de cevaba eklenecektir.

Pagination

TO BE PROVIDED

Doğrulama

API isteklerinde kullanıcı bilgilerinizi vererek kendinizi doğrulamanız beklenmektedir. API kullanıcı bilgilerinizi ZiraatPay’de “Hesabım” linkinden güncelleyebileceğiniz gibi, gereken değişiklikleri Müşteri Destek ekibimize de iletebilirsiniz. Her bir API kullanıcısının kendi email adresi ve şifresi vardır. ZiraatPay sistemine API üzerinden erişim ve işlem yapma yetkisi veren bu email adresi ve şifre bilgisinin kullanıcı tarafından gizli tutulması ve iyi saklanması gerekmektedir.

Tüm API istekleri HTTPS üzerinden yapılmalıdır. Standard HTTP üzerinden yapılan istekler başarısızlıka sonuçlanacaktır. Doğrulama her bir API isteğinde yeniden yapılmaktadır.

					MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]

				

Entegrasyon Modelleri

Barındırılan Ödeme Sayfası (HP)

Bu model, ödeme akışı için Asseco SEE ortamlarında barındırılan ZiraatPay ortak ödeme sayfalarını kullanır. Kart verisine dokunmadan yapılacak olan işlemde, işlem sonucu son adımda üye iş yeri sistemine aktarılır. Ortak ödeme sayfası kullanılarak gerçekleştirilen işlemler MO/TO ya da 3D Secure kullanımlı olarak yapılabilir.

Adım 1:

Üye iş yeri Web sitesi ortak ödeme sayfası modeli belirterek bir satış talebi yapar. ZiraatPay ödeme sayfasında görüntülenecek ya da işlem aşamasında kullanılabilecek tüm Sipariş / Fatura / Üye iş yeri / Ürün / Kargo detayları da bu aşamada kabul edilir.

Adım 2:

Ödeme talebi sonucunda geçerli bir oturum anahtarı oluşturulur ve geri üye iş yeri sistemine gönderilir. Üye iş yeri Web Sitesi bu oturum anahtarını alır ve kart sahibi ZiraatPay Ödeme Sayfaları'na yönlendirilir.

Adım 3:

Bu adımda üye iş yeri, kart sahibini ZiraatPay ortak ödeme sayfalarına yönlendirir. Ortak ödeme sayfalarında açılan kart tanımlama, kayıtlı kart listesi, ürün detayları, taksit tablo panellerini kullanarak kart sahibi ödeme işlemini gerçekleştirme isteğini gönderir.

Adım 4:

ZiraatPay finansal işlemi gerçekleştirerek işlem sonucunda kart sahibini üye iş yerinin ilk adımda belirttiği dönüş URL'ine gönderir.

Bu son adımda kart sahibi tarafında oluşabilecek tarayıcı sorunları, işlemden vazgeçme, elektrik ya da internet kesintisi gibi durumlarda üye iş yeri işlem akıbetini API model sorgularını kullanarak öğrenebilir. İşlem başarılı olmuşsa üye iş yeri tarafında ilgili aksiyonlar alınır. Başarılı olmadığı durumlarda ise kart sahibi ilgili ödeme için tekrar ortak ödeme sayfalarına yönlendirilebilir.

Direct POST - MOTO

Bu entegrasyon modelinde ortak ödeme sayfalarında farklı olarak son kullanıcı görsel arabirim servisi ZiraatPay tarafından yapılmaz. Tüm kullanıcı görsel arabirimlerini (user interfaces) kendi ortamlarında barındırmak, versiyonlamak ve yönetmek isteyen üye iş yerleri bu modeli kullanabilirler. %100 PCI DSS uyumluluğunu mümkün kılan bu modelde, aşağıda anlatıldığı şekilde üye iş yeri sisteminde / sayfasında sunulan form direkt olarak ZiraatPay ortamlarına HTTP POST kullanılarak hassas veriye dokunmadan işlem desteği sağlanır. Üye iş yerleri müşterilerine kayıtlı kartlarla işlem yaptırabildiği gibi, yeni kartlarla da işlem imkanı sunar.

Adım 1:

Üye iş yeri sistemi gerekli tüm işlem / sipariş detaylarını vererek oturum anahtarı isteğini gönderir. Bu adımdaki verilerin hiçbiri hassas veri kapsamında bulunmaz.

Adım 2:

Oturum anahtarı isteği (Session token request) işlenerek tüm verilerin geçerli olması durumunda üye iş yeri kullanımına açılan oturum anahtarı paylaşılır.

Adım 3:

Elde edilen oturum anahtarı bilgisiyle üye iş yeri web sayfasında form gösterilir. Bu form kodu örneği için aşağıdaki bölümü inceleyebilirsiniz.

Extra Puan Adimi:

Üye is yeri ZiraatPay Direct Post metodlarinda puan kullanimi için SESSIONTOKEN, CARDPAN,CARDEXPIRY ile puan sorgulama islemi yapmalidir. QUERYPOINTS dönüs degerine göre örnek form içindeki points alani doldurulmali. Puan ile satis örneklerine buradan ulasabilirsiniz. Ardindan puanli satis isteginin ilgili ödeme sistemine iletilmesi için SESSIONTOKEN ve BIN parametreleri ile QUERYPAYMENTSYSTEMS sorgusu yapilmali ve dönüs degerinde yer alan ödeme sistemi adi örnek form içinde paymentSystem alaninda gönderilmelidir.

Adım 4:

Kart sahibi, üye iş yeri sayfasında (ya da HTTP destekleyen herhangi bir mobil / masaüstü uygulama da olabilir) gösterilen formda gerekli alanları doldurarak işlem isteğini yapar. Üye iş yeri bu formdaki tüm alanları direkt olarak ZiraatPay sistemine POST eder.

Adım 5:

ZiraatPay tüm işlem detaylarını ve ödeme formundan gelen bilgileri kullanarak finansal işlemi gerçekleştirir. Bu süreçte kart sahibi ZiraatPay tarafından servis edilen herhangi bir görsel arabirim görmeyecektir. Gerçekleştirilen bu işlem MOTO bir işlem niteliği taşır.

Adım 6:

ZiraatPay bu işlem isteğini ilgili banka ya da ödeme sistemi terminaline taşıyarak işlemi gerçekleştirir. Daha sonra bu işlem sonucu ilk adımda belirtilen üye iş yeri dönüş URL adresine gönderilir.

Direct POST (MOTO) Test Formu

<!DOCTYPE html> <html> <head> <title>Sample POST Form</title> <meta charset="utf-8"> <script> function hideCardPANData() { if (document .getElementById('isPayWithCardToken').checked) { document.getElementById('cardPANData').style.display = 'none'; document .getElementById('cardTokenContainer').style.display = 'block'; } else { document .getElementById('cardTokenContainer').style.display = 'none'; document.getElementById('cardPANData').style.display = 'block'; } } </script> <style type="text/css"> form { display: table; } p { display: table-row; } label { display: table-cell; } input { display: table-cell; } </style> </head> <body onload="hideCardPANData();"> <form action="https://vpos.ziraatpay.com.tr/merchant/post/sale/[SECURE_SESSION_TOKEN]" method="post"> <div> <label for="isPayWithCardToken">Pay with Card Token</label> <input type="checkbox" onclick="hideCardPANData();" name="isPayWithCardToken" id="isPayWithCardToken" autocomplete="off" maxlength="32" /> </div> <div class="container"> <div id="cardPANData"> <p> <label for="cardOwner">Card Owner Name</label> <input type="text" name="cardOwner" id="cardOwner" autocomplete="off" maxlength="32" /> </p> <p> <label for="pan">Card Number (PAN) </label> <input type="text" id="pan" name="pan" autocomplete="off" maxlength="19" /> </p> <p> <label for="expiryMonth">Expiration Date</label> <select name="expiryMonth" id="expiryMonth"> <option value="01">January</option> <option value="02">February</option> <option value="03">March</option> <option value="04">April</option> <option value="05">May</option> <option value="06">June</option> <option value="07">July</option> <option value="08">August</option> <option value="09">September</option> <option value="10">October</option> <option value="11">November</option> <option value="12">December</option> </select> <select name="expiryYear" id="expiryYear"> <option value="2016">2016</option> <option value="2017">2017</option> <option value="2018">2018</option> <option value="2019">2019</option> <option value="2020">2020</option> <option value="2021">2021</option> <option value="2022">2022</option> <option value="2023">2023</option> <option value="2024">2024</option> <option value="2025">2025</option> <option value="2026">2026</option> <option value="2027">2027</option> <option value="2028">2028</option> <option value="2029">2029</option> <option value="2030">2030</option> <option value="2031">2031</option> <option value="2032">2032</option> <option value="2033">2033</option> <option value="2034">2034</option> </select> </p> <p> <label for="cvv">Security Code (CVV)</label> <input type="input" name="cvv" id="cvv" autocomplete="off" maxlength="4" /> </p> <p> <label for="saveCard">Save Card</label> <input type="checkbox" name="saveCard" id="saveCard" value="YES" /> </p> <p> <label for="cardName">Card Name</label> <input type="text" name="cardName" id="cardName" /> </p> <p> <label for="installmentCount">Installment Count</label> <input type="text" name="installmentCount" id="installmentCount" /> </p> <input type="hidden" value="" name="points" id="points" /> <input type="hidden" value="" name="paymentSystem" id="paymentSystem" /> </div> <div id="cardTokenContainer"> <p> <label for="cardToken">>Card Token</label> <input type="text" name="cardToken" id="cardToken" autocomplete="off" maxlength="64" /> </p> <p> <label for="installmentCount">Installment Count</label> <input type="text" name="installmentCount" id="installmentCount" /> </p> </div> <input type="submit" value="Submit" /> </form> <script type="text/javascript" src="https://ZIRAATPAY_HOST/ziraatpay/static/external/whitewolf-v3.js"></script> <script type="text/javascript"> whitewolf.run(h.online-metrix.net, ORG_ID, SESSIONTOKEN); </script> <noscript> <iframe style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" src="https://h.online-metrix.net/tags?org_id=ORG_ID&session_id=UNIQUE_SESSION_ID&pageid=PAGEID"> </iframe> </noscript> </body> </html>

					
merchantPaymentId: PaymentId-FbnzDdx04fZu
apiMerchantId: 700100000
paymentSystem: My İşbank VPOS Account (Test)
paymentSystemType: ISBANK
paymentSystemEftCode: 0064
pgTranDate: 20170113 12:20:35
pgTranId: 17013MUjC07014059
pgTranRefId: 701300002882
pgTranApprCode: 733185
pgOrderId: PaymentId-FbnzDdx04fZu
sessionToken: FOEMQGVTVWOQCJRSS6DARRRV62RQK2FIKUY7ZMXKBNX6SOUJ
random: -349886350
customerId: Customer-QjOnxH8Z
SD_SHA512: bff497614a8767e3176fede4f3f8274225a8f619469a1c5eafe2e785fbc438aeb5345c51be30d976d53db5b73adf026347db1144c52cbc2133364aa13e933d45
sdSha512: 7f1485a24f1790e0791fe9de5ec33d4e98057578f77a4c39fdd4bd874079d6e3af9271da020c57ed8acd7642ec801ad80dae0c574462a58a6722fbfa361a0b65
responseCode: 00
responseMsg: Approved
                      
				

Direct POST - 3D Güvenli

Bu entegrasyon modelinde ortak ödeme sayfalarında farklı olarak, son kullanıcı görsel arabirim servisi ZiraatPay tarafından yapılmaz. Tüm kullanıcı görsel arabirimlerini (user interfaces) kendi ortamlarında barındırmak, versiyonlamak ve yönetmek isteyen üye iş yerleri bu modeli kullanabilirler. %100 PCI DSS uyumluluğunu mümkün kılan bu modelde, aşağıda anlatıldığı şekilde üye iş yeri sisteminde / sayfasında sunulan form direkt olarak ZiraatPay ortamlarına HTTP POST kullanılarak hassas veriye dokunmadan işlem desteği sağlanır. Üye iş yerleri müşterilerine kayıtlı kartlarla işlem yaptırabildiği gibi, yeni kartlarla da işlem imkanı sunar. Buradan gerçekleştirilen işlemler 3D Güvenli olma özelliği taşır.

Adım 1:

Üye iş yeri sistemi gerekli tüm işlem / sipariş detaylarını vererek oturum anahtarı isteğini gönderir. Bu adımdaki verilerin hiçbiri hassas veri kapsamında bulunmaz.

Adım 2:

Oturum anahtarı isteği (Session token request) işlenerek tüm verilerin geçerli olması durumunda üye iş yeri kullanımına açılan oturum anahtarı paylaşılır.

Adım 3:

Elde edilen oturum anaharı bilgisiyle üye iş yeri web sayfasında form gösterilir. Bu form kodu örneği için aşağıdaki bölümü inceleyebilirsiniz.

Extra Puan Adimi:

Üye is yeri ZiraatPay Direct Post metodlarinda puan kullanimi için SESSIONTOKEN, CARDPAN,CARDEXPIRY ile puan sorgulama islemi yapmalidir. QUERYPOINTS dönüs degerine göre örnek form içindeki points alani doldurulmali. Puan ile satis örneklerine buradan ulasabilirsiniz. Ardindan puanli satis isteginin ilgili ödeme sistemine iletilmesi için SESSIONTOKEN ve BIN parametreleri ile QUERYPAYMENTSYSTEMS sorgusu yapilmali ve dönüs degerinde yer alan ödeme sistemi adi örnek form içinde paymentSystem alaninda gönderilmelidir.

Adım 4:

Kart sahibi, üye iş yeri sayfasında (ya da HTTP destekleyen herhangi bir mobil / masaüstü uygulama da olabilir) gösterilen formda gerekli alanları doldurarak işlem isteğini yapar. Üye iş yeri bu formdaki tüm alanları direkt olarak ZiraatPay sistemine POST eder.

Adım 5:

ZiraatPay tüm işlem detaylarını ve ödeme formundan gelen bilgileri kullanarak finansal işlemi gerçekleştirir. Bu süreçte kart sahibi ZiraatPay tarafından servis edilen herhangi bir görsel arabirim görmeyecektir. Gerçekleştirilen bu işlem 3D Secure güvenli bir işlem niteliği taşır.

Adım 6:

ZiraatPay kart sahibini 3D Secure güvenlikli işlem için ACS (Access Control Server) sayfalarına yönlendirir.

Adım 7:

ACS (Access Control Server) birimi, 3D doğrulama servis sayfalarını gösterir ve bu adımda kart sahibinin mobil telefonuna bu işlem için oluşturulan güvenli otorizasyon kodu SMS olarak gönderilir.

Adım 8:

ACS sunucusu (Access Control Server) kullanıcıyı doğrulayarak ilgili ZiraatPay arabirimlerine gönderir.

Adım 9:

Bu işlem sonucu, ZiraatPay sistemi tarafından ilk adımda belirtilen üye iş yeri dönüş URL adresine gönderilir.

Direct POST (3D Güvenli) Test Formu

<!DOCTYPE html> <html> <head> <title>Sample POST Form</title> <meta charset="utf-8"> <script> function hideCardPANData() { if (document .getElementById('isPayWithCardToken').checked) { document.getElementById('cardPANData').style.display = 'none'; document .getElementById('cardTokenContainer').style.display = 'block'; } else { document .getElementById('cardTokenContainer').style.display = 'none'; document.getElementById('cardPANData').style.display = 'block'; } } </script> <style type="text/css"> form { display: table; } p { display: table-row; } label { display: table-cell; } input { display: table-cell; } </style> </head> <body onload="hideCardPANData();"> <form action="https://vpos.ziraatpay.com.tr/ziraatpay/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]" method="post"> <div> <label for="isPayWithCardToken">Pay with Card Token</label> <input type="checkbox" onclick="hideCardPANData();" name="isPayWithCardToken" id="isPayWithCardToken" autocomplete="off" maxlength="32" /> </div> <div class="container"> <div id="cardPANData"> <p> <label for="cardOwner">Card Owner Name</label> <input type="text" name="cardOwner" id="cardOwner" autocomplete="off" maxlength="32" /> </p> <p> <label for="pan">Card Number (PAN)</label> <input type="text" id="pan" name="pan" autocomplete="off" maxlength="19" /> </p> <p> <label for="expiryMonth">Expiration Date</label> <select name="expiryMonth" id="expiryMonth"> <option value="01">January</option> <option value="02">February</option> <option value="03">March</option> <option value="04">April</option> <option value="05">May</option> <option value="06">June</option> <option value="07">July</option> <option value="08">August</option> <option value="09">September</option> <option value="10">October</option> <option value="11">November</option> <option value="12">December</option> </select> <select name="expiryYear" id="expiryYear"> <option value="2016">2016</option> <option value="2017">2017</option> <option value="2018">2018</option> <option value="2019">2019</option> <option value="2020">2020</option> <option value="2021">2021</option> <option value="2022">2022</option> <option value="2023">2023</option> <option value="2024">2024</option> <option value="2025">2025</option> <option value="2026">2026</option> <option value="2027">2027</option> <option value="2028">2028</option> <option value="2029">2029</option> <option value="2030">2030</option> <option value="2031">2031</option> <option value="2032">2032</option> <option value="2033">2033</option> <option value="2034">2034</option> </select> </p> <p> <label for="cvv">Security Code (CVV)</label> <input type="input" name="cvv" id="cvv" autocomplete="off" maxlength="4" /> </p> <p> <label for="saveCard">Save Card</label> <input type="checkbox" name="saveCard" id="saveCard" value="YES" /> </p> <p> <label for="cardName">Card Name</label> <input type="text" name="cardName" id="cardName" /> </p> <p> <label for="installmentCount">Installment Count</label> <input type="text" name="installmentCount" id="installmentCount" /> </p> <input type="hidden" value="" name="points" id="points" /> <input type="hidden" value="" name="paymentSystem" id="paymentSystem" /> </div> </div> <div id="cardTokenContainer"> <p> <label for="cardToken">Card Token</label> <input type="text" name="cardToken" id="cardToken" autocomplete="off" maxlength="64" /> </p> <p> <label for="installmentCount">Installment Count</label> <input type="text" name="installmentCount" id="installmentCount" /> </p> </div> <input type="submit" value="Submit" /> </form> <script type="text/javascript" src="https://ZIRAATPAY_HOST/ziraatpay/static/external/whitewolf-v3.js"></script> <script type="text/javascript"> whitewolf.run(h.online-metrix.net, ORG_ID, SESSIONTOKEN); </script> <noscript> <iframe style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" src="https://h.online-metrix.net/tags?org_id=ORG_ID&session_id=UNIQUE_SESSION_ID&pageid=PAGEID"> </iframe> </noscript> </body> </html>

Kartsız Direct POST - 3D Güvenli

Aşağıda belirtilen kartsız ödeme yöntemleri üzerinden entegrasyon sağlamak için "Kartsız DIRECT POST (3D Güvenli) Test Formu" örneğini baz alınız.

• Maximum Mobil

Kartsız DIRECT POST (3D Güvenli) Test Formu

<!DOCTYPE html> <html> <head> <title>Sample Cardless POST Form</title> <meta charset="utf-8"> </head> <body> <form action="https://vpos.ziraatpay.com.tr/ziraatpay/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]" method="post"> <input type="text" name="installmentCount" id="installmentCount" /> <input type="hidden" value="" name="cardlessPaymentSystem" id="cardlessPaymentSystem" /> <input type="submit" value="Submit" /> </form> <script type="text/javascript" src="https://ZIRAATPAY_HOST/ziraatpay/static/external/whitewolf-v3.js"></script> <script type="text/javascript"> whitewolf.run(h.online-metrix.net, ORG_ID, SESSIONTOKEN); </script> <noscript> <iframe style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;" src="https://h.online-metrix.net/tags?org_id=ORG_ID&session_id=UNIQUE_SESSION_ID&pageid=PAGEID"> </iframe> </noscript> </body> </html>

					
merchantPaymentId: PaymentId-FVKAjOiFHeuE
apiMerchantId: 700100000
paymentSystem: ISBANK TEST
paymentSystemType: ISBANK
paymentSystemEftCode: 0064
pgTranDate: 20170112 14:13:13
pgTranId: 17012ONNI07013454
pgTranRefId: 701200002832
pgTranApprCode: 733185
pgOrderId: PaymentId-FVKAjOiFHeuE
customerId: Customer-u1Q4G1oG
amount: 11.76
installment: 1
sessionToken: VYD7AXJ6C446GIN55V6KKOB677VRTOZHG5HTSMP3EJCMEQYF
random: tpN2ynMYAn
SD_SHA512: 0f2b4945aefc71f547107898c2002c40d9d4a1508f7f00ee894138f6bc247ebc1238ead5aa01b6ba09bc7932a5957235b7837cc0270781d0a45055fe31648b61
sdSha512: 099e32f8df3130457d2b1595b069794ef6ed08c85a679f72336c5371e91087b223536b317fc43643ae0da06ea29e985a3c8185ab611606308760b0c260aa412f
responseCode: 00
responseMsg: Approved
                      
				

Direct Post 3D Kimlik Doğrulama

Bu entegrasyon modeli, 3D kimlik doğrulama sürecinin SALE / Preauth API Çağrısından ayrı olarak tamamlandığı senaryoya dayanmaktadır. Üye İşyeri, kart sahibinin kart bilgilerini girdiği ve gönderdiği bir sayfa sunar, 3D kimlik doğrulama sürecinin başladığı yer burasıdır. Kimlik doğrulama sürecinden gelen cevaba göre üye işyeri API üzerinden yetkilendirme yapar.

Adım 1:

Üye iş yeri Web sitesi, oturum tanımlamak için geçerli bir anahtar değeri elde etmek amacı ile bir oturum anahtarı (Session Token) isteğinde bulunur.

Adım 2:

Ödeme oturumu isteği işlenir; bir oturum anahtarı (Session Token) oluşturulur ve API yanıtında satıcı sistemine geri gönderilir.

Adım 3:

Üye iş yeri sistemi, verilen güvenli oturum anahtarını (Session Token) kullanarak ödeme ve cüzdan sayfasını açar.

Adım 4:

Kart sahibi sayfayla etkileşime girer ve Gönder düğmesine tıklar. Üye iş yeri sistemi bu sayfadan aldığı tüm bilgileri MSU sistemine gönderir.

Adım 5:

MSU, işyeri sayfasından POST talebini alır ve 3D kimlik doğrulama akışına devam etmek için 3D ACS'ye (Erişim Kontrol Sunucusu) yönlendirir.

Adım 6:

ACS, kart sahibinin kimlik doğrulaması için cep telefonuna gönderilen doğru (dinamik) kodu girmesi gereken 3D Güvenlik Sayfasını açar.

Adım 7:

MSU, 3D Kimlik Doğrulamasının başarılı ya da başarısız yanıtını işler.

Adım 8:

3D Kimlik Doğrulama işleminin son yanıtı, satıcının sayfasına iletilir. Üye iş yerinin daha sonra API aracılığıyla yetkilendirme (Sale / Preauth) verdiğinde, gönderilen formdaki sonucu dinlemesi ve ayrıştırması beklenir.

3D Kimlik Doğrulama Direct Post Test Formu

Kart Bilgi Formu ile 3D Kimlik Doğrulama

			
<form action="https://test.ziraatpay.com.tr/ziraatpay/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="post">
	<input type="text" name="cardOwner" placeholder="Card Owner" maxlength="32" />
	<input type="text" name="pan" placeholder="PAN" maxlength="19" />
	<select name="expiryMonth">
		<option value="01">January</option>
		<option value="02">February</option>
	</select> 
	<select name="expiryYear">
		<option value="2019">2019</option>
		<option value="2020">2020</option>
		<option value="2021">2021</option>
	</select>
	<input type="password" name="cvv" placeholder="CVV" maxlength="4" />
	<input type="checkbox" name="saveCard" />
	<input type="text" name="cardName" placeholder="Card Name"/>
	<input type="text" name="cardCutoffDay" placeholder="Card Cutoff Day"/>
	<input type="text" name="installmentCount" placeholder="Installment Count"/>
	<input type="hidden" name="points" />
	<input type="submit" value="Submit" />
</form>
			
		

Kart Token Form ile 3D Kimlik Doğrulama

			
<form action="https://test.ziraatpay.com.tr/ziraatpay/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="pan" type="text" size="20" />
	<input name="cardOwner" type="text" size="20" />
	<input name="expiryMonth" type="text" size="2"/>
	<input name="expiryYear" type="text" size="4"/>
	<input name="cvv" type="text" size="4"/>
	<input name="cardCutoffDay" type="text" size="2"/>
	<input name="callbackUrl" value="[merchant-return-url-handler]" />
	<input type="submit" value="Complete Payment"/>
</form>

veya ödeme mevcut bir token alınmış kartla yapılacaksa
			
<form action="https://test.ziraatpay.com.tr/ziraatpay/api/v2/post/auth3d/[SECURE_SESSION_TOKEN]" method="POST">
	<input name="cardToken" type="text"  placeholder="Card Token"size="20" />
	<input name="cvv" type="text" placeholder="CVV" size="4" />
	<input type="submit" value="Complete Payment"/>
</form>
			
		

					
sessionToken: 3URSNNY5C6ZATI656WIPXZXDSTAN3PNGLTXLY75H7FNBA7UJ
auth3DToken: AUTH3DTOKEN
responseCode: 00
responseMsg: Approved
mdStatus: 1
mdErrorMsg: Authenticated
                      
				

API & HPP URLs

API URL: https://vpos.ziraatpay.com.tr/ziraatpay/api/v2
Hosted Payment Page URL (HPP): https://vpos.ziraatpay.com.tr/payment/[SECURE_SESSION_TOKEN]
DirectPost 3D URL: https://vpos.ziraatpay.com.tr/ziraatpay/api/v2/post/sale3d/[SECURE_SESSION_TOKEN]
DirectPost Non3D URL: https://vpos.ziraatpay.com.tr/merchant/post/sale/[SECURE_SESSION_TOKEN]

GLOBAL AÇIK KAYNAK E-TİCARET ALTYAPILARI

ZiraatPay olarak birden fazla E-ticaret altyapısı ile entegre durumdayız, ilgili plugin'i aşağıdaki listeden indirebilir ve sisteminiz içine kurabilirsiniz.

OpenCart

OpenCart, açık kaynak kodlu çevrimiçi alışveriş yönetim sistemidir. OpenCart sayesinde online mağazanızı yönetebilir ve entegre işlemlerini kolayca gerçekleştirebilirsiniz.

Presta Shop

PrestaShop, açık kaynak kodlu olarak yayınlanan PHP tabanlı ücretsiz bir e-ticaret yazılımıdır. E-ticaret Alanında en çok tercih edilen yazılımlardan birisidir.

Woo Commerce

WooCommerce, Wordpress geliştiricileri tarafından geliştirilmiş açık kaynak kod kaynaklı e-ticaret eklentisidir. Toplamda 63 dil seçeneği olan bu eklenti açık kaynak olması sebebi ile WordPress geliştiricileri tarafından sürekli güncellenmekte ve farklı ihtiyaçlara özel modüller geliştirilmektedir.

Eklentilerimiz iş ortağımız EticSoft tarafından gerçekleştirilmektedir. Eklentileri indirmek için tıklayınız. Eklentiler ile ilgili taleplerinizi Bildirim Gönder - EticSoft Support destek adresi üzerinden iletebilirsiniz.

Hata Yönetimi

Bir isteğin hata ile sonuçlanması durumunda; dönüş cevabı içerisinde ERROR ve ERRORCODE parametreleri bulunacaktır. Genel olarak meydana gelebilecek iki tür hata bulunmaktadır: Sistem hatalar ve ödeme geçidinden kaynaklanan hatalar.

Merkezi Hatalar

Merkezi hatalar genellikle geçersiz ya da yanlış verilen parametre değerlerinden kaynaklanmaktadır. Bu hataların kodu ERR100xx formatındadır.

Ödeme Sistemleri (vPOS) Kaynaklı Hatalar

ZiraatPay API yapısı, banka tarafında kullanılmakta olan ödeme geçidinden kaynaklanan hatalar için farklı bir dizi hata kodu kullanmaktadır. Bu hata dizisi ISO-8583 ’e ait 39. alan cevap değerlerinden türetilmiştir. Bu hataların kod formatı ERR200xx şeklindedir.

Ek hata cevap parametreleri

İşlemin gerçekleşmemesi durumunda gerçek hatayı açıklayıcı ya da detaylandırıcı nitelikte Sanal POS / Ödeme Sistemi tarafından iletilen mesajlar 2 tane ek cevap parametresi içinde iletilmektedir PGTRANERRORCODE ve PGTRANERRORTEXT . İletilen bu bilgiler özellikle banka tarafında az rastlanan ve genel hata durumlarını açıklayan cevap bilgileridir.

Hatalı cevap örnekleri

Hata durumu içeren bazı API cevap örnekleri yan tarafta bulunabilir.

					{ 
    "errorCode" : "ERR10027", 
    "responseCode" : "99", 
    "errorMsg" : "Geçersiz kart bilgisi (TOKEN) belirtilmiş", 
    "responseMsg" : "Declined",
    "violatorParam" : ""
}                       
				

					{
    "errorCode":"ERR20051",
    "responseCode":"99",
    "errorMsg":"Belirtilen kredi kartının limiti bu işlem için yeterli değildir",
    "responseMsg":"Declined",
    "violatorParam":""
}						
				

					{
    "errorCode":"ERR20099",
    "responseCode":"99",
    "errorMsg":"Lütfen yeniden deneyiniz, sorun devam ederse bankanızla iletişime geçiniz.",
    "responseMsg":"Declined",
    "violatorParam":""
}						
				

					{
    "apiMerchantId" : "6008138000",
    "paymentSystem" : "Teb test ps",
    "pgTranDate" : "20141215 17:22:54",
    "merchantPaymentId" : "session-a7bAS3AddR5PApN",
    "pgTranId" : "14349RW4Q89120700",
    "pgTranRefId" : "4398417187960",
    "pgOrderId" : "session-a7bRkDJK091pN",
    "responseCode" : "00",
    "responseMsg" : "Approved"
}						
				

Bildirimler

ZiraatPay, ilgili firmaya finansal işlemlerle ilgili olayları bildirmek için kullanılan yerleşik bir mekanizmaya sahiptir. Daha spesifik olarak ZiraatPay, belirli bir olay hakkında bir firmaya aşağıdaki durumlarda bildirim mesajları gönderir:

• Onaylanmış bir işlem Gerçekleştirilen

Bu bildirim hizmeti, ZiraatPay, banka ödeme ağ geçidinden, bu işlemin onaylandığını onaylayan belirli bir işlem için başlatılan istek için bir yanıt aldığında onaylanan işlemler için tetiklenir.
Firmanın bitiş noktasında bildirim göndermeye çalışılırken 5 saniye bir zaman aşımına uğradığını unutmayın.

Nasıl çalışır?

Bir satıcı, bir dinleyici bitiş noktası oluşturmalı ve bu bitiş noktasına işaret eden URL, bu satıcının profiline eklenmelidir. ZiraatPay, daha sonra yukarıdaki listeden bahsedilen belirli bir olay meydana geldiğinde firmaya bildirim gönderir.
Böyle bir zaman olayı meydana geldiğinde, ZiraatPay sağda gösterilen ilgili parametreleri içeren URL'ye güvenli bir FORM POST gönderir.

					NOTIFICATIONTYPE: TRANSACTIONAPPROVED
CHANNEL: [MERCHANTBUSINESSID]
CUSTOMER: [CUSTOMERID]
CUSTOMERNAME: [CUSTOMERNAME]   
AMOUNT: [AMOUNT]
TRANSACTIONTYPE: [TRANSACTIONTYPE]
CURRENCY: [CURRENCY]
STATUS: [STATUS]
MERCHANTPAYMENTID: [MERCHANTPAYMENTID]
PGTRANSACTIONID: [PGTRANSACTIONID]
INSTALLMENTCOUNT: [INSTALLMENTCOUNT]
EFTCODE: [INSTALLMENTCOUNT]
				

Metadata

ZiraatPay sisteminde bazı önemli anahtar data alanları şunlardır:

İşlem

Her bir finansal istek ZiraatPay sisteminde bir “işlem”e karşılık gelir. Mutabakat ise bu işlemlerin kaydı üzerinden yapılır.

İşlemlerin belli tipleri ve durumları vardır. Lütfen yan tarafta verilen tanımlara göz atınız.

					/* Sale */ SALE,
/* Pre-authorization */	PREAUTH,
/* Post-authorization */ POSTAUTH,
/* Refund */ REFUND,
/* Partial Refund */ PTREFUND,
/* Credit, Free refund */ CREDIT,
/* Void action */ VOID
				

					/* In Progress, Created */ IP,
/* CAncelled by CardHolder during approval */ CA,
/* FAiled / Declined (Response from the integrated vPOS) */	FA,
/* APproved (Response from the integrated vPOS) */ AP,
/* VoiDed (As secondary process) (Response from the integrated vPOS) */ VD,
/* Needs manual review (Response from the integrated vPOS exists) */ MR
			 
				
				

Diğer Kullanım Özellikleri

ZiraatPay API'nin diğer kullanım alanlarını ve örneklerini aşağıda bulabilirsiniz.

Ödeme Sayfası Bağlantısı (URL) Kullanımı

Ödeme sayfası bağlantısı (URL) kullanımı SMS, mobil uygulama bildirimleri, push mesajlar , e-mail gibi kanallar ile ödemenin yapılacağı linkin müşteri ile paylaşıldığı bir ödeme opsiyonudur. Bu akışta üye iş yeri bir ödeme sayfası linki oluşturarak bu linki ilgili müşteri ile paylaşır. Müşteri kendisine ulaşan ödeme sayfası linkine tıklayarak ödeme sayfasına gider. Bu sayfada ödeme yapacağı tutarı, karşılığında alacağı ürünleri görür. Kart bilgilerini sayfadaki forma girer ve işlemini tamamlar.

Ödeme sayfası bağlantısı oluşturmak isteyen üye iş yeri öncelikli olarak ZiraatPay API üzerinden ilgili parametreler ile bir SESSIONTOKEN isteğinde bulunur. Üye iş yeri başarılı bir şekilde oluşturulan oturum anahtarı bilgisi ile satış ya da ön otorizasyon yapacağı ödeme sayfası linkini oluşturur ve ilgili müşteriyle bu linki paylaşır. Müşteri linkin geçerlilik süresi dolmadan linke tıklayıp işlemi tamamlamalıdır. Geçerlilik süresi dolan linkler "Sonlandırılmış oturum (session) bilgisi." hata sayfasına yönlendirilirken geçersiz bir oturum anahtarı ile oluşturulan linkler ise "Geçersiz oturum (session) bilgisi." sayfasına yönlendirilir. Linklerin geçerlilik süresi SESSIONTOKEN isteğindeki SESSIONEXPIRY parametresi ile belirlenir ve bu parametrenin varsayılan değeri 7gündür.

Başarılı bir şekilde sonlanan işlemlerin cevabı ise SESSIONTOKEN isteğinde gönderilen RETURNURL parametresindeki adrese POST edilir.

Adım 1:

ZiraatPay API üzerinden SESSIONTOKEN isteği ile bir session token oluşuturulur. ([SESSIONTOKEN])

Adım 2:

Bu session token kullanılarak ödeme sayfası linki oluşturulur. (Örn. https://test.ZiraatPay.com.tr/merchant/payment/[SESSIONTOKEN])

Adım 3:

Link ilgili müşteriye mail, SMS, bildirim vs. olarak gönderilir.

Adım 4:

Müşteri linke tıklayarak ödeme sayfasına gider ve ödeme işlemini gerçekleştirir.

Adım 5:

Ödeme işleminin sonucu SESSIONTOKEN isteğindeki RETURNURL parametresi ile belirtilen adrese POST edilir.

Test Kartları

Burada farklı bankalar için test kartları bulabilirsiniz
Nestpay bankaları için 3D Secure şifresi "a" dır.

					
					

                    

                        

                            

                                
Banka
                                
Kart Numarası
                                
S.K.T
                                
CVV
                                
3D Güvenli Şifre
                            
                        
                        

                            

                                
Ziraat-VISA
                                
4546711234567894
                                
12/2026
                                
000
                                
a
                            
                        
                        

                            

                                
Ziraat-MASTER
                                
5401341234567891
                                
12/2026
                                
000
                                
a
                            
                        
                         
                        

                            

                                
AKBANK-VISA
                                
4355084355084358
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
AKBANK-MASTER
                                
5571135571135575
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
TEB-VISA
                                
4402934402934406
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
TEB-MASTER
                                
5101385101385104
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
HALKBANK-VISA
                                
4920244920244921
                                
12/2030
                                
001
                                
a
                            
                        
                        

                            

                                
HALKBANK-MASTER
                                
5404355404355405
                                
12/2030
                                
001
                                
a
                            
                        
                        

                            

                                
FINANSBANK-VISA
                                
4022774022774026
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
FINANSBANK-MASTER
                                
5456165456165454
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
ISBANK-VISA
                                
4508034508034509
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
ISBANK-MASTER
                                
5406675406675403
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
ANADOLUBANK-VISA
                                
4258464258464253
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
ANADOLUBANK-MASTER
                                
5222405222405229 
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
HSBC
                                
5100051016005572
                                
01/2020
                                
742
                                
a
                            
                        
                        

                            

                                
INGBANK-VISA
                                
4555714555714556
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
INGBANK-MASTER
                                
5400245400245409
                                
12/2030
                                
000
                                
a
                            
                        
                        

                            

                                
QNBFINANS-TROY
                                
9792350046201275
                                
07/2027
                                
993
                            
                        
                        

                            

                                
GARANTI-TROY
                                
9792052565200010
                                
01/2027
                                
327
                            
                        
                        

                            

                                
YKB-TROY
                                
6501617060023449
                                
12/2026
                                
000
                            
                        
                        

                            

                                
YKB-TROY
                                
6501617025774490
                                
12/2026
                                
000
                            
                        
                        

                            

                                
YKB-TROY
                                
6501617063597076
                                
12/2026
                                
000
                            
                        
                        

                            

                                
TURKIYE FINANS-TROY
                                
9792182023832743
                                
10/2028
                                
878
                                
a
                            
                        
                         

                            

                                
SEKERBANK-TROY
                                
6501750104751517
                                
12/2027
                                
516
                                
a
                            
                        
                         

                            

                                
AKBANK-TROY
                                
9792072000017956
                                
12/2027
                                
000
                                
a
                            
                        
                        

                            

                                
ABANK-TROY
                                
36577312700094
                                
12/2027
                                
000
                                
a
                            
                        
                        

                            

                                
YKB-VISA
                                
4506344103118942
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-VISA
                                
4506347023253988
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-VISA
                                
4506347028991897
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-VISA
                                
4506347026523718
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-MASTER
                                
5400617004770430
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-MASTER
                                
5400617020092306
                                
12/2025
                                
000
                            
                        
                        

                            

                                
YKB-MASTER
                                
5400617030400291
                                
12/2025
                                
000
                            
                        
                         

                            

                                
GARANTI-VISA
                                
4824892919057014
                                
12/2025
                                
067
                            
                        
                         

                            

                                
GARANTI-MASTER
                                
5378297758742014
                                
05/2025
                                
467
                            
                        
                        

                            

                                
KUVEYTTURK-MASTER
                                
5188961939192544
                                
06/2025
                                
929
                                
123456
                            
                        
                         

                            

                                
VAKIFBANK-VISA
                                
4938460158754205
                                
01/2024
                                
715
                                
123456
                            
                        
                        

                            

                                
VAKIFBANK-VISA
                                
4119790155203496
                                
04/2024
                                
579
                                
123456
                            
                        
                        

                            

                                
VAKIFBANK-MASTER
                                
5400617020092306
                                
12/2025
                                
Yok
                                
123456
                            
                        
				
                
					
				

Finansal İşlemler

ZiraatPay sisteminde yer alan tüm işlem tipleri aşağıdaki gibidir:

Satış

Satış işlemi, müşterinin kredi kartından ödemenin anında tahsil edildiği bir işlemdir.

İstek parametreleri:

ACTION:

SALE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CUSTOMEREMAIL:

string, conditional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, conditional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, conditional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERIP:

string, conditional Max length: 39 Kart Sahibi (Müşteri) IP Adresi.

CUSTOMERUSERAGENT:

string, optional Max length: 512 Kart Sahibi (Müşteri) Teknik Donanım.

CUSTOMERBIRTHDAY:

date, optional Max length: 16 Format: [dd-MM-yyyy] Müşteri Doğum Günü.

TCKN:

string, optional Max length: 16 TCKN / Müşteri Kimlik Numarası.

AUTH3DTOKEN:

string, optional Max length: 16 description

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CARDCVV:

string, optional Max length: 4 Kart güvenlik kodu, CVV değeri.

SAVECARD:

string, optional Max length: 3 Bu parametre değeri 'yes' olarak gönderildiğinde ödeme sayfasında kart otomatik olarak kaydedilecektir. Save Card parametresi API entegrasyon modeli için kullanılamaz

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

POINTS:

string, optional Max length: 500

Sale by points can be used via points argument of sale action. This parameter gets its argument as a json format and parse it according to payment system.

AKBANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"XCBCHIPPARA", "value":"10"}]
• MULTIPLE POINTS USAGE: [{"name":"XCBCHIPPARA", "value":"10"},{"name":"PCBCHIPPARA", "value":"10"},{"name":"CCBCHIPPARA", "value":"10"}]

ISBANK SALE BY POINTS SAMPLE

• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"MAXIPUAN","value":"1"}]

FINANSBANK SALE BY POINTS SAMPLE

• You can use points if and only if PARAPUAN equal to AMOUNT
• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
POINTS : [{"name":"PARAPUAN","value":"10"}]

TEB BANK SALE BY POINTS SAMPLE

• You can use points if and only if KULLANBONUS equal to AMOUNT
• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
POINTS : [{"name":"KULLANBONUS","value":"10"}]

HALKBANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"ODUL", "value":"10"}]

AKTIFBANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"KULLANPUAN","value":"10"}]

GARANTI BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"FBB","value":"5160.02"},{"name":"BNS","value":"91462.68"}]

YAPI KREDI BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"PUAN","value":"10.00"}]

HSBC BANK SALE BY POINTS SAMPLE

• POINTS must be json String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"ODUL","value":"10.00"}]

VAKIFBANK SALE BY POINTS SAMPLE

• POINTS must be JSOn String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"PUAN","value":"283567.72"}]

SEKERBANK SALE BY POINTS SAMPLE

• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"KULLANBONUS","value":"10"}]

DENIZBANK SALE BY POINTS SAMPLE

• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"BONUSAMOUNT","value":"10.00"}]

ZIRAATBANK SALE BY POINTS SAMPLE

• POINTS must be JSON String, you can use POINTS argument in SALE method like below
• POINTS : [{"name":"PUANSORGU","value":"PUANSORGU"},{"name":"KULLANPUAN","value":"10"}]

BILLTOADDRESSLINE:

string, optional Max length: 255 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 16 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 32 Ship To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

FASTSHIPPING:

string, optional Max length: 3 Bu parametre teslimat / kargolama işleminin hızlı / acil seçeneğiyle yapılıp yapılmadığını gösterir. Hızlı teslimat seçeneği kullanılmışsa üye iş yeri tarafından "yes" olarak gönderilmelidir. Tüm geçerli değerleri görün (2)

EXTRA:

string, optional Max length: 4000 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string), IframeDomainUrl indicates from which URL address payment will be proceesed., {"PREAUTH":"YES"} parameter indicates that payment will be processed as pre-authorization even if is started as sale., IGNORECUSTOMERCOMMISSION(values : YES/NO).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED", "IGNORECUSTOMERCOMMISSION" : "YES"}

Other bank parameters

• MAXIMUMMOBIL - include Maximum Mobil payment system name like below to have Maximum Mobil tab on Default HPP
  {"MaximumMobilPaymentSystem":"PaymentSystemName"}
• GIROGATE payment methods. If one of payment methods is sent as "Yes", authentication will be done using GiroGate payment methods. Possible values: YES/NO.
  • SOFORT: {"SOFORT": "YES"}
  • SAFETYPAY: {"SAFETYPAY": "YES"}
  • QIWI: {"QIWI": "YES"}
  • GIROPAY: {"GIROPAY": "YES"}
  • IDEAL: {"IDEAL": "YES"}
  • FINNISHONLINEBANKING: {"FINNISHONLINEBANKING": "YES"}
  • BANCONTACT: {"BANCONTACT": "YES"}
  • ALIPAY: {"ALIPAY": "YES"}
  • MULTIBANCO: {"MULTIBANCO": "YES"}
  • TRUSTPAY: {"TRUSTPAY": "YES"}
  • EPS: {"EPS": "YES"}
  • MYBANK: {"MYBANK": "YES"}
  • P24: {"P24": "YES"}
  • BOLETO: {"BOLETO": "YES"}
  • ELO: {"ELO": "YES"}
  • SEPA: {"SEPA": "YES"}
  • UPOP: {"UPOP": "YES"}
• ISBANK - include in extra like below to send agriculture template info to Isbank when doing imece card operations.
  {"IMCKOD":"imckod", "FDONEM":"fdonem"}

SHIPTOPHONE:

string, optional Max length: 32 Teslimat bilgilerine ait telefon numarası

BILLTOPHONE:

string, optional Max length: 32 Fatura bilgilerine ait telefon numarası

BUYERTYPE:

string, optional Max length: 1 Default value: 'A' Üye / Anonim kullanıcı bayrağı Tüm geçerli değerleri görün ()

SELLERID:

string, optional Max length: 1024 Satıcı başına benzersiz değer.

COMMISSIONAMOUNT:

string, optional Max length: 512 description

DISCOUNTAMOUNT:

decimal, optional Max length: 30 ORDERITEMS içerisinde belirtilen toplam tutardan düşülecek indirim tutarını belirtir. Eğer bu alanda bir değer yollanırsa, AMOUNT alanı ORDERITEMS toplamı ile DISCOUNTAMOUNT indirim tutarı farkına eşit olmalıdır. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

TOTALSELLERCOMMISSIONAMOUNT:

decimal, optional Max length: 30 description

TOTALSELLERPAYMENTAMOUNT:

decimal, optional Max length: 30 description

NOTIFICATIONURL:

string, optional Max length: 255 description

SELLERPAYMENTAMOUNT:

string, optional Max length: 512 description

CUSTOMERTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (4)

CAMPAIGNS:

string, optional Max length: 1024 It represents the campaigns which is provided encoded JSON object. Example: [{"campaignCode": "taks3","campaignName": "2","campaignExtra": "ArtiTaksit"}] - while sending the request it must be encoded

					
ACTION: SALE
AMOUNT: 18.75
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-3gMvdMzXMj2q
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
CUSTOMER: Customer-Lsw7mJAm
CUSTOMERNAME: Name Lsw7mJAm
CUSTOMEREMAIL: Lsw7mJAm@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name Lsw7mJAm
CUSTOMERPHONE: +901638874658
CUSTOMERBIRTHDAY: 01-01-2001
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
CARDPAN: 5456165456165454
CARDEXPIRY: 12.2020
CARDCVV: 000
		 
				

					{
  "action" : "SALE",
  "merchant" : "10000000",
  "amount" : 18.75,
  "currency" : "TRY",
  "apiMerchantId" : "600600000",
  "paymentSystem" : "My Finans Webpos Online Account (Test)",
  "paymentSystemType" : "FINANS",
  "paymentSystemEftCode" : "0111",
  "pgTranDate" : "20160729 12:18:53",
  "merchantPaymentId" : "PaymentId-3gMvdMzXMj2q",
  "pgTranId" : "16211MS3D00124776",
  "pgTranRefId" : "621112352883",
  "pgOrderId" : "PaymentId-3gMvdMzXMj2q",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}                       
				

Preauth

Ön Otorizasyon işlemi müşterinin kredi kartında söz konusu tutara bloke koyan bir işlemdir. Bu şekilde bloke edilen tutar, Son Otorizasyon işlemi yapılana kadar karttan tahsilat yapmaz. Ön otorizasyon işlemi ile konulan blokenin süresi bankaya göre değişebilmektedir . Bu süre üç gün kadar kısa olabileceği gibi birkaç ay kadar uzun da olabilir. Üye iş yeri olarak kendi finansal güvenliğiniz için, ön otorizasyon onayı alan siparişlerin teslimatında hızlı davranmanızı ve bu işlemleri en kısa zamanda son otorizasyonla kapatmanızı öneririz.

İstek parametreleri:

ACTION:

PREAUTH, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CUSTOMEREMAIL:

string, conditional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, conditional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, conditional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERIP:

string, conditional Max length: 39 Kart Sahibi (Müşteri) IP Adresi.

CUSTOMERUSERAGENT:

string, optional Max length: 512 Kart Sahibi (Müşteri) Teknik Donanım.

CUSTOMERBIRTHDAY:

date, optional Max length: 16 Format: [dd-MM-yyyy] Müşteri Doğum Günü.

TCKN:

string, optional Max length: 16 TCKN / Müşteri Kimlik Numarası.

AUTH3DTOKEN:

string, optional Max length: 16 description

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

CARDCVV:

string, optional Max length: 4 Kart güvenlik kodu, CVV değeri.

SAVECARD:

string, optional Max length: 3 Bu parametre değeri 'yes' olarak gönderildiğinde ödeme sayfasında kart otomatik olarak kaydedilecektir. Save Card parametresi API entegrasyon modeli için kullanılamaz

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

BILLTOADDRESSLINE:

string, optional Max length: 255 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 16 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 32 Ship To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

FASTSHIPPING:

string, optional Max length: 3 Bu parametre teslimat / kargolama işleminin hızlı / acil seçeneğiyle yapılıp yapılmadığını gösterir. Hızlı teslimat seçeneği kullanılmışsa üye iş yeri tarafından "yes" olarak gönderilmelidir. Tüm geçerli değerleri görün (2)

EXTRA:

string, optional Max length: 4000 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string), IframeDomainUrl indicates from which URL address payment will be proceesed., {"PREAUTH":"YES"} parameter indicates that payment will be processed as pre-authorization even if is started as sale., IGNORECUSTOMERCOMMISSION(values : YES/NO).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED", "IGNORECUSTOMERCOMMISSION" : "YES"}

Other bank parameters

• MAXIMUMMOBIL - include Maximum Mobil payment system name like below to have Maximum Mobil tab on Default HPP
  {"MaximumMobilPaymentSystem":"PaymentSystemName"}
• GIROGATE payment methods. If one of payment methods is sent as "Yes", authentication will be done using GiroGate payment methods. Possible values: YES/NO.
  • SOFORT: {"SOFORT": "YES"}
  • SAFETYPAY: {"SAFETYPAY": "YES"}
  • QIWI: {"QIWI": "YES"}
  • GIROPAY: {"GIROPAY": "YES"}
  • IDEAL: {"IDEAL": "YES"}
  • FINNISHONLINEBANKING: {"FINNISHONLINEBANKING": "YES"}
  • BANCONTACT: {"BANCONTACT": "YES"}
  • ALIPAY: {"ALIPAY": "YES"}
  • MULTIBANCO: {"MULTIBANCO": "YES"}
  • TRUSTPAY: {"TRUSTPAY": "YES"}
  • EPS: {"EPS": "YES"}
  • MYBANK: {"MYBANK": "YES"}
  • P24: {"P24": "YES"}
  • BOLETO: {"BOLETO": "YES"}
  • ELO: {"ELO": "YES"}
  • SEPA: {"SEPA": "YES"}
  • UPOP: {"UPOP": "YES"}
• ISBANK - include in extra like below to send agriculture template info to Isbank when doing imece card operations.
  {"IMCKOD":"imckod", "FDONEM":"fdonem"}

SHIPTOPHONE:

string, optional Max length: 32 Teslimat bilgilerine ait telefon numarası

BILLTOPHONE:

string, optional Max length: 32 Fatura bilgilerine ait telefon numarası

BUYERTYPE:

string, optional Max length: 1 Default value: 'A' Üye / Anonim kullanıcı bayrağı Tüm geçerli değerleri görün ()

SELLERID:

string, optional Max length: 1024 Satıcı başına benzersiz değer.

COMMISSIONAMOUNT:

string, optional Max length: 512 description

SELLERPAYMENTAMOUNT:

string, optional Max length: 512 description

DISCOUNTAMOUNT:

decimal, optional Max length: 30 ORDERITEMS içerisinde belirtilen toplam tutardan düşülecek indirim tutarını belirtir. Eğer bu alanda bir değer yollanırsa, AMOUNT alanı ORDERITEMS toplamı ile DISCOUNTAMOUNT indirim tutarı farkına eşit olmalıdır. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

NOTIFICATIONURL:

string, optional Max length: 255 description

CUSTOMERTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (4)

					ACTION: PREAUTH
AMOUNT: 18.73
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-a1aJk7isjUFa
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD
MERCHANT: [MERCHANT]
CUSTOMER: Customer-8UtUjDuF
CUSTOMERNAME: Name 8UtUjDuF
CUSTOMEREMAIL: 8UtUjDuF@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name 8UtUjDuF
CUSTOMERPHONE: +903150474176
CUSTOMERBIRTHDAY: 01-01-2001
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
CARDPAN: 4022774022774026   
CARDEXPIRY: 12.2020
CARDCVV: 000
SELLERID: seller01; seller02
COMMISSIONAMOUNT: 50,55;35,62
           
				

					{
  "action" : "PREAUTH",
  "merchant" : "10000000",
  "amount" : 18.73,
  "currency" : "TRY",
  "apiMerchantId" : "600600000",
  "paymentSystem" : "My Finans Webpos Online Account (Test)",
  "paymentSystemType" : "FINANS",
  "paymentSystemEftCode" : "0111",
  "pgTranDate" : "20160729 12:28:16",
  "merchantPaymentId" : "PaymentId-a1aJk7isjUFa",
  "pgTranId" : "16211McQE00102144",
  "pgTranRefId" : "621112352885",
  "pgOrderId" : "PaymentId-a1aJk7isjUFa",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}                     
				

Postauth

Son Otorizasyon(Post Otorizasyon), Ön Otorizasyon işlemi kullanılarak daha önceden rezerve edilen belirli bir tutarın müşterinin kredi kartından tahsil edildiği bir işlemdir. Son Otorizasyon (Post Otorizasyon) işlemine, Ön Otorizasyon işlemi için belirtilenden daha yüksek bir tutar girdiğiniz takdirde Son Otorizasyon(Post Otorizasyon) işlemi reddedilebilir. Ön Otorizasyon yapılandan daha küçük bir tutar girilmesi halinde otorizasyonda yalnızca müşterinin kartında işlem için bulunandan daha düşük miktarlardaki bakiyeleri yakalamak üzere ayarlama yapılır. Son Otorizasyon(Post Otorizasyon) işlemleri ön otorizasyon alındıktan sonra belirli bir süre içerisinde tamamlanmalıdır. Bu süre, kart düzenleyenin politikasına göre 3 gün ile 75 gün arasında değişiklik gösterir.

İstek parametreleri:

ACTION:

POSTAUTH, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

PGTRANID:

string, conditional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

AMOUNT:

decimal, optional Max length: 30 Default value: '0' İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

ORDERITEMS:

string, optional Max length: 100000 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

					ACTION: POSTAUTH
MERCHANT: [MERCHANT]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPAYMENTID: ziraatpay-1352728431091
ORDERITEMS:  [
{
	"productCode": "T00D3AITCC",
	"quantity": 2
},
{
	"productCode": "B00D9AVYBM",
	"amount": 150
}
				

					{
    "action"   : "POSTAUTH",
    "merchant" : "testmerchant",
    "amount"   :   "17.22",
    "currency" : "TRY",
    "pgTranId": "12317QR6A12524",
    "merchantPaymentId": "ziraatpay-1352728431091",
    "responseMsg": "Approved",
    "responseCode": "00",
    "pgTranRefId": "231700000252",
    "pgOrderId": "ORDER-12317QQDG12490",
    "apiMerchantId":"700100000",
    "paymentSystem":"ISBANK TEST",
    "pgTranDate":"20140927 14:51:27"
}                        
				

İptal

İptal işlemi kendisinden başka her işlemi iptal etmek için kullanılır. İptal işleminin başarılı olması için, bu işlemin, kartı düzenleyen banka (Issuer) tarafındaki “gün sonu mutabakat” sürecinde yer almamış olması gerekmektedir. Gün Sonu Mutabakatı, tüm işlemlerin mutabakatı için iş gününün sonunda gerçekleştirilen süreçtir. Bu işlem tam olarak, söz konusu ödeme tutarının, kredi kartı hamilinin hesabından üye iş yerinin banka hesabına aktarıldığında gerçekleşir. Bu nedenle, “gün sonu mutabakatının” bir parçası olarak halihazırda işlem görmüş bir satış ya da son otorizasyon işlemini iptal etmek istemeniz gibi bir durumda, iptal edilen istek için bir başarısız hata kodu alırsınız. Bu durumda, “iptal” işlemi yerine “ücret iadesi” seçeneğini kullanmanız gerekir.

İstek parametreleri:

ACTION:

VOID, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

PGTRANID:

string, conditional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

					ACTION: VOID
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
PGTRANID: 14339MfqD01014997   
REFLECTCOMMISSION : 
				

					{
    "merchantPaymentId":"session-QKFRg437iRrg",
    "pgTranId":"14339MfqD01014997",
    "pgTranRefId":"433912398111",
    "pgOrderId":"session-QKFRg437iRrg",
    "responseCode":"00",
    "responseMsg":"Approved"
}                       
				

İade

Bir Ücret İadesi işlemi, sistemdeki mevcut bir siparişe yönelik bakiyelerin müşterinin kredi kartına iadesini sağlar. Tamamlanmış bir ödeme işlemini iade etmek için, o işlemin numarasına ihtiyaç duyulur. Bu numara rapor ekranlarından temin edilebilir. Bir Tüm ödeme tutarının iadesini gerçekleştirdiğinizde ödeme tutarı asıl tutara sıfırlanacaktır.

İstek parametreleri:

ACTION:

REFUND, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

AMOUNT:

decimal, optional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, optional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

PGTRANID:

string, conditional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

NOTIFICATIONURL:

string, optional Max length: 255 description

ORDERITEMS:

string, optional Max length: 100000 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

REFLECTCOMMISSION:

string, optional Max length: 3 Default value: 'NO' description Tüm geçerli değerleri görün (2)

					ACTION: REFUND
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
CURRENCY: TRY
AMOUNT: 17.17
PGTRANID: 14339MjuG01015018
REFLECTCOMMISSION: No
				

					{
    "merchantPaymentId":"session-deQdckAmzHK4",
    "pgTranId":"14339MkiG01015022",
    "pgTranRefId":"433912398115",
    "pgOrderId":"session-deQdckAmzHK4",
    "responseCode":"00",
    "responseMsg":"Approved",
    "refundType":"FULL"
}                       
				

Session

Session Token

Oturum anahtarı tarayıcı ve ya API bazlı entegrasyon modellerinde kullanılabilir. Sistem geçerli oturum anahtarı isteğine API'ye sınırlı zaman aralığında(tanımlı olarak 7 gün. İstek içerisinde değiştirebilir) erişim hakkı tanımaktadır. Oturum anahtarı isteği her oturum için tekil bir üye iş yeri sipariş numarası beklemektedir. Aşağadaki kurallara uygun şekilde oturum anahtarı aynı üye iş yeri sipariş numarası ile kullanılabilir:

Üye iş yeri bu sipariş numarası ile sonlandırılmış(basarılı veya iptal edilmiş) bir işleme sahip degil ise.

Oturum anahtarının geçerlilik süresi dolmamış ise.

Aynı sipariş numarası ile yeni oluşturulacak oturum anahtarında ana oturum degişkenleri(amount, customer,currency,sessionType and returnUrl) değişmedi ise

üye iş yeri aynı sipariş numarası ile yukaridaki maddelere göre oturum anahtarı isteği gönderebilir.

				
<!--
    NOTE
    * Replace UNIQUE_SESSION_ID with a uniquely generated handle
    * PAGEID is only needed for TDCloud, replace PAGEID with an unique ID for that page, if omitted, default is 1 for production
    * For production replace h.online-metrix.net with a local URL and configure your web server to redirect to h.online-metrix.net. When using whitewolf, if a web server is configured, HOST should be the host of your web server, if not configured the HOST should be h.online-metrix.net
    * Replace ZIRAATPAY_HOST with the appropriate host
        Test:       test.ziraatpay.com.tr
        Production: vpos.ziraatpay.com.tr
-->
<script type="text/javascript" src="https://ZIRAATPAY_HOST/ziraatpay/static/external/whitewolf-v3.js"></script>
<script type="text/javascript">
	whitewolf.run(HOST, ORG_ID, UNIQUE_SESSION_ID);
</script>
<noscript>
    <iframe
        style="width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;"
        src="https://h.online-metrix.net/tags?org_id=ORG_ID&session_id=UNIQUE_SESSION_ID&pageid=PAGEID">
    </iframe>
</noscript>
				
			

İstek parametreleri:

ACTION:

SESSIONTOKEN, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, required Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTYPE:

string, required Max length: 15 Ödeme ve Cüzdan için oturum tipi (PAYMENTSESSION or WALLETSESSION) Tüm geçerli değerleri görün (2)

RETURNURL:

string, required Max length: 256 Başarılı veya başarısız ödeme ardından dönüş URL değeri.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

CUSTOMER:

string, required Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CUSTOMEREMAIL:

string, optional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, required Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, optional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERBIRTHDAY:

date, optional Max length: 16 Format: [dd-MM-yyyy] Müşteri Doğum Günü.

CUSTOMERIP:

string, required Max length: 39 Kart Sahibi (Müşteri) IP Adresi.

CUSTOMERUSERAGENT:

string, optional Max length: 512 Kart Sahibi (Müşteri) Teknik Donanım.

ORDERITEMS:

string, conditional Max length: 100000 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

HASORDERITEMS:

string, optional Max length: 3 description

TCKN:

string, optional Max length: 16 TCKN / Müşteri Kimlik Numarası.

SESSIONEXPIRY:

string, optional Max length: 5 Default value: '168h' Tanımlı oturum geçerlilik süresi, varsayılan geçerlilik süresi 7 gündür ( 7x24 saat ).

LANGUAGE:

string, optional Max length: 2 Default value: 'tr' Ödeme süresince kullanılacak sayfa dili.

BILLTOADDRESSLINE:

string, optional Max length: 255 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 32 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 32 Ship To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

FASTSHIPPING:

string, optional Max length: 3 Default value: 'NO' Bu parametre teslimat / kargolama işleminin hızlı / acil seçeneğiyle yapılıp yapılmadığını gösterir. Hızlı teslimat seçeneği kullanılmışsa üye iş yeri tarafından "yes" olarak gönderilmelidir. Tüm geçerli değerleri görün (2)

EXTRA:

string, optional Max length: 4000 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string), IframeDomainUrl indicates from which URL address payment will be proceesed., {"PREAUTH":"YES"} parameter indicates that payment will be processed as pre-authorization even if is started as sale., IGNORECUSTOMERCOMMISSION(values : YES/NO).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED", "IGNORECUSTOMERCOMMISSION" : "YES"}

Other bank parameters

• MAXIMUMMOBIL - include Maximum Mobil payment system name like below to have Maximum Mobil tab on Default HPP
  {"MaximumMobilPaymentSystem":"PaymentSystemName"}
• GIROGATE payment methods. If one of payment methods is sent as "Yes", authentication will be done using GiroGate payment methods. Possible values: YES/NO.
  • SOFORT: {"SOFORT": "YES"}
  • SAFETYPAY: {"SAFETYPAY": "YES"}
  • QIWI: {"QIWI": "YES"}
  • GIROPAY: {"GIROPAY": "YES"}
  • IDEAL: {"IDEAL": "YES"}
  • FINNISHONLINEBANKING: {"FINNISHONLINEBANKING": "YES"}
  • BANCONTACT: {"BANCONTACT": "YES"}
  • ALIPAY: {"ALIPAY": "YES"}
  • MULTIBANCO: {"MULTIBANCO": "YES"}
  • TRUSTPAY: {"TRUSTPAY": "YES"}
  • EPS: {"EPS": "YES"}
  • MYBANK: {"MYBANK": "YES"}
  • P24: {"P24": "YES"}
  • BOLETO: {"BOLETO": "YES"}
  • ELO: {"ELO": "YES"}
  • SEPA: {"SEPA": "YES"}
  • UPOP: {"UPOP": "YES"}
• ISBANK - include in extra like below to send agriculture template info to Isbank when doing imece card operations.
  {"IMCKOD":"imckod", "FDONEM":"fdonem"}

SHIPTOPHONE:

string, optional Max length: 32 Teslimat bilgilerine ait telefon numarası

BILLTOPHONE:

string, optional Max length: 32 Fatura bilgilerine ait telefon numarası

DISCOUNTAMOUNT:

decimal, optional Max length: 30 ORDERITEMS içerisinde belirtilen toplam tutardan düşülecek indirim tutarını belirtir. Eğer bu alanda bir değer yollanırsa, AMOUNT alanı ORDERITEMS toplamı ile DISCOUNTAMOUNT indirim tutarı farkına eşit olmalıdır. (AMOUNT = ORDERITEMS - DISCOUNTAMOUNT)

SELLERID:

string, optional Max length: 1024 Satıcı başına benzersiz değer.

COMMISSIONAMOUNT:

string, optional Max length: 512 description

SELLERPAYMENTAMOUNT:

string, optional Max length: 512 description

TOTALSELLERCOMMISSIONAMOUNT:

decimal, optional Max length: 30 description

TOTALSELLERPAYMENTAMOUNT:

decimal, optional Max length: 30 description

CUSTOMERTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (4)

ALLOWEDINSTALLMENTS:

string, optional Max length: 64 description

					ACTION: SESSIONTOKEN   
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
AMOUNT: 11.21
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-FuldmrwwiOpb
RETURNURL: https://neon-app.local.payten.com.tr/msu.merchant/index.jsp
CUSTOMER: Customer-jNPz2qSI
CUSTOMERNAME: Name jNPz2qSI
CUSTOMEREMAIL: jNPz2qSI@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name jNPz2qSI
CUSTOMERPHONE: 6381053412
ORDERITEMS:  [ 
        { 
            "productCode": "T00D3AITCC",
            "name": "Galaxy Note 3", 
            "description": "Description of Galaxy Note 3", 
            "quantity": 2, 
            "amount": 449.99
        }, 
        { 
            "productCode": "B00D9AVYBM",
            "name": "Samsung Galaxy S III", 
            "description": "Samsung Galaxy S III (S3) Triband White (Boost Mobile)", 
            "quantity": 1, 
            "amount": 149.95 
        }, 
        { 
            "productCode": "B00NQGP5M8",
            "name": "Apple iPhone 6", 
            "description": "Apple iPhone 6, Gold, 64 GB (Unlocked) by Apple", 
            "quantity": 1, 
            "amount": 139.95 
        }, 
        { 
            "productCode": "B00U8KSUIG",
            "name": "Samsung Galaxy S6", 
            "description": "Samsung Galaxy S6 SM-G920F 32GB (FACTORY UNLOCKED) 5.1 QHDBlack-InternationalVersion", 
            "quantity": 1, 
            "amount": 129.95 
        } 
]

DISCOUNTAMOUNT: 2.50
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
SESSIONTYPE: PAYMENTSESSION
SELLERID: seller01; seller02
COMMISSIONAMOUNT: 50.55;35.62
		

					{
  "sessionToken" : "HCZVQH5FIR5QBHBQCT6AMUJLVHEHXCMSQ2HA5I6WCGQKQNQX",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

					ACTION: SESSIONTOKEN   
AMOUNT: 17.82
CURRENCY: TRY
MERCHANTPAYMENTID: PaymentId-DkOxtbUcP7gF
MERCHANTUSER: [MERCHANTUSER] 
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
RETURNURL: https://neon-app.local.payten.com.tr/msu.merchant/index.jsp
CUSTOMER: Customer-PJYbATmL
CUSTOMERNAME: Name PJYbATmL
CUSTOMEREMAIL: PJYbATmL@email.com
CUSTOMERIP: 127.0.0.1
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36
NAMEONCARD: Name PJYbATmL
CUSTOMERPHONE: 8487817375
ORDERITEMS:  [ 
        { 
            "productCode": "T00D3AITCC", 
            "name": "Galaxy Note 3", 
            "description": "Description of Galaxy Note 3", 
            "quantity": 2, 
            "amount": 449.99
        }, 
        { 
            "productCode": "B00D9AVYBM", 
            "name": "Samsung Galaxy S III", 
            "description": "Samsung Galaxy S III (S3) Triband White (Boost Mobile)", 
            "quantity": 1, 
            "amount": 149.95 
        }, 
        { 
            "productCode": "B00NQGP5M8", 
            "name": "Apple iPhone 6", 
            "description": "Apple iPhone 6, Gold, 64 GB (Unlocked) by Apple", 
            "quantity": 1, 
            "amount": 139.95 
        }, 
        { 
            "productCode": "B00U8KSUIG", 
            "name": "Samsung Galaxy S6", 
            "description": "Samsung Galaxy S6 SM-G920F 32GB (FACTORY UNLOCKED) 5.1 QHDBlack-InternationalVersion", 
            "quantity": 1, 
            "amount": 129.95 
        } 
] 
BILLTOADDRESSLINE: Road
BILLTOCITY: Istanbul
BILLTOCOUNTRY: Turkey
BILLTOPOSTALCODE: 1103
BILLTOPHONE: 123456789
SHIPTOADDRESSLINE: Road
SHIPTOCITY: Ankara
SHIPTOCOUNTRY: Turkey
SHIPTOPOSTALCODE: 1105
SHIPTOPHONE: 987654321
SESSIONTYPE: WALLETSESSION

					{
  "sessionToken" : "HZ3JBAFJ72AJTWRR75JOKWTFHMVHG7Y6UH6VTAGABLMV7LID",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

Pay by Link Payment İşlemleri

Ödeme Linki Ekleme

Bakınız Açıklama

Not: Link ile ödeme mevcut müşteri ile yapılacaksa istekte CUSTOMER gönderilmelidir, aksi taktirde yeni müşteri parametreleri CUSTOMERNAME, CUSTOMERPHONE ve CUSTOMEREMAIL zorunludur.

İstek parametreleri:

ACTION:

PAYBYLINKPAYMENT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONEXPIRY:

string, required Max length: 6 Default value: '168h' Tanımlı oturum geçerlilik süresi, varsayılan geçerlilik süresi 7 gündür ( 7x24 saat ).

MERCHANTPAYMENTID:

string, required Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

AMOUNT:

decimal, required Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CURRENCY:

string, required Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

CUSTOMER:

string, required Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

RETURNURL:

string, optional Max length: 512 Başarılı veya başarısız ödeme ardından dönüş URL değeri.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CUSTOMEREMAIL:

string, conditional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, conditional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, optional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

TCKN:

string, optional Max length: 11 TCKN / Müşteri Kimlik Numarası.

LANGUAGE:

string, optional Max length: 2 Default value: 'tr' Ödeme süresince kullanılacak sayfa dili.

ORDERITEMS:

string, optional Max length: 100000 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

NOTIFICATIONCHANNELS:

string, optional Max length: 16 NOTIFICATIONCHANNELS parametresi bildirim kanallarının belirtilmesi için kullanılır. Birden fazla kanal ile bildirim yapılacaksa kanallar , (virgül ile) birleştirilmelidir. Örn: EMAIL,SMS

BILLTOADDRESSLINE:

string, optional Max length: 255 Bill To Address Line

BILLTOCITY:

string, optional Max length: 32 Bill To City

BILLTOPOSTALCODE:

string, optional Max length: 16 Bill To Postal Code

BILLTOCOUNTRY:

string, optional Max length: 32 Bill To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

BILLTOPHONE:

string, optional Max length: 32 Fatura bilgilerine ait telefon numarası

SHIPTOADDRESSLINE:

string, optional Max length: 255 Ship To Address Line

SHIPTOCITY:

string, optional Max length: 32 Ship To City

SHIPTOPOSTALCODE:

string, optional Max length: 32 Ship To Postal Code

SHIPTOCOUNTRY:

string, optional Max length: 32 Ship To Country
ISO 3166-1 standardında yer alan bir alpha-3 kodu gönderilmelidir.

SHIPTOPHONE:

string, optional Max length: 32 Teslimat bilgilerine ait telefon numarası

EXTRA:

string, optional Max length: 4000 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string), IframeDomainUrl indicates from which URL address payment will be proceesed., {"PREAUTH":"YES"} parameter indicates that payment will be processed as pre-authorization even if is started as sale., IGNORECUSTOMERCOMMISSION(values : YES/NO).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED", "IGNORECUSTOMERCOMMISSION" : "YES"}

Other bank parameters

• MAXIMUMMOBIL - include Maximum Mobil payment system name like below to have Maximum Mobil tab on Default HPP
  {"MaximumMobilPaymentSystem":"PaymentSystemName"}
• GIROGATE payment methods. If one of payment methods is sent as "Yes", authentication will be done using GiroGate payment methods. Possible values: YES/NO.
  • SOFORT: {"SOFORT": "YES"}
  • SAFETYPAY: {"SAFETYPAY": "YES"}
  • QIWI: {"QIWI": "YES"}
  • GIROPAY: {"GIROPAY": "YES"}
  • IDEAL: {"IDEAL": "YES"}
  • FINNISHONLINEBANKING: {"FINNISHONLINEBANKING": "YES"}
  • BANCONTACT: {"BANCONTACT": "YES"}
  • ALIPAY: {"ALIPAY": "YES"}
  • MULTIBANCO: {"MULTIBANCO": "YES"}
  • TRUSTPAY: {"TRUSTPAY": "YES"}
  • EPS: {"EPS": "YES"}
  • MYBANK: {"MYBANK": "YES"}
  • P24: {"P24": "YES"}
  • BOLETO: {"BOLETO": "YES"}
  • ELO: {"ELO": "YES"}
  • SEPA: {"SEPA": "YES"}
  • UPOP: {"UPOP": "YES"}
• ISBANK - include in extra like below to send agriculture template info to Isbank when doing imece card operations.
  {"IMCKOD":"imckod", "FDONEM":"fdonem"}

					
ACTION: PAYBYLINKPAYMENT   
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]
CUSTOMER: Customer-UCUoumJV   
SESSIONTYPE: PAYMENTSESSION   
MERCHANTPAYMENTID: Payment-UCUoumJV   
AMOUNT: 10.00   
CURRENCY: TRY   
CUSTOMEREMAIL: customerEmail-UCUoumJV   
CUSTOMERNAME: CustomerNameUCUoumJV   
CUSTOMERPHONE: 123456789     
RETURNURL: http://merchantReturnUrl
SESSIONTYPE: PAYMENTSESSION
SESSIONEXPIRY: 168h
EXTRA:[
	{ 
		"IsbankBolumKodu": 1
	}
     ]  
ORDERITEMS:[ 
        { 
            "code": "T00D3AITCC", 
            "name": "Galaxy Note 3", 
            "description": "Description of Galaxy Note 3", 
            "quantity": 2, 
            "amount": 449.99
        }, 
        { 
            "code": "B00D9AVYBM", 
            "name": "Samsung Galaxy S III", 
            "description": "Samsung Galaxy S III (S3) Triband White (Boost Mobile)", 
            "quantity": 1, 
            "amount": 149.95 
        }, 
        { 
            "code": "B00NQGP5M8", 
            "name": "Apple iPhone 6", 
            "description": "Apple iPhone 6, Gold, 64 GB (Unlocked) by Apple", 
            "quantity": 1, 
            "amount": 139.95 
        }, 
        { 
            "code": "B00U8KSUIG", 
            "name": "Samsung Galaxy S6", 
            "description": "Samsung Galaxy S6 SM-G920F 32GB (FACTORY UNLOCKED) 5.1 QHDBlack-InternationalVersion", 
            "quantity": 1, 
            "amount": 129.95 
        } 
    ]    

					
{
  "sessionToken" : "HZ3JBAFJ72AJTWRR75JOKWTFHMVHG7Y6UH6VTAGABLMV7LID",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

Ödeme Linki İptal Etme

PAYBYLINKPAYMENTCANCEL Link ile ödeme işlemini iptal etmek için kullanılır.

İstek parametreleri:

ACTION:

PAYBYLINKPAYMENTCANCEL, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

PAYBYLINKTOKEN:

string, required Max length: 48 description

					
ACTION: PAYBYLINKPAYMENTCANCEL   
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT] 
PAYBYLINKTOKEN: [PAYBYLINKTOKEN] 

					
{
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

Ödeme Linkini Yeniden Gönderme

PAYBYLINKPAYMENTRESEND işlemi Kart Sahibine yeniden bir hatırlatma maili göndermek için kullanılır.

İstek parametreleri:

ACTION:

PAYBYLINKPAYMENTRESEND, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

PAYBYLINKTOKEN:

string, required Max length: 48 description

NOTIFICATIONCHANNELS:

string, optional Max length: 16 NOTIFICATIONCHANNELS parametresi bildirim kanallarının belirtilmesi için kullanılır. Birden fazla kanal ile bildirim yapılacaksa kanallar , (virgül ile) birleştirilmelidir. Örn: EMAIL,SMS

					
ACTION: PAYBYLINKPAYMENTRESEND   
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT] 
PAYBYLINKTOKEN: [PAYBYLINKTOKEN] 

					
{
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

Tekrarlı Ödeme Planı Aksiyonları

Tekrarlı Ödeme Planı Ekleme

RECURRINGPLAN aksiyonu, belli bir tutar için ayrı ayrı ayarlanmış zamanlarda planlanmış ödemeler grubuna dair olan aksiyonları içerir.

İstek parametreleri:

ACTION:

RECURRINGPLANADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

INSTANTPAYMENT:

string, optional Max length: 3 Default value: 'NO' description Tüm geçerli değerleri görün (2)

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CUSTOMERNAME:

string, optional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMEREMAIL:

string, required Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, optional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

RECURRINGPLANCODE:

string, required Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

FIRSTAMOUNT:

decimal, optional Max length: 30 İlk tekrarlı ödeme tutarı.

RECURRINGAMOUNT:

decimal, required Max length: 30 Tekrarlı ödeme tutarları.

RECURRENCECOUNT:

decimal, required Max length: 2 Default value: '1' Tekrarlı ödeme planındaki tekrar sayısı.

FREQUENCY:

string, required Max length: 4 Tekrarlı ödeme sıklığı. Gün için D, ay için M, yıl için Y kullanılmalıdır. (Örn.: 5D, 3M, 1Y).

STARTDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy] İşlem sorgulama tarih aralığı için başlangıç değeridir.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

PAYMENTSYSTEM:

string, optional Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

ORDERITEMS:

string, optional Max length: 100000 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

TOTALSELLERCOMMISSIONAMOUNT:

decimal, optional Max length: 30 description

TOTALSELLERPAYMENTAMOUNT:

decimal, optional Max length: 30 description

					ACTION: RECURRINGPLANADD   
INSTANTPAYMENT: YES		
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]  
CUSTOMER: merchant-2yQZyloV
CUSTOMERNAME: CustomerName 2yQZyloV
CUSTOMEREMAIL: 2yQZyloV@email.com
CARDPAN: 4242420000004242
CARDEXPIRY: 12.2020
NAMEONCARD: Test User
RECURRINGPLANCODE: Code-JSjAuDXf
FIRSTAMOUNT: 1.00
RECURRINGAMOUNT: 100.00
RECURRENCECOUNT: 5
FREQUENCY: 5D
CURRENCY: TRY
STARTDATE: 01-10-2015
PAYMENTSYSTEM: GarantiPOS     

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "recurringPlanCode" : "Code-JSjAuDXf"
}
				

Tekrarlı Ödeme Planı Güncelleme

Tekrarlı Ödeme Planı Güncelleme

RECURRINGPLANEDIT isteği bir tekrarlı ödeme planı veya bir tekrarlı ödemenin belirli özelliklerini güncellemek için kullanılır.
Bu istek ile tekrarlı ödeme planının,

• Durumu
• Kart Bilgileri
• Tekrarlı ödeme tutarı
• Öeme sistemi

ve bir tekrarlı ödemenin,

• Durumu
• Başlangıç tarihi
• Tutarı

güncellenebilir.

İstek parametreleri:

ACTION:

RECURRINGPLANEDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

RECURRINGPLANCODE:

string, required Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

RECURRINGSTATUS:

string, optional Max length: 16 Tekrarlı ödeme durum bilgisi.

RECURRINGAMOUNT:

decimal, optional Max length: 30 Tekrarlı ödeme tutarları.

PAYMENTSYSTEM:

string, optional Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

RECURRENCE:

decimal, optional Max length: 2 Düzenlenecek tekrarlı ödeme.

STARTDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy] İşlem sorgulama tarih aralığı için başlangıç değeridir.

AMOUNT:

decimal, optional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

					ACTION: RECURRINGPLANEDIT   
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANT: [MERCHANT]  
CARDPAN: 
CARDEXPIRY: 
NAMEONCARD: 
RECURRINGPLANCODE: Code-JSjAuDXf
RECURRINGAMOUNT: 50.00
RECURRINGSTATUS: INACTIVE
RECURRENCECOUNT:
STARTDATE: 
AMOUNT:
PAYMENTSYSTEM:      

					{
  "action" : "RECURRINGPLANEDIT",
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

Tekrarlı Ödeme Kartı Planı Aksiyonları

Tekrarlı Ödeme Planı Kartı Ekleme

RECURRINGPLANCARDADD action lets you to add card and relate it to recurring plan.

İstek parametreleri:

ACTION:

RECURRINGPLANCARDADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

RECURRINGPLANCODE:

string, required Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

					ACTION: RECURRINGPLANCARDADD   
MERCHANT: [MERCHANT]  
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CARDPAN: 4242420000004242
CARDEXPIRY: 12.2020
NAMEONCARD: Test User
CARDSAVENAME: Test Name
CARDTOKEN: 
RECURRINGPLANCODE: Code-JSjAuDXf   

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "cardToken" : "T45FWSAXNHZPC4NYCGVQSYY4INTCCPB3GC5MJ2HGD2YKLCG6"
}
				

Tekrarlı Ödeme Planı Kartı Sil

RECURRINGPLANCARDDELETE action lets you to remove relation between card and recurring plan.

İstek parametreleri:

ACTION:

RECURRINGPLANCARDDELETE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

RECURRINGPLANCODE:

string, required Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

CARDTOKEN:

string, required Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

					ACTION: RECURRINGPLANCARDDELETE   
MERCHANT: [MERCHANT]  
MERCHANTUSER: [MERCHANTUSER]   
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CARDTOKEN: [CARDTOKEN]
RECURRINGPLANCODE: [RECURRINGPLANCODE]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				

e-Cüzdan Aksiyonları

Kart Güncelleme

EWALLETEDITCARD aksiyonu, mevcut bir kart anahtarı vererek bu kartı düzenleyebilmenizi sağlar. Değiştirilmesine izin verilen tek alanlar kartın son kullanma tarihi ve kaydetme adımıdır.

İstek parametreleri:

ACTION:

EWALLETEDITCARD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, required Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CARDEXPIRY:

string, optional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, optional Max length: 64 Kart üzerinde yazan isim.

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

					MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
ACTION: EWALLETEDITCARD
CARDTOKEN: ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN
CARDSAVENAME: My Card Name (New)
CARDEXPIRY: 12.2020     
				

					{
    "cardToken":"ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN",
    "responseCode":"00",
    "responseMsg":"Approved"
}                       
				

Kart Silme

EWALLETDELETECARD aksiyonu ile kayıtlı müşteri kartlarınızı silebilirsiniz. Bir kart sistemden silindikten sonra sorgulanamaz, güncellenemez ya da bununla herhangi bir şekilde ödeme yapılamaz. Kart silmek için, aşağıdaki alanların ZiraatPay’e gönderilmesi gerekmektedir:

İstek parametreleri:

ACTION:

EWALLETDELETECARD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, required Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

					ACTION: EWALLETDELETECARD
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CARDTOKEN: ZP7BJ24P5HTA4EKKHMOAEAPWJWSWKMCKQ54EWK37IBAEUPPN
				

					{
    "responseCode":"00",
    "responseMsg":"Approved"
}                       
				

Satıcı Aksiyonları

Satıcı Ekle

The SELLERADD action lets you add a seller. You should give the required parameters also optional parameters like TCKN.

İstek parametreleri:

ACTION:

SELLERADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SELLERID:

string, required Max length: 32 Satıcı başına benzersiz değer.

NAME:

string, required Max length: 512 İsim

LASTNAME:

string, required Max length: 512 description

EMAIL:

string, required Max length: 512 description

MOBILENUMBER:

string, required Max length: 64 description

TCKN:

string, conditional Max length: 11 TCKN / Müşteri Kimlik Numarası.

VKN:

string, conditional Max length: 10 Vergi Kimlik No

IBAN:

string, required Max length: 34 description

IBANUSD:

string, optional Max length: 34 description

IBANEUR:

string, optional Max length: 34 description

IBANGBP:

string, optional Max length: 34 description

SELLERPAYMENTDAYS:

string, required Max length: 32 Satıcı ödeme günleri, noktalı virgülle ayrılmış indeks formatında gönderilmelidir. Günler için indeksler aşağıdaki gibidir: Pazartesi(0), Salı(1), Çarşamba(2), Perşembe(3), Cuma(4). Örnek olarak, satıcı ödeme günlerinin Pazartesi ve Cuma olması için SELLERPAYMENTDAYS parametresinin değeri aşağıdaki gibi gönderilmelidir: 0;4;

ACCOUNTOWNERNAME:

string, conditional Max length: 512 description

ACCOUNTOWNERLASTNAME:

string, conditional Max length: 512 description

SELLERPAYMENTDUEDAY:

integer, optional Max length: 2 description

COMMERCIALTITLE:

string, conditional Max length: 512 description

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

COMMISSIONAPPLYTYPE:

string, conditional Max length: 3 COMMISSIONAPPLYTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONAPPLIERTYPE:

string, conditional Max length: 3 COMMISSIONAPPLIERTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONVALUE:

decimal, optional Max length: 30 description

ONBEHALFOFMERCHANT:

string, optional Max length: 16 description

SELLERURL:

string, optional Max length: 256 description

ISDEFAULT:

string, optional Max length: 3 Default value: 'NO' description

CITY:

string, optional Max length: 64 description Tüm geçerli değerleri görün (81)

					ACTION: SELLERADD
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SELLERID: [SELLER ID]
NAME: [SELLER NAME]
LASTNAME: [SELLER LASTNAME]
EMAIL: [seller@email.com]
MOBILENUMBER: [1234567890]
TCKN: [012345678911]
SELLERPAYMENTDUEDAY: [2]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "seller" : {
    "sellerId" : "Seller-vd6ShJUF",
    "name" : "Seller01",
    "lastName" : "LastName-XKGo",
    "email" : "seler01@email.com",
    "mobileNumber" : "+900408866157",
    "status" : "WA",
    "sellerpaymentdueday" : "2",
    "merchant" : {
      "businessId" : "10000000",
      "name" : "MSU Test Merchant",
      "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
      "phone" : "+902123650505",
      "webAddress" : "http://www.asseco-see.com.tr/"
    }
  }
}
				

Satıcıyı Güncelle

SELLEREDIT işlemi mevcut satıcı kayıtlarını güncellemenizi sağlar. Seller ID ve Üye işyeri ID gerekli parametrelerini sağlayarak isim, soyisim, telefon numarası, e-posta, TCKN ve satıcı durumu alanlarını güncelleyebilirsiniz.

İstek parametreleri:

ACTION:

SELLEREDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SELLERID:

string, required Max length: 32 Satıcı başına benzersiz değer.

NAME:

string, optional Max length: 512 İsim

LASTNAME:

string, optional Max length: 512 description

EMAIL:

string, optional Max length: 512 description

MOBILENUMBER:

string, optional Max length: 64 description

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

TCKN:

string, conditional Max length: 11 TCKN / Müşteri Kimlik Numarası.

VKN:

string, conditional Max length: 10 Vergi Kimlik No

IBAN:

string, required Max length: 34 description

IBANUSD:

string, optional Max length: 34 description

IBANEUR:

string, optional Max length: 34 description

IBANGBP:

string, optional Max length: 34 description

SELLERPAYMENTDAYS:

string, required Max length: 32 Satıcı ödeme günleri, noktalı virgülle ayrılmış indeks formatında gönderilmelidir. Günler için indeksler aşağıdaki gibidir: Pazartesi(0), Salı(1), Çarşamba(2), Perşembe(3), Cuma(4). Örnek olarak, satıcı ödeme günlerinin Pazartesi ve Cuma olması için SELLERPAYMENTDAYS parametresinin değeri aşağıdaki gibi gönderilmelidir: 0;4;

ACCOUNTOWNERNAME:

string, conditional Max length: 512 description

ACCOUNTOWNERLASTNAME:

string, conditional Max length: 512 description

SELLERPAYMENTDUEDAY:

integer, optional Max length: 2 description

COMMERCIALTITLE:

string, conditional Max length: 512 description

COMMISSIONAPPLYTYPE:

string, conditional Max length: 3 COMMISSIONAPPLYTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONAPPLIERTYPE:

string, conditional Max length: 3 COMMISSIONAPPLIERTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONVALUE:

decimal, optional Max length: 30 description

ONBEHALFOFMERCHANT:

string, optional Max length: 16 description

SELLERURL:

string, optional Max length: 256 description

ISDEFAULT:

string, optional Max length: 3 Default value: 'NO' description

CITY:

string, optional Max length: 64 description Tüm geçerli değerleri görün (81)

					ACTION: SELLEREDIT
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SELLERID: [SELLER ID]
NAME: []
LASTNAME: []
EMAIL: []
MOBILENUMBER: []
TCKN: []
STATUS: []
SELLERPAYMENTDUEDAY: []

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "seller" : {
    "sellerId" : "Seller-vd6ShJUF",
    "name" : "Seller01",
    "lastName" : "LastName-XKGo",
    "email" : "seler01@email.com",
    "mobileNumber" : "+900408866157",
    "status" : "OK",
    "sellerpaymentdueday" :  "2"
    "merchant" : {
      "businessId" : "10000000",
      "name" : "MSU Test Merchant",
      "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
      "phone" : "+902123650505",
      "webAddress" : "http://www.asseco-see.com.tr/"
    }
  }
}
		

Satıcı Ödeme Tarihi Güncellemesi

Satıcının işleminin ödeme tarihini günceller

İstek parametreleri:

ACTION:

UPDATEPAYMENTDATE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTPAYMENTID:

string, optional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

PGTRANID:

string, optional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

ORDERITEMS:

string, required Max length: 4096 Sipariş bilgileri JSON formatinda bir diziden oluşmaktadır. Gönderilecek verinin URL Encoded olarak kodlandığından emin olunuz. Geçerli format tanımları için lütfen sağ tarafta bulunan istek örneklerindeki kullanımları inceleyiniz.

					ACTION: UPDATESELLERPAYMENTDATE
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SESSIONTOKEN: [SESSIONTOKEN]
MERCHANTPAYMENTID: [MERCHANTPAYMENTID]
PGTRANID: [21127PnXF19482]
ORDERITEMS: [ URLEncoded [{"pgTranId": "23268LaVH13763","merchantPaymentDate":"08.04.2024"},{"pgTranId": "23263Q7kC16459","merchantPaymentDate":"08.04.2024"}] ]

					{
    "responseCode": "00",
    "responseMsg": "Approved"
}
				

Başvuru İşlemleri

Başvuru ekle

APPLICATIONADD işlemi başvuru eklemenizi sağlar. Zorunlu parametreleri girmelisiniz.

İstek parametreleri:

ACTION:

APPLICATIONADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

APPLICATIONNAME:

string, required Max length: 256 description

APPLICATIONEMAIL:

string, required Max length: 64 description

APPLICATIONPHONE:

string, required Max length: 64 description

APPLICATIONWEBADDRESS:

string, required Max length: 256 description

APPLICATIONTURNOVER:

string, required Max length: 256 description

APPLICATIONCOMPANYTYPE:

string, optional Max length: 16 description Tüm geçerli değerleri görün (4)

APPLICATIONSHAREHOLDERS:

string, optional Max length: 100000 description

APPLICATIONMERCHANT:

string, optional Max length: 100000 description

APPLICATIONFINANCIALDATA:

string, optional Max length: 100000 description

APPLICATIONSALESUPPORTDATA:

string, optional Max length: 100000 description

APPLICATIONRISKMANAGEMENTDATA:

string, optional Max length: 100000 description

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

					ACTION: APPLICATIONADD
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
APPLICATIONNAME: [APPLICATIONNAME]
APPLICATIONEMAIL: [APPLICATIONEMAIL]
APPLICATIONPHONE: [APPLICATIONPHONE]
APPLICATIONWEBADDRESS: [APPLICATIONWEBADDRESS]
APPLICATIONTURNOVER: [APPLICATIONTURNOVER]
APPLICATIONCOMPANYTYPE: [APPLICATIONCOMPANYTYPE]
APPLICATIONSHAREHOLDERS:[APPLICATIONSHAREHOLDERS]
APPLICATIONMERCHANT:[APPLICATIONMERCHANT]
APPLICATIONSALESUPPORTDATA:[APPLICATIONSALESUPPORTDATA]
APPLICATIONRISKMANAGEMENTDATA:[APPLICATIONRISKMANAGEMENTDATA]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "application" : {
    "applicationName" : "Application Name",
    "applicationEmail" : "Application Email",
    "applicationPhone" : "Application Phone",
    "applicationWebAddress" : "www.google.com",
    "applicationTurnover" : "Application Turnover",
    "applicationCompanyType" : "Application company type",
    "applicationDate": "2022-04-01 08:23:28.211",
    "applicationCode": "UKKYXGJNUFEJIHSBUS4MR3S3G2ODAE7QY53LLCMEZ7H7SJSB",
    "applicationStatus": "PA",
    "applicationShareholders":[
            {
                "name": "002",
                "surname": "002",
                "phone": "+38345698325",
                "email": "002@gmail.com",
                "idNumber": "002",
                "signAuthority": "YES",
                "signAuthorityDuration": "01-02-2026 01:00"
            },
            {
                "name": "001",
                "surname": "001",
                "phone": "+38345698325",
                "email": "001@gmail.com",
                "idNumber": "001",
                "signAuthority": "NO",
                "signAuthorityDuration": "01-02-2026 01:00"
            }
        ],
     "applicationMerchant": [
            {
                "commercialTitle": "123",
                "name": "123",
                "surname": "123",
                "email": "123@email.com",
                "phoneNumber": "+38345698325",
                "landPhone": "+3834569832",
                "address": "123",
                "eCommerce": "123"
            }
        ],
       "applicationFinancialData": {
            "merchantCommissionSchema": "MCS_ZERO_COMMISSION",
            "paymentSystemPool": "testPaymentSystemPool"
        },
        "applicationSaleSupportData": {
             "ssl": "test_ssl2",
             "content": "test_content2",
             "whois": "test_whois",
             "tradeRegistryNumber": "test_tradeRegistryNumber"
        },
         "applicationRiskManagmentDataVo": {
            "kkbPoint": "kkbPoint",
            "mcc": "1352",
            "threeDCondition": "THD_ALL",
            "threeDLimit": "0",
            "complaintRecord": "complaintRecord",
            "product": "DON",
            "contractSigned": "YES",
            "blockageTimeAndDay": "",
            "integrationModel": "API",
            "guaranteeAmount": "50.5",
            "guaranteeAmountStartDate": "01-02-2026 01:00",
            "guaranteeAmountEndDate": "01-02-2026 01:00",
            "foreignCardPermission": "YES"
        }
  }
}
	

Başvuru Düzenle

BAŞVURUDÜZENLE seçeneği başvuruyu düzenlemenizi sağlar. Zorunlu parametreler olan isim ve email adresini, ayrıca opsiyonel parametreleri de düzenleyebilirsiniz.

İstek parametreleri:

ACTION:

APPLICATIONEDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

APPLICATIONNAME:

string, conditional Max length: 256 description

APPLICATIONEMAIL:

string, conditional Max length: 64 description

APPLICATIONCODE:

string, optional Max length: 64 Başvuru kodu

APPLICATIONPHONE:

string, optional Max length: 64 description

APPLICATIONWEBADDRESS:

string, optional Max length: 256 description

APPLICATIONTURNOVER:

string, optional Max length: 256 description

APPLICATIONCOMPANYTYPE:

string, optional Max length: 16 description Tüm geçerli değerleri görün (4)

APPLICATIONSTATUS:

string, optional Max length: 16 description Tüm geçerli değerleri görün (23)

APPLICATIONSHAREHOLDERS:

string, optional Max length: 100000 description

APPLICATIONSIGNAUTHORITIES:

string, optional Max length: 100000 description

APPLICATIONMERCHANT:

string, optional Max length: 100000 description

APPLICATIONDOCUMENTDATA:

string, optional Max length: 10000000 description

APPLICATIONFINANCIALDATA:

string, optional Max length: 100000 description

APPLICATIONSALESUPPORTDATA:

string, optional Max length: 100000 description

APPLICATIONRISKMANAGEMENTDATA:

string, optional Max length: 100000 description

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

					ACTION: APPLICATIONEDIT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
APPLICATIONNAME: [APPLICATIONNAME]
APPLICATIONEMAIL: [APPLICATIONEMAIL]
APPLICATIONPHONE: [APPLICATIONPHONE]
APPLICATIONWEBADDRESS: [APPLICATIONWEBADDRESS]
APPLICATIONTURNOVER: [APPLICATIONTURNOVER]
APPLICATIONCOMPANYTYPE: [APPLICATIONCOMPANYTYPE]
APPLICATIONSTATUS:[APPLICATIONSTATUS]
APPLICATIONSHAREHOLDERS:[APPLICATIONSHAREHOLDERS]
APPLICATIONMERCHANT:[APPLICATIONMERCHANT]
APPLICATIONSALESUPPORTDATA:[APPLICATIONSALESUPPORTDATA]
APPLICATIONDOCUMENTDATA:[APPLICATIONDOCUMENTDATA]
APPLICATIONRISKMANAGEMENTDATA:[APPLICATIONRISKMANAGEMENTDATA]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "application" : {
    "applicationName" : "Application Name",
    "applicationEmail" : "Application Email",
    "applicationPhone" : "Application Phone",
    "applicationWebAddress" : "www.google.com",
    "applicationTurnover" : "Application Turnover",
    "applicationStatus" : "Application status",
    "applicationCompanyType" : "Application company type",
    "applicationDate": "2022-04-01 08:23:28.211",
    "applicationCode": "UKKYXGJNUFEJIHSBUS4MR3S3G2ODAE7QY53LLCMEZ7H7SJSB",
    "applicationShareholders":[
            {
                "name": "002",
                "surname": "002",
                "phone": "+38345698325",
                "email": "002@gmail.com",
                "idNumber": "002",
                "signAuthority": "YES",
                "signAuthorityDuration": "01-02-2026 01:00"
            },
            {
                "name": "001",
                "surname": "001",
                "phone": "+38345698325",
                "email": "001@gmail.com",
                "idNumber": "001",
                "signAuthority": "NO",
                "signAuthorityDuration": "01-02-2026 01:00"
            }
        ],
     "applicationMerchant": [
            {
                "commercialTitle": "123",
                "name": "123",
                "surname": "123",
                "email": "123@email.com",
                "phoneNumber": "+38345698325",
                "landPhone": "+3834569832",
                "address": "123",
                "eCommerce": "123"
            }
        ],
      "applicationFinancialData": {
            "merchantCommissionSchema": "MCS_ZERO_COMMISSION",
            "paymentSystemPool": "testPaymentSystemPool"
        },
      "applicationSaleSupportData": {
             "ssl": "test_ssl2",
             "content": "test_content2",
             "whois": "test_whois",
             "tradeRegistryNumber": "test_tradeRegistryNumber"
        },
       "applicationDocumentData": [
        {
            "fileType": "JPEG",
            "fileContent": "iLe+8q38tU8zEAOSimLdxx8ZQWMHY4HbOMDIUX6ygt/W8dBAKBQCAQCAQCgUAgEAgEAuFkwP8ATX9UIiXmF98AAAAASUVORK5CYII=",
            "documentType": "IDENTITY",
            "fileName": "fileName"
        }
    ],
     "applicationRiskManagmentDataVo": {
            "kkbPoint": "kkbPoint",
            "mcc": "1352",
            "threeDCondition": "THD_ALL",
            "threeDLimit": "0",
            "complaintRecord": "complaintRecord",
            "product": "DON",
            "contractSigned": "YES",
            "blockageTimeAndDay": "",
            "integrationModel": "API",
            "guaranteeAmount": "50.5",
            "guaranteeAmountStartDate": "01-02-2026 01:00",
            "guaranteeAmountEndDate": "01-02-2026 01:00",
            "foreignCardPermission": "YES"
        }
  }
}
	

Başvuru Sorgulama

QUERYAPPLICATION başvuru işlemi sorgulamanizi sağlar. Zorunlu parametreleri girmelisiniz.

İstek parametreleri:

ACTION:

QUERYAPPLICATION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

APPLICATIONNAME:

string, optional Max length: 256 description

APPLICATIONEMAIL:

string, optional Max length: 64 description

APPLICATIONCODE:

string, optional Max length: 64 Başvuru kodu

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

					ACTION: QUERYAPPLICATION
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
   "applications": [{
    "applicationName" : "Application Name",
    "applicationEmail" : "Application Email",
    "applicationPhone" : "Application Phone",
    "applicationWebAddress" : "www.google.com",
    "applicationTurnover" : "Application Turnover",
    "applicationStatus" : "Application status",
    "applicationCompanyType" : "Application company type",
    "applicationCode": "UKKYXGJNUFEJIHSBUS4MR3S3G2ODAE7QY53LLCMEZ7H7SJSB"
        "applicationShareholders":[
            {
                "name": "002",
                "surname": "002",
                "phone": "+38345698325",
                "email": "002@gmail.com",
                "idNumber": "002",
                "signAuthority": "YES",
                "signAuthorityDuration": "01-02-2026 01:00"
            },
            {
                "name": "001",
                "surname": "001",
                "phone": "+38345698325",
                "email": "001@gmail.com",
                "idNumber": "001",
                "signAuthority": "NO",
                "signAuthorityDuration": "01-02-2026 01:00"
            }
        ],
     "applicationMerchant": [
            {
                "commercialTitle": "123",
                "name": "123",
                "surname": "123",
                "email": "123@email.com",
                "phoneNumber": "+38345698325",
                "landPhone": "+3834569832",
                "address": "123",
                "eCommerce": "123"
            }
        ],
       "applicationFinancialData": {
            "merchantCommissionSchema": "MCS_ZERO_COMMISSION",
            "paymentSystemPool": "testPaymentSystemPool"
        },
        "applicationSaleSupportData": {
             "ssl": "test_ssl2",
             "content": "test_content2",
             "whois": "test_whois",
             "tradeRegistryNumber": "test_tradeRegistryNumber"
        },
         "applicationRiskManagmentDataVo": {
            "kkbPoint": "kkbPoint",
            "mcc": "1352",
            "threeDCondition": "THD_ALL",
            "threeDLimit": "0",
            "complaintRecord": "complaintRecord",
            "product": "DON",
            "contractSigned": "YES",
            "blockageTimeAndDay": "",
            "integrationModel": "API",
            "guaranteeAmount": "50.5",
            "guaranteeAmountStartDate": "01-02-2026 01:00",
            "guaranteeAmountEndDate": "01-02-2026 01:00",
            "foreignCardPermission": "YES"
        }
     }]  
}
	

Başvuru onayla

APPLICATIONAPPROVE işlemi başvuru onaylamanızı sağlar. Zorunlu parametreleri girmelisiniz.

İstek parametreleri:

ACTION:

APPLICATIONAPPROVE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

APPLICATIONEMAIL:

string, required Max length: 64 description

APPLICATIONNAME:

string, required Max length: 256 description

APPLICATIONSTATUS:

string, required Max length: 4 description Tüm geçerli değerleri görün (23)

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

APPLICATIONREJECTMSG:

string, optional Max length: 256 description

					ACTION: APPLICATIONAPPROVE
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
APPLICATIONEMAIL: [APPLICATIONEMAIL]
APPLICATIONPHONE: [APPLICATIONPHONE]

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "application" : {
    "applicationName" : "Application Name",
    "applicationEmail" : "Application Email",
    "applicationPhone" : "Application Phone",
    "applicationWebAddress" : "www.google.com",
    "applicationTurnover" : "Application Turnover",
    "applicationStatus" : "Application status",
    "applicationCompanyType" : "Application company type"
  }
}
	

Currency Actions

Currency Exchange

Currency Exchange

İstek parametreleri:

ACTION:

CURRENCYEXCHANGE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

FROMCURRENCY:

string, required Max length: 3 description Tüm geçerli değerleri görün (33)

TOCURRENCY:

string, required Max length: 3 description Tüm geçerli değerleri görün (33)

AMOUNT:

decimal, optional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

					ACTION: CURRENCYEXCHANGE
MERCHANTUSER: apiuser@testmerchant.com   
MERCHANTPASSWORD: Pluto321`   
MERCHANT: 10000000      
FROMCURRENCY: USD   
TOCURRENCY: TRY   
AMOUNT: 10.00 

				{
	"fromCurrency": "USD",
	"toCurrency": "TRY",
	"amount": "10.00",
	"convertedAmount": "60.62"
}
				

Satıcıyı Güncelle

SELLEREDIT işlemi mevcut satıcı kayıtlarını güncellemenizi sağlar. Seller ID ve Üye işyeri ID gerekli parametrelerini sağlayarak isim, soyisim, telefon numarası, e-posta, TCKN ve satıcı durumu alanlarını güncelleyebilirsiniz.

İstek parametreleri:

ACTION:

SELLEREDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SELLERID:

string, required Max length: 32 Satıcı başına benzersiz değer.

NAME:

string, optional Max length: 512 İsim

LASTNAME:

string, optional Max length: 512 description

EMAIL:

string, optional Max length: 512 description

MOBILENUMBER:

string, optional Max length: 64 description

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

TCKN:

string, conditional Max length: 11 TCKN / Müşteri Kimlik Numarası.

VKN:

string, conditional Max length: 10 Vergi Kimlik No

IBAN:

string, required Max length: 34 description

IBANUSD:

string, optional Max length: 34 description

IBANEUR:

string, optional Max length: 34 description

IBANGBP:

string, optional Max length: 34 description

SELLERPAYMENTDAYS:

string, required Max length: 32 Satıcı ödeme günleri, noktalı virgülle ayrılmış indeks formatında gönderilmelidir. Günler için indeksler aşağıdaki gibidir: Pazartesi(0), Salı(1), Çarşamba(2), Perşembe(3), Cuma(4). Örnek olarak, satıcı ödeme günlerinin Pazartesi ve Cuma olması için SELLERPAYMENTDAYS parametresinin değeri aşağıdaki gibi gönderilmelidir: 0;4;

ACCOUNTOWNERNAME:

string, conditional Max length: 512 description

ACCOUNTOWNERLASTNAME:

string, conditional Max length: 512 description

SELLERPAYMENTDUEDAY:

integer, optional Max length: 2 description

COMMERCIALTITLE:

string, conditional Max length: 512 description

COMMISSIONAPPLYTYPE:

string, conditional Max length: 3 COMMISSIONAPPLYTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONAPPLIERTYPE:

string, conditional Max length: 3 COMMISSIONAPPLIERTYPE sadece CA parametresini desteklemektedir. Diğer parametreler geçerli değil. Tüm geçerli değerleri görün (3)

COMMISSIONVALUE:

decimal, optional Max length: 30 description

ONBEHALFOFMERCHANT:

string, optional Max length: 16 description

SELLERURL:

string, optional Max length: 256 description

ISDEFAULT:

string, optional Max length: 3 Default value: 'NO' description

CITY:

string, optional Max length: 64 description Tüm geçerli değerleri görün (81)

					ACTION: SELLERADD
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SELLERID: [SELLER ID]
NAME: []
LASTNAME: []
EMAIL: []
MOBILENUMBER: []
TCKN: []
STATUS: []

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "seller" : {
    "sellerId" : "Seller-vd6ShJUF",
    "name" : "Seller01",
    "lastName" : "LastName-XKGo",
    "email" : "seler01@email.com",
    "mobileNumber" : "+900408866157",
    "status" : "OK",
    "merchant" : {
      "businessId" : "10000000",
      "name" : "MSU Test Merchant",
      "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
      "phone" : "+902123650505",
      "webAddress" : "http://www.asseco-see.com.tr/"
    }
  }
}
				

Müşteri Komisyon Aksiyonları

Müşteri Komisyonu Güncelleme

EDITCUSTOMERCOMMISSION aksiyonu müşteri maliyet yansıtma şablon bilgisinin düzenlenmesini sağlar.

İstek parametreleri:

ACTION:

EDITCUSTOMERCOMMISSION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CURRENCYCOMMISSIONS:

string, required Max length: 200000 description

ACTIVATIONDATE:

date, required Max length: 32 Format: [dd-MM-yyyy HH:mm] Eş Güdümlü Evrensel Zaman (UTC) standardında aktivasyon tarihi

					
ACTION: EDITCUSTOMERCOMMISSION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SESSIONTOKEN: [SESSIONTOKEN]
DEFAULTCOMMISSION: [DEFAULTCOMMISSION]
PAYMENTSYSTEMBASEDCOMMISSIONLIST: [PAYMENTSYSTEMBASEDCOMMISSIONLIST]
ACTIVATIONDATE: [dd-MM-yyyy HH:mm]
					
				

				
{
  "responseCode" : "00",
  "responseMsg" : "Approved"
}
				
			

OTP İşlemleri

OTP ekle

OTPADD isteği yeni bir OTP (tek seferlik şifre) yaratmak ve eklemek için kullanılır

İstek parametreleri:

ACTION:

OTPADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

EMAIL:

string, required Max length: 64 description

				
ACTION: OTPADD
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
EMAIL: [EMAIL]
				
			

				
{
	"responseCode": "00",
	"responseMsg": "Approved",
	"otp": {
		"otpCode": "107038",
		"createdTs": "2022-08-18 16:08:43.578",
		"status": "OK"
	}
}
				
			

Edit OTP

OTPEDIT request can be used to generate and edit OTP (One time password)

İstek parametreleri:

ACTION:

OTPEDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

OTPCODE:

string, required Max length: 6 description

OTPSTATUS:

string, required Max length: 2 description Tüm geçerli değerleri görün (4)

EMAIL:

string, required Max length: 64 description

				
ACTION: OTPEDIT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
EMAIL: [EMAIL]
				
			

				
{
	"responseCode": "00",
	"responseMsg": "Approved",
	"otp": {
		"otpCode": "107038",
		"createdTs": "2022-08-18 16:08:43.578",
		"status": "OK"
	}
}
				
			

Bin Rule İşlemleri

Bin Kuralı ekle

BINRULEADD isteği, yeni bir Bin Kuralı oluşturmak ve eklemek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, required Max length: 128 Bin Kuralı

CARDBRAND:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (9)

CARDTYPE:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (6)

CARDNETWORK:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (10)

ISSUER:

string, conditional Max length: 128 description

COUNTRYISOA3:

string, conditional Max length: 3 description

LOWERLIMIT:

decimal, optional Max length: 22 description

UPPERLIMIT:

decimal, optional Max length: 22 description

STATUS:

string, required Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

INSTALLMENTTYPE:

string, optional Max length: 64 description Tüm geçerli değerleri görün (2)

INSTALLMENTCOUNT:

integer, optional Max length: 2 Default value: '1' description

FOREIGN:

string, optional Max length: 3 description Tüm geçerli değerleri görün (2)

UNDEFINEDBIN:

string, optional Max length: 3 description Tüm geçerli değerleri görün (2)

				
ACTION: BINRULEADD
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
STATUS: [STATUS]
CARDBRAND: [CARDBRAND]
CARDTYPE: [CARDTYPE]
CARDNETWORK: [CARDNETWORK]
COUNTRYISOA3: [COUNTRYISOA3]
ISSUER: [ISSUER]
LOWERLIMIT: [LOWERLIMIT]
UPPERLIMIT: [UPPERLIMIT]
INSTALLMENTTYPE: [INSTALLMENTTYPE]
INSTALLMENTCOUNT: [INSTALLMENTCOUNT]
				
			

				
{
    "responseCode": "00",
    "responseMsg": "Approved",
    "binRule": {
        "ruleName": "TEST11",
        "cardBrand": "VISA",
        "cardType": "DEBIT",
        "countryIsoA3": "ALB",
        "issuer": "test11",
        "cardNetwork": "WORLD",
        "lowerLimit": 2.5,
        "upperLimit": 3.7,
        "status": "OK",
        "installmentType": MULTIPLESHOT,
        "installmentCount": 3      
    }

				

QUERY BIN Kuralı

QUERYBINRULE QUERY BIN Kuralı sistem üzerindeki tüm bin kurallarını sorgulamak için kullanılır.

İstek parametreleri:

ACTION:

QUERYBINRULE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, optional Max length: 128 Bin Kuralı

				
ACTION: QUERYBINRULE
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
				
			

				
{
    "responseCode": "00",
    "responseMsg": "Approved",
    "binRules": [
        {
            "ruleName": "TESTDEMO19",
            "cardBrand": "VISA",
            "cardType": "CREDIT",
            "countryIsoA3": "TUR",
            "issuer": "test11",
            "cardNetwork": "WORLD",
            "lowerLimit": 2.5,
            "upperLimit": 3.7,
            "status": "OK",
            "installmentType": MULTIPLESHOT,
       		"installmentCount": 3
        }   "status": "OK"
        },
        {
            "ruleName": "RuleForTest",
            "cardBrand": "MC",
            "countryIsoA3": "TUR",
            "issuer": "test11",
            "cardNetwork": "WORLD",
            "lowerLimit": 2.5,
            "upperLimit": 3.7,
            "status": "OK",
            "installmentType": ONESHOT,
       		"installmentCount": 1            
        }
    ]
}
				

Bin Kuralı sil

BINRULEDELETE isteği, mevcut bir Bin Kuralını silmek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEDELETE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, required Max length: 128 Bin Kuralı

				
ACTION: BINRULEDELETE
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
				
			

				
{
	"responseCode": "00",
	"responseMsg": "Approved"
}
				
			

Bin Kuralı düzenle

BINRULEEDIT isteği, mevcut bir Bin Kuralını düzenlemek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEEDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, required Max length: 128 Bin Kuralı

CARDBRAND:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (9)

CARDTYPE:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (6)

CARDNETWORK:

string, conditional Max length: 8 description Tüm geçerli değerleri görün (10)

ISSUER:

string, conditional Max length: 128 description

COUNTRYISOA3:

string, conditional Max length: 3 description

LOWERLIMIT:

decimal, optional Max length: 22 description

UPPERLIMIT:

decimal, optional Max length: 22 description

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

INSTALLMENTTYPE:

string, optional Max length: 64 description Tüm geçerli değerleri görün (2)

INSTALLMENTCOUNT:

integer, optional Max length: 2 Default value: '1' description

FOREIGN:

string, optional Max length: 3 description Tüm geçerli değerleri görün (2)

UNDEFINEDBIN:

string, optional Max length: 3 description Tüm geçerli değerleri görün (2)

				
ACTION: BINRULEEDIT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
STATUS: [STATUS]
CARDBRAND: [CARDBRAND]
CARDTYPE: [CARDTYPE]
CARDNETWORK: [CARDNETWORK]
COUNTRYISOA3: [COUNTRYISOA3]
ISSUER: [ISSUER]
LOWERLIMIT: [LOWERLIMIT]
UPPERLIMIT: [UPPERLIMIT]
INSTALLMENTTYPE: [INSTALLMENTTYPE]
INSTALLMENTCOUNT: [INSTALLMENTCOUNT]
				
			

				
{
    "responseCode": "00",
    "responseMsg": "Approved",
    "binRule": {
        "ruleName": "TEST12",
        "cardBrand": "VISA",
        "cardType": "DEBIT",
        "countryIsoA3": "ALB",
        "issuer": "test12",
        "cardNetwork": "WORLD",
        "lowerLimit": 2.7,
        "upperLimit": 3.9,
        "status": "OK",
        "installmentType": "MULTIPLESHOT",
        "installmentCount": "4"
    }
}
				
			

Üye İş Yeri Ayarları

MERCHANTSETTINGSEDIT Üye İş Yeri Ayarları Düzenle

Bu api çağrısı, DURUM, ÖDEME POLİTİKASI VEYA ÜÇ D KISITLAMA gibi mevcut Üye İş Yeri ayarlarını güncellemenizi sağlar.
Ödeme Politikası Değerleri: THD_ALL (Always use 3D Secure/Her zaman 3D Güvenlik kullan) THD_OPT (3D Secure is optional(Card Holder decides)/ Kart sahibi (Müşteri) isterse, 3D Güvenlik kullan) THD_BASED_ON_LIMIT (Use 3D Secure depending on the Transaction Amount / İşlem miktarına göre 3D kullan) THD_OPT_SAVED_CARDS (Always 3D for new cards, optional 3D for saved cards/Yeni kartlarda her zaman, kayıtlı kartlarda müşteri isterse 3D Güvenlik kullan)
3D Kısıtlama Değerleri: NO_RESTRICTION (No 3D restriction/3D kısıtlaması yok FULL_THD (Only allow Full-3D secure transactions (mdStatus=1) / Sadece Full-3D güvenlikli işlemlere izin ver (mdStatus=1) HALF_THD_MD12 (Allow Half-Secure 3D transactions if issuer bank or card is not registered to directory (mdStatus=1, 2)/ ğer banka veya kart dizine kayıtlı değilse Half-Secure 3D işlemlere izin ver (mdStatus=1, 2)) HALF_THD_MD129(Allow Half-Secure 3D transactions if merchant is not registered to directory (mdStatus=1, 2, 9)/Eğer üye işyeri dizine kayıtlı değilse Half-Secure 3D işlemlerine izin ver (mdStatus=1, 2, 9) )

İstek parametreleri:

ACTION:

MERCHANTSETTINGSEDIT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

ONBEHALFOFMERCHANT:

string, required Max length: 64 description

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

THREEDRESTRICTION:

string, optional Max length: 20 description Tüm geçerli değerleri görün (2)

PAYMENTPOLICY:

string, optional Max length: 20 description Tüm geçerli değerleri görün (4)

THREEDAMOUNTLIMIT:

decimal, optional Max length: 22 description

				
ACTION:MERCHANTSETTINGSEDIT
MERCHANTPASSWORD:[PASSWORD]
ONBEHALFOFMERCHANT:10000000
MERCHANTUSER:[SYSTEMUSER]
STATUS:OK
PAYMENTPOLICY:THD_BASED_ON_LIMIT
THREEDRESTRICTION:FULL_THD
THREEDAMOUNTLIMIT:3.5
				
			

				
{
    "merchantSettings": {
        "businessId": "10000000",
        "name": "ZiraatPay",
        "paymentPolicy": "THD_BASED_ON_LIMIT",
        "integrationModel": "ALL",
        "threeDAmountLimit": 3.5,
        "status": "OK",
        "threeDRestriction": "FULL_THD"
    }
}
				
			

Kullanıcıyı Doğrula

VALIDATEUSER api çağrısı, kullanıcıyı doğrulamak için kullanılacaktır.

İstek parametreleri:

ACTION:

VALIDATEUSER, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

USERPHONE:

string, required Max length: 20 Kullanıcıya ait cep telefonu numarası.

USEREMAIL:

string, optional Max length: 128 Kullanıcıya ait E-posta adresi.

TERMINALID:

string, required Max length: 7 Üye işyerine ait tekil terminal numarası.

				
ACTION:VALIDATEUSER
MERCHANTPASSWORD:[PASSWORD]
MERCHANTUSER:[SYSTEMUSER]
USERPHONE:[+905389580758]
USEREMAIL :[usertest@email.com]
TERMINALID : [100000]
				
			

				
{
	"responseCode": "00",
	"responseMsg": "Approved"
}
				
			

OTP Doğrula

OTPVERIFICATION api çağrısı, OTP doğrulamak için kullanılacaktır

İstek parametreleri:

ACTION:

OTPVERIFICATION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

OTPCODE:

string, required Max length: 6 description

EMAIL:

string, required Max length: 64 description

				
ACTION:VALIDATEUSER
MERCHANTPASSWORD:[PASSWORD]
MERCHANTUSER:[SYSTEMUSER]
USERPHONE:[+905389580758]
USEREMAIL :[usertest@email.com]
OTPCODE : [OTPCode]
				
			

				
{
  	"IsOTPverified":"OK",
  	"OTPcode":"121212"
}
				
			

OTP Sms Doğrula

OTPSMSCHECK api çağrısı, OTP Sms doğrulamak için kullanılacaktır

İstek parametreleri:

ACTION:

OTPSMSCHECK, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

USERPHONE:

string, required Max length: 64 Kullanıcıya ait cep telefonu numarası.

USEREMAIL:

string, optional Max length: 128 Kullanıcıya ait E-posta adresi.

				
ACTION:VALIDATEUSER
MERCHANTPASSWORD:[PASSWORD]
MERCHANTUSER:[SYSTEMUSER]
USERPHONE:[+905389580758]
USEREMAIL :[usertest@email.com]
				
			

				
{
  "IsOTPSent": true//false
  "SIMstatus": "CHANGED"//NOTOK//NOTCHANGED
  "responseMsg": "Template name alanı hatalıdır"
}
				
			

Sim Bloke Ekleme

ADDSIMBLOCK Api çağrısı kullanıcının sim bloklamak için kullanılacaktır.

İstek parametreleri:

ACTION:

ADDSIMBLOCK, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

APPREF:

string, required Max length: 40 description

SMSNUMBER:

string, required Max length: 64 description

GSMOPERATOR:

integer, optional Max length: 1 description

FRAUDDATE:

date, conditional Max length: 16 Format: [dd-MM-yyyy] description

				
ACTION:ADDSIMBLOCK
MERCHANTPASSWORD:[PASSWORD]
MERCHANTUSER:[SYSTEMUSER]
SMSNUMBER:[+905389580758]
GSMOPERATOR :[1]
FRAUDDATE : [09-08-2023]
				
			

				
{   "responseCode": "00",
    "responseMsg": "Approved"
}
				
			

Bin Rule, Ödeme Sistemi Havuzu İlişkisi İşlemleri

Bin Kuralı, Ödeme Sistemi Havuzu İlişkisi ekle

BINRULEPSPASSOCADD isteği, yeni bir Bin Kuralı, Ödeme sistemi ilişkisi eklemek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEPSPASSOCADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, required Max length: 128 Bin Kuralı

PAYMENTSYSTEMPOOLNAME:

string, required Max length: 255 Ödeme sistemi havuzu

PAYMENTSYSTEM:

string, required Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

STATUS:

string, required Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

				
ACTION: BINRULEPSPASSOCEDIT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
PAYMENTSYSTEMPOOLNAME: [PAYMENTSYSTEMPOOLNAME]
PAYMENTSYSTEM: [PAYMENTSYSTEM]
STATUS: [STATUS]
				
			

				
{
    "responseCode": "00",
    "responseMsg": "Approved",
    "binRule": {
        "ruleName": "TEST11",
        "paymentSystemPoolName": "PSPOOL_TEST",
        "paymentSystem": "Akbank",
        "status": "OK",     
    }
}
				
		   

Bin Kuralı, Ödeme Sistemi İlişkisi düzenle

BINRULEPSPASSOCEDIT isteği, mevcut bir Bin Kuralı, Ödeme sistemi ilişkisini düzenlemek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEPSPASSOCADD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

RULENAME:

string, required Max length: 128 Bin Kuralı

PAYMENTSYSTEMPOOLNAME:

string, required Max length: 255 Ödeme sistemi havuzu

PAYMENTSYSTEM:

string, required Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

STATUS:

string, required Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

				
ACTION: BINRULEPSPASSOCEDIT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
PAYMENTSYSTEMPOOLNAME: [PAYMENTSYSTEMPOOLNAME]
PAYMENTSYSTEM: [PAYMENTSYSTEM]
STATUS: [STATUS]
BINRULEPSPOOLASSOCNAME: [ASSOC-sfdsafa]
				
			

				
{
    "responseCode": "00",
    "responseMsg": "Approved",
    "binRule": {
        "ruleName": "TEST11",
        "paymentSystemPoolName": "PSPOOL_TEST",
        "paymentSystem": "Akbank",
        "status": "OK",     
    }
}
				
		   

QUERY BIN Kuralı, Ödeme Sistemi İlişkisi

QUERYBINRULEPSPASSOC QUERYBINRULEPSPASSOCDescription

İstek parametreleri:

ACTION:

QUERYBINRULEPSPASSOC, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

				
ACTION: QUERYBINRULEPSPASSOC
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
				
			

				
	{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "binRulePSPoolAssoc" : [ {
    "binRuleName" : "urlChange",
    "paymentSytemPoolName" : "All Payment System In Pool",
    "paymentSystem" : "YKB",
    "status" : "OK",
    "addedDate" : 1678453875268,
    "addedBy" : "Paratika Super Admin",
    "modifiedBy" : ""
  }, {
    "binRuleName" : "testingRule",
    "paymentSytemPoolName" : "Test Pool",
    "paymentSystem" : "Finansbank",
    "status" : "OK",
    "addedDate" : 1678453725637,
    "addedBy" : "Paratika Super Admin",
    "modifiedBy" : ""
  } ]
}
				
		   

Bin Kuralı, Ödeme Sistemi İlişkisi sil

BINRULEPSPASSOCDELETE isteği, mevcut bir Bin Kuralı, Ödeme sistemi ilişkisi silmek için kullanılır.

İstek parametreleri:

ACTION:

BINRULEPSPASSOCDELETE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

BINRULEPSPOOLASSOCNAME:

string, required Max length: 128 Association Name, unique and is autogenerated

				
ACTION: BINRULEPSPASSOCDELETE
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RULENAME: [RULENAME]
PAYMENTSYSTEMPOOLNAME: [PAYMENTSYSTEMPOOLNAME]
PAYMENTSYSTEM: [PAYMENTSYSTEM]
				
			

				
	{
		"responseCode": "00",
		"responseMsg": "Approved"

	}
				
		   

Sorgulama İşlemleri

İşlem Sorgulama

İşlem Sorgulama aksiyonu belli bir sipariş/ödeme numarası (MerchantPaymentID) bilgisini vererek bu numara altındaki başarılı işlemlerin ya da işlem numarasını (PGTRANID) vererek belli bir işleme ait detayların görüntülenmesini sağlar. Bu detaylar ödemenin durumu, ödeme sistemi/vpos sağlayıcı banka, taksit sayısı ve faiz oranı vs gibi bilgiler olacaktır.

Bankaların işlemlere cevap verme süresi azami 90 saniyedir. Üye işyeri olarak bu sürenin altında bir zaman aşımı değeri belirleyecekseniz, işlemin bankadaki durumunu öğrenmek için QUERYTRANSACTION servisini kullanmanız önemlidir.Bankadan işleme geç cevap gelmesi veya gelmemesi durumunda bu servisi entegre etmeniz önemlidir.Bu servis sayesinde işlemin MSU daki durumunu öğrenir ve ERP sistemlerinizi doğru güncelleyebilirsiniz.

İstek parametreleri:

ACTION:

QUERYTRANSACTION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, required Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

PGTRANID:

string, optional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

TRANSACTIONSTATUS:

string, optional Max length: 18 İslem durum bilgisi.

STARTDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için başlangıç değeridir.

ENDDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için bitiş değeridir.

OFFSET:

string, optional Max length: 4 Default value: '0' Sayfalama işleminde kullanılacak işlem raporu işlem sayısı bazında başlangıç değeri, offset.

LIMIT:

string, optional Max length: 4 Default value: '1000' Sorgulama cevabında yer alacak azami işlem sayısı.

MERCHANTPAYMENTID:

string, optional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

CUSTOMER:

string, optional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CUSTOMEREMAIL:

string, optional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, optional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERPHONE:

string, optional Max length: 64 Müşteri telefon ya da cep telefonu numarası. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

SELLERID:

string, optional Max length: 32 Satıcı başına benzersiz değer.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

					ACTION: QUERYTRANSACTION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
PGTRANID: 18285OQZD14766
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "transactionCount" : "1",
  "totalTransactionCount" : "1",
  "transactionList" : [ {
    "pgTranTraceAudit" : "828514893296",
    "pgTranReturnCode" : "00",
    "pgOrderId" : "10000000-PaymentId-mQ15HqoF7d8f",
    "pgTranApprCode" : "294906",
    "pgTranId" : "18285OQZD14766",
    "pgTranRefId" : "828514893296",
    "timePsSent" : "2018-10-12 14:16:26.815",
    "timePsReceived" : "2018-10-12 14:16:27.967",
    "timeCreated" : "2018-10-12 14:16:26.474",
    "amount" : 80,
    "transactionStatus" : "AP",
    "currency" : "TRY",
    "paymentSystem" : "My Finans Webpos Online Account (Test)",
    "panLast4" : "4026",
    "transactionType" : "SALE",
    "installmentCount" : 1,
    "cardOwnerMasked" : "N*** G***",
    "customerId" : "Customer-GUZUbLrQ",
    "bin" : "402277",
    "sellers" : [ {
      "sellerId" : "tigran",
      "commissionAmount" : 10
    }, {
      "sellerId" : "benjamin",
      "commissionAmount" : 10
    }, {
      "sellerId" : "aurela",
      "commissionAmount" : 20
    }, {
      "sellerId" : "alfred",
      "commissionAmount" : 4.5
    }, {
      "sellerId" : "john",
      "commissionAmount" : 10
    }, {
      "sellerId" : "alketa",
      "commissionAmount" : 5.5
    }, {
      "sellerId" : "nora",
      "commissionAmount" : 10
    }, {
      "sellerId" : "kate",
      "commissionAmount" : 10
    } ]
  } ]
}                       
				

Taksit Sorgulama

QUERYINSTALLMENT isteği alındığında sistemde tanımlı ve kart sahibinin kullanımına açık olan taksit seçeneklerin bilgisi dönülmektedir.

İstek parametreleri:

ACTION:

QUERYINSTALLMENT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

BIN:

string, optional Max length: 8 BIN değeri (Kredi / Banka kartının ilk 8 hanesi). Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

PAYMENTSYSTEM:

string, optional Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

PAYMENTSYSTEMTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (34)

					ACTION: QUERYINSTALLMENT
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
		           
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "paymentSystemEftCode" : "0111",
  "paymentSystemNetwork" : "CARD_FNS",
  "paymentSystemList" : [ {
    "name" : "My Finans Webpos Online Account (Test)",
    "paymentSystem" : 1,
    "installmentList" : [ {
      "count" : "NOT_ON_US",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 0
    } ]
  }, {
    "name" : "My Sanalakpos Account (Test)",
    "paymentSystem" : 2,
    "paymentSystemEftCode" : "0046",
    "paymentSystemNetwork" : "AXESS",
    "installmentList" : [ {
      "count" : "NOT_ON_US",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 0
    } ]
  }, {
    "name" : "My Halkbank Sanalpos Account (Test)",
    "paymentSystem" : 3,
    "paymentSystemEftCode" : "0012",
    "paymentSystemNetwork" : "PARAF",
    "installmentList" : [ {
      "count" : "NOT_ON_US",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 0
    } ]
  }, {
    "name" : "ISBANK TEST",
    "paymentSystem" : 4,
    "paymentSystemEftCode" : "0064",
    "paymentSystemNetwork" : "MAXIMUM",
    "installmentList" : [ {
      "count" : "NOT_ON_US",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 0
    } ]
  } ]
}                      
				

Kart Sorgulama

QUERYCARD aksiyonu kullanılarak belli bir müşteri (kart sahibi) için kaydedilmiş olan kart token değerleri ya da belli bir token’a ait kart detayları bilgileri alınabilir.

İstek parametreleri:

ACTION:

QUERYCARD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, optional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDSAVENAME:

string, optional Max length: 64 Kaydı yapılacak kart için verilen isim.

CUSTOMER:

string, optional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

OFFSET:

integer, optional Max length: 4 Default value: '0' Sayfalama işleminde kullanılacak işlem raporu işlem sayısı bazında başlangıç değeri, offset.

LIMIT:

integer, optional Max length: 4 Default value: '1000' Sorgulama cevabında yer alacak azami işlem sayısı.

					ACTION: QUERYCARD
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CUSTOMER: merchant20140920
				

					{
    "responseCode":"00",
    "responseMsg":"Approved",
    "cardCount":"1",
    "totalCardCount":"1",
    "cardList":[{
         "cardToken":"YGQHGWH4L3V3T6M2W6HHZ6FGJCZ5EKI5SBFGHHZORD55P6YV", 
         "cardOwner":"NAME SURNAME", 
         "panLast4":"0520", 
         "customer":"merchant20140920", 
         "cardBin":"540667", 
         "cardbrand":"MC", 
         "cardType":"CREDIT", 
         "cardLevel":"CLASSIC", 
         "cardNetwork":"MAXIMUM", 
         "cardIssuer":"T. IS BANKASI A.S.", 
         "cardVirtual":"NO", 
         "cardCountryIso":"TUR", 
         "cardPaymentSystem":"ISBANK TEST", 
         "cardExpiry":"01.2023", 
         "cardName":"ISBANKASI", 
         "pan":"540667***0520" 
    }]
}                       
				

Kart Vade Sorgulama

QUERYCARDEXPIRY aksiyonu içinde bulunulan ay ve gelecek ay içerisinde geçerliliği dolacak olan kartların sorgulanmada kullanılır.

İstek parametreleri:

ACTION:

QUERYCARDEXPIRY, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, required Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

CUSTOMER:

string, required Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

OFFSET:

string, optional Max length: 4 Default value: '0' Sayfalama işleminde kullanılacak işlem raporu işlem sayısı bazında başlangıç değeri, offset.

LIMIT:

string, optional Max length: 4 Default value: '1000' Sorgulama cevabında yer alacak azami işlem sayısı.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

					ACTION: QUERYCARDEXPIRY
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CUSTOMER: merchant20140920
				

					{
    "responseCode":"00",
    "responseMsg":"Approved",
    "cardCount":"1",
    "totalCardCount":"1",
    "cardList":[{
        "cardToken" : "YGQHGWH4L3V3T6M2W6HHZ6FGJCZ5EKI5SBFGHHZORD55P6YV",
        "cardOwner" : "NAME SURNAME",
        "panLast4" : "0520",
        "customer" : "merchant20140920",
        "cardBin" : "540667",
        "cardExpiry" : "04.2015",
        "pan" : "540667***0520"
    }]
}                       
				

Oturum Sorgulama

QUERYSESSION aksiyonu geçerli bir oturumun bilgilerinin sorgulamada kullanılır.

İstek parametreleri:

ACTION:

QUERYSESSION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, required Max length: 48 Oturum anahtarı.

					ACTION: QUERYSESSION
SESSIONTOKEN: [SESSIONTOKEN]	
			
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "session" : {
    "token" : "EMEVAXFGO7G4UWRTJD3R5QJ5ZOQJLY4YWLAOQJRKE7A2Z36L",
    "apiAction" : "SESSIONTOKEN",
    "merchantPaymentId" : "PaymentId-bl94pcHQ1mpO",
    "firstAmount" : 18.63,
    "amount" : 18.63,
    "currency" : "TRY",
    "returnUrl" : "https://neon-app.local.payten.com.tr/msu.merchant/index.jsp",
    "language" : "tr",
    "redirectWaitingTime" : 0,
    "itemTotalAmount" : 18.63, 
    "shippingContact" : {
      "address" : "Road",
      "city" : "Ankara",
      "country" : "Turkey",
      "postalCode" : "1105",
      "phone" : "987654321"
    },
    "billingContact" : {
      "address" : "Road",
      "city" : "Istanbul",
      "country" : "Turkey",
      "postalCode" : "1103",
      "phone" : "123456789"
    },
    "fastShipping" : false,
    "extra" : "{\"IframeDomainUrl\":\"https://www.google.com/\"}",
    "allowedUrl" : "https://www.google.com/"
  },
  "merchant" : {
    "businessId" : "***",
    "name" : "MSU Test Merchant",
    "tradingName" : "Trading name",
    "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
    "phone" : "+902123650505",
    "fax" : "+902123650555",
    "webAddress" : "http://www.asseco-see.com.tr/",
    "additionalDetails" : "Asseco SEE",
    "secretKey" : "***",
    "paymentPolicy" : "THD_ALL",
    "domains" : "www.domain.com,https://www.google.com/,alketa.com",
    "preInformationText" : "
NA
",
    "remoteSalesAgreement" : "
NA
",
    "useHpp" : true,
    "integrationModel" : "API"
  },
  "customer" : {
    "id" : "Customer-CVnUJCST",
    "email" : "CVnUJCST@email.com",
    "phone" : "+906613328056",
    "name" : "Name CVnUJCST",
    "birthday" : "2001-01-01",
    "lastLogin" : "16.10.2017 14:24"
  },
  "orderItems" : [ {
    "code" : "u91f4",
    "name" : "seat belt",
    "description" : "seat belt description ...",
    "amount" : 9.01,
    "quantity" : 1
  }, {
    "code" : "1rnxq8",
    "name" : "lace",
    "description" : "lace description ...",
    "amount" : 3.39,
    "quantity" : 1
  }, {
    "code" : "bdvhiv",
    "name" : "television",
    "description" : "television description ...",
    "amount" : 4.5,
    "quantity" : 1
  }, {
    "code" : "5cwai",
    "name" : "mp3 player",
    "description" : "mp3 player description ...",
    "amount" : 1.6,
    "quantity" : 1
  }, {
    "code" : "vhlt5d",
    "name" : "bookmark",
    "description" : "bookmark description ...",
    "amount" : 0.13,
    "quantity" : 1
  } ]
}

				

BIN Sorgulama

QUERYBIN Talep BIN bilgi almak için kullanılabilir

İstek parametreleri:

ACTION:

QUERYBIN, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

BIN:

string, conditional Max length: 8 BIN değeri (Kredi / Banka kartının ilk 8 hanesi). Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

					ACTION: QUERYPAYMENTSYSTEMS
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
BIN: 511452
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "bin" : {
    "bin" : "450803",
    "cardBrand" : "VISA",
    "cardType" : "CREDIT",
    "cardLevel" : "BUSINESS",
    "cardNetwork" : "MAXIMUM",
    "issuer" : "T. IS BANKASI A.S.",
    "virtual" : "NO",
    "countryIsoA3" : "TUR",
    "issuerType": "ISBANK",
    "is6Digit": "YES",
    "is8Digit": "NO"
  }
} 	
				

Ödeme sistemlerini Sorgulama

Ödeme sistemlerini Sorgulama QUERYPAYMENTSYSTEMS Talep tüm ödeme sistemlerini almak için kullanılabilir

İstek parametreleri:

ACTION:

QUERYPAYMENTSYSTEMS, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

BIN:

string, conditional Max length: 8 BIN değeri (Kredi / Banka kartının ilk 8 hanesi). Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

					ACTION: QUERYPAYMENTSYSTEMS
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
BIN: 511452
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "installmentPaymentSystem" : {
    "name" : "ISBANK TEST",
    "paymentSystem" : 1,
    "paymentSystemEftCode": "0064",
    "installmentList" : [ {
      "count" : "2",
      "customerCostCommissionRate" : 0.5
    }, {
      "count" : "3",
      "customerCostCommissionRate" : 0.5
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 0.5
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 0.5
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 0.5
    } ]
  },
  "oneShotPaymentSystem" : {
    "name" : "My Sanalakpos Account (Test)",
    "paymentSystem" : 1,
    "paymentSystemEftCode" : "0046",
    "installmentList" : [ {
      "count" : "1",
      "customerCostCommissionRate" : 0.3
    } ]
  }
} 	
				

Query Pay By Link Payment

The Query Pay By Link Payment İstek, istek filtrelerine göre tek tıkla ödemelerini döndürür. Yanıttaki tarih özellikleri satıcının zaman diliminde döndürülür ve ISO_8601 olarak biçimlendirilir

İstek parametreleri:

ACTION:

QUERYPAYBYLINKPAYMENT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

PAYBYLINKTOKEN:

string, conditional Max length: 48 description

STARTDATE:

date, conditional Max length: 32 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için başlangıç değeridir.

ENDDATE:

date, conditional Max length: 32 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için bitiş değeridir.

DUEDATE:

date, optional Max length: 16 Format: [dd-MM-yyyy HH:mm] description

CUSTOMEREMAIL:

string, optional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

PAYBYLINKSTATUS:

string, optional Max length: 2 description Tüm geçerli değerleri görün (5)

					
ACTION: QUERYPAYBYLINKPAYMENT
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
PAYBYLINKTOKEN: [TF7MPD55XU656FPW7ZJOGYVJ2X2AOKMNMDTXHECEQPYGO2RS]
PAYBYLINKSTATUS: []
CREATEDTS: []
DUEDATE: []
CUSTOMEREMAIL: []
				

					
{  
   "payByLinkPaymentList":[  
      {  
         "amount":10,
         "dueDate":"2016-06-27T21:10:41",
         "currency":"TRY",
         "cardHolderEmail":"testcustomer@email.com",
         "createdTs":"2016-06-20T14:46:41",
         "token":"3LQ74ANRG6RSAA32KYFELZX2VKPD22SN7KPWHYOOWQSXGBLE",
         "status":"SD"
      },
      {  
         "amount":10,
         "dueDate":"2016-06-27T15:00:42",
         "currency":"TRY",
         "cardHolderEmail":"testcustomer@email.com",
         "createdTs":"2016-06-20T14:46:42",
         "token":"HKLON7HKRJGEZGHOY3WE3GHLIY7TG4ZRGIGU4XFETJLJSRWV",
         "status":"SD"
      }
   ],
   "responseCode":"00",
   "responseMsg":"Approved"
}
 					
				

PAN Sorgulama

QUERYPAN aksiyonu belli bir kart pan bilgisi verilerek BIN bilginin sorgulanmasında kullanılır.

İstek parametreleri:

ACTION:

QUERYPAN, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDPAN:

string, required Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

					ACTION: QUERYPAN
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
CARDPAN: 5406670000000009
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "bin" : {
    "bin" : "540667",
    "cardBrand" : "MC",
    "cardType" : "CREDIT",
    "cardLevel" : "CLASSIC",
    "cardNetwork" : "MAXIMUM",
    "issuer" : "T. IS BANKASI A.S.",
    "virtual" : "NO",
    "countryIsoA3" : "TUR"
  }
} 	
				

					ACTION: QUERYPAN
SESSIONTOKEN: [SESSIONTOKEN]
CARDPAN: 5406670000000009
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "bin" : {
    "bin" : "540667",
    "cardBrand" : "MC",
    "cardType" : "CREDIT",
    "cardLevel" : "CLASSIC",
    "cardNetwork" : "MAXIMUM",
    "issuer" : "T. IS BANKASI A.S.",
    "virtual" : "NO",
    "countryIsoA3" : "TUR"
  }
} 	
			
		
	

Üye İş Yeri İçerik Sorgulama

QUERYMERCHANTCONTENT aksiyonu, üye iş yerinin sattığı ürünler için verilmiş olan ID bilgisinin sorgulanmasını sağlar.

İstek parametreleri:

ACTION:

QUERYMERCHANTCONTENT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTCONTENTID:

string, optional Max length: 16 Üye iş yeri tekil içerik belirtecidir.

					ACTION: QUERYMERCHANTCONTENT
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANTCONTENTID: 00AXVTSiHX99Z
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "merchantContentList" : [ {
    "merchantContentType" : "tac",
    "language" : "tr",
    "merchant" : "009testID001",
    "displayed" : "true",
    "content" : "test"
  } ]
}	
				

Puan Sorgulama

QUERYPOINTS aksiyonu belli bir kart için mevcut olan puanların banka sisteminden sorgulanmasını sağlar.

İstek parametreleri:

ACTION:

QUERYPOINTS, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CARDCVV:

string, optional Max length: 4 Kart güvenlik kodu, CVV değeri.

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

PAYMENTSYSTEM:

string, optional Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

					
   ACTION: QUERYPOINTS
   MERCHANTUSER: [MERCHANTUSER]
   MERCHANT: [MERCHANT]  
   MERCHANTPAYMENTID: session-vMMSSxDCxL9o
   MERCHANTPASSWORD: [MERCHANTPASSWORD]
   AMOUNT: 15.25   
   CURRENCY: TRY   
   CUSTOMER: merchant-7CtRNVbX   
   CARDEXPIRY: 12.2020   
   NAMEONCARD: NameOnCard
   CARDCVV: 000   
   CARDPAN: 4355084355084358
   PAYMENTSYSTEM: GarantiPOS 
				
				

					
						{
  "action" : "QUERYPOINTS",
  "merchant" : "testmerchant",
  "amount" : 15.25,
  "currency" : "TRY",
  "apiMerchantId" : "100100000",
  "paymentSystem" : "My Sanalakpos Account (Test)",
  "pgTranDate" : "",
  "merchantPaymentId" : "session-vMMSSxDCxL9o",
  "pgTranId" : "15182NCJB01021266",
  "pgTranRefId" : "",
  "pgOrderId" : "session-vMMSSxDCxL9o",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "points" : [ {
    "name" : "PCBCHIPPARABAKIYE",
    "value" : "000000009856"
  }, {
    "name" : "CCBCHIPPARABAKIYE",
    "value" : "000000083118"
  }, {
    "name" : "XCBCHIPPARABAKIYE",
    "value" : "000000029196"
  }, {
    "name" : "CCBCHIPPARAACIKLAMA",
    "value" : "ccb chip para aciklama"
  }, {
    "name" : "PCBCHIPPARAACIKLAMA",
    "value" : "pcb chip para aciklama"
  }, {
    "name" : "XCBCHIPPARAACIKLAMA",
    "value" : "xcb chip para aciklama"
  }, {
    "name" : "ERRORCODE",
    "value" : ""
  } ]
}
					
				

					
						{
  "action" : "QUERYPOINTS",
  "merchant" : "testmerchant",
  "amount" : 12.58,
  "currency" : "TRY",
  "apiMerchantId" : "700100000",
  "paymentSystem" : "My İşbank VPOS Account (Test)",
  "pgTranDate" : "",
  "merchantPaymentId" : "session-nmR4PEmEihOO",
  "pgTranId" : "15182PonE07021429",
  "pgTranRefId" : "",
  "pgOrderId" : "session-nmR4PEmEihOO",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "points" : [ {
    "name" : "NUMCODE",
    "value" : "00"
  }, {
    "name" : "HOSTMSG",
    "value" : "TOPLAMMAXIPUAN: 50.00 TL"
  }, {
    "name" : "HOSTDATE",
    "value" : "0701-154039"
  }, {
    "name" : "MAXIPUAN",
    "value" : "50.00"
  }, {
    "name" : "ERRORCODE",
    "value" : ""
  } ]
}
					
				

					
						{
  "action" : "QUERYPOINTS",
  "merchant" : "testmerchant",
  "amount" : 17.31,
  "currency" : "TRY",
  "apiMerchantId" : "600100000",
  "paymentSystem" : "My Finans Webpos Online Account (Test)",
  "pgTranDate" : "",
  "merchantPaymentId" : "session-GHmNvtjCKMos",
  "pgTranId" : "15182PrjH00128947",
  "pgTranRefId" : "",
  "pgOrderId" : "session-GHmNvtjCKMos",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "points" : [ {
    "name" : "NUMCODE",
    "value" : "00"
  }, {
    "name" : "PARAPUANTRL",
    "value" : "000000002631"
  }, {
    "name" : "SEYAHATAVANSPUANTRL",
    "value" : ""
  }, {
    "name" : "SEYAHATAVANSPUANVADETARIHI",
    "value" : ""
  }, {
    "name" : "PARAPUAN",
    "value" : "000000002631"
  }, {
    "name" : "CAVVRESULTCODE",
    "value" : "3"
  }, {
    "name" : "ERRORCODE",
    "value" : ""
  } ]
}
					
				

					
{
  "action" : "QUERYPOINTS",
  "merchant" : "testmerchant",
  "amount" : 17.27,
  "currency" : "TRY",
  "apiMerchantId" : "000100000012656",
  "paymentSystem" : "Vakifbank",
  "paymentSystemType" : "VAKIFBANK",
  "paymentSystemEftCode" : "0015",
  "merchantPaymentId" : "PaymentId-YwOuiloCfCHK",
  "pgTranId" : "bf2a7eef537a4e1bad0ca5be00f07519",
  "pgTranRefId" : "000075283460",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "points" : [ {
    "name" : "PUAN",
    "value" : "283567.72"
  } ]
}
					
		

					
{
  "action" : "QUERYPOINTS",
  "merchant" : "10000000",
  "amount" : 11.22,
  "currency" : "TRY",
  "apiMerchantId" : "9916570",
  "paymentSystem" : "HSBC",
  "paymentSystemType" : "HSBC",
  "paymentSystemEftCode" : "0123",
  "pgTranDate" : "",
  "merchantPaymentId" : "PaymentId-7Yx5s2QSMRvP",
  "pgTranId" : "",
  "pgTranRefId" : "",
  "pgOrderId" : "",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "points" : [ {
    "name" : "ODUL",
    "value" : "5612.47"
  } ]
}
					
		

Tekrarlı Ödeme Planı Sorgulama

QUERYRECURRINGPLAN aksiyonu tekrarlı ödeme planı kodu veya belli bir başlangıç/bitiş tarih aralığı verilerek tekrarlı ödeme plan(ların)ın detaylarının sorgulanmasını sağlar.

İstek parametreleri:

ACTION:

QUERYRECURRINGPLAN, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, optional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, optional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, optional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

STARTDATE:

date, conditional Max length: 16 Format: [dd-MM-yyyy] İşlem sorgulama tarih aralığı için başlangıç değeridir.

ENDDATE:

date, conditional Max length: 16 Format: [dd-MM-yyyy] İşlem sorgulama tarih aralığı için bitiş değeridir.

RECURRINGPLANCODE:

string, conditional Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

CARDPAN:

string, optional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CUSTOMER:

string, optional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

					ACTION: QUERYRECURRINGPLAN
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RECURRINGPLANCODE: Code-JSjAuDXf
				

					{
  "action" : "QUERYRECURRINGPLAN",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "recurringPlan" : {
    "recurringPlanCode" : "Code-wAasdfMW",
    "firstAmount" : 0,
    "recurringAmount" : 100,
    "startDate" : "01-10-2015 00:00",
    "scheduledEndDate" : "04-10-2015 00:00",
    "recurrenceCount" : 2,
    "completedRecurrence" : 0,
    "frequency" : "3D",
    "currency" : "TRY",
    "paymentSytem" : "My Finans Webpos Online Account",
    "status" : "ACTIVE"
  },
  "recurringPaymentList" : [ {
    "startDate" : "01-10-2015 00:00",
    "status" : "PENDING",
    "executionDate" : "",
    "recurrence" : 1,
    "amount" : 100,
    "tryCount" : 0
  }, {
    "startDate" : "04-10-2015 00:00",
    "status" : "PENDING",
    "executionDate" : "",
    "recurrence" : 2,
    "amount" : 100,
    "tryCount" : 0
  } ],
   "merchant" : {
    "businessId" : "[MERCHANT_BUSINESS_ID]",
    "name" : "[MERCHANTNAME]",
    "address" : "[MERCHANTADDRESS]",
    "phone" : "[MERCHANTPHONE]",
    "fax" : "[MERCHANTFAX]",
    "webAddress" : "http://www.asseco-see.com.tr/",
    "additionalDetails" : "Asseco South Eastern Europe",
    "secretKey" : "[SECRETKEY]",
    "referrer" : "https://www.example.com"
  },
  "customer" : {
    "id" : "MRCH_CUST_ID_123",
    "email" : "customerEmail-DA1y5O0U",
    "phone" : "11111111111111",
    "name" : "CustomerNameDA1y5O0U",
    "lastLogin" : "30.01.2015 16:11"
  },
  "card" : {
    "cardToken" : "CBCANDT5NRAJK2DCKYWZ2LZ6XIPCXXMPOBEKXEXSCD4YZN6O",
    "cardOwner" : "Name oa9iDQNM",
    "panLast4" : "5454",
    "customer" : "Customer-oa9iDQNM",
    "cardBin" : "545616",
    "cardExpiry" : "12.2020"
  }
}                       
				

Tekrarlı Ödeme Planı Kartı Sorgulama

QUERYRECURRINGPLANCARD request will return the details of cards for a specified recurring plan by using RECURRINGPLANCODE.

İstek parametreleri:

ACTION:

QUERYRECURRINGPLANCARD, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

RECURRINGPLANCODE:

string, required Max length: 16 Tekrarlı ödeme için kullanılan tekil (unique) kod.

					ACTION: QUERYRECURRINGPLANCARD
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
RECURRINGPLANCODE: [Code-UPAG0PzB]
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "cardList" : [ {
    "cardToken" : "BKSJWIERRJQFODRQ27AEI3JLLNLVDZ64Z74I6D2Q6GJ73YBN",
    "cardOwnerMasked" : "N*** A*******",
    "panLast4" : "5454",
    "customer" : "Customer-AtdW4XGx",
    "cardBin" : "545616",
    "cardExpiry" : "12.2020",
    "pan" : "545616***5454"
  }, {
    "cardToken" : "T45FWSAXNHZPC4NYCGVQSYY4INTCCPB3GC5MJ2HGD2YKLCG6",
    "cardOwnerMasked" : "N*** V*******",
    "panLast4" : "5454",
    "customer" : "Customer-Vdsj1bTN",
    "cardBin" : "545616",
    "cardExpiry" : "12.2020",
    "pan" : "545616***5454"
  }, {
    "cardToken" : "RF4DIKGLC65GLBTJWUJJDJAERGKTZ27NN7PPEE7NEPWBJGVP",
    "cardOwnerMasked" : "N*** f*******",
    "panLast4" : "5454",
    "customer" : "Customer-f2EWrLZE",
    "cardBin" : "545616",
    "cardExpiry" : "12.2020",
    "pan" : "545616***5454"
  }, {
    "cardToken" : "Z6VJJMIYBNWDVIXUC3547D356FX5DZZT5KVIZBA4Z3GYAVN5",
    "cardOwnerMasked" : "d***",
    "panLast4" : "9159",
    "customer" : "Customer-f2EWrLZE",
    "cardBin" : "409070",
    "cardExpiry" : "12.2020",
    "pan" : "409070***9159"
  } ]
}                       
				

Kampanya Sorgulama

QUERYCAMPAIGN aksiyonu kullanılarak kampanyalara ulaşabilirsiniz.

İstek parametreleri:

ACTION:

QUERYCAMPAIGN, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

BIN:

string, conditional Max length: 8 BIN değeri (Kredi / Banka kartının ilk 8 hanesi). Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

					ACTION: QUERYCAMPAIGN
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
BIN: 511452
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "campaignCodeList" : [ {
    "campaignName" : "Test1",
    "campaignCode" : "123",
    "installment" : "4",
    "minInstallment" : 3,
    "maxInstallment" : 4,
    "installmentAmount" : "3",
    "currency" : "TRY",
    "paymentSystemType" : "FINANS",
    "campaignType" : "ADDITIONALINSTALLMENT",
    "forCreditCards" : true,
    "forBusinessCards" : false,
    "details" : "Test details"
  }, {
    "campaignName" : "Test2",
    "campaignCode" : "456",
    "installment" : "4",
    "minInstallment" : 2,
    "maxInstallment" : 2,
    "installmentAmount" : "3",
    "currency" : "TRY",
    "paymentSystemType" : "FINANS",
    "campaignType" : "POSTPONE",
    "forCreditCards" : false,
    "forBusinessCards" : true,
    "details" : "Test details 2"
  } ]
}	
				

Online Kampanya Sorgulama

QUERYCAMPAIGNONLINE kart sahiplerinin kampanyaları üye işyerlerinde mevcutsa bu kampanyalardan yararlanmak için istekte bulunulabilir. Banka tarafından yapılan sorgu ve finansal işlem.

İstek parametreleri:

ACTION:

QUERYCAMPAIGNONLINE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

AMOUNT:

decimal, conditional Max length: 30 İşlem tutarı bilgisidir. Önemli Not: Üye iş yerlerinin ZiraatPay’e ilettikleri tutar KDV dahil tutardır. ZiraatPay ek olarak herhangi bir vergi hesaplaması yapmaz.

INSTALLMENTS:

integer, required Max length: 2 İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDCVV:

string, optional Max length: 4 Kart güvenlik kodu, CVV değeri.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

CUSTOMERIP:

string, optional Max length: 39 Kart Sahibi (Müşteri) IP Adresi.

CUSTOMERUSERAGENT:

string, optional Max length: 512 Kart Sahibi (Müşteri) Teknik Donanım.

EXTRA:

string, optional Max length: 4000 Extra Parameter is a custom parameter that is used to pass additional parameters to session token. This parameter is expected to be in JSON(URL-ENCODED) format. If they are mispelled, they will be ignored! Supported parameters are: CardHolderAgreementMode(value: NONE/SHOW/SHOWCHECKED/SHOWCHECKEDDISABLED), AlwaysSaveCard(value: true/false), BuyerType (value: L for logged in customer; A for anonymous, F for the first shopping with memebership. OR it can be 0, 1, 2 for those cases), IsbankBolumKodu(string), IframeDomainUrl indicates from which URL address payment will be proceesed., {"PREAUTH":"YES"} parameter indicates that payment will be processed as pre-authorization even if is started as sale., IGNORECUSTOMERCOMMISSION(values : YES/NO).
EXTRA: {"AlwaysSaveCard": "true", "BuyerType": "L", "IsbankBolumKodu": 12, "CardHolderAgreementMode": "SHOWCHECKED", "IGNORECUSTOMERCOMMISSION" : "YES"}

Other bank parameters

• MAXIMUMMOBIL - include Maximum Mobil payment system name like below to have Maximum Mobil tab on Default HPP
  {"MaximumMobilPaymentSystem":"PaymentSystemName"}
• GIROGATE payment methods. If one of payment methods is sent as "Yes", authentication will be done using GiroGate payment methods. Possible values: YES/NO.
  • SOFORT: {"SOFORT": "YES"}
  • SAFETYPAY: {"SAFETYPAY": "YES"}
  • QIWI: {"QIWI": "YES"}
  • GIROPAY: {"GIROPAY": "YES"}
  • IDEAL: {"IDEAL": "YES"}
  • FINNISHONLINEBANKING: {"FINNISHONLINEBANKING": "YES"}
  • BANCONTACT: {"BANCONTACT": "YES"}
  • ALIPAY: {"ALIPAY": "YES"}
  • MULTIBANCO: {"MULTIBANCO": "YES"}
  • TRUSTPAY: {"TRUSTPAY": "YES"}
  • EPS: {"EPS": "YES"}
  • MYBANK: {"MYBANK": "YES"}
  • P24: {"P24": "YES"}
  • BOLETO: {"BOLETO": "YES"}
  • ELO: {"ELO": "YES"}
  • SEPA: {"SEPA": "YES"}
  • UPOP: {"UPOP": "YES"}
• ISBANK - include in extra like below to send agriculture template info to Isbank when doing imece card operations.
  {"IMCKOD":"imckod", "FDONEM":"fdonem"}

PAYMENTSYSTEMTYPENAME:

string, optional Max length: 100 description

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

					
 ACTION: QUERYCAMPAIGNONLINE
 MERCHANTUSER: [MERCHANTUSER]
 MERCHANT: [MERCHANT]  
 MERCHANTPAYMENTID: PaymentId-pqkzBsVhLD3K
 MERCHANTPASSWORD: [MERCHANTPASSWORD]
 AMOUNT: 15.92
 INSTALLMENTS : 3   
 CURRENCY: TRY   
 CUSTOMER: merchant-7CtRNVbX   
 CARDEXPIRY: 12.2020   
 NAMEONCARD: NameOnCard
 CARDCVV: 000   
 CARDPAN: 5406670000000009 
				
				

					
{
  "action" : "QUERYCAMPAIGNONLINE",
  "merchant" : "testmerchant",
  "amount" : 15.92,
  "installment" : "1",
  "currency" : "TRY",
  "apiMerchantId" : "700658785",
  "paymentSystem" : "Türkiye İş Bankası Sanal POS",
  "paymentSystemType" : "ISBANK",
  "paymentSystemEftCode" : "0064",
  "pgTranDate" : "",
  "merchantPaymentId" : "PaymentId-pqkzBsVhLD3K",
  "pgTranId" : "16180OzcC07010161",
  "pgTranRefId" : "",
  "pgOrderId" : "PaymentId-pqkzBsVhLD3K",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "campaigns" : [ {
    "campaignCode" : "000001",
    "campaignName" : "kampanya1",
    "campaignExtra" : ""
  }, {
    "campaignCode" : "000002",
    "campaignName" : "kampanya2",
    "campaignExtra" : ""
  }, {
    "campaignCode" : "000003",
    "campaignName" : "kampanya3",
    "campaignExtra" : ""
  } ]
}
					
				

Ödeme Sistemi Verileri Sorgulama

Query Payment System Data QueryPSData

İstek parametreleri:

ACTION:

QUERYPAYMENTSYSTEMDATA, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

INSTALLMENTS:

integer, required Max length: 2 Default value: '1' İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

EFTCODE:

string, optional Max length: 4 description

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

BIN:

string, conditional Max length: 8 BIN değeri (Kredi / Banka kartının ilk 8 hanesi). Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

PAYMENTSYSTEMTYPE:

string, conditional Max length: 32 description Tüm geçerli değerleri görün (34)

CURRENCY:

string, optional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

					ACTION: QUERYPAYMENTSYSTEMDATA
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
INSTALLMENTS: 1   
PAYMENTSYSTEMTYPE: FINANS
				

					
{
  "paymentSystemType" : "FINANS",
  "responseCode" : "00",
  "responseMsg" : "Approved"
} 					
				

Üye İşyeri Komisyonunu Sorgulama

QUERYMERCHANTCOMMISSION request can be used to get transaction hosting commission

İstek parametreleri:

ACTION:

QUERYMERCHANTCOMMISSION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, optional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

					ACTION: QUERYMERCHANTCOMMISSION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SESSIONTOKEN: [SESSIONTOKEN]
				

					{
    "responseCode": "00",
    "responseMsg": "Approved",
    "paymentDueInDays": "30",
    "merchantPaymentDayIndexes": "0;3;4",
    "paymentSystemBased": "YES",
    "defaultCommission": {
        "installmentList": [
            {
                "count": "1",
                "merchantCostCommissionRate": 1
            },
            {
                "count": "2",
                "merchantCostCommissionRate": 2
            },
            {
                "count": "3",
                "merchantCostCommissionRate": 3
            },
            {
                "count": "4",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "5",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "6",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "7",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "8",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "9",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "10",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "11",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "12",
                "merchantCostCommissionRate": 50
            },
            {
                "count": "crNotOnUs",
                "merchantCostCommissionRate": 0
            },
            {
                "count": "crOnNetwork",
                "merchantCostCommissionRate": 0
            }
        ]
    },
    "paymentSystemBasedCommissionList": [
        {
            "paymentSystemName": "My Sanalakpos Account (Test)",
            "installmentList": [
                {
                    "count": "1",
                    "merchantCostCommissionRate": 0.4
                },
                {
                    "count": "2",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "3",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "4",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "5",
                    "merchantCostCommissionRate": 0.29
                },
                {
                    "count": "6",
                    "merchantCostCommissionRate": 0.29
                },
                {
                    "count": "7",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "8",
                    "merchantCostCommissionRate": 0.38
                },
                {
                    "count": "9",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "10",
                    "merchantCostCommissionRate": 0.39
                },
                {
                    "count": "11",
                    "merchantCostCommissionRate": 0.39
                },
                {
                    "count": "12",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "crNotOnUs",
                    "merchantCostCommissionRate": 0
                },
                {
                    "count": "crOnNetwork",
                    "merchantCostCommissionRate": 0
                }
            ]
        }
    ],
    "distinctPaymentSystemId": [
        "your-payment-system-id",
        "DEFAULT"
    ],
    "paymentSystemNames": {
        "your-payment-system-id": "My Sanalakpos Account (Test)",
        "DEFAULT": "DEFAULT"
    },
         "classifiedCommissionList": [
        {
            "currency": "EUR",
            "currencyCommissions": [
                {
                    "id": "00BYLHh9UyDE",
                    "commissionKey": "CR8",
                    "commissionValue": 0,
                    "currency": "EUR",
                    "dueDate": 0,
                    "paymentSystemCurrencyCommissions": [
                        {
                            "id": "00BYLHh9Uxzm",
                            "paymentSystemId": "your-payment-system-id",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        },
                        {
                            "id": "00BYLHh9Uxzl",
                            "paymentSystemId": "DEFAULT",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        }
                    ],
                    "active": true,
                    "validated": false,
                    "version": 0
                },
                {
                    "id": "00BYLHh9UyCG",
                    "commissionKey": "CR2",
                    "commissionValue": 0,
                    "currency": "EUR",
                    "dueDate": 0,
                    "paymentSystemCurrencyCommissions": [
                        {
                            "id": "00BYLHh9UyE0",
                            "paymentSystemId": "DEFAULT",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        },
                        {
                            "id": "00BYLHh9UyDz",
                            "paymentSystemId": "your-payment-system-id",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        }
                    ],
                    "active": true,
                    "validated": false,
                    "version": 0
                },
                {
                    "id": "00BYLHh9UyC3",
                    "commissionKey": "CR1",
                    "commissionValue": 0,
                    "currency": "EUR",
                    "dueDate": 0,
                    "paymentSystemCurrencyCommissions": [
                        {
                            "id": "00BYLHh9UyDZ",
                            "paymentSystemId": "your-payment-system-id",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        },
                        {
                            "id": "00BYLHh9UyDa",
                            "paymentSystemId": "DEFAULT",
                            "commissionValue": 0,
                            "dueDate": 0,
                            "validated": false,
                            "version": 0
                        }
                    ],
                    "active": true,
                    "validated": false,
                    "version": 0
                },
                ...
            ]
        }
}	
				

Müşteri Komisyonunu Sorgulama

QUERYCUSTOMERCOMMISSION aksiyonu müşteri komisyon şema bilgisinin sorgulanmasını sağlar.

İstek parametreleri:

ACTION:

QUERYCUSTOMERCOMMISSION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

ACTIVATIONDATE:

date, optional Max length: 32 Format: [dd-MM-yyyy HH:mm] Eş Güdümlü Evrensel Zaman (UTC) standardında aktivasyon tarihi

ACTIVATIONDATEINMILLISECONDS:

string, optional Max length: 19 description

			ACTION: QUERYCUSTOMERCOMMISSION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SESSIONTOKEN: [SESSIONTOKEN]
ACTIVATIONDATE: [dd-MM-yyyy HH:mm] 
			
		

			
				{
  "activationDate" : "25-03-2019 18:20",
  "paymentSystemBased" : "YES",
  "defaultCommission" : {
    "installmentList" : [ {
      "count" : "2",
      "customerCostCommissionRate" : 2.55
    }, {
      "count" : "3",
      "customerCostCommissionRate" : 3.2
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 4.5
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 5.1
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 5.99
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 6.12
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 6.77
    }, {
      "count" : "9",
      "customerCostCommissionRate" : 6.89
    }, {
      "count" : "10",
      "customerCostCommissionRate" : 6.99
    }, {
      "count" : "11",
      "customerCostCommissionRate" : 7.99
    }, {
      "count" : "12",
      "customerCostCommissionRate" : 8.22
    } ]
  },
  "paymentSystemBasedCommissionList" : [ {
    "paymentSystemName" : "Test Payment System Name",
    "installmentList" : [ {
      "count" : "2",
      "customerCostCommissionRate" : 0
    }, {
      "count" : "3",
      "customerCostCommissionRate" : 0.51
    }, {
      "count" : "4",
      "customerCostCommissionRate" : 6.35
    }, {
      "count" : "5",
      "customerCostCommissionRate" : 8.76
    }, {
      "count" : "6",
      "customerCostCommissionRate" : 10.11
    }, {
      "count" : "7",
      "customerCostCommissionRate" : 12.33
    }, {
      "count" : "8",
      "customerCostCommissionRate" : 14.05
    }, {
      "count" : "9",
      "customerCostCommissionRate" : 16.23
    }, {
      "count" : "10",
      "customerCostCommissionRate" : 18.22
    }, {
      "count" : "11",
      "customerCostCommissionRate" : 19.33
    }, {
      "count" : "12",
      "customerCostCommissionRate" : 19.97
    } ]
  } ]
}
			
		

Sipariş Kalemini Sorgula

QUERYORDERITEM belirtilen üye işyeri ödeme numarası için ödeme kalemlerinin listesini döner.

İstek parametreleri:

ACTION:

QUERYORDERITEM, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

PGTRANID:

string, conditional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

MERCHANTPAYMENTID:

string, conditional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

					ACTION: QUERYORDERITEM
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
MERCHANTPAYMENTID : [MERCHANTPAYMENTID]
SESSIONTOKEN: [SESSIONTOKEN]

				

					
					{
    "responseCode": "00",
    "responseMsg": "Approved",
    "orderItemList": [
        {
            "code": "ljwsd",
            "name": "keyboard",
            "description": "keyboard description ...",
            "sellerId": "MySeller",
            "quantity": 1,
            "productCategoryCode": 4722,
            "amount": 100,
            "sellerPaymentAmount": 10
        },
        {
            "code": "ljwsd",
            "name": "keyboard",
            "description": "keyboard description ...",
            "sellerId": "MySeller",
            "quantity": 1,
            "productCategoryCode": 4722,
            "amount": 100,
            "sellerPaymentAmount": 10
        },
        {
            "code": "ljwsd",
            "name": "keyboard",
            "description": "keyboard description ...",
            "sellerId": "MySeller",
            "quantity": 1,
            "productCategoryCode": 4722,
            "amount": 100,
            "sellerPaymentAmount": 10
        }
    ]
}                      
	
	

Satıcı Sorgulama

QUERYSELLER belirli bir satıcı için kaydedilen tüm satıcıları veya belirli satıcı kimliği değerine dayanarak belirli satıcının ayrıntılarını almak için istek kullanılabilir.

İstek parametreleri:

ACTION:

QUERYSELLER, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SELLERID:

string, optional Max length: 32 Satıcı başına benzersiz değer.

ONBEHALFOFMERCHANT:

string, optional Max length: 64 description

STATUS:

string, optional Max length: 2 Statü, durum bilgisi.

					ACTION: QUERYSELLER
SESSIONTOKEN: [SESSIONTOKEN]
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SELLERID: seller-id
				

					{
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "sellers" : [ {
    "sellerId" : "seller-id",
    "name" : "seller-name",
    "lastName" : "seller-lastname",
    "email" : "seller@email.com",
    "mobileNumber" : "+902123650505",
    "status" : "OK",
    "merchant" : {
      "businessId" : "10000000",
      "name" : "ZiraatPay",
      "address" : "İTÜ Ayazağa Kampüsü Teknokent ARI 1 Binası No: 12 34469 Maslak",
      "phone" : "+902123650505",
      "webAddress" : "http://www.asseco-see.com.tr/"
    },
    "iban" : "TR330006100519786457841326",
    "ibanUsd" : "TR330006100519786457841326",
    "ibanEur" : "TR330006100519786457841326",
    "ibanGbp" : "TR330006100519786457841326",
    "accountOwnerName" : "seller-owner-name",
    "accountOwnerLastName" : "seller-owner-lastname"
  } ]
}                      
				

Recon Transaction Sorgulama

Query Recon Transaction Mutabakat işlem ayrıntılarını sorgulamak için kullanılır.

İstek parametreleri:

ACTION:

RECONTRANSACTION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, optional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

PAYMENTSYSTEMTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (34)

PGORDERID:

string, optional Max length: 64 description

PGTRANID:

string, optional Max length: 64 Ödeme sistemi / Sanal POS tarafında verilen işlem numarası (Transaction ID) bilgisi.

PGTRANAPPRCODE:

string, optional Max length: 64 description

STARTDATE:

date, conditional Max length: 16 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için başlangıç değeridir.

ENDDATE:

date, conditional Max length: 16 Format: [dd-MM-yyyy HH:mm] İşlem sorgulama tarih aralığı için bitiş değeridir.

OFFSET:

string, optional Max length: 6 Default value: '0' Sayfalama işleminde kullanılacak işlem raporu işlem sayısı bazında başlangıç değeri, offset.

LIMIT:

string, optional Max length: 4 Default value: '1000' Sorgulama cevabında yer alacak azami işlem sayısı.

MERCHANTPAYMENTID:

string, optional Max length: 128 Üye iş yeri tekil (unique) ödeme / sipariş kodu.

TRANSACTIONTYPE:

string, optional Max length: 32 description Tüm geçerli değerleri görün (11)

ENDOFDAYDATE:

string, optional Max length: 3 description Tüm geçerli değerleri görün (2)

					ACTION: RECONTRANSACTION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
PAYMENTSYSTEMTYPE: [FINANS]
PGORDERID : [PGORDERID]

				

					
{
  "action" : "RECONTRANSACTION",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "transactionCount" : "1",
  "totalTransactionCount" : "1",
  "transactionList" : [ {
    "pgTranTraceAudit" : "128613979044",
    "pgTranReturnCode" : "00",
    "pgOrderId" : "10000000-PaymentId-hg0vbZCu5U7R",
    "pgTranApprCode" : "267222",
    "pgTranId" : "21286NzFJ10201",
    "pgTranRefId" : "128613979044",
    "timePsSent" : "2021-10-13 12:49:28.167",
    "timePsReceived" : "2021-10-13 12:49:29.705",
    "timeCreated" : "2021-10-13 12:49:27.880",
    "amount" : 13.43,
    "transactionStatus" : "AP",
    "currency" : "TRY",
    "paymentSystem" : "Finansbank",
    "panLast4" : "5454",
    "transactionType" : "SALE",
    "installmentCount" : 1,
    "cardOwnerMasked" : "N*** s***",
    "customerId" : "Customer-sNFwPkY8",
    "bankCommissionRate" : 0.94,
    "bankCommissionAmount" : -0.1262,
    "bankAmount" : 13.3038,
    "posId" : "11111111111111111111111111111",
    "merchantBusinessId" : "10000000",
    "pgTranDate" : "20211013 13:51:05",
    "merchantPaymentId" : "PaymentId-hg0vbZCu5U7R",
    "paymentSystemType" : "FINANS",
    "bin" : {
      "bin" : "545616",
      "cardBrand" : "VISA",
      "cardType" : "CREDIT",
      "cardLevel" : "GOLD",
      "cardNetwork" : "CARD_FNS",
      "issuer" : "FINANS",
      "virtual" : "NO",
      "countryIsoA3" : "UGA"
    },
    "schemaValue" : {
      "commissionKey" : "CR1",
      "commissionValue" : 0.94,
      "currency" : "TRY",
      "schemaName" : "PSCS_ZERO_COMMISSION",
      "dueDate" : 0
    }
  } ]
}		
				

Ödeme Sistemi Havuzu Sorgulama

QUERYPAYMENTSYSTEMPOOL Ödeme sistem havuzlarını almak için istek kullanılabilir

İstek parametreleri:

ACTION:

QUERYPAYMENTSYSTEMPOOL, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

STATUS:

string, optional Max length: 2 Statü, durum bilgisi. Tüm geçerli değerleri görün (4)

					ACTION: QUERYPAYMENTSYSTEMPOOL
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
STATUS: OK
				

					{
    "responseCode": "00",
    "responseMsg": "Approved",
    "PsPools": [
        {
            "name": "All Payment System In Pool",
            "status": "OK"
        },
        {
            "name": "Halkbank",
            "status": "OK"
        },
        {
            "name": "YKB Pool",
            "status": "OK"
        },
        {
            "name": "Akbank Pool",
            "status": "OK"
        },
        {
            "name": "Isbank Pool",
            "status": "OK"
        },
        {
            "name": "Vakifbank Pool",
            "status": "OK"
        },
        {
            "name": "HSBC Pool",
            "status": "OK"
        },
        {
            "name": "Teb Pool",
            "status": "OK"
        },
        {
            "name": "Finans Pool",
            "status": "OK"
        }
    ]
} 	
				

Tarım Şablonu Sorgula

QUERYAGRICULTURETEMPLATE request can be used to get agriculture template information from bank side.

İstek parametreleri:

ACTION:

QUERYAGRICULTURETEMPLATE, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, conditional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

CURRENCY:

string, conditional Max length: 3 ISO Alpha para birimi kodu. Örneğin: TRY, EUR, USD, GBP. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/ISO_4217#Position_of_ISO_4217_code_in_amounts. Tüm geçerli değerleri görün (33)

PAYMENTSYSTEM:

string, optional Max length: 128 Ödeme sisteminin (banka ödeme geçidinin /vPOS hesabının) adı. Belirtilen isim ZiraatPay’de ilgili ekranlarda tanımlanan isimle aynı olmalıdır, aksi takdirde burada belirtilen değer gözardı edilir ve ZiraatPay’in akıllı değişim özelliği devreye alınır.

INSTALLMENTS:

integer, optional Max length: 2 Default value: '1' İşlemde kullanılacak taksit sayısı. Bu değer ödeme sisteminde tanımlı ve geçerli bir değer olmalıdır.

CUSTOMER:

string, conditional Max length: 128 Üye iş yeri sisteminde tanımlı olan müşteri kodu ya da numarası. Üye iş yeri tarafında bu değer tekil (unique) olmalıdır. TCKN gibi bilgiler de kullanılabilir.

CUSTOMEREMAIL:

string, optional Max length: 64 Müşteri e-posta bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CUSTOMERNAME:

string, optional Max length: 128 Müşteri ad soyad bilgisi. Müşteri / Kart sahibi bilgilendirme özellikleri kullanımlarında bu bilginin doğru olarak geçilmesi zorunludur.

CARDTOKEN:

string, conditional Max length: 64 Kaydedilen kart numara (PAN) ve kartın geçerlilik bitiş tarih bilgisi için verilen güvenli alfa-nümerik değer. Kart bilgilerinin verilmediği durumlarda bu değerin verilmesi zorunludur.

CARDPAN:

string, conditional Max length: 19 PAN (Primary account number), kart numarası. Detaylar için lütfen bakınız, https://en.wikipedia.org/wiki/Bank_card_number.

CARDEXPIRY:

string, conditional Max length: 7 Kartın geçerlilik bitiş tarihi. [mm.yy] formatında belirtilmelidir.

NAMEONCARD:

string, conditional Max length: 64 Kart üzerinde yazan isim.

FORGROUP:

string, optional Max length: 3 Default value: 'YES' Grup içi sorgulama ve diğer özellikler için kullanılan belirteçtir. Kabul edilen değerler şunlardır: 'yes', 'no'.

					ACTION: QUERYAGRICULTURETEMPLATE   
MERCHANTUSER: [MERCHANTUSER] 
MERCHANTPASSWORD: [MERCHANTPASSWORD]   
MERCHANT: [MERCHANT]     
CURRENCY: TRY      
MERCHANTPAYMENTID: PaymentId-xKYNX3KFWwfi   
CARDPAN: 5456165456165454   
CARDEXPIRY: 12.2025   
CUSTOMER: Customer-nLRiOspV   
CUSTOMERNAME: Name nLRiOspV   
CUSTOMEREMAIL: nLRiOspV@email.com   
CUSTOMERIP: 127.0.0.1   
CUSTOMERUSERAGENT: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.81 Safari/537.36   
NAMEONCARD: Name nLRiOspV   
CUSTOMERPHONE: +904196113535   
CUSTOMERBIRTHDAY: 01-01-2001   


				

					 {
  "apiMerchantId" : "3123",
  "paymentSystem" : "AgricultureVPOS",
  "paymentSystemType" : "DENIZBANKINTERTECH",
  "paymentSystemEftCode" : "0134",
  "merchantPaymentId" : "PaymentId-xUASUZrAczOj",
  "pgTranId" : "117312***0043",
  "pgTranRefId" : "hostid",
  "pgOrderId" : "10000000-PaymentId-xUASUZrAczOj",
  "pgTranReturnCode" : "00",
  "pgTranApprCode" : "949377",
  "pgTranTraceAudit" : "Success",
  "responseCode" : "00",
  "responseMsg" : "Approved",
  "agricultureTemplate" : [ {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 4,
    "paymentFrequency" : 4,
    "commissionRate" : 1.23
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 5,
    "paymentFrequency" : 5,
    "commissionRate" : 1.71
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 6,
    "paymentFrequency" : 3,
    "commissionRate" : 1.00
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 6,
    "paymentFrequency" : 6,
    "commissionRate" : 3.13
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 8,
    "paymentFrequency" : 1,
    "commissionRate" : 1.00
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 9,
    "paymentFrequency" : 9,
    "commissionRate" : 1.65
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 9,
    "paymentFrequency" : 3,
    "commissionRate" : 3.08
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 10,
    "paymentFrequency" : 1,
    "commissionRate" : 2.35
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 11,
    "paymentFrequency" : 1,
    "commissionRate" : 3.04
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 1,
    "commissionRate" : 3.73
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 3,
    "commissionRate" : 5.12
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 6,
    "commissionRate" : 7.18
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 4,
    "paymentFrequency" : 4,
    "commissionRate" : 1.23
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 11,
    "paymentFrequency" : 1,
    "commissionRate" : 3.04
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 10,
    "paymentFrequency" : 1,
    "commissionRate" : 2.35
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 1,
    "commissionRate" : 3.73
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 3,
    "commissionRate" : 5.12
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 5,
    "paymentFrequency" : 5,
    "commissionRate" : 1.71
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 6,
    "paymentFrequency" : 3,
    "commissionRate" : 1.00
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 9,
    "paymentFrequency" : 9,
    "commissionRate" : 1.65
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 6,
    "paymentFrequency" : 6,
    "commissionRate" : 3.13
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 12,
    "paymentFrequency" : 6,
    "commissionRate" : 7.18
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 9,
    "paymentFrequency" : 3,
    "commissionRate" : 3.08
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 8,
    "paymentFrequency" : 1,
    "commissionRate" : 1.00
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 3,
    "paymentFrequency" : 1,
    "commissionRate" : 2.00
  }, {
    "templateName" : "12 AY VADE 120 BLK A",
    "maturityPeriod" : 3,
    "paymentFrequency" : 3,
    "commissionRate" : 2.00
  } ]
}	
				

Başvuru Dokümanı Sorgulama

QUERYAPPLICATIONDOCUMENT isteği başvuruya ait dokümanları listelemek için kullanılabilir

İstek parametreleri:

ACTION:

QUERYAPPLICATIONDOCUMENT, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

APPLICATIONCODE:

string, required Max length: 64 Başvuru kodu

APPLICATIONDOCUMENTTYPE:

string, optional Max length: 64 Başvuru doküman tipi Tüm geçerli değerleri görün (16)

SESSIONTOKEN:

string, conditional Max length: 48 Oturum anahtarı.

			
ACTION: QUERYAPPLICATIONDOCUMENT
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
APPLICATIONCODE: [APPLICATIONCODE]
APPLICATIONDOCUMENTTYPE: [APPLICATIONDOCUMENTTYPE]
			
		

			
{
	"responseCode": "00",
	"responseMsg": "Approved",
	"applicationDocuments": [
		{
			"fileType": "PNG",
			"fileContent": "iVBORw0KGgoAAAANSUhEUgAAAKoAAABVCAYAAADZsn9OAAAMy0lEQVR42u1dD5RUVRm/i4AoQvgvDoW2uIM7b6IV2D/z3pusYXfn/SlFQGZntuwcy+PJP0VaekiKQu0YHkEwTpZUlmigZmaZUSpJ4p9UtPiTAYYKyh+h3ZlZFnYXF7bvu292d968++bPMntmlr7fOffMMvPeffd+93e/+33f/e6DMQKBQCAQCAQCgUAgEAgEAoFAIBBOIhycec6YWHjy1ESTJCfCFZ6eIBtOUiGUDHrCbGSi6cLr41HpSKLZ12MVqScW8W5IXH7B5B7GhpGUCEXWopVjgKCrgJjH+knaX2JRKXEo4p0DZC0jaRGKhniTNF9E0NQCRP5322zv2SQtQlEQm1U+Lt4src9GVE7WSGWYJEYoCo7M8UyMR327cyFqIiI9SBIjFIeo0YrzYFnfkxNRo9LDJDFCUXBodsVHgaibc1r6o94FJDFCUYBx0kTUuzIHZ6q9M+KpIIkRiobW2RVTgIjvZ1jyj8cj3qVbw2wkSYtQVLwTHDcuFpV2CEkalVb2hNkpJCVCSaDF9IxNNHm/HotIy2MR74q2qPcOKCpJhkAgEAgEAoFQLCTCE8+Kz/FMb2+WQu1NlXqsqXJGfJan4i3TcypJh1ACHn/5qLaI99vg3W/C1D5b/LRZ6gDPf01b2KOQpAhFA6bugea8DcNQmYP+0s4PZk4aTxIjFAVIPtCkW3JLSvHeShIjFAX5JKXEopWUlEIoDuKfP//MOB43yUpUqRuIehVJjFA0xKLeIGjVjsxJ09IjPdr40SQtQpE9fzYKyPp4vNm3G0orkDMG/z4Qi0rbW5u8t5CECCVG2PJRrZdXVsXnSNNj0fJyOn1KIBAIBMJJi/bmSeNj4clXxiLe+8HBWg226ZKW2R4F7VeSDqGowIToeLiyPhaR9mbM8I96f4Lnq0hihKLg4BxpAhBxW27n+qVlJDFCUYAZU4lm77rsh/t8h1ubKq8hiRGKBlj6JyWivnmw/K8B7RqHvz+Epb67rVnqiqG2jXoXtUa8l9Cb/QilY7MyVpZeSCoEAoEwqJgaHMcU/QGmGjuSZSvzhz5HgiGUFvymxgJmj62oxvOcwATCYKIl7PGBZ38FlMVYYk3eRYm5F5p7LplwOhGVMNgoY+XBUYwFhR77gbDvDPD2/wDefrZ3T3XG53o0Iiqh8JC1a5mq38tU8zEo90NZzgJGpYOoTdKN8aj3nxmSpo/GIt6HWkC7ElEJhYeqb3GQSdG/kOmW5xgbvrGajcAj0hsZG/Eoc3nnFBGVUECibs6XqORMEYio/xeYFvoYq2m4gH+m75ZUN36EqdpnmGLovKAQ/Q0+lm92uhUbrGNqSOurS4W6VK2eqfUVOdY3jCn1H+dtrdLs2UbTzHOhvvpk3Q2sOniOuApwfBTNy6/pbQeWgBZiakOt5RxlAMrjU58+E4j6poNMsn41/y2XgvLw+UYWhKiVgTFMNsqtMbz43KwOYM2MSmhro63/OC7+RpnXVaKa4U4QwiYW0LfzT1m7kROiunoEkOg78N1LUNqBBMd4CZjd8PkudO5xdzKkoBYGXzUehfIylP8m7z/WX5/RyYPaivF7Jof8Wdq62NJkvK2vA+Fu4N/XNYKgjVehvq5kvV1Q34a0wR8LE2UZ3P8XuPadlGt72/EhfH8Qynq47ntCwir6XbwfAfPv8HlEQKb/8N9yLarxLKsL1ZwAUWHiGnfDby9C2cblEjA2Qjt/7agzAARUjB/CdWvhmrfh82ha/7uhtELZwOt0m0TFI6rxil0g6MGCtpKNNfBbj0Ng9mt3gnatctU8iv5kxvudg3EcyHcTC4rDPdaEsi21q5g/hIPaKqyvV0v79cvg3niebXmdaz7784/nVUdOz9FXDpiosnEln3DOa1+2kVnWIsLrMvf/peQKW7JEfQ0I8EpWkvYL+m9M5L2q5lyuPfMfvBgQa0aORH3G0iQudSn6Wcn79gyMRMZDTFFO69dKBSYpb6Px8wERdVr9J5IaPP26t5jcKKUojPMzysi971h+VrpEddN0mX6XjXmCZfJraRPAqocvNfpOy5xwqddNQOlEzVZ67W1Rf7j2BlNEQTPAtR37mdI4LcX02FUiRB0B970rWOHaoL16Wl0+WM53CfuvGi0wTvvdxxfIinZvyRNVAXtHNW5nteBMyXoT/PtpYadUEBou9faAuGmR0jgE5Zd8+a2uPt3mrNU1nA11PuLQ3lhfvkRVjQQQ6WH4vA/KX2HyPJVy33vJa56Fa+aDuYIvJOs3L9Ae94eu4APnGFBtbv914PSh/RYwlyXt7fQ2rOW/uRXF2HvCRPWYp8JYLBGQtAu+v8bhDAdg+VbNNy3fAOSimLdxx8vRf/1LSR8kfcX8VmkTFZ2RWu0827WWt7tTIMR2HhlIRZU2mnv5OCNREK47PEaQG/bpBGGCRGI3oqrgCNU1KHwQ0Sbz+8dy56kX6OXWhqZyh8IN6Dyp+m8Ecri5YOEpxXjhhImKZpFqHnba9vr1TJzfOgzGZgqT66dzuWSMqBjP5NS+EiLqTq49hKET0IzO68Fj1q8e0PNxMgTMTkedfnNiTkRFTYrhlcLI4kfO+rWlJUNUWZ8Ozzgo0Hr32mzpgULWvi/o05OlS9RM6p6HrYyDgg4tHNDzUUsHjI4BE1U2flywUIpq3CMg0t0lQtRtUP9GwTMfcJhdA+6/du0QI6p2XZZ7XhXYSEuESw+SSDUrLJtVf4I7JGjfYbiot4iW85w1qv7NnPuKmwXoHMk8dryVO0up7RCFcEqHqJZDav/ugzycnTJWrU9gtfonoZ23QdnO71fNWIoMjpxsRP2zQOD3OXaX6vSL4fvVeccwC01U1NqyvoCHbtCezc8rLxWidognkr4WlrkRGZ+L9res3Z7cTcsvZDjEifpHgSCX2jSq36jiGmugYZvCEbUMyPCrnOPCpUvUF+GZ61ycyXmuz0QHUzWeGnj4bGgT9Q0BYX5g209X9dcE5kEr3Ls6aQvelSwruDM2WERFe1tEUuy3CvYtmiy9bVHNN0qYqM+zGjBbVGO3MMjvD00WP1P7isNZtWLIG5L5tP39D4i8/qFLVHSmutIIeAw69I1+QYc08cZA6NKk41NWMGcqE1ExRBUQ7Mooxqrk9uiwIeRMWeEp2bzUEe/EiajovxA/U39a6IAJ+z/UnClFf5s7QOIZerNgB6ODKaHZKcJZKBiQFwbF689EVNxKVM19aYN6lJWXjxoUr9+vf3nw46j+sfD3E8LdNtzTd7Zzv6P/SmPDyeH19yY2oJdsEyDanYI4HiaFpBJb0W8VDMhvxYMX+qwj4F8ooqoY5DcOpPUrLoxOTFRO4xlhuRN1i6Atd7JML5UoBFF57NmodRmzHQ4TwBl37XTJUsOA/9qhR1RLU+6FTs3kZ4EUTRXmYFqd+ZNdOOYNgro6k5sIZX1hKwxguyVMFIKoddokmEDvC/NGrV0sy9nCLVVZu0e4PexKVMGgYvJLnVbP5eXXQjytzpPyP/MViqjWBL9FYAIc56mI9nbuEphpC20HErH/ivHToedMpXdMNQ4L94Et4RxiNdoUu6AbfC4e9L+SOaGLeWZSprBVIYjKY7g8f9Q5adCpk6Edirkc+vYP16iAO1EXuUzubr7FaeV57mPVmndQiIohp4DxnHA8alO2s1XjQcGYJridihOJ57Nyx7d7KBK1O/f8UZcdKUwQyT0MMnhef29yTK79SdeqbkTlK0yW+DDu4KUmRheSqLxv4JwKg/RGS18uLa8LyJtzel+arEqaqH7tu9ymzBQct0i6gmdAuS67xvosQrESlDHRYjAD/tZJhWykOgLku4OHbXIiKti0mAeQuc73bIk9hSYqbmejZhSRDY9z95lYvP8dWUjaxmRwJlX9saEVnsLsJ1n7IgiyXbiEyw2NWffYUbCqcR2PnzoF38UnxJSG8clB3JRCvs0g4ZECZ+Qmvmz317EP6qjO2kc8MYDngRRB/Nd63jqYWBfxgZdDC/q0Ci7hdaFwxmB6nTarL40w3bxQjKtsISCUJybR9Lf/AKvR6xz14rYobnGmZofh8RjRiy6qqkYnzaijtkQdTB7qQ/gUrtnTJ2HqaQbuYEH9sj6/b0VVwYypM746NOKomEOKg8iPc2BeKuYyBvN7lyfWgQfq8CAf1oNhI1/wDIfXOQGum5CWs+pk3XA+ONkO4bntUuHxCiQ3tgOX74t4ZMMeT0QHCJ/Bckx2weunBst5VIQTHpxG9/al9jPzgUZsA29HDgcfUWngtVbOr3v/sb9IStmYybe4q4ITHfLG8B1/brCE3tk6kJ0pAoGISiAQUQlEVAKBiEogouq/EyRXXEaCIZQWMHY4HbOMDIUX6ygt/W8dBAKBQCAQCAQCgUAgEAgEAuFkwP8ATX9UIiXmF98AAAAASUVORK5CYII=",
			"documentType": "IDENTITY",
			"fileName": "image.png",
			"filePath" : "/application-files/ZCKZAPMGG3LZYTAU7KMWV2IRBAFXBSGXNAYDEIQVUWGMK4IB/IDENTITY"
		}
	]
}
			
		

İşlem Barındırma Komisyonu Sorgulama

QUERYTRANSACTIONHOSTINGCOMMISSION bu istek işlem barındırma komisyonu sorgulamak için kullanılabilir

İstek parametreleri:

ACTION:

QUERYTRANSACTIONHOSTINGCOMMISSION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

MERCHANT:

string, optional Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

			ACTION: QUERYTRANSACTIONHOSTINGCOMMISSION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
SESSIONTOKEN: [SESSIONTOKEN]
			
		

			
				{
    "responseCode": "00",
    "responseMsg": "Approved",
    "transactionHostingCommissionSchemaList": [
        {
            "name": "TEST_THCS"
        },
        {
            "name": "THCS_ZERO_COMMISSION"
        },
        {
            "name": "thcDev"
        }
    ]
}
			
		

Query OTP(One time password)

QUERYOTP request can be used to get OTP(One time password).

İstek parametreleri:

ACTION:

QUERYOTP, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANTUSER:

string, conditional Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, conditional Max length: 128 API Kullanıcı şifresi.

SESSIONTOKEN:

string, optional Max length: 48 Oturum anahtarı.

OTPCODE:

string, required Max length: 6 description

EMAIL:

string, required Max length: 64 description

				
ACTION: QUERYOTP
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
OTPCODE: [OTPCODE]
				
			

				
{
	"responseCode": "00",
	"responseMsg": "Approved",
	"otpCode": "107038",
	"createdTs": "2022-08-18 16:08:43.578",
	"status": "OK"
}
				
			

Üye İş Yeri Kullanıcı Sorgulama

QUERYMERCHANTINFORMATION request, üye işyeri kullanıcılarını sorgulamak amacıyla kullanılır

İstek parametreleri:

ACTION:

QUERYMERCHANTINFORMATION, required Max length: 128 API çağrısında yapılacak ana işlem belirteci.

MERCHANT:

string, required Max length: 128 Sistemde tanımlı olan üye iş yeri kodu bilgisidir.

MERCHANTUSER:

string, required Max length: 128 API Kullanıcısı.

MERCHANTPASSWORD:

string, required Max length: 128 API Kullanıcı şifresi.

			
ACTION: QUERYMERCHANTINFORMATION
MERCHANT: [MERCHANT]
MERCHANTUSER: [MERCHANTUSER]
MERCHANTPASSWORD: [MERCHANTPASSWORD]
			
		

			
{
  "responseCode": "00",
  "responseMsg": "Approved",
  "merchantInformationList": [
  {
    "merchantName": "Test Merchant",
	"merchantUserInformation": [
	{
	  "merchantUser": "Test User",
	  "merchantPhone": "+902123456789",
	  "merchantEmail": "merchantuser@testmerchant.com"
	 }
	]
   }
 ]
}