Ödül ve Puan Kullanımı

Craftgate üzerinden ödeme alırken bankaların müşterilerine sunduğu puan, ek taksit, taksit atlatma gibi imkanları sorgulayabilir, ödeme esnasında bu ödülleri kullanabilirsiniz.

Entegrasyon aşamasında ödül sorgulama ve kullanımına ilişkin çeşitli senaryoları test ederken Ödül ve Puan Özellikli Test Kartları sayfasındaki kartları kullanabilirsiniz.

Not: Tamamı cüzdandan tahsil edilen ödemelerde ödül ya da puan kullanılamaz.

Ödül Sorgulama

Ödeme işleminden önce açık ya da saklı kart bilgilerini kullanarak bankanın müşteriye sunduğu ödül ve puanları aşağıdaki gibi sorgulayabilirsiniz.

URL

Ödül ve puan kullanımı ile ödeme başlatmak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /payment/v1/card-loyalties/retrieve

İstek Parametreleri

Ödül/puan sorgulama işlemi için açık ya da saklı kart bilgilerinden birinin gönderilmesi yeterlidir.

Açık Kart Bilgisi ile Sorgulama

Parametre Adı Tipi Zorunlu Açıklama
cardNumber string Evet Kart numarası
expireYear string Evet Kartın son kullanım tarihinin yılı
expireMonth string Evet Kartın son kullanım tarihinin ayı
cvc string Hayır Kart güvenlik kodu. Ödül sorgulama yapılabilecek POS'larınızda CVC'siz işlem özelliği açık değilse bu alanı göndermeniz gerekmektedir

Saklı Kart Bilgisi ile Sorgulama

Parametre Adı Tipi Zorunlu Açıklama
cardUserKey string Evet Kart kullanıcı anahtarı. Craftgate tarafından üretilir ve kart saklama isteği sonrası üye işyerine dönülür. Kişi bazlı özeldir. Örneğin; Alican kişisi cardUserKey ile ifade edilir.
cardToken string Evet Kart anahtarı. Craftgate tarafından üretilir ve kart saklama isteği sonrası üye işyerine dönülür. Kart bazlı özeldir. CardUserKey ile birlikte kullanılır. Örneğin; Alican(cardUserKey) kişisinin Garanti Kredi kartı(cardToken) gibi.

Dönüş Parametreleri

Sorgulama işlemi sonucunda dönen parametreler API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Açıklama
cardBrand string Kartın bağlı olduğu kart ailesi
force3ds boolean Bu kartla yapılacak ödeme işlemi için 3DS zorunluluğu bulunup bulunmadığı bilgisi. Üye işyeri ilgili POS için 3DS'i zorunlu kılmışsa ya da kart bir debit kart ise true döner
pos MerchantPos İletilen ödül ya da puanların sorgulanması için kullanılmış olan POS bilgisi (bkz: Ödeme POS Bilgisi)
loyalties Loyalty[] Sorgulama sonucunda bankadan iletilen ödül ve puanların listesi (bkz: Ödül Detayı)

Ödül Detayı

Müşteriye tanımlı bir ödül için detay bilgisi içerir. Barındırdığı alanlar ödülün tipine göre farklılıklar gösterir.

Parametre Adı Tipi Her Zaman Mevcut Açıklama
type string Evet Ödül tipi (bkz: Ödül Tipleri)
reward Reward Hayır Yalnızca puan tipindeki ödüller için mevcuttur. Müşterinin kullanabileceği puanların kırılımını içerir. (bkz: Puan Bilgisi)
message string Hayır Puan dışındaki tipler için mevcuttur. İlgili tipe ait bankanın sağladığı ödül detayını içerir.
Puan Bilgisi

Müşteriye tanımlı puan bilgisini içerir. Ödeme ekranında bu değerlerin toplamını gösterebilir, ödemeyi gerçekleştirirken kırılımlarını gönderebilirsiniz.

Parametre Adı Tipi Her Zaman Mevcut Açıklama
cardRewardMoney decimal Hayır Müşterinin kartına tanımlı genel kullanım amaçlı puan tutarı. Bu şekilde tanımlanmış bir puan bilgisi yoksa bu alan yer almaz
firmRewardMoney decimal Hayır Müşterinin ilgili üye işyerine özel olarak tanımlanmış puan tutarı. Bu şekilde tanımlanmış bir puan bilgisi yoksa bu alan yer almaz

Ödül Kullanımı

Ödeme işlemi esnasında yalnızca tek bir ödül kullanılabilir. Puan tipindeki ödül kullanımları için genel ve özel puanlar aynı anda kullanılabilir.

Ödül kullanımı için ödeme işlemi esnasında diğer ödeme bilgilerinin yanısıra (bkz: Ödeme Alma), ödül bilgisinin kart bilgileri içerisindeki bir loyalty alanında iletilmesi yeterlidir.

Kullanılacak Ödül Bilgisi

Kullanılmak istenen ödülün detaylarını içerir. Gönderilmesi gereken alanlar ödülün tipine göre farklılık gösterir

Parametre Adı Tipi Her Zaman Mevcut Açıklama
type string Evet Ödül tipi (bkz: Ödül Tipleri)
reward Reward Hayır Yalnızca puan tipindeki ödüller için iletilmelidir (bkz: Puan Kullanımı Parametreleri)

Puan Kullanımı Parametreleri

Parametre Adı Tipi Zorunlu Açıklama
cardRewardMoney decimal Hayır Müşterinin kartına tanımlı genel kullanım amaçlı puandan kullanılacak tutar. Bu şekilde bir puan kullanımı istenmiyorsa bu alan gönderilmemelidir
firmRewardMoney decimal Hayır Müşterinin ilgili üye işyerine özel olarak tanımlanmış puandan kullanılacak tutar. Bu şekilde bir puan kullanımı istenmiyorsa bu alan gönderilmemelidir

Dönüş Parametreleri

Ödemede kullanılan ödül bilgileri, ödeme işlemi sonucunda dönen diğer bilgilere ek olarak loyalty alanında dönülmektedir. Dönülen bilgiler Ödül Detayı bölümünde belirtilen parametreleri içerir.

Örnek Kodlar

Açık kaynak kodlu Craftgate API client'larındaki örnek kodları inceleyebilirsiniz.

Ödül Sorgulama

Ödemede Ödül Kullanımı