Ödeme ve Session Sorgulama
Member'ın session kapsamında yaptığı ödemelerin detayını döner. iyzico ile Öde (PWI) ile session başlatan ödeme bu kapsamdadır.
Ödeme ve Session Sorgulama
POST https://api.iyzipay.com/v1/pay-with-iyzico/third-party-session/retrieve/payment
Headers
Content-Type
application/json
Authorization
Authorization
İstek Parametreleri
checkoutFormToken
string
Evet
Yapılan işleme ait token değeri.
locale
string
Hayır
İstek için gönderilen dil değeri. EN ve TR değerini alabilir.
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.
Örnek İstek
{
"checkoutFormToken": "{{checkoutToken}}",
"locale": "tr",
"conversationId": "conversationId"
}Örnek Yanıt
{
"status": "success",
"locale": "tr",
"systemTime": 1749032413350,
"conversationId": "conversationId",
"token": "e54b957b-a153-410c-8761-79c9bd4ff44f",
"callbackUrl": "https://merchant-callback.com",
"paymentStatus": "SUCCESS",
"price": 1.00000000,
"paidPrice": 1.00000000,
"installment": 1,
"paymentId": "24259238",
"memberEmail": "[email protected]",
"memberGsmNumber": "+905555555555",
"merchantCommissionRate": 0E-8,
"merchantCommissionRateAmount": 0E-8,
"iyziCommissionRateAmount": 0.01750000,
"iyziCommissionFee": 0E-8,
"cardType": "CREDIT_CARD",
"cardAssociation": "MASTER_CARD",
"cardFamily": "Advantage",
"binNumber": "550472",
"lastFourDigits": "0003",
"basketId": "B67832",
"currency": "TRY",
"itemTransactions": [
{
"itemId": "BI101",
"paymentTransactionId": "26268394",
"transactionStatus": 2,
"price": 1.00000000,
"paidPrice": 1.00000000,
"merchantCommissionRate": 0E-8,
"merchantCommissionRateAmount": 0E-8,
"iyziCommissionRateAmount": 0.01750000,
"iyziCommissionFee": 0E-8,
"blockageRate": 0E-8,
"blockageRateAmountMerchant": 0E-8,
"blockageRateAmountSubMerchant": 0E-8,
"blockageResolvedDate": "2025-06-05 00:00:00",
"subMerchantPrice": 0E-8,
"subMerchantPayoutRate": 0E-8,
"subMerchantPayoutAmount": 0E-8,
"merchantPayoutAmount": 0.98250000,
"convertedPayout": {
"paidPrice": 1.00000000,
"iyziCommissionRateAmount": 0.01750000,
"iyziCommissionFee": 0E-8,
"blockageRateAmountMerchant": 0E-8,
"blockageRateAmountSubMerchant": 0E-8,
"subMerchantPayoutAmount": 0E-8,
"merchantPayoutAmount": 0.98250000,
"iyziConversionRate": 0E-8,
"iyziConversionRateAmount": 0E-8,
"currency": "TRY"
}
}
],
"authCode": "054626",
"phase": "AUTH",
"hostReference": "mock00034iyzihostrfn",
"signature": "a77fac0a954181b9816bac2d0ba55047d2bfb1934d8efaa6de39b93b91bc9d6c",
"sessionInfo": {
"sessionToken": "f403ef2f-fb08-4111-afd6-495811ef6b25",
"sessionStatus": "ACTIVE",
"memberIdentifier": "f1409923-57cb-468f-8df2-704ea02075e3",
"paymentType": "CARD_PAYMENT"
}
}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.
token
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.
paymentStatus
String
Ödeme isteğinin durumunu gösterir. Success ise karttan ilgili tutar çekilmiştir. SUCCESS, FAILURE
memberEmail
String
İşlem yapan member'ın email bilgisi
memberGsmNumber
String
İşlem yapan member'ın gsm number bilgisi
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
paymentId
String
Ödemeye ait id, üye işyeri tarafından mutlaka saklanmalıdır. Ödemenin iptali ve iyzico ile iletişimde kullanılır.
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.
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.
mdStatus
String
Bankadan dönen değerdir. Sadece ödeme başarısız ise ve işlem 3ds ile yapılmışsa bu değer döner. 0,2,3,4,5,6,7 değerlerini alabilir. 3D İşlemi Başarılı ise 1 değerini alır.
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.
sessionToken(sessionInfo)
String
Member'ın aynı ödeme tipinde yaptığı ödeme işlemine ait session key bilgisidir.
sessionStatus(sessionInfo)
String
Kullanıcıya ait session durumudur. ACTIVE veya PASSIVE değerlerini alır.
memberIdentifier(sessionInfo)
String
Member unique key bilgisidir. Bu key, ödeme işlemlerinde member bilgisi için kullanılır.
paymentType(sessionInfo)
String
Ödeme tipini belirtir. FUND veya CARD_PAYMENT değerlerini dönebilir. FUND: Bakiye Ödemesi CARD_PAYMENT: Kart Ödemesi
callbackUrl
String
İstekte belirtilen ve işlem sonucunda yönlendirilen URL adres bilgisidir.
Last updated