-
Tami Sanal POS
Tami Sanal POS
İade İşlemi Genel Açıklama
İade işlemi, Tami üzerinden gerçekleştirdiğiniz bir ödemenin tamamını veya bir kısmını iade etmenizi sağlar. İade işlemi için ödemeye ait sipariş numarasını (orderId) ve iade edilmek istenen tutar bilgisini (amount) istenen şekilde şifreleyerek göndermeniz gerekir. Tutar (amount) gönderilmezse, orijinal siparişin tüm tutarı iade edilir.
Tami Test/Prod Portal Bilgileri
Entegrasyonunuzu canlıya almadan önce, gerçek para hareketi oluşturmadan test edebilmeniz için Tami Test Portalı’nı kullanabilirsiniz.
Test Portalı adresi: https://sandbox-portal.tami.com.tr
Test portalına giriş yaparak işlemlerinizi görüntülemek ve gerektiğinde iptal/iade yapmak isterseniz, size özel bir test portalı kullanıcısı tanımlanması gerekir. Bunun için TeknikDestek@tami.com.tr adresinden destek ekibimize ulaşabilirsiniz.
Prod Portalı adresi: https://portal.tami.com.tr
Üretim ortamı bilgileriniz için bu adresten üye olabilir veya e-ticaret destek birimimize başvurabilirsiniz.
Tami Test / Prod Api Kullanıcıları
Tami API’lerini entegre ederken iki farklı ortam kullanılır: Sandbox (Test) ve Prod (Üretim).
- Test (Sandbox) Ortamı
Gerçek para hareketi oluşturmadan entegrasyonunuzu test etmenizi sağlar. İstekleriniz test endpoint’lerine gönderilir ve yukarıdaki Tami Test Portalı üzerinden takip edilebilir.
Sandbox ortamında API üzerinden test işlemi gönderebilmeniz için kullanabileceğiniz bilgiler aşağıdadır:
| Alan | Değer |
|---|---|
| Merchant Number | 77006950 |
| Terminal Number | 84006953 |
| Secret Key | 0edad05a-7ea7-40f1-a80c-d600121ca51b |
- Prod (Üretim) Ortamı
Canlı işlemlerin gerçekleştiği, gerçek ödemelerin alındığı ortamdır.
Üretim ortamı bilgileriniz için https://portal.tami.com.tr üzerinden üye olabilir ya da e-ticaret destek birimimize başvurabilirsiniz.
PG Auth Token Oluşturma
Sanal POS servislerine gönderilen isteklerde, header içerisinde PG-Auth-Token alanının gönderilmesi zorunludur.
PG-Auth-Token, aşağıdaki formatta oluşturulur:
MerchantNumber:TerminalNumber:Hash
Hash değeri; işyerinize ait Merchant numarası, Terminal numarası ve Secret Key bilgilerinin arka arkaya (sırasıyla) birleştirilip SHA-256 algoritmasıyla hashlenmesi ve elde edilen sonucun Base64 formatına çevrilmesiyle oluşturulur.
Aşağıda bu hesaplamayı gösteren örnek bir Java kod bloğu yer almaktadır:
public class SHA256Example {
public static String sha256(Long merchantNumber, Long terminalNumber, String secretKey) {
String text = merchantNumber.toString() + terminalNumber.toString() + secretKey;
try {
MessageDigest digest = MessageDigest.getInstance("SHA-256");
byte[] hash = digest.digest(text.getBytes(StandardCharsets.UTF_8));
String sha256Hex = DatatypeConverter.printBase64Binary(hash);
return sha256Hex;
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
return null;
}
}
}
Oluşturduğunuz Hash değerini, Merchant numarası ve Terminal numarası ile yukarıdaki formatta birleştirerek PG-Auth-Token header değerini oluşturabilirsiniz.
İade İşlemi API Bilgileri
İade işlemi için kullanılacak endpoint bilgileri aşağıdadır:
| Ortam | Endpoint |
|---|---|
| Test (Sandbox) | https://sandbox-paymentapi.tami.com.tr/api/v0/payment/refund |
| Üretim (Prod) | https://paymentapi.tami.com.tr/api/v0/payment/refund |
İsteklerinizi POST metodu ile, çalıştığınız ortama (test/üretim) uygun endpoint’e göndermeniz gerekir.
İade İsteğinin Atılma Yöntemi
İade işlemlerinde gönderilen isteğin gövdesinde (body) değerler açık bir şekilde değil, imzalanarak şifrelenmiş tek bir değerin iletilmesi beklenir. Bu değer, signedRequest alanı ile gönderilir.
Tami tarafından dönen response da aynı şekilde imzalanarak şifrelenmiş olup signedResponse alanı içerisinde iletilir. signedResponse değerinin nasıl çözümleneceğine dair detaylı bilgi aşağıdaki başlıklarda yer almaktadır.
Bunlara ek olarak, header alanında da aşağıdaki bilgilerin gönderilmesi gerekir:
- PG-Auth-Token: Nasıl hesaplanacağı yukarıdaki “PG Auth Token Oluşturma” başlığında anlatılmıştır.
- CorrelationId: Her istek için tekil (unique) olması gereken, değişken bir değerdir.
- PG-Api-Version: v4 olarak iletilmesi gerekir.
İmzalanarak Şifrelenecek Parametreler ve Açıklamaları
İade işleminde istek gövdesi (body) içerisinde değerler açık bir şekilde değil, şifrelenmiş değer signedRequest alanında gönderilir.
signedRequest değeri, aşağıdaki tabloda yer alan alanlardan oluşturulan bir requestin şifrelenmesiyle elde edilir. Zorunlu (Z) olarak işaretlenen alan eksik ya da hatalı gönderilirse işlem hata ile sonuçlanır.
signedRequest içerisine dahil edilecek alanlar ve kuralları aşağıdaki tabloda belirtilmiştir. Kısaltmalar: (O) Opsiyonel, (Z) Zorunlu.
| Alan | Format | Uzunluk | O/Z | Açıklama |
|---|---|---|---|---|
| orderId | String | (2-36) | Z | İade edilmek istenen satış işlemine ait sipariş numarası bilgisidir. |
| amount | Decimal | O | Parçalı iade istekleri için kullanılır. İşlemin tamamı değil, belli bir kısmı iade edilmek istendiğinde gönderilmelidir. Boş gönderilirse orijinal işlemin tutarı esas alınır. Küsurat ayracı nokta (.) ile yapılmalıdır. | |
| reason | String | 150 | O | İade nedeni bilgisidir. |
İstek Token’ı Oluşturma (signedRequest)
İşlem güvenliği açısından, üye işyerleri tarafından iletilen isteklerdeki bilgilerin açık şekilde gönderilmesi tercih edilmez. Bunun yerine, istek gövdesi (body) içerisinde Tami tarafından istenen alanlara göre hazırlanan requestin imzalanıp şifrelenmesiyle oluşan signedRequest değerinin gönderilmesi beklenir.
SignedRequest oluşturma adımlarının ayrıntılı anlatımı ve kod örnekleri için İstek Token’ı Oluşturma (signedRequest) sayfasına bakabilirsiniz.
API İstek Örneği
{
"signedRequest": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU4R0NNIiwiYWxnIjoiZGlyIn0..5LnRGpOvLXkyNbtawbuf.2cgejy-QdeSOZK_J6oCuqjWwaUEqAw7UPJmEiVtGb-q7LNpL-EeZz2LejyIVhdjyaTDvzFkEWotkaRn_FvCc6vmxcceSfjAGNEs4OL8ZnBEejUYArTpfOl5icCUtrbp3rh..."
}
Yukarıdaki signedRequest değeri örnek/test amaçlı kısaltılmıştır. Gerçek bir istek çok daha uzun bir JWE (şifrelenmiş token) değeri içerir.
API İstek Cevabı Örneği
Başarılı işlemde dönen cevap:
{
"signedResponse": "eyJraWQiOiIzNzAzZTQ3MOU0ODlgWspWwWlDoWjIjp7InM1Y3Y4VfYjZ3YWcIiOiI5InZwIiwiYWxnIjoiZGly..."
}
İstek Cevabı Parametreleri ve Açıklamaları
İşlem başarılı olduğunda, Tami tarafından iletilen cevap (response) içerisinde yalnızca signedResponse alanı döner. Aşağıdaki tabloda listelenen diğer tüm alanlar (success, systemTime, correlationId, amount, currency vb.) bu durumda response içerisinde açık olarak yer almaz; bunların tamamı signedResponse alanının içinde şifrelenmiş halde taşınır. Bu alanlara ancak signedResponse değeri çözümlendiğinde (decode edildiğinde) ulaşabilirsiniz. Çözümleme adımları bir sonraki başlıkta anlatılmaktadır.
İşlem başarısız olduğunda ise signedResponse hiç dönmez; bu durumda success, systemTime, correlationId, errorCode, errorMessage ve errorGroup alanları doğrudan açık olarak iletilir.
| Parametre Adı | Format | Nerede Yer Alır | Açıklama |
|---|---|---|---|
| success | String | signedResponse içinde (başarısız işlemde açık) | İşlemin sonucunu bildirir. true ise işlem başarılı, false ise işlem başarısızdır. |
| systemTime | dateTime | signedResponse içinde (başarısız işlemde açık) | Tami tarafından yanıtın oluşturulduğu tarih ve saat bilgisini belirtir. |
| correlationId | String | signedResponse içinde (başarısız işlemde açık) | İade isteğinde üye işyerinin gönderdiği işlem numarası değeridir. |
| transactionDate | dateTime | signedResponse içinde | Başarılı iade edilen işlemin gerçekleştirildiği tarih ve saat bilgisini belirtir. |
| amount | Number | signedResponse içinde | Başarılı iade edilen işlemin tutar bilgisidir. |
| currency | String | signedResponse içinde | Başarılı iade edilen işlemin döviz kodu bilgisidir. |
| errorCode | String | Açık (yalnızca success:false durumunda) | İşlem başarısız olursa iletilir. Hata kodu bilgisini içerir. |
| errorMessage | String | Açık (yalnızca success:false durumunda) | İşlem başarısız olursa iletilir. Hata mesajı bilgisidir. |
| bankAuthCode | String | signedResponse içinde | Banka onay kodu. |
| bankReferenceNumber | String | signedResponse içinde | İşleme ait Retref numarası. |
| errorGroup | String | Açık (yalnızca success:false durumunda) | İlgili hatanın grubunu gösterir. İşyerleri hata kodu ve hata gruplarından faydalanarak kendi tarafındaki kuralları yönetebilir. |
Cevap Token’ı Çözümleme (signedResponse)
signedResponse alanı içerisinde iletilen değerin çözümlenerek yukarıdaki parametrelere erişilmesi için gereken adımlar bu bölümde yer alacaktır.
Çözümleme adımlarının ayrıntılı anlatımı ve kod örnekleri için Cevap Token’ı Çözümleme (signedResponse) sayfasına bakabilirsiniz.
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.
- C# Kod Örnekleri için tıklayınız.
- VB.Net Kod Örnekleri için tıklayınız.
- Java Kod Örnekleri için tıklayınız.
- PHP Kod Örnekleri için tıklayınız.
- NodeJS Kod Örnekleri için tıklayınız.
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.
Hata Kodları
Hata kodları listesine bu sayfadan ulaşabilirsin.
Test Kartları
Test kartları listesine bu sayfadan ulaşabilirsin.
