Tami üzerinden gerçekleştirilmek istenen 3d'li ödeme için belirtilen tutar kadar karttan bakiyenin bloke edilmesini sağlar. İşlem ilk olarak 3d doğrulama adımından başlatılır. Başarılı sonuçlanan 3d doğrulama sonrasında 3d tamamlama adımında işlem gerçek bir ön otorizasyon işlemi gerçekleştirilmiş olur.
Ön otorizasyon işleminde karttan tutar bloke edilmiş olur. Ön otorizasyon kapama işlemi ile birlikte karttan ödeme alınmış olur.
Test/Prod Ortamları API Kullanıcı Bilgisi
Sandbox test portaline https://sandbox-portal.tami.com.tr adresinden
ulaşabilirsin. Test kullanıcıları ile test portale giriş yapıldığında bu
kullanıcıya bağlı işyeri tarafından gerçekleştirilen işlemleri
görüntülenebilir. İşlemler iptal/iade edilebilir. Test kullanıcı bilgileri için TeknikDestek@tami.com.tr
adresine ulaşabilirsin.
Hash Hesaplama
Bir çok işlem tipi için gönderilen isteğin header bilgisine PG-Auth-Token eklenmelidir. PG-Auth-Token değeri “MerchantNumber:TerminalNumber:Hash” değerlerinden oluşur.
Burada hash hesabı yapılırken üye işyerine ait merchantNumber, terminalNumber ve secretKey bilgileri sha256 ile hashleyip stringe çevrilerek elde edilir.
public class SHA256Example {\n public static String sha256(Long merchantNumber, Long terminalNumber, String secretKey) {\n String text = merchantNumber.toString() + terminalNumber.toString() + secretKey;\n try {\n MessageDigest digest = MessageDigest.getInstance(\"SHA-256\");\n byte[] hash = digest.digest(text.getBytes(StandardCharsets.UTF_8));\n String sha256Hex = DatatypeConverter.printBase64Binary(hash);\n return sha256Hex;\n } catch (NoSuchAlgorithmException e) {\n e.printStackTrace();\n return null;\n }\n }\n }
TAMİ Test Portalı Bilgileri
Tami test portalına https://sandbox-portal.tami.com.tr adresinden erişebilirsiniz. Bu adresten yukarıda iletilen kullanıcılar ile portal ekranını görüntüleyebilirsin.
Üretim ortamı bilgileriniz için https://portal.tami.com.tr adresinden üye olabilir veya e-ticaret destek birimine başvurabilirsin.
3D'li Ön Otorizasyon İşlemi API Bilgileri
Test ortamında yapılacak çalışmalarda "https://sandbox-paymentapi.tami.com.tr/payment/pre-auth" url'i kullanılacaktır.
Üretim ortamında yapılacak çalışmalarda ise "https://paymentapi.tami.com.tr/payment/pre-auth" url'i kullanılacaktır.
İstek Parametreleri ve Açıklamaları
Sanal POS 3D’li Peşin/Taksitli satış işlemleri için gerekli olan istek yapısı aşağıdaki tabloda belirtilmiştir. İstek mesajındaki bilgi ve açıklamalar incelenmeli ve istek mesajı bu tabloda belirtilen kurallara göre sağlanmalıdır:
Parametre Adı
Format
Uzunluk
(O)psiyonel / (Z)orunlu/ (Ş)artlı
Açıklama
orderId
String
(2-36)
Z
Ödeme
isteğinin Tami-müşteri arasındaki iletişiminde kullanılan tekil bir iletişim
bilgisidir.
Üye işyeri ve pos çifti için bu değer tekil olmalıdır. OrderId alanı, alfanümerik karakterler ile yalnızca '-' ve '_' karakterlerini içerebilir. Ancak, '-' ve '_' karakterlerini art arda içermemelidir.
amount
Decimal
Z
İşlem
tutarıdır. Küsurat ayracı nokta (.) ile yapılmalıdır.
currency
String
3
Z
İşlemin döviz
kodunu belirtir. Örnek: TL için TRY gönderilmeli.
installmentCount
Number
Z
Yapılmak istenen işlemin taksit bilgisidir. Peşin işlem için 1 gönderilmelidir. 0 gönderilmesi kabul edilmez.
paymentGroup
String
Z
Ödeme grubu,
varsayılan PRODUCT.
paymentChannel
enum
O
Ödeme kanalı.
Geçerli değerler enum içinde sunulmaktadır: WEB, MOBILE, MOBILE_WEB,
MOBILE_IOS, MOBILE_ANDROID, MOBILE_WINDOWS, MOBILE_TABLET, MOBILE_PHONE
callbackUrl
String
Ş
İşlem 3d'li olarak yapılmak isteniyorsa gönderilmesi zorunludur. 3d doğrulama sonucunun döneceği adrestir. Üye işyerine ait bir adres olmalıdır.
card
Object
Z
cvv
String
Z
Ödemenin
alınacağı kartın güvenlik kodu bilgisi.
expireMonth
Number
(1-12)
Z
Ödemenin
alınacağı kartın son kullanma tarihi ay bilgisi.
expireYear
Number
4
Z
Ödemenin
alınacağı kartın son kullanma tarihi yıl bilgisi.
holderName
String
30
Z
Ödemenin
alınacağı kart sahibinin adı soyadı bilgisi.
number
String
(5-35)
Z
Ödemenin
alınacağı kart numarası bilgisi.
billingAddress
Object
O
address
String
400
O
Üye işyeri
tarafındaki fatura adresi bilgisi.
emailAddress
String
O
Üye işyerine
ait mail bilgisi
city
String
30
O
Üye işyeri
tarafındaki fatura adresi şehir bilgisi.
companyName
String
100
O
Üye işyerinin
ticari unvan bilgisi.
country
String
50
O
Üye işyeri
tarafındaki fatura adresi ülke bilgisi.
contactName
String
30
O
Üye işyeri
tarafındaki fatura adresi, ad soyad bilgisi.
phone
String
O
Üye işyeri
tarafındaki alıcıya ait GSM numarası.
zipCode
String
15
O
Üye işyeri
tarafındaki fatura adresi posta kodu.
district
String
50
O
Üye işyeri
tarafındaki fatura adresi semt bilgisi.
shippingAddress
Object
O
address
String
400
O
Üye işyeri
tarafındaki teslimat adresi bilgisi.
emailAddress
String
O
Üye işyerine
ait mail bilgisi
city
String
30
O
Üye işyeri
tarafındaki teslimat adresi şehir bilgisi.
country
String
50
O
Üye işyeri
tarafındaki teslimat adresi ülke bilgisi.
contactName
String
30
O
Üye işyeri
tarafındaki teslimat adresi, ad soyad bilgisi.
zipCode
String
15
O
Üye işyeri
tarafındaki teslimat adresi posta kodu bilgisi.
district
String
50
O
Üye işyeri
tarafındaki teslimat adresi semt bilgisi.
buyer
Object
Z
Üye işyeri tarafındaki alıcıya ait bilgileri içerir.
ipAddress
String
Z
Üye işyeri tarafındaki alıcıya ait ip adresidir. Alıcının gerçek ip adresi iletilmesi gerekmektedir.
buyerId
String
50
Z
Üye işyeri tarafındaki alıcıya ait id bilgisidir.
name
String
30
Z
Üye işyeri tarafındaki alıcıya ait ad bilgisidir.
surName
String
30
Z
Üye işyeri tarafındaki alıcıya ait soyad bilgisidir.
identityNumber
String
11
O
Üye işyeri
tarafındaki alıcıya ait kimlik (TCKN) numarası.
city
String
50
O
Üye işyeri
tarafındaki alıcıya ait şehir bilgisi.
country
String
50
O
Üye işyeri
tarafındaki alıcıya ait ülke bilgisi.
emailAddress
String
Z
Üye işyeri tarafındaki alıcıya ait e-posta bilgisi. E-posta adresi alıcıya ait geçerli ve erişilebilir bir adres olmalıdır.
phoneNumber
String
Z
Üye işyeri tarafındaki alıcıya ait GSM numarasıdır
registrationAddress
String
400
O
Üye işyeri
tarafındaki alıcıya ait kayıt adresi.
zipCode
String
15
O
Üye işyeri
tarafındaki alıcıya ait posta kodu.
registrationDate
Date
O
Üye işyeri
tarafındaki alıcıya ait kayıt tarihi. Tarih formatı 2015-09- 17 23:45:06
şeklinde olmalıdır.
lastLoginDate
Date
O
Üye işyeri
tarafındaki alıcıya ait son giriş tarihi. Tarih formatı 2015- 09-17 23:45:06
şeklinde olmalıdır.
basket
O
basketId
String
50
Ş
Üye işyeri
tarafındaki sepete ait id. Basket içerisinde item iletilirse basketId
gönderilmesi zorunlu olur.
basket/basketItems
List
0
itemId
String
50
Ş
Üye işyeri
tarafındaki sepetteki ürüne ait id. Basket içerisinde item iletilirse itemId
gönderilmesi zorunlu olur.
itemType
String
50
Ş
Üye işyeri
tarafındaki sepetteki ürüne ait tip. Geçerli enum değerler: PHYSICAL ve
VIRTUAL.
Basket içerisinde item iletilirse itemType gönderilmesi zorunlu olur.
name
String
50
Ş
Üye işyeri
tarafındaki sepetteki ürüne ait ismi. Basket içerisinde item iletilirse name
gönderilmesi zorunlu olur.
category
String
50
O
Üye işyeri
tarafındaki sepetteki ürüne ait kategori .
subCategory
String
100
O
Üye işyeri
tarafındaki sepetteki ürüne ait alt kategori.
unitPrice
Decimal
min 0.0
O
Üye işyeri
tarafındaki sepetteki ürünün tekil tutarıdır.
totalPrice
Decimal
min 0.0
Ş
Üye işyeri tarafındaki sepetteki ürüne ait toplam tutar. 0 ve 0’dan küçük olamaz, tutarlar toplamı sepet tutarına (amount) eşit olmalıdır. Unitprice * numberOfProducts = totalPrice olmalı. Basket objesi içerisinde item iletilirse totalPrice gönderilmesi zorunlu olur.
numberOfProducts
Number
1-99999
O
Üye işyeri
tarafındaki sepetteki ürünün adedidir.
securityHash
String
Z
Dokumanda belirtilen şekilde hesaplanıp iletilmesi beklenen değerdir. Eksik veya hatalı iletilirse işlem bankaya yönlendirilmez, hata verilir.
3D'li Ön Otorizayon İstek Cevabı Parametreleri ve Açıklamaları
Parametre
Adı
Format
Açıklama
success
String
İşlemin sonucunu bildirir. True ise işlem başarılı, False ise işlem
başarısızdır. False dönmesi durumunda hata almıştır. Hata detayı errorCode ve
errorMessage alanlarında paylaşılır.
currency
String
Başarılı iptal edilen işlemin döviz kodu bilgisidir.
orderId
String
Satış işlemine ait sipariş numarası
amount
Number
Başarılı iptal edilen işlemin tutar bilgisidir.
systemTime
DateTime
İşlemin gerçekleşme zamanıdır
transactionDate
DateTime
Satış işleminin gerçekleşme zamanının blgisidir.
correlationId
String
İptal isteğinde üye işyerinin gönderdiği işlem numarası değeridir.
card
List
İşleme ait kart bilgileri iletilir
card/binNumber
String
Kartın ilk 8 hanesi
card/maskedNumber
String
Maskeli kart numarası
card/cardBrand
String
Kart bankası
card/cardOrganization
String
Kart organizasyonu
card/cardType
String
Kart organizasyonu
threeDSHtmlContent
String
3d doğrulama sayfasına yönlendirecek html content bilgisidir. Content
içeriği base 64'te decode edilerek Html elde edilir.
errorCode
String
İşlem başarısız olursa iletilir. Hata kodu bilgisini içerir
errorGroup
String
İlgili hatanın grubunu gösterir. İşyerleri hata kodu ve hata gruplarından
faydalanarak kendi tarafındaki kuralları yönetebilir.
errorMessage
String
İşlem başarısız olursa iletilir. Hata mesajı bilgisidir.
securityHash
String
İşlemin sonucunun doğru kaynaktan geldiğini belirlemek için kullanılacak
değerdir. Dokumanda nasıl hesaplanması gerektiği belirtilmiştir.
3D ön otorizasyon başlatma
sonucunda elde edilen HTML data ile kart bankasının 3d doğrulama ekranı
görüntülenecektir. Kart sahibi cep telefonuna gelen şifreyi girdikten sonra doğrulamanın
cevabı callbackUrl parametresinde belirttiğiniz adrese iletilecektir. Tami bu adrese
aşağıdaki değerleri post edecektir.
3D doğrulama sonucu başarılı
olduğunda karttan henüz para çekilmemiştir. Cevapta dönen succes alanı true
olduğunda işlemi ödemeye çevirmek için bir sonraki 3D’li satış işlemi tamamlama
adımına geçebilirsiniz.
3D doğrulama yanıtı, işyerine ait callback adresine
iletilirken, işlem güvenliğinin sağlanması amacıyla Tami tarafından ilgili
yanıta ‘hashedData’ parametresi eklenerek gönderilmektedir. İşyerlerinin, bu
değeri ilgili dokümantasyonda belirtilen yöntemle kendi tarafında yeniden
hesaplayarak doğrulaması gerekmektedir.
İşyeri tarafında hesaplanan değer ile Tami tarafından
iletilen HashedData değerinin eşleşmesi durumunda, ilgili işlem güvenli kabul
edilerek 3D tamamlama adımına geçilmelidir. Bu doğrulama sürecinin uygulanması
ve işlemin güvenliğinin teyit edilmesi tamamen işyerinin sorumluluğundadır.
3D Doğrulama Cevabı Parametreleri ve Açıklamaları
Parametre Adı
Format
Açıklama
cardBrand
String
Kart Markası
cardOrganization
String
Kart Organizasyonu
cardType
String
Kart Tipi
currencyCode
String
İşlem Para Birimi
hashedData
String
Cevapta dönen bilgilerin doğruluğunu kontrol etmek için kullanılacak değer
installmentCount
Number
İşlem Taksit Sayısı
maskedNumber
Number
Maskeli olarak kart numarası
mdStatus
String
Bilgilendirme amaçlı dönen mdStatus değeridir. Başarılı durumlar için 1, başarısız için ise 0, 2, 3, 4, 5, 6, 7, 8 olarak dönebilir.
orderId
String
Sipariş numarası
success
String
Yapılan 3d doğrulama işleminin sonucunu bildirir. İşlem başarılı ise true, hatalı ise false döner.
systemTime
DateTime
İşlem Tarihi
txnAmount
Number
İşlem Tutarı
hashParams
String
HashedData değeri oluşturan paramtrelerin bilgisi,sırası iletilir. HashedData değeri hesaplanırken bu alana göre hesaplama yapılmalı
3D Doğrulama cevabında dönen Success alanının false olması durumunda aşağıdaki tablo hatanın sebebi ile ilgili yardımcı olacaktır.
mdStatus
Açıklama
mdStatus =0
3-D Secure imzası geçersiz veya doğrulama
mdStatus =2
Kart sahibi veya bankası sisteme kayıtlı değil
mdStatus =3
Kartın bankası sisteme kayıtlı değil
mdStatus =4
Doğrulama denemesi, kart sahibi sisteme daha sonra kayıt olmayı seçmiş
mdStatus =5
Doğrulama yapılamıyor
mdStatus =6
3-D Secure hatası
mdStatus =7
Sistem hatası
mdStatus =8
Bilinmeyen kart no
HashedData Hesaplaması
3D Doğrulama cevabında dönen
bilgilerin doğru kaynaktan geldiğini anlamak için aşağıda iletilen alanlara
göre hashedData hesaplayarak response’daki bu bilgi ile karşılaştırabilirsiniz.
3D Doğrulamada Tami’nin döndüğü response’da iletilen
“hashedHata” verisi hesaplanırken; doğrulama cevabında Tami’nin ilettiği
“hashParams” alanında iletilen alanlar sıra ile yan yana getirilerek bir data
oluşturulur (hashItems). Oluşan bu datanın sonuna firmaya ait secretKey verisi
eklenir ve sha512 ile hashlenir. Base 64 te encode edilir ve şifrelenmiş
hashedData elde edilir. Örnek kodlar aşağıda verilmiştir.
İşyerleri her zaman 3D Doğrulama
cevabında dönülen hashParams alanındaki alanlara göre hashedData hesabı
yaptığında ileride buraya eklenen ya da çıkarılan bir bilgi olduğunda,
entegrasyonlarında ek bir değişiklik yapması gerekmeyecektir.
NOT: Peşin işlemlerde
“InstallmentCount” bilgisinin 1 olarak gönderilmesi beklenir. Bu bilgi ile
hashedData ya eklenir.
HashedData Verisi Elde Edilirken;
Adım 1) 3D Doğrulama
cevabında dönülen HashParams verisindeki değerler split edilerek “HashItems” elde edilir.
Adım 2) HashParams da istenen bilgilerle oluşturulan data ile (adım1) işyerine ait secretKey verisi sha 512 ile hashlenir. Hashlenen bu veri base64 de encode edilerek “HashedData” elde edilir .
Tami üye işyerleri tarafından gerçekleştirilen başarılı olarak 3d doğrulaması yapılmış işlemlerin tamamlaması için kullanılır. Bu servis çağırılarak 3d tamamlanması yapıldığında karttan belirtilen tutar bloke edilmiş olur. Sonrasında ön otorizasyon kapama yapılarak işlem finansallaştırılmalıdır.
3D'li Ön Otorizasyon İşlemi Tamamlama API Bilgileri
Test ortamında yapılacak çalışmalarda "https://sandbox-paymentapi.tami.com.tr/payment/complete-3ds" url'i kullanılacaktır.
Üretim ortamında yapılacak çalışmalarda ise "https://paymentapi.tami.com.tr/payment/complete-3ds" url'i kullanılacaktır.
3D'li Ön Otorizasyon İşlemi Tamamlama İstek Parametreleri ve Açıklamaları
Alan
Format
Uzunluk
(O)psiyonel
/ (Z)orunlu
Açıklama
orderId
String
(2-36)
Z
3d doğrulaması başarılı tamamlanmış sipariş numarası bilgisi
securityHash
String
Z
Dokumanda belirtilen alanlara göre hesaplanıp iletilmesi beklenen değerdir. Eksik veya hatalı iletilirse işlem bankaya yönlendirilmez, hata verilir.
3D'li Ön Otorizasyon İşlemi Tamamlama API İstek Örneği
3D'li Satış İşlemi Tamamlama İstek Cevabı Parametreleri ve Açıklamaları
Parametre Adı
Format
Açıklama
errorCode
String
Hata kodu
errorMessage
String
Hata mesajı
success
String
True dönmesi durumunda satış başarılı, false dönmesi durumunda hata alınmıştır. Hata detayı error code ve error message alanlarında paylaşılır
systemTime
dateTime
İşlem tarihi
correlationId
String
İşlem numarası
orderId
String
Sipariş numarası
amount
Number
İşlem tutarı
currency
String
İşlem para
birimi
installmentCount
Number
İşlem taksit
sayısı
card/binNumber
String
Kartın ilk 8 hanesi
card/maskedNumber
String
Maskeli kart numarası
card/cardBrand
String
Kart markası
card/cardOrganization
String
Kart organizasyonu
card/cardType
String
Kart tipi
securityHash
String
İşlemin sonucunun doğru kaynaktan geldiğini belirlemek için kullanılacak değerdir. Dokumanda nasıl hesaplanması gerektiği belirtilmiştir.
bankAuthCode
String
Banka Onay Kodu
bankReferenceNumber
String
İşleme ait Retref numarası
errorGroup
String
İlgili hatanın grubunu gösterir. İşyerleri hata kodu ve hata gruplarından faydalanarak kendi tarafındaki kuralları yönetebilir.
transactionDate
DateTime
Satış işleminin gerçekleşme zamanının bilgisidir.
POST
Merchant ID
Terminal ID
Secret Key
{\n \"orderId\": \"\"\n}
Hata Oluştu
Başarılı
Security Hash Hesaplama
Yapılacak servis isteklerinde ve gelen servis cevaplarında securityHash alanının hesaplanması için buradaki dokümantasyondan yararlanabilirsin.
Kod Örnekleri
Aşağıda, çeşitli yazılım dilleri kullanılarak yazılmış özel kod örneklerinin linkleri verilmiştir. Tercih ettiğiniz programlama diline ait link üzerinden, önceden belirlenmiş değerlerle yazılmış olan kodları detaylı bir şekilde inceleyebilirsin.
Bu örnekler, ilgili işlem tipini içeren kodları içermektedir ve farklı dillerde yazıldığı için çeşitli yaklaşımları ve pratikleri de gözlemleyebilirsin. Bu sayede tercih ettiğiniz programlama diline dair daha iyi anlaşılır ve özgün örneklerle çalışma imkanı bulabilirsin.
Unutmayın ki bu örnekler ön tanımlı değerlerle yazılmıştır ve gerçek projelerde kullanımı için gerekli uyarlama ve güvenlik önlemleri alman gerekebilir.