Hata Grupları

Craftgate API, bir işlem ya da sorgu yürütülürken sistemsel ya da kurgusal bir hata oluşması durumunda belli formatta bir cevap döner. API dokümantasyonu giriş sayfasındaki Hatalı İşlemler bölümünde de belirtildiği üzere bu gibi durumlarda dönecek cevap içerisinde yalnızca errors isimli bir alan yer alır. Oluşan hataya ilişkin detayları içeren bu objenin parametreleri aşağıdaki gibidir:

Bir hata durumunda üye işyerleri kendi taraflarındaki iş kurallarını yürütmek ve/veya kullanıcıya göre yerelleştirilmiş hata mesajları gösterebilmek için errorCode ve errorGroup alanlarından faydalanabilir.

Önemli Not: Ödeme ile ilgili hatalar için mutlak suretle errorGroup alanını kullanınız.

Örnek 1 Kredi kartı limiti yetersiz hatası alınan bir ödeme denemesi için dönülen hata:

{
    "errors": {
        "errorCode": "10051",
        "errorDescription": "Kart limiti yetersiz, yetersiz bakiye",
        "errorGroup": "NOT_SUFFICIENT_FUNDS"
    }
}

Örnek 2 Girilen kart bilgilerindeki son kullanım tarihi alanının hatalı olduğu durumda dönülen hata:

{
    "errors": {
        "errorCode": "4152",
        "errorDescription": "Kart son kullanma yılı \"2010\" geçersiz"
    }
}

Hata Grupları

Craftgate tarafından dönen hatalardan, hata kodu 10000den büyük olanlar ödeme hataları, 10000den küçük olanlar validasyon hatalarıdır.

Validasyon Hataları (Entegrasyon Kaynaklı)

Craftgate API, ödeme alma, iptal/iade uygulama gibi işlemlerde, banka ya da ödeme kuruluşu ile iletişim kurmadan önce, üye işyeri tarafından iletilmiş olan istek parametrelerini çeşitli kontrollerden geçirir. Bu kontroller esnasında, hatalı biçimlendirilmiş ya da iş kurallarına uygun olmayan bir parametre tespit edildiğinde (hatalı kart numarası, geçmiş tarihli son kullanım tarihi, eksik ödeme bilgisi, vb.) istek validasyon hatası olarak işaretlenir ve bir hata mesajı döner. Bu tür hatalar, hata kodları 10000den küçük hatalardır. Bu hataların error group değeri dönülmez.

Ödeme başarım oranlarınızı olabildiğince yüksek tutabilmeniz için canlıya geçiş yapmadan önce bu gibi hataları önceden tespit edip, sistemlerinizi bu hatalarla karşılaşmayacak şekilde kurgulamanız önerilir. Entegrasyon başarılı bir biçimde tamamlanmışsa canlı ortamda hiç görülmemesi beklenir. Ancak olası entegrasyon sorunlarının kullanıcının önüne düşmemesi için, Craftgate ile entegre olan üye işyerleri, 10000den küçük hata kodlarına sahip hataları yakalamalı ve kullanıcıya yansıtmamalıdır.

Ödeme Hataları (Ödeme Kaynaklı)

Ödemeye ilişkin hatalar, errorGroup değerleri ve açıklamaları ile aşağıdaki tabloda listelenmiştir. Bu hata grupları bankalardan ve ödeme ve e-para kuruluşlarından Craftgate'e dönen hata mesajlarına uygun olarak tasarlanmıştır. Burada listelenen her bir hata grubu 10xxx formatında bir koda (errorCode) sahiptir.