API Dokümanı
2 Çeşit Pay N Kolay API'si bulunmaktadır. Bu API'ler ile kendi ödeme form yapınızı oluşturabilirsiniz.
API'ler ile üye işyeri kendi ödeme formunu kullanır.
Minimum TLS 1.2 kullanılmalıdır. TLS Bağlantı Sorunlarını Çözme Kılavuzu için tıklayınız.
1 - Pay N Kolay API Kullanımı ( Taksitleri kendi taksit tablolarınızdan getirmek istersiniz kullanacağınız versiyon )
Bu versiyonda tüm değişkenler "https://paynkolaytest.nkolayislem.com.tr/Vpos/v1/Payment" adresine Body'de form-data olarak POST edilir. ( sx, clientRefCode, successUrl, failUrl, amount, installmentNo, cardHolderName, month, year, cvv, cardNumber, use3D, transactionType, rnd, hashData, environment, currencyNumber )
Payment Servis linki: "https://paynkolaytest.nkolayislem.com.tr/Vpos/v1/Payment" İlgili tüm değişkenleri Postman collection'ından görebilirsiniz.
İşlem, 3D değilse ödeme alınır ve successURL sayfanıza response parametreleri dönülür. Response Dönüş Parametreleri
use3D "true" ise 3D formu gelecektir. Bu formu şu şekilde ekranda çalıştırabilirsiniz.
echo "<div style:display:none>". $BANK_REQUEST_MESSAGE= $obj->BANK_REQUEST_MESSAGE . "</div>";
Gelen 3D formu çalıştırıldığında ilgili bankanın 3D secure penceresi açılır ve burada 3D secure şifresi girilmesi beklenir.
3D Secure işlemi sonrasında success sayfasına ödemeyi tamamlamak için bir referenceCode gönderilir. Bu referans kodu sx değeri ile birlikte https://paynkolaytest.nkolayislem.com.tr/Vpos/Payment/CompletePayment POST edip ödeme işlemini tamamlayabilirsiniz.
Her iki versiyonda da, 3D secure işlem sonrası CompletePayment servisi ile işlem tamamlanır. 3D secure olmayan işlemlerde CompletePayment servisi kullanılmamaktadır.
2 - Pay N Kolay API Kullanımı ( Taksitleri Pay N Kolay taksit tablolarından getirmek isterseniz kullanacağız versiyon )
Bu API'nin kullanımında önce taksitler çağırılır. Taksitleri çağırmak için "sx, amount, cardNumber, hosturl, iscardvalid" değişkenleri "https://paynkolaytest.nkolayislem.com.tr/Vpos/Payment/PaymentInstallments" adresine Body'de form-data olarak POST edilir.
Sadece BIN numarası ile ( kartın ilk 8 hanesi ile ) taksit sorgulamak için iscardvalid parametresi "false" olarak gönderilmeli, ya da hiç gönderilmemelidir.
PaymentInstallments servisinden gelen EncodedValue tutar bilgisi ( AUTHORIZATION_AMOUNT ), taksit bilgisi (INSTALLMENT) diğer değiştkenler ile birlikte Payment Servis'ine Body'de form-data olarak POST edilir. ( EncodedValue, installmentNo, amount , sx, clientRefCode, successUrl, failUrl, amount, installmentNo, cardHolderName, month, year, cvv, cardNumber, EncodedValue, use3D, transactionType, hosturl, rnd, hashData, environment ) . Payment Servis linki: "https://paynkolaytest.nkolayislem.com.tr/Vpos/Payment/Payment" İlgili tüm değişkenleri Postman collection'ından görebilirsiniz.
İşlem 3D değilse bu aşamada ödeme alınır. İşlem sonlanır. Response Dönüş Parametreleri
Payment servisine POST edildiğinde, 3D true ise 3D formu gelecektir. Bu formu şu şekilde ekranda çalıştırabilirsiniz.
echo "<div style:display:none>". $BANK_REQUEST_MESSAGE= $obj->BANK_REQUEST_MESSAGE . "</div>";
Gelen 3D formu çalıştırıldığında ilgili bankanın 3D secure penceresi açılır ve burada 3D secure şifresi girilmesi beklenir.
3D Secure işlemi sonrasında success sayfasına ödemeyi tamamlamak için bir referenceCode gönderilir. Bu referans kodu sx değeri ile birlikte https://paynkolaytest.nkolayislem.com.tr/Vpos/v1/CompletePayment POST edip ödeme işlemini tamamlayabilirsiniz.