PTT Akıllı Esnaf Geliştirici Merkezi

Genel Bakış

API entegrasyonunda üye işyeri kendi ödeme formunu kullanır. Bu form üzerindeki kontrolleri ve kuralları uygulaması gerekir.

• Kart numarası(PAN) luhn algoritmasına tabi tutulmalıdır.
• Kartın hamilinin adı ve soyadı alınmalıdır.
• Son kullanma tarihi geçmiş kartlar ile API'ye sorgu yapılmamalıdır.
• AMEX kartları ile işlem alabilir şekilde tasarlanmalıdır.

3D ile Ödeme

Tek çekim, taksitli ve tek tıkla ödeme işlemleri için uygundur. İşleme gönderilen kartın bakiyesinden ilgili miktarı çekme işlemi yapar. 3D secure başlatılması için session açar ve sessionId döner. Bu servisten dönen threeDsessionId iframe yöntemiyle 3Dyönlendirme servis url’ine eklenerek 3D doğrulama akışının yapılması sağlanır. Eğer 3D doğrulama başarılı ise Sistem otomatik olarak ödemeye gönderir.
Taksitli / Taksitsiz işlem yapılabilir.

Method Name : threeDPayment
Http Method : Post
Content-Type : application/json

Request Parametreleri

Response Parametreleri

Örnekler

{
    "clientId": 1,
    "apiUser": "testUser",
    "rnd": "***",
    "timeSpan": "20191121160000",
    "hash": "***",
    "orderId": "12345678901234567890",
    "callbackUrl": "***merchantCallbackUrl***",
    "amount": 100,
    "currency": 949,
    "installmentCount": 0
  }

{
   "code": 0,
   "message":
   "Başarılı",
   "threeDSessionId":
   "***"
 } 

3D ile Ödeme için Json Format Örneği

{
   "orderId": "string",
   "amount": 0,
   "currency": 0,
   "installmentCount": 0,
   "callbackUrl": "string",
   "description": "string",
   "clientId": 0,
   "apiUser": "string",
   "rnd": "string",
   "timeSpan": "string",
   "hash": "string"
 }

Ödeme Sorgulama

PTT Akıllı Esnaf ta kaydı oluşturulan bir işlemin detayları sorgulanabilir. İşlem sorgulama servisidir. OrderID ile işlem sorgulama yapılabilmektedir.

Method Name : inquiry
Http Method : Post
Content-Type : application/json

Request Parametreleri

Response Parametreleri

Örnekler

{
    "clientId": 1,
    "apiUser": "testUser",
    "rnd": "***",
    "timeSpan": "20191121160000",
    "hash": "***",
    "orderId": "12345678901234567890"
  } 

{
    "code": 0,
    "message": "Başarılı",
    "payments": [
                  {
                    "createDate":
                    "20151012112230",
                    "orderId":
                    "12345678901234567890",
                    "code": 0,
                    "message":
                    "Success",
                    "bankCode":
                    111,
                    "amount":
                    22.11,
                    "currency":
                    "949",
                    "clientId": 1
                  }
               ]
  }

İptal

Bankalar gün sonu almadan önce işlemin iptal edilmesidir. OrderId ile ödeme işleminin iptal edilmesini sağlar.

Method Name : void
Http Method : Post
Content-Type : application/json

Request Parametreleri

Response Parametreleri

Örnekler

{
    "clientId": 1,
    "apiUser": "testUser",
    "rnd": "***",
    "timeSpan": "20191121160000",
    "hash": "***",
    "orderId": "12345678901234567890"
  } 

{
    "code": 0,
    "message": "Başarılı",
    "orderId": "12345678901234567890",
  }

İade

Bankaların gün sonu aldıktan sonra işlemin kısmi veya tam olarak iade edilmesidir. Ödeme işlemini iade eder. Tam iade ve kısmi iade yapılabilmesini sağlar.

Method Name : refund
Http Method : Post
Content-Type : application/json

Request Parametreleri

Response Parametreleri

Örnekler

{
    "clientId": 1,
    "apiUser": "testUser",
    "rnd": "***",
    "timeSpan": "20191121160000",
    "hash": "***",
    "orderId": "12345678901234567890"
    "amount": "2211"
  } 

{
    "code": 0,
    "message": "Başarılı",
    "orderId": "12345678901234567890",
  }

İşlem Listeleme

Tarihe göre işlemleri listeler. Tarih gönderilerek iletilen tarihteki tüm işlemlerin listelenmesini sağlar.

Method Name : history
Http Method : Post
Content-Type : application/json

Request Parametreleri

Response Parametreleri

Örnekler

{
    "clientId": 1,
    "apiUser": "testUser",
    "rnd": "***",
    "timeSpan": "20191121160000",
    "hash": "***",
    "reconciliationDate": "20200101"
    "page": "1"
    "pageSize": "10"
  } 

{
    "code": 0,
    "message": "Başarılı",
    "payments": [
                  {
                    "createDate": "20151012112230",
                    "orderId": "12345678901234567890",
                    "code": 0,
                    "message": "Success",
                    "bankCode": 111,
                    "amount": 22.11,
                    "currency": "949",
                    "clientId": 1
                  }
                ]
}

Ortak Ödeme Sayfası

Server tarafından startThreeDSession servisi ile threeDSessionId alınarak client tarafına iletilir. client tarafında browser aracılığıyla threeDSecure url’ine get işlemi gerçekleştirilir. Parametre olarak threeDSessionId değerleri eklenir.

Method Name : threeDSecure
Http Method : get
Content-Type : html/text

Request Parametreleri

<iframe src="https://******/threeDSecure/{threeDSessionId}" height="250" width="400"></iframe>

Hash Mekanizması

private string CreateHash()
{
   var ApiKey = "";
   var ClientId = "";
   var ApiUser = "";
   var Rnd = "";
   var TimeSpan = "";
   var hashString =ApiKey + ClientId + ApiUser + Rnd + TimeSpan;
   System.Security.Cryptography.SHA512 sha = new
   System.Security.Cryptography.SHA512CryptoServiceProvider();
   byte[] bytes = Encoding.UTF8.GetBytes(hashString);
   byte[] hashingbytes = sha.ComputeHash(bytes);
   var hash = Convert.ToBase64String(hashingbytes);
   return hash;
}

Ortam ve Test Kart Bilgileri

Test Kartları

Hata Kodları ve Açıklamaları

Açık Kaynak

WooCommerce, Opencart, Magento ve Prestashop e-ticaret yazılımları için hazırlanmış olan entegrasyon modüllerini web sitenize kurarak, PTT Akıllı Esnaf'a kolayca entegre olabilirsiniz.

Ayrıca PHP SDK dosyasını kullanarak özel yazılımlarınıza entegre edebilirsiniz.

PTT Akıllı Esnaf Woocommerce Entegrasyonu

PTT Akıllı Esnaf Opencart Entegrasyonu

PTT Akıllı Esnaf Magento Entegrasyonu

PTT Akıllı Esnaf PrestaShop Entegrasyonu

PTT Akıllı Esnaf PHP SDK