Kart Ödeme Servisi
Tokenization ödeme yöntemi ile kart ödemesi gerçekleştirmek için bu servis kullanılır. "Son Ödeme Bilgisi Alma" servisinden dönen paymentType "CARD_PAYMENT" ise bu ödeme servisi tetiklenmelidir.
Card Payment Service
POST
https://api.iyzipay.com/v1/pay-with-iyzico/third-party-session/checkout/auth
Headers
Content-Type
application/json
Authorization
Authorization
access-token
{{accessToken}}
İstek Parametreleri
sessionToken
String
Evet
Member'ın aynı ödeme tipinde ödeme yaptığı session key bilgisidir.
memberIdentifier
String
Evet
Member unique key bilgisidir. Bu key, ödeme işlemlerinde member bilgisi için kullanılır.
conversationId
String
Hayır
İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.
locale
String
Hayır
iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri tr’dir.
paymentType
String
Evet
Ödemenin yapılacağı türü belirtir. Kart Ödemelerinde "3DS" veya "NON3D" olarak gönderilmelidir.
paidPrice
Decimal
Evet
Tahsil edilecek nihai tutar.
price
Decimal
Evet
Ödeme sepet tutarı. Kırılım tutarlar toplamı, sepet tutarına eşit olmalı.
callbackUrl
String
Evet
Ödeme akışında üye işyerine başarılı ve hatalı sonucu bildirmek üzere alınan URL adresi. Geçerli bir ssl sertifikasına sahip olmalıdır.
paymentGroup
String
Hayır
Ödeme grubu, varsayılan PRODUCT. Geçerli değerler enum içinde sunulmaktadır: PRODUCT, LISTING, SUBSCRIPTION
currency
String
Evet
Para birimi. Default değeri TRY’dir. Kullanılabilen diğer değerler ise USD, EUR, GBP’dir.
basketId
String
Hayır
Üye işyeri sepet id’si.
buyerId
String
Evet
Üye işyeri tarafındaki alıcıya ait id bilgisi.
buyerName
String
Evet
Üye işyeri tarafındaki alıcıya ait ad.
buyerSurname
String
Evet
Üye işyeri tarafındaki alıcıya ait soyadı.
identityNumber
String
Evet
Alıcıya ait TCKN bilgisi.
email
String
Evet
Üye işyeri tarafındaki alıcıya ait e-posta bilgisi. E-posta adresi alıcıya ait geçerli ve erişilebilir bir adres olmalıdır.
gsmNumber
String
Hayır
Üye işyeri tarafındaki alıcıya ait GSM numarası.
registrationAddress
String
Evet
Üye işyeri tarafındaki alıcıya ait kayıt adresi.
city
String
Evet
Üye işyeri tarafındaki alıcıya ait şehir bilgisi.
country
String
Evet
Üye işyeri tarafındaki alıcıya ait ülke bilgisi.
IP
String
Hayır
Üye işyeri tarafındaki alıcıya ait IP adresi.
zipCode
String
Evet
Üye işyeri tarafındaki alıcıya ait posta kodu.
address(shippingAddress)
String
Evet
Üye işyeri tarafındaki teslimat adresi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
contactName(shippingAddress)
String
Evet
Üye işyeri tarafındaki teslimat adresi ad soyad bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
city(shippingAddress)
String
Evet
Üye işyeri tarafındaki teslimat adresi şehir bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
country(shippingAddress)
String
Evet
Üye işyeri tarafındaki teslimat adresi ülke bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
zipCode(shippingAddress)
String
Evet
Üye işyeri tarafındaki teslimat adresi posta kodu.
address(billingAddress)
String
Evet
Alıcıya ait fatura adres bilgisi.
contactName(billingAddress)
String
Evet
Alıcıya ait fatura ad soyad bilgisi.
city(billingAddress)
String
Evet
Alıcıya ait fatura şehir bilgisi.
country(billingAddress)
String
Evet
Alıcıya ait fatura ülke bilgisi.
basketItemId
String
Evet
Üye işyeri tarafındaki sepetteki ürüne ait id. Not: Bir ödeme isteğine maksimum 500 basketItem eklenebilir.
basketItemPrice
String
Evet
Üye işyeri tarafındaki sepetteki ürüne ait tutar. 0 ve 0’dan küçük olamaz, tutarlar toplamı sepet tutarına (price) eşit olmalıdır.
basketItemName
String
Evet
Üye işyeri tarafındaki sepetteki ürüne ait ismi.
basketItemCategory1
String
Evet
Üye işyeri tarafındaki sepetteki ürüne ait 1. kategori.
basketItemCategory2
String
Hayır
Üye işyeri tarafındaki sepetteki ürüne ait 2. kategori.
basketItemItemType
String
Evet
Üye işyeri tarafındaki sepetteki ürüne ait tip. Geçerli enum değerler: PHYSICAL ve VIRTUAL
Örnek 3DS İsteği
Örnek 3DS Yanıtı
3DS Yanıt Parametreleri
status
String
İstek sonucunu döner. success ya da failure değerlerini dönebilir.
locale
String
İstek gönderilen, dilde yanıt dönmektedir.
systemTime
Long
İstek anındaki unix zaman değerini ifade eder.
conversationId
String
İstek esnasında gönderilen değer aynen geri iletilir.
sessionToken
String
Member'ın aynı ödeme tipinde ödeme yaptığı session key bilgisidir.
paymentId
Long
iyzico tarafından üretilen uniq ödeme numarası bilgisidir.
paymentStatus
String
Ödeme durum bilgisidir. SUCCESS ve FAILURE değerini alabilir.
threeDSHtmlContent
String
Banka doğrulama ekranının yer aldığı html sayfasını dönmektedir.
checkoutFormToken
String
İşleme ait checkoutform token değeridir.
signature
String
İmza doğrulaması yapılabilecek signature değeridir.
Örnek NON3D İsteği
NON3D Yanıtı
NON3D Yanıt Parametreleri
status
String
Yapılan isteğin sonucunu bildirir. Başarılı ise success, hatalı ise failure döner.
locale
String
İstekte belirtilen locale değeri geri dönülür, varsayılan değeri tr’dir.
systemTime
Long
Dönen sonucun o anki unix timestamp değeridir.
conversationId
String
İstek esnasında gönderilmişse, sonuçta aynen geri iletilir.
sessionToken
String
Member'ın aynı ödeme tipinde yaptığı ödeme işlemine ait session key bilgisidir.
paymentId
String
Ödemeye ait id, üye işyeri tarafından mutlaka saklanmalıdır. Ödemenin iptali ve iyzico ile iletişimde kullanılır.
paymentStatus
String
Ödeme isteğinin durumunu gösterir. Success ise karttan ilgili tutar çekilmiştir. SUCCESS, FAILURE
callbackUrl
String
İstekte belirtilen ve işlem sonucunda yönlendirilen URL adres bilgisidir.
checkoutToken
String
Checkout form için oluşturulan tekil değer. Her istek için özel üretilir ve işyerine dönülür. Ödemenin sonucunu öğrenmek için zorunlu bir alandır.
price
Decimal
Ödeme sepet tutarı. Kırılım tutarlar toplamı sepet tutarına eşit olmalı.
paidPrice
Decimal
İndirim vade farkı vs. hesaplanmış POS’tan geçen, tahsil edilen, nihai tutar.
installment
Integer
Ödemenin taksit bilgisi, tek çekim için 1 döner. Geçerli değerler: 1, 2, 3, 6, 9, 12
fraudStatus
Integer
Ödeme işleminin fraud filtrelerine göre durumu. Eğer ödemenin fraud risk skoru düşük ise ödemeye anında onay verilir, bu durumda 1 değeri döner. Eğer fraud risk skoru yüksek ise ödeme işlemi reddedilir ve -1 döner. Eğer ödeme işlemi daha sonradan incelenip karar verilecekse 0 döner. Geçerli değerler: 0, -1 ve 1. Üye işyeri sadece 1 olan işlemlerde ürünü kargoya vermelidir, 0 olan işlemler için bilgilendirme beklemelidir.
merchantCommissionRate
Decimal
Üye işyerinin uyguladığı vade/komisyon oranı. Örneğin price=100, paidPrice=110 ise üye işyeri vade/komisyon oranı %10’dur. Bilgi amaçlıdır.
merchantCommissionRateAmount
Decimal
Üye işyerinin uyguladığı vade/komisyon tutarı. Örneğin price=100, paidPrice=110 ise üye işyeri vade/komisyon tutarı 10’dur. Bilgi amaçlıdır.
iyziCommissionRateAmount
Decimal
Ödemeye ait iyzico işlem komisyon tutarı.
iyziCommissionFee
Decimal
Ödemeye ait iyzico işlem ücreti .
basketId
String
Üye işyeri tarafından gönderilen sepet id’si.
currency
String
Ödemenin yapıldığı para birimi.
errorCode
String
İşlem hatalıysa, bu hataya dair belirtilen koddur.
errorMessage
String
İşlem hatalıysa, bu hataya dair belirtilen mesajdır, locale parametresine göre dil desteği sunar.
errorGroup
String
İşlem hatalıysa, bu hataya dair belirtilen gruptur.
currency
String
Ödemenin alındığı para birimi.
itemId (ItemTransactions)
String
Üye işyeri tarafından iletilen, sepetteki ürüne ait id.
transactionStatus (ItemTransactions)
Integer
Ödeme kırılımının durumu. Ödeme fraud kontrolünde ise 0 değeri döner, bu durumda fraudStatus değeri de 0’dır. Ödeme, fraud kontrolünden sonra reddedilirse -1 döner. Pazaryeri modelinde ürüne onay verilene dek bu değer 1 olarak döner. Pazaryeri modelinde ürüne onay verilmişse bu değer 2 olur. Geçerli değerler: 0, -1, 1, 2.
paymentTransactionId (ItemTransactions)
String
Ödeme kırılımına ait id, üye işyeri tarafından mutlaka saklanmalıdır. Ödeme kırılımının iadesi, onayı, onay geri çekmesi ve iyzico ile iletişimde kullanılır. Tercihen itemId ile ilişkili bir şekilde tutulmalıdır.
price (ItemTransactions)
Decimal
Üye işyeri tarafındaki sepetteki ürüne ait tutar.
paidPrice (ItemTransactions)
Decimal
Tahsilat tutarının kırılım bazındaki dağılımı. Üye işyeri tarafından mutlaka saklanmalıdır.
merchantCommissionRate (ItemTransactions)
Decimal
Üye işyerinin uyguladığı vade/komisyon oranının kırılım bazında dağılmış oranı.
merchantCommissionRateAmount (ItemTransactions)
Decimal
Üye işyerinin uyguladığı vade/komisyon tutarıın, kırılım bazında dağılmış tutarı.
iyziCommissionRateAmount (ItemTransactions)
Decimal
iyzico işlem komisyon tutarının kırılım bazında dağılmış tutarı.
iyziCommissionFee (ItemTransactions)
Decimal
iyzico işlem ücretinin kırılım bazında dağılmış tutarı.
blockageRate (ItemTransactions)
Decimal
Kırılım bazında üye işyeri blokaj oranı. iyzico – üye işyeri anlaşmasına göre, üye işyerine işlem bazında blokaj uygulayabilir. Bu blokaj üye işyeri fraud riskini önlemek içindir, blokaj süresi boyunca para iyzico’da tutulur, bu süre sonrasında üye işyerine gönderilir.
blockageRateAmountMerchant (ItemTransactions)
Decimal
Kırılım bazında üye işyeri blokaj tutarının, üye işyerine yansıyan rakamı. Blokaj tutarı mümkün olduğunca üye işyerine yansıtılır. Eğer blokaj tutarı, üye işyeri tutarından daha büyükse bu durumda alt üye işyerine de yansıtılır.
blockageResolvedDate (ItemTransactions)
String
İşlem bazında blokaj çözülme tarihi. yyyy-MM-dd HH:mm:ss formatındadır, örneğin 2015-10-19 14:36:52.
merchantPayoutAmount (ItemTransactions)
Decimal
Bu kırılım için, iyzico işlem ücreti, komisyon tutarı ve blokajlar düşüldükten sonra üye işyerine gönderilecek tutar.
paidPrice(convertedPayout)
Decimal
Tahsilat tutarının kırılım bazındaki dağılımı. Üye işyeri tarafından mutlaka saklanmalıdır.
iyziCommissionRateAmount (convertedPayout)
Decimal
iyzico işlem komisyon tutarının kırılım bazında dağılmış tutarı.
iyziCommissionFee (convertedPayout)
Decimal
iyzico işlem ücretinin kırılım bazında dağılmış tutarı.
blockageRateAmountMerchant (convertedPayout)
Decimal
Kırılım bazında üye işyeri blokaj tutarının, üye işyerine yansıyan rakamı. Blokaj tutarı mümkün olduğunca üye işyerine yansıtılır. Eğer blokaj tutarı, üye işyeri tutarından daha büyükse bu durumda alt üye işyerine de yansıtılır.
merchantPayoutAmount (convertedPayout)
Decimal
Bu kırılım için, iyzico işlem ücreti, komisyon tutarı ve blokajlar düşüldükten sonra üye işyerine gönderilecek tutar.
iyziConversationRate (convertedPayout)
Decimal
Bu kırılım için, iyzico işlem ücreti, komisyon tutarı ve blokajlar düşüldükten sonra üye işyerine gönderilecek tutar.
iyziConversationRateAmount (convertedPayout)
Decimal
Bu kırılım için, iyzico işlem ücreti, komisyon tutarı ve blokajlar düşüldükten sonra üye işyerine gönderilecek tutar.
currency (convertedPayout)
String
Ödemenin alındığı para birimi.
authCode
String
iyzico tarafından üretilen uniq değer.
phase
String
Ödeme fazı bilgisi. AUTH değerini alır.
signature
String
İmza doğrulaması için kullanılabilecek signature değeridir.
cardType
String
Sadece kartlı ödemelerde döner. Eğer ödeme yapılan kart yerel bir kart ise, kart tipi bilgisini döner. DEBIT_CARD ve CREDIT_CARD değerlerini alır.
cardAssociation
String
Sadece kartlı ödemelerde döner. Eğer ödeme yapılan kart yerel bir kart ise, kartın ait olduğu kuruluş. Geçerli değerler: VISA, MASTER_CARD, AMERICAN_EXPRESS, TROY
cardFamily
String
Sadece kartlı ödemelerde döner. Eğer ödeme yapılan kart yerel bir kart ise, kartın ait olduğu aile. Geçerli değerler: Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage
binNumber
String
Ödeme yapılan kartın ilk 6 hanesi.
lastFourDigits
String
Ödeme yapılan kartın son 4 hanesi.
Last updated