Ödeme Oluşturma
Ödeme Oluşturma API’si müşterinin kart ödemelerinin işlenmesinden sorumludur. Bu hizmet kullanıldığında iyzico işlemin başarısına ilişkin anında yanıt verir.
TROY, MASTERCARD, VISA ve AMEX markalı kartlarla yapılan işlemleri destekler.
BONUS, WORLD, MAXIMUM, AXESS, CARDFINANS, PARAF, ADVANTAGE gibi taksit programlarına katılmış olan kartlara 2, 3, 6, 9 ve 12 taksit seçenekleri sunulmaktadır.
Panelde başarılı işlemler yeşil renkte, başarısız işlemler ise kırmızı renkte görüntülenir.
Üye iş yeri, conversationId ve basketId parametrelerini kendi tarafında sipariş numarası olarak kullanabilir.
Bu özellikleri birleştirerek müşterilerinize, işlemlerinin başarısı veya başarısızlığı hakkında gerçek zamanlı geri bildirim sağlayarak kusursuz bir ödeme deneyimi sağlayabilirsiniz.
NON-3DS Ödeme Oluşturma
POST
https://api.iyzipay.com/payment/auth
Request Body
locale
String
iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri tr’dir. en olarak kullanılabilir.
conversationId
String
İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir. En yaygın kullanış biçimi üye iş yerinin sipariş numarasıdır.
price*
Decimal
Ödeme sepet tutarı. Kırılım (sepetin içerisindeki ürünler) tutarlar toplamı sepet tutarına eşit olmalı.
paidPrice*
Decimal
İndirim vade farkı vs. hesaplanmış POS’tan geçecek nihai tutar. Price değerinden küçük, büyük veya eşit olabilir.
expireMonth*
String
Ödemenin alınacağı kartın son kullanma tarihi ayı. Eğer saklı kart ile ödeme yapılmıyorsa zorunludur.
cardNumber*
String
Ödemenin alınacağı kart numarası. Eğer saklı kart ile ödeme yapılmıyorsa zorunludur.
paymentGroup
String
Ödeme grubu, varsayılan PRODUCT. Geçerli değerler enum içinde sunulmaktadır: PRODUCT, LISTING, SUBSCRIPTION, OTHER.
paymentChannel
String
Ödeme kanalı. Geçerli değerler enum içinde sunulmaktadır: WEB, MOBILE, MOBILE_WEB, MOBILE_IOS, MOBILE_ANDROID, MOBILE_WINDOWS, MOBILE_TABLET, MOBILE_PHONE
basketId
String
Üye işyeri tarafından ilgili ödemenin sepetini tanımlamak için kullanılan id'dir. Sipariş numarası ya da anlamlı bir değer olabilir.
installment*
Integer
Taksit bilgisi, tek çekim için 1 gönderilmelidir. Geçerli değerler: 1, 2, 3, 6, 9, 12
expireYear*
String
Ödemenin alınacağı kartın son kullanma tarihi yılı. Eğer saklı kart ile ödeme yapılmıyorsa zorunludur.
currency*
String
Ödemenin alınacağı para birimi default TL olarak belirlenmiştir. Diğer değerler ise USD, EUR, GBP olmak üzere, farklı para birimleri ile alışverişin hesabınıza tanımlandığından emin olunuz.
address(BillingAddress)*
String
Üye işyeri tarafındaki fatura adresi.
country(BillingAddress)*
String
Üye işyeri tarafındaki fatura adresi ülke bilgisi.
city(BillingAddress)*
String
Üye işyeri tarafındaki fatura adresi şehir bilgisi.
contactName(BillingAddress)*
String
Üye işyeri tarafındaki fatura adresi, ad soyad bilgisi.
lastLoginDate(Buyer)
String
Üye işyeri tarafındaki alıcıya ait son giriş tarihi. Tarih formatı 2015-09-17 23:45:06 şeklinde olmalıdır.
registrationDate(Buyer)
String
Üye işyeri tarafındaki alıcıya ait kayıt tarihi. Tarih formatı 2015-09-17 23:45:06 şeklinde olmalıdır.
zipCode(Buyer)
String
Üye işyeri tarafındaki alıcıya ait posta kodu.
registrationAddress(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait kayıt adresi.
ip(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait IP adresi.
gsmNumber(Buyer)
String
Üye işyeri tarafındaki alıcıya ait GSM numarası.
email(Buyer)*
String
Ü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.
country(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait ülke bilgisi.
city(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait şehir bilgisi.
identityNumber(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait kimlik (TCKN) numarası.
surname(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait soyad.
name(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait ad.
id(Buyer)*
String
Üye işyeri tarafındaki alıcıya ait id.
registerCard
Integer
Ödeme esnasında kartın kaydedilip kaydedilmeyeceğini belirleyen parametre. Varsayılan değeri 0 olup, geçerli değerler 0 ve 1’dir.
cardHolderName*
String
Ödemenin alınacağı kart sahibinin adı soyadı. Eğer saklı kart ile ödeme yapılmıyorsa zorunludur.
cvc*
String
Ödemenin alınacağı kartın güvenlik kodu. Eğer saklı kart ile ödeme yapılmıyorsa zorunludur. Saklı kartla ödeme yapılırken gönderilirse aynen bankaya iletilir.
price(BasketItems)*
Decimal
Ü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.
category2(BasketItems)
String
Üye işyeri tarafındaki sepetteki ürüne ait kategori 2.
category1(BasketItems)*
String
Üye işyeri tarafındaki sepetteki ürüne ait kategori 1.
name(BasketItems)*
String
Üye işyeri tarafındaki sepetteki ürüne ait isim.
itemType(BasketItems)*
String
Üye işyeri tarafındaki sepetteki ürüne ait tip. Geçerli enum değerler: PHYSICAL ve VIRTUAL.
id(BasketItems)*
String
Üye işyeri tarafındaki sepetteki ürüne ait id. Not: Bir ödeme isteğine maksimum 500 basketItem eklenebilir.
zipCode(ShippingAddress)
String
Üye işyeri tarafındaki teslimat adresi posta kodu.
address(ShippingAddress)*
String
Üye işyeri tarafındaki teslimat adresi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
country(ShippingAddress)*
String
Üye işyeri tarafındaki teslimat adresi ülke bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
city(ShippingAddress)*
String
Üye işyeri tarafındaki teslimat adresi şehir bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
contactName(ShippingAddress)*
String
Üye işyeri tarafındaki teslimat adresi, ad soyad bilgisi. Sepetteki ürünlerden en az 1 tanesi fiziksel ürün (itemType=PHYSICAL) ise zorunludur.
zipCode(BillingAddress)
String
Üye işyeri tarafındaki fatura adresi posta kodu.
Ödeme Oluşturma'dan Dönen Parametreler
status
String
Yapılan isteğin sonucunu bildirir. İşlem başarılı ise success, hatalı ise failure döner.
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.
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.
paymentId
String
Ödemeye ait id, üye işyeri tarafından mutlaka saklanmalıdır. Ödemenin iptali ve iyzico ile iletişimde kullanılı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.
currency
String
Ödemenin alındığı para birimi.
installment
Integer
Ödemenin taksit bilgisi, tek çekim için 1 döner. Geçerli değerler: 1, 2, 3, 6, 9, 12.
paymentStatus
String
İşlemin sonucunu gösterir. Geçerli değerler SUCCESS, FAILURE, INIT_THREEDS, CALLBACK_THREEDS, BKM_POS_SELECTED, CALLBACK_PECCO
basketId
String
Üye işyeri tarafından gönderilen sepet id’si.
binNumber
String
Ödeme yapılan kartın ilk 6 hanesi.
cardAssociation
String
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
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
cardType
String
Eğer ödeme yapılan kart yerel bir kart ise, kartın ait olduğu tipi. Geçerli değerler: CREDIT_CARD, DEBIT_CARD, PREPAID_CARD
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.
iyziCommissionFee
Decimal
Ödemeye ait iyzico işlem ücreti.
iyziCommissionRateAmount
Decimal
Ödemeye ait iyzico işlem komisyon tutarı.
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.
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.
itemId(ItemTransactions)
String
Üye işyeri tarafından iletilen, sepetteki ürüne ait id.
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.
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.
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.
iyziCommissionFee(ItemTransactions)
Decimal
iyzico işlem ücretinin 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ı.
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ı.
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(ItemTransactions)(convertedPayout)
Decimal
Tahsilat tutarının kırılım bazındaki dağılımı. Üye işyeri tarafından mutlaka saklanmalıdır.
iyziCommissionFee(ItemTransactions)(convertedPayout)
Decimal
iyzico işlem ücretinin kırılım bazında dağılmış tutarı.
iyziCommissionRateAmount(ItemTransactions)(convertedPayout)
Decimal
iyzico işlem komisyon tutarının kırılım bazında dağılmış tutarı.
blockageRateAmountMerchant(ItemTransactions)(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(ItemTransactions)(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(ItemTransactions)(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(ItemTransactions)(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(ItemTransactions)(convertedPayout)
String
Ödemenin alındığı para birimi.
Son olarak aşağıdaki başlıkları analiz ederek, ödeme sorgusunun sonucunu etkili bir şekilde yönetebilir ve yanıtlayabilirsiniz, böylece müşterileriniz için sorunsuz ve güvenilir bir ödeme süreci sağlayabilirsiniz.
status
parametresi işlemin durumu hakkında bilgi sağlar.success
, işlemin başarıyla tamamlandığını ve ödemenin işlendiğini gösterir.failure
, işlemin başarısız olduğunu belirtir ve başarısızlığın nedenine ilişkin bir hata mesajı verilir.Bu hizmet için
paymentStatus
parametresi boştur.paymentId
vepaymentTransactionId
değerleri, ileride referans noktası olarak kullanılabileceği için saklanmalıdır.Başarısız bir işlem durumunda (
failure
durumu),errorCode
,errorMessage
veerrorGroup
parametreleri, hatayla ilgili ayrıntıları sağlayarak ilgili değerlerle birlikte döndürülür.
Last updated