Ödeme Sorgulama

iyzico'da kaydı oluşturulan bir işlemin detayları daha sonra sorgulanabilir. Bunun için ödeme sorgulama servisi kullanılabilir.

Servise gönderilmesi gereken parametreler şu şekildedir:

iyzico Ödeme Sorgulama

POST https://api.iyzipay.com/payment/detail

Request Body

NameTypeDescription

ip

string

İşlemin gönderildiği ip adresi.

paymentId*

string

iyzico tarafından işleme verilen benzersiz ödeme numarası. İstek esnasında paymentId veya paymentConversationId parametrelerinden birinin gönderilmesi zorunludur.

locale

string

iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri tr’dir.

conversationId

string

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.

paymentConversationId*

string

Üye işyeri tarafından işleme verilen benzersiz sipariş numarası. İstek esnasında paymentId veya paymentConversationId parametrelerinden birinin gönderilmesi zorunludur.

{
    "status": "success",
    "locale": "tr",
    "systemTime": 1698048416625,
    "conversationId": "123456789",
    "price": 1.00000000,
    "paidPrice": 1.00000000,
    "installment": 1,
    "paymentId": "20885695",
    "fraudStatus": 1,
    "merchantCommissionRate": 0E-8,
    "merchantCommissionRateAmount": 0E-8,
    "iyziCommissionRateAmount": 0.04000000,
    "iyziCommissionFee": 0.25000000,
    "cardType": "CREDIT_CARD",
    "cardAssociation": "MASTER_CARD",
    "cardFamily": "Axess",
    "binNumber": "552608",
    "lastFourDigits": "0006",
    "basketId": "f3edeaa6-766c-4139-a66b-69ed08517258",
    "currency": "TRY",
    "itemTransactions": [
        {
            "itemId": "7ab0ee59-18b4-4e30-9ca8-04197bb34127",
            "paymentTransactionId": "22599895",
            "transactionStatus": 2,
            "price": 1.00000000,
            "paidPrice": 1.00000000,
            "merchantCommissionRate": 0E-8,
            "merchantCommissionRateAmount": 0E-8,
            "iyziCommissionRateAmount": 0.04000000,
            "iyziCommissionFee": 0.25000000,
            "blockageRate": 0E-8,
            "blockageRateAmountMerchant": 0E-8,
            "blockageRateAmountSubMerchant": 0E-8,
            "blockageResolvedDate": "2023-10-28 00:00:00",
            "subMerchantPrice": 0E-8,
            "subMerchantPayoutRate": 0E-8,
            "subMerchantPayoutAmount": 0E-8,
            "merchantPayoutAmount": 0.71000000,
            "convertedPayout": {
                "paidPrice": 1.00000000,
                "iyziCommissionRateAmount": 0.04000000,
                "iyziCommissionFee": 0.25000000,
                "blockageRateAmountMerchant": 0E-8,
                "blockageRateAmountSubMerchant": 0E-8,
                "subMerchantPayoutAmount": 0E-8,
                "merchantPayoutAmount": 0.71000000,
                "iyziConversionRate": 0E-8,
                "iyziConversionRateAmount": 0E-8,
                "currency": "TRY"
            }
        }
    ],
    "authCode": "514687",
    "phase": "AUTH",
    "hostReference": "mock00007iyzihostrfn",
    "paymentStatus": "SUCCESS"
}

Ödeme Sorgulama'dan Dönen Yanıt

{
    "status": "success",
    "locale": "tr",
    "systemTime": 1698048416625,
    "conversationId": "123456789",
    "price": 1.00000000,
    "paidPrice": 1.00000000,
    "installment": 1,
    "paymentId": "20885695",
    "fraudStatus": 1,
    "merchantCommissionRate": 0E-8,
    "merchantCommissionRateAmount": 0E-8,
    "iyziCommissionRateAmount": 0.04000000,
    "iyziCommissionFee": 0.25000000,
    "cardType": "CREDIT_CARD",
    "cardAssociation": "MASTER_CARD",
    "cardFamily": "Axess",
    "binNumber": "552608",
    "lastFourDigits": "0006",
    "basketId": "f3edeaa6-766c-4139-a66b-69ed08517258",
    "currency": "TRY",
    "itemTransactions": [
        {
            "itemId": "7ab0ee59-18b4-4e30-9ca8-04197bb34127",
            "paymentTransactionId": "22599895",
            "transactionStatus": 2,
            "price": 1.00000000,
            "paidPrice": 1.00000000,
            "merchantCommissionRate": 0E-8,
            "merchantCommissionRateAmount": 0E-8,
            "iyziCommissionRateAmount": 0.04000000,
            "iyziCommissionFee": 0.25000000,
            "blockageRate": 0E-8,
            "blockageRateAmountMerchant": 0E-8,
            "blockageRateAmountSubMerchant": 0E-8,
            "blockageResolvedDate": "2023-10-28 00:00:00",
            "subMerchantPrice": 0E-8,
            "subMerchantPayoutRate": 0E-8,
            "subMerchantPayoutAmount": 0E-8,
            "merchantPayoutAmount": 0.71000000,
            "convertedPayout": {
                "paidPrice": 1.00000000,
                "iyziCommissionRateAmount": 0.04000000,
                "iyziCommissionFee": 0.25000000,
                "blockageRateAmountMerchant": 0E-8,
                "blockageRateAmountSubMerchant": 0E-8,
                "subMerchantPayoutAmount": 0E-8,
                "merchantPayoutAmount": 0.71000000,
                "iyziConversionRate": 0E-8,
                "iyziConversionRateAmount": 0E-8,
                "currency": "TRY"
            }
        }
    ],
    "authCode": "514687",
    "phase": "AUTH",
    "hostReference": "mock00007iyzihostrfn",
    "paymentStatus": "SUCCESS"
}

Ödeme Sorgulama'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.

Last updated