Ana içeriğe geç

Masterpass ile Ödeme Alma

Bu entegrasyon yöntemi, üye işyerinin Masterpass client entegrasyonunu kendi tarafında gerçekleştirip, sunucu tarafında Craftgate üzerinden Masterpass ödemelerinin alınması için kullanılır. Bu sayede üye işyeri Craftgate'in sunmuş olduğu bir çok katma değerleri servislerden faydalanabilir.

Masterpass Token Oluşturulması

Kullanıcı kart ve taksit seçimini tamamladıktan sonra bu servis aracılığıyla Masterpass ödeme işleminde kullanılacak token değeri alınır. Bu token, Masterpass client SDK'sı içindeki MFS.purchase methodu içindeki token alanında kullanılır.

POST/payment/v2/masterpass-payments/generate-token

İstek Parametreleri

Masterpass token oluştururken gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

msisdn
string
zorunlu

Alıcıya ait telefon numarası

userId
string
zorunlu

Son kullanıcının Masterpass hesabı ilişkilendirmesinde kullanılan değer

binNumber
number
zorunlu

Seçilen karta ait ilk 6 veya 8 hane. Masterpass MFS.listCards methodu yanıtında, seçilen karta ait obje içerisindeki Value1 alanından erişilebilir

forceThreeDS
boolean
zorunlu

İşlem 3D secure gerçekleştirilmek isteniyorsa true gönderilmelidir.

createPayment
conversationId
string

İstekle beraber gönderilip, cevapla birlikte alınabilecek, "bumerang" değer. Farklı istekleri birbirleriyle ilişkilendirmek için kullanılabilir. Genellikle üye işyerinin ödemeye ilişkin sipariş numarası kullanılır. Sipariş numarası ile kullanmanız sonradan işlemleri incelemenize yardımcı olacaktır.
Veri içinde güvenlik sorunu yaratabilecek özel karakterler kullanılmamalıdır. Veri + veya - karakteri ile başlayamaz, ancak içerisinde kullanılabilir.

externalId
string

Genellikle üye işyeri tarafındaki, ödemeye ilişkin sipariş numarası veya sepet numarası olarak kullanılır. Daha sonradan sorgulama servislerinde bu id ile sorgulama yapabilirsiniz.
Veri içinde güvenlik sorunu yaratabilecek özel karakterler kullanılmamalıdır. Veri + veya - karakteri ile başlayamaz, ancak içerisinde kullanılabilir.

price
decimal
zorunlu

Toplam ödeme tutarı. Sepetteki ürün/hizmet tutarları toplamının bu tutara eşit olması gerekmektedir

paidPrice
decimal
zorunlu

Komisyon ve indirim gibi farklar dahil edilerek hesaplanan, karttan çekilecek nihai tutar. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir. İşlemde vade farkı var ise vade farkı eklenmiş tutar bu parametreye girilmelidir.

installment
number
zorunlu

Ödemenin tahsil edileceği taksit sayısı. Tek çekim için 1 olarak gönderilebilir.

buyerMemberId
number

Ödemenin ilişkilendirildiği alıcı ID'si. Üye işyerinin kendi sistemlerindeki ID değerini değil, Craftgate sistemlerindeki ID değerini ifade eder

currency
Currency
zorunlu

bkz: Para Birimleri Ödemenin tahsil edileceği para birimi

Değerler:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
paymentGroup
PaymentGroup
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentPhase
PaymentPhase
Değerler:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

Genellikle üye işyeri tarafındaki, ödemenin alındığı kanal veya ödemeye özel bir bilgi tutmak için kullanılır. Daha sonradan sorgulama servislerini kullanarak bu değer ile sorgulama yapabilirsiniz.

bankOrderId
string

Ödeme alınırken bankaya iletilecek orderId parametresi. Opsiyonel olduğu için gönderilmemesi ve orderId değerinin Craftgate tarafından üretilmesi önerilir.

clientIp
string

Ödeme yapan alıcının IP adresi.

posAlias
string

Ödemeyi geçirmek istediğiniz pos'un alias değeri. Ödemenin geçeceği pos'a kendiniz karar verdiyseniz bu parametre ile ilgili posdan ödeme alabilirsiniz.

items
PaymentItem[]
zorunlu

Ödemeye ilişkin kırılım bilgileri. En az bir kırılım gönderilmesi ve gönderilen kırılımların tutarlarının toplamının price alanına eşit olması zorunludur

additionalParams
map<string, object>

Ödemeye ait gönderilmek istenen ek parametreler. bkz: Ödeme Ek Parametreleri

loyalty
Loyalty

Ödeme esnasında kullanılmak istenen ödül bilgileri. Detaylı bilgilere Ödül ve Puan Kullanımı adresinden ulaşabilirsiniz.

Dönüş Parametreleri

Token oluşturma işleminin 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:

referenceId
string

Masterpass ödeme işleminin tamamlanmasında kullanılacak değer

token
string

Masterpass client SDK'sı içerisinde kullanılacak token değeri

orderNo
string

MFS.purchase methodunda kullanılacak orderNo değeri. Eğer bankOrderId parametresi iletilirse, iletilen değer döner. bankOrderId parametresi iletilmezse otomatik olarak oluşturulan bir orderNo değeri döner.

Non3DS Masterpass Ödemesi

Eğer MFS.purchase methodu çağrısı sonrası yanıt içerisinde yer alan responseCode değeri 5001 ise, bu durum Masterpass ödeme işleminin OTP yöntemi ile doğrulanması gerektiğini gösterir. Client tarafında OTP doğrulamasını Masterpass entegrasyonunuz ile tamamladıktan sonra, elde etmiş olduğunuz token değerini aşağıdaki servis aracılığıyla Craftgate'e ileterek ödeme işlemi tamamlanabilir.

POST/payment/v2/masterpass-payments/complete

İstek Parametreleri

Masterpass Non3DS ödeme tamamlanırken gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

referenceId
string
zorunlu

İlgili işlem için token oluşturma yanıtında dönen değer.

token
string
zorunlu

Masterpass tarafından dönen, ödemeyi tamamlamak için kullanılacak olan token değeri

Dönüş Parametreleri

Non3DS ödeme tamamlama işleminin 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:

id
number

Ödemenin ID'si. Bu değer ödeme isteği için Craftgate tarafından belirlenen eşsiz değerdir. Veritabanınızda sipariş bilgileri ile eşleştirip saklamayı unutmayınız.

createdDate
date

Ödemenin gerçekleştirildiği tarih

price
decimal

Ödemenin toplam sepet tutarı

paidPrice
decimal

Müşterinin ödediği toplam tahsilat tutarı. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir

walletPrice
decimal

Cüzdandan tahsil edilen tutar

currency
Currency

Ödemeye ilişkin para birimi. bkz: Para Birimleri

Değerler:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
buyerMemberId
number

Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer

installment
number

Ödemenin taksit sayısı

conversationId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen conversationId değeri

externalId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri

paymentType
PaymentType
Değerler:
CARD_PAYMENT
DEPOSIT_PAYMENT
WALLET_PAYMENT
CARD_AND_WALLET_PAYMENT
BANK_TRANSFER
APM
paymentGroup
PaymentGroup
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentSource
PaymentSource
Değerler:
API
CHECKOUT_FORM
PAY_BY_LINK
paymentStatus
PaymentStatus
Değerler:
FAILURE
SUCCESS
INIT_THREEDS
CALLBACK_THREEDS
WAITING
paymentPhase
PaymentPhase
Değerler:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen paymentChannel değeri

isThreeDS
boolean

Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği

merchantCommissionRate
decimal

Son kullanıcıya yansıtılan vade farkı oranı

merchantCommissionRateAmount
decimal

Son kullanıcıya yansıtılan vade farkı tutarı. paidPrice ile price arasındaki farka eşittir

bankCommissionRate
decimal

Banka komisyon oranı

bankCommissionRateAmount
decimal

Banka komisyon tutarı

cardUserKey
string

Ödeme esnasında kart saklanmak istenmiş ise kart saklanır ve bu alan dolu gelir. Başarılı ödeme sonrası kaydedilen kartın saklı kart kullanıcı anahtarını ifade eder. Üye işyeri tarafından müşteriyle ilişkilendirilerek saklanmalıdır

cardToken
string

Ödeme esnasında kart saklanmak istenmiş ise kart saklanır ve bu alan dolu gelir. Başarılı ödeme sonrası kaydedilen kartın saklı kart anahtarını ifade eder. Üye işyeri tarafından müşteriyle ilişkilendirilerek saklanmalıdır

paidWithStoredCard
boolean

Ödemenin saklı kartla gerçekleştirilip gerçekleştirilmediğini belirtir

binNumber
string

Kartın ilk 8 hanesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir.

lastFourDigits
string

Kartın son 4 hanesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir

cardHolderName
string

Kart sahibinin adı/soyadı

bankCardHolderName
string

Bankada kayıtlı olan kart sahibi adı/soyadı. Bazı durumlarda PF poslarında dönüş null olabilir

authCode
string

Ödemeye ilişkin banka tarafından verilen authCode değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir. Bazı durumlarda PF poslarında dönüş null olabilir

hostReference
string

Ödemeye ilişkin banka tarafından verilen hostReference değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir

transId
string

Ödemeye ilişkin banka tarafından verilen transId değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir. Bazı durumlarda PF poslarında dönüş null olabilir

orderId
string

Ödemeye ilişkin banka tarafından verilen orderId değeri

cardType
CardType

(bkz: Kart Tipleri) Kartın tipini ifade eder. Tamamı cüzdan ile ödenen ödemelerde boş gelir

Değerler:
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
cardAssociation
CardAssociation

Kartı sağlayan kart kuruluşuunu ifade eder. Tamamı cüzdan ile ödenen ödemelerde boş gelir

Değerler:
VISA
MASTER_CARD
AMEX
TROY
JCB
UNION_PAY
MAESTRO
DISCOVER
DINERS_CLUB
cardBrand
string

Ödemenin alındığı kartın ailesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir

requestedPosAlias
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen posAlias değeri

pos
MerchantPos

Ödemenin alındığı pos bilgileri

loyalty
Loyalty

Ödemede kullanılmış olan ödül bilgileri (bkz: Ödül ve Puan Kullanımı)

fraudId
number

Şüpheli işlem olarak belirlenmesi durumunda şüpheli işlem kaydına ait id bilgisi (bkz: Şüpheli İşlem Yönetimi)

fraudAction
FraudAction

Şüpheli işlem olarak belirlenmesi durumunda şüpheli işlem kaydına ait aksiyon bilgisi (bkz: Şüpheli İşlem Aksiyonları)

Değerler:
BLOCK
REVIEW
paymentTransactions
PaymentTransaction[]

Ödeme isteği yapılırken gönderilen kırılım bilgileri ile, ödemenin bu kırılımlar bazındaki fiyatlama ve para gönderimi bilgilerini içerir

additionalData
map<string, map>

Ödeme sonucuna ilişkim ek bilgiler.

3D Secure Masterpass Ödemesi

Eğer MFS.purchase method çağrısı sonrası yanıt içerisinde yer alan responseCode değeri 5010 ise, bu durum Masterpass ödeme işleminin 3D Secure yöntemi ile doğrulanması gerektiğini gösterir. Aşağıda 3D Secure ödeme akışı için ilgili adımlar listelenmiştir.

3D Secure Ödemenin Başlatılması

POST/payment/v2/masterpass-payments/3ds-init

İstek Parametreleri

Masterpass 3DS ödeme başlatma için beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

referenceId
string
zorunlu

İlgili işlem için token oluşturma yanıtında dönen değer.

callbackUrl
string
zorunlu

3D Secure doğrulama sonucunu, üye işyerine iletmek için kullanılacak adres

Dönüş Parametreleri

Masterpass 3DS ödeme başlatma işleminin 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:

returnUrl
string

MFS.purchase yöntemi yanıtında elde edilen url3D alanının sonuna eklenerek kullanıcının yönlendirileceği adres

   window.location = `${purchaseResult.url3D}&returnUrl=${returnUrl}`;

3D Secure Ödemenin Doğrulanması

Kullanıcı, kendisini doğrulaması sonrası 3D Secure Ödeme Başlatma isteğinde belirtilen callbackUrl adresine yönlendirilecektir. Detaylar için bkz.3D Secure Doğrulama

3D Secure Ödemenin Tamamlanması

Bir önceki adımda ilgili kontroller tamamlandıktan sonra, callbackUrl'e iletilen parametreler içerisinde yer alan paymentId değeri ile birlikte aşağıdaki servis aracılığıyla 3D Secure ödeme işlemi tamamlanabilir.

POST/payment/v2/masterpass-payments/3ds-complete

İstek Parametreleri

Masterpass 3DS ödeme tamamlama için beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

paymentId
number
zorunlu

3D Secure Ödemenin Doğrulanması adımında elde edilen paymentId değeri.

Dönüş Parametreleri

Masterpass 3D Secure ödeme tamamlama işleminin 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:

id
number

Ödemenin ID'si. Bu değer ödeme isteği için Craftgate tarafından belirlenen eşsiz değerdir. Veritabanınızda sipariş bilgileri ile eşleştirip saklamayı unutmayınız.

createdDate
date

Ödemenin gerçekleştirildiği tarih

price
decimal

Ödemenin toplam sepet tutarı

paidPrice
decimal

Müşterinin ödediği toplam tahsilat tutarı. Tamamı ya da bir kısmı cüzdandan tahsil edilen ödemelerde cüzdandan tahsil edilecek tutar da bu tutara dahildir

walletPrice
decimal

Cüzdandan tahsil edilen tutar

currency
Currency

Ödemeye ilişkin para birimi. bkz: Para Birimleri

Değerler:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
buyerMemberId
number

Alıcı üyeyle ilişkilendirilmiş ödemelerde yer alan, ilgili üyenin ID'sini belirten değer

installment
number

Ödemenin taksit sayısı

conversationId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen conversationId değeri

externalId
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen externalId değeri

paymentType
PaymentType
Değerler:
CARD_PAYMENT
DEPOSIT_PAYMENT
WALLET_PAYMENT
CARD_AND_WALLET_PAYMENT
BANK_TRANSFER
APM
paymentGroup
PaymentGroup
Değerler:
PRODUCT
LISTING_OR_SUBSCRIPTION
paymentSource
PaymentSource
Değerler:
API
CHECKOUT_FORM
PAY_BY_LINK
paymentStatus
PaymentStatus
Değerler:
FAILURE
SUCCESS
INIT_THREEDS
CALLBACK_THREEDS
WAITING
paymentPhase
PaymentPhase
Değerler:
AUTH
PRE_AUTH
POST_AUTH
paymentChannel
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen paymentChannel değeri

isThreeDS
boolean

Ödemenin 3D Secure ile gerçekleştirilip gerçekleştirilmediği

merchantCommissionRate
decimal

Son kullanıcıya yansıtılan vade farkı oranı

merchantCommissionRateAmount
decimal

Son kullanıcıya yansıtılan vade farkı tutarı. paidPrice ile price arasındaki farka eşittir

bankCommissionRate
decimal

Banka komisyon oranı

bankCommissionRateAmount
decimal

Banka komisyon tutarı

cardUserKey
string

Ödeme esnasında kart saklanmak istenmiş ise kart saklanır ve bu alan dolu gelir. Başarılı ödeme sonrası kaydedilen kartın saklı kart kullanıcı anahtarını ifade eder. Üye işyeri tarafından müşteriyle ilişkilendirilerek saklanmalıdır

cardToken
string

Ödeme esnasında kart saklanmak istenmiş ise kart saklanır ve bu alan dolu gelir. Başarılı ödeme sonrası kaydedilen kartın saklı kart anahtarını ifade eder. Üye işyeri tarafından müşteriyle ilişkilendirilerek saklanmalıdır

paidWithStoredCard
boolean

Ödemenin saklı kartla gerçekleştirilip gerçekleştirilmediğini belirtir

binNumber
string

Kartın ilk 8 hanesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir.

lastFourDigits
string

Kartın son 4 hanesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir

cardHolderName
string

Kart sahibinin adı/soyadı

bankCardHolderName
string

Bankada kayıtlı olan kart sahibi adı/soyadı. Bazı durumlarda PF poslarında dönüş null olabilir

authCode
string

Ödemeye ilişkin banka tarafından verilen authCode değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir. Bazı durumlarda PF poslarında dönüş null olabilir

hostReference
string

Ödemeye ilişkin banka tarafından verilen hostReference değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir

transId
string

Ödemeye ilişkin banka tarafından verilen transId değeri. Tamamı cüzdan ile ödenen ödemelerde boş gelir. Bazı durumlarda PF poslarında dönüş null olabilir

orderId
string

Ödemeye ilişkin banka tarafından verilen orderId değeri

cardType
CardType

(bkz: Kart Tipleri) Kartın tipini ifade eder. Tamamı cüzdan ile ödenen ödemelerde boş gelir

Değerler:
CREDIT_CARD
DEBIT_CARD
PREPAID_CARD
cardAssociation
CardAssociation

Kartı sağlayan kart kuruluşuunu ifade eder. Tamamı cüzdan ile ödenen ödemelerde boş gelir

Değerler:
VISA
MASTER_CARD
AMEX
TROY
JCB
UNION_PAY
MAESTRO
DISCOVER
DINERS_CLUB
cardBrand
string

Ödemenin alındığı kartın ailesini belirtir. Tamamı cüzdan ile ödenen ödemelerde boş gelir

requestedPosAlias
string

Üye işyeri tarafından ödeme isteği içerisinde gönderilen posAlias değeri

pos
MerchantPos

Ödemenin alındığı pos bilgileri

loyalty
Loyalty

Ödemede kullanılmış olan ödül bilgileri (bkz: Ödül ve Puan Kullanımı)

fraudId
number

Şüpheli işlem olarak belirlenmesi durumunda şüpheli işlem kaydına ait id bilgisi (bkz: Şüpheli İşlem Yönetimi)

fraudAction
FraudAction

Şüpheli işlem olarak belirlenmesi durumunda şüpheli işlem kaydına ait aksiyon bilgisi (bkz: Şüpheli İşlem Aksiyonları)

Değerler:
BLOCK
REVIEW
paymentTransactions
PaymentTransaction[]

Ödeme isteği yapılırken gönderilen kırılım bilgileri ile, ödemenin bu kırılımlar bazındaki fiyatlama ve para gönderimi bilgilerini içerir

additionalData
map<string, map>

Ödeme sonucuna ilişkim ek bilgiler.