Ö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:

Parametre ismi Tip Zorunluluk Açıklama
ip string evet İşlemin gönderildiği ip adresi.
paymentId string evet iyzico tarafından işleme verilen benzersiz ödeme numarası.
locale string hayır iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri tr’dir.
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.
paymentConversationId string hayır Üye işyeri tarafından işleme verilen benzersiz sipariş numarası.

Servisten dönen parametreler şu şekildedir:

Parametre İsmi Veri Tipi Açıklama
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.

$request = new \Iyzipay\Request\RetrievePaymentRequest();
$request->setLocale(\Iyzipay\Model\Locale::TR);
$request->setConversationId("123456789");
$request->setPaymentId("1");
$request->setPaymentConversationId("123456789");

$payment = \Iyzipay\Model\Payment::retrieve($request, Config::options());
RetrievePaymentRequest request = new RetrievePaymentRequest();
request.Locale = Locale.TR.ToString();
request.ConversationId = "123456789";
request.PaymentId = "1";
request.PaymentConversationId = "123456789";

Payment payment = Payment.Retrieve(request, options);
RetrievePaymentRequest retrievePaymentRequest = new RetrievePaymentRequest();
retrievePaymentRequest.setLocale(Locale.TR.getValue());
retrievePaymentRequest.setConversationId("123456789");
retrievePaymentRequest.setPaymentId("1");
retrievePaymentRequest.setPaymentConversationId("123456789");

Payment payment = Payment.retrieve(retrievePaymentRequest, options);
iyzipay.payment.retrieve({
    locale: Iyzipay.LOCALE.TR,
    conversationId: '123456789',
    paymentId: '1',
    paymentConversationId: '123456789'
}, function (err, result) {
    console.log(err, result);
    done();
})
request = {
    locale: 'tr',
    conversationId: '123456789',
    paymentId: '262',
    paymentConversationId: '123456789'
}
bkm = Iyzipay::Model::Payment.new.retrieve(request, @options)
request = dict([('locale', 'tr')])
request['conversationId'] = '123456789'
request['paymentId'] = '1'
request['paymentConversationId'] = '123456789'

payment_auth = iyzipay.PaymentAuth()
payment_auth_response = payment_auth.retrieve(request, options)
//Request
{
    "locale": "tr",
    "conversationId": "123456789",
    "paymentId": "26130"
}

//Response
{
    "status": "success",
    "locale": "tr",
    "systemTime": 1470730549806,
    "conversationId": "123456789",
    "price": 1,
    "paidPrice": 1.1,
    "installment": 1,
    "paymentId": "26130",
    "fraudStatus": 1,
    "merchantCommissionRate": 10,
    "merchantCommissionRateAmount": 0.1,
    "iyziCommissionRateAmount": 0.03245,
    "iyziCommissionFee": 0.25,
    "cardType": "CREDIT_CARD",
    "cardAssociation": "MASTER_CARD",
    "cardFamily": "Paraf",
    "binNumber": "552879",
    "basketId": "B67832",
    "currency": "TRY",
    "itemTransactions": [
        {
            "itemId": "BI101",
            "paymentTransactionId": "38208",
            "transactionStatus": 2,
            "price": 0.3,
            "paidPrice": 0.33,
            "merchantCommissionRate": 10,
            "merchantCommissionRateAmount": 0.03,
            "iyziCommissionRateAmount": 0.009735,
            "iyziCommissionFee": 0.075,
            "blockageRate": 10,
            "blockageRateAmountMerchant": 0.033,
            "blockageRateAmountSubMerchant": 0,
            "blockageResolvedDate": "2016-08-16 10:27:18",
            "subMerchantPrice": 0,
            "subMerchantPayoutRate": 0,
            "subMerchantPayoutAmount": 0,
            "merchantPayoutAmount": 0.212265,
            "convertedPayout": {
                "paidPrice": 0.33,
                "iyziCommissionRateAmount": 0.009735,
                "iyziCommissionFee": 0.075,
                "blockageRateAmountMerchant": 0.033,
                "blockageRateAmountSubMerchant": 0,
                "subMerchantPayoutAmount": 0,
                "merchantPayoutAmount": 0.212265,
                "iyziConversionRate": 0,
                "iyziConversionRateAmount": 0,
                "currency": "TRY"
            }
        },
        {
            "itemId": "BI102",
            "paymentTransactionId": "38209",
            "transactionStatus": 2,
            "price": 0.5,
            "paidPrice": 0.55,
            "merchantCommissionRate": 10,
            "merchantCommissionRateAmount": 0.05,
            "iyziCommissionRateAmount": 0.016225,
            "iyziCommissionFee": 0.125,
            "blockageRate": 10,
            "blockageRateAmountMerchant": 0.055,
            "blockageRateAmountSubMerchant": 0,
            "blockageResolvedDate": "2016-08-16 10:27:18",
            "subMerchantPrice": 0,
            "subMerchantPayoutRate": 0,
            "subMerchantPayoutAmount": 0,
            "merchantPayoutAmount": 0.353775,
            "convertedPayout": {
                "paidPrice": 0.55,
                "iyziCommissionRateAmount": 0.016225,
                "iyziCommissionFee": 0.125,
                "blockageRateAmountMerchant": 0.055,
                "blockageRateAmountSubMerchant": 0,
                "subMerchantPayoutAmount": 0,
                "merchantPayoutAmount": 0.353775,
                "iyziConversionRate": 0,
                "iyziConversionRateAmount": 0,
                "currency": "TRY"
            }
        },
        {
            "itemId": "BI103",
            "paymentTransactionId": "38210",
            "transactionStatus": 2,
            "price": 0.2,
            "paidPrice": 0.22,
            "merchantCommissionRate": 10,
            "merchantCommissionRateAmount": 0.02,
            "iyziCommissionRateAmount": 0.00649,
            "iyziCommissionFee": 0.05,
            "blockageRate": 10,
            "blockageRateAmountMerchant": 0.022,
            "blockageRateAmountSubMerchant": 0,
            "blockageResolvedDate": "2016-08-16 10:27:18",
            "subMerchantPrice": 0,
            "subMerchantPayoutRate": 0,
            "subMerchantPayoutAmount": 0,
            "merchantPayoutAmount": 0.14151,
            "convertedPayout": {
                "paidPrice": 0.22,
                "iyziCommissionRateAmount": 0.00649,
                "iyziCommissionFee": 0.05,
                "blockageRateAmountMerchant": 0.022,
                "blockageRateAmountSubMerchant": 0,
                "subMerchantPayoutAmount": 0,
                "merchantPayoutAmount": 0.14151,
                "iyziConversionRate": 0,
                "iyziConversionRateAmount": 0,
                "currency": "TRY"
            }
        }
    ],
    "paymentStatus": "SUCCESS"
}

Örnek Kodlar

var Iyzipay = require('iyzipay'); var iyzipay = new Iyzipay({ apiKey: "sandbox-afXhZPW0MQlE4dCUUlHcEopnMBgXnAZI", secretKey: "sandbox-wbwpzKIiplZxI3hh5ALI4FJyAcZKL6kq", uri: 'https://sandbox-api.iyzipay.com' }); iyzipay.payment.retrieve({ locale: Iyzipay.LOCALE.TR, conversationId: '123456789', paymentId: '1', paymentConversationId: '123456789' }, function (err, result) { console.log(result); });