Ana içeriğe geç

Ö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.

bilgi

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.

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

cardNumber
string
zorunlu

Kart numarası

expireYear
string
zorunlu

Kartın son kullanım tarihinin yılı

expireMonth
string
zorunlu

Kartın son kullanım tarihinin ayı

cvc
string

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

cardUserKey
string
zorunlu

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
zorunlu

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:

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 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 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

type
LoyaltyType
zorunlu
Değerler:
REWARD_MONEY
ADDITIONAL_INSTALLMENT
POSTPONING_INSTALLMENT
EXTRA_POINTS
GAINING_MINUTES
POSTPONING_STATEMENT
reward
Reward

Yalnızca puan tipinde kullanılan ödül bilgisi

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. Bkz: Ödeme Dönüş Parametreleri

Örnek Kodlar

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

Ödül Sorgulama

Loading..

Ödemede Ödül Kullanımı

Loading..