Retrieve Payment Detail and Session Info
Returns the details of the payments made by the Member within the scope of the session. The payment that starts the session with Pay with iyzico (PWI) is within this scope.
Payment and Session Retrieve
POST https://api.iyzipay.com/v1/pay-with-iyzico/third-party-session/retrieve/payment
Headers
Content-Type
application/json
Authorization
Authorization
Request Parameters
checkoutFormToken
string
Evet
The token value of the transaction.
locale
string
Hayır
The language value sent for the request. Can take the value EN and TR.
conversationId
string
Hayır
A value that you can send during the request and receive in the result can be used to make a request/response match.
Request
{
"checkoutFormToken": "{{checkoutToken}}",
"locale": "en",
"conversationId": "conversationId"
}Response
{
"status": "success",
"locale": "en",
"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"
}
}Response Parameters
status
String
Service response result (success / failure).
locale
String
Language. Default: TR Can take TR and EN values.
systemTime
Long
Response system timestamp value.
conversationId
String
If set, conversation ID to match request and response.
token
String
The token value of the checkoutform used in the checkout process.
paymentStatus
String
Payment response result (SUCCESS, FAILURE).
memberEmail
String
Member's email information.
memberGsmNumber
String
Member's gsm number information.
price
Decimal
Total amount of basket.
paidPrice
Decimal
Final amount (including installment fee) that will be charged to customer’s card. Merchants should store this value in their system.
installment
Integer
Ödemenin taksit bilgisi, tek çekim için 1 döner. Geçerli değerler: 1, 2, 3, 6, 9, 12
paymentId
String
ID of the payment. Merchants should keep payment ID in their system (this ID will be used for cancel requests).
merchantCommissionRate
Decimal
Merchant commission rate (e.g. price=100 & paidPrice=110, then merchant commission rate = 10).
merchantCommissionRateAmount
Decimal
Merchant commission rate amount (e.g. price=100 & paidPrice=110, then merchant commission rate amount = 10).
iyziCommissionRateAmount
Decimal
iyzico commission rate amount for payment transaction.
iyziCommissionFee
Decimal
iyzico commission fee for payment transaction.
basketId
String
Merchant's basket ID.
errorCode
String
Error code if service response status is failure.
errorMessage
String
Error message if service response status is failure.
errorGroup
String
Error group if service response status is failure.
currency
String
The currency in which payment is received.
itemId (ItemTransactions)
String
Item ID of each item in basket.
transactionStatus (ItemTransactions)
Integer
The status of the payment breakdown. Returns 0 if the payment is under fraud check, in which case the fraudStatus is also 0. -1 if the payment is rejected after the fraud check. In the marketplace model, this value returns 1 until the product is approved. If the product is approved in the marketplace model, this value is 2. Valid values: 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
Item price of each item in basket.
paidPrice (ItemTransactions)
Decimal
Captured amount from card based on each item. Merchants should keep paidPrice in their system.
merchantCommissionRate (ItemTransactions)
Decimal
The ratio of the maturity/commission rate applied by the merchant, broken down by segment.
merchantCommissionRateAmount (ItemTransactions)
Decimal
Amount of the maturity/commission amount applied by the merchant, broken down on a breakdown basis.
iyziCommissionRateAmount (ItemTransactions)
Decimal
iyzico commission rate amount for payment transaction.
iyziCommissionFee (ItemTransactions)
Decimal
iyzico commission fee for payment transaction.
blockageRate (ItemTransactions)
Decimal
Merchant blockage rate on a breakdown basis. iyzico may apply transaction-based blockage to the merchant according to the iyzico - merchant agreement. This blockage is to prevent merchant fraud risk, the money is kept at iyzico during the blockage period and sent to the merchant after this period.
blockageRateAmountMerchant (ItemTransactions)
Decimal
The amount of the merchant blockage amount reflected to the merchant on a breakdown basis. The blockage amount is reflected to the merchant as much as possible. If the blockage amount is greater than the merchant amount, then it is also reflected to the sub-merchant.
blockageResolvedDate (ItemTransactions)
String
Date of unblocking by transaction. yyyy-MM-dd HH:mm:ss format, for example 2015-10-19 14:36:52.
merchantPayoutAmount (ItemTransactions)
Decimal
Payout amount for each item transaction. This is the amount that remains after after substracting iyzicoCommissionRateAmount, iyzicoCommissionFee and blockageRateAmountMerchant from paidPrice(ItemTransactions)
paidPrice(convertedPayout)
Decimal
Converted charged amount to card based on each item. Merchants should keep paidPrice in their system.
iyziCommissionRateAmount (convertedPayout)
Decimal
Converted iyzico commission rate amount based on each item.
iyziCommissionFee (convertedPayout)
Decimal
Converted iyzico commission fee based on each item.
blockageRateAmountMerchant (convertedPayout)
Decimal
The amount of the merchant blockage amount reflected to the merchant on a breakdown basis. The blockage amount is reflected to the merchant as much as possible. If the blockage amount is greater than the merchant amount, then it is also reflected to the sub-merchant.
merchantPayoutAmount (convertedPayout)
Decimal
Converted payout amount for each item transaction. This the amount that remains after substracting iyzicoCommissionRateAmount, iyzicoCommissionFee and blockageRateAmountMerchant from paidPrice(ItemTransactions).
iyziConversationRate (convertedPayout)
Decimal
iyzico conversation rate.
iyziConversationRateAmount (convertedPayout)
Decimal
For this breakdown, the amount to be sent to the merchant after deducting iyzico transaction fee, commission amount and blockages.
currency (convertedPayout)
String
Currency for payout conversion.
mdStatus
String
It is the value returned from the bank. This value is returned only if the payment failed and the transaction was made with 3ds. It can take the values 0,2,3,4,5,6,7. If the 3D Transaction is Successful, it takes the value 1.
authCode
String
uniq value produced by iyzico.
phase
String
Payment phase information. Takes the value AUTH.
signature
String
The signature value that can be used for signature verification.
cardType
String
Returns only for card payments. If the payment card is a local card, it returns the card type information. It takes the values DEBIT_CARD and CREDIT_CARD.
cardAssociation
String
Returns only for card payments. If the payment card is a local card, the organization to which the card belongs. Valid values: VISA, MASTER_CARD, AMERICAN_EXPRESS, TROY
cardFamily
String
Returns only for card payments. If the payment card is a local card, the family to which the card belongs. Valid values: Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage
binNumber
String
First 6 digit of card.
lastFourDigits
String
Last 4 digits of the payment card.
sessionToken(sessionInfo)
String
This is the session key information of the payment transaction made by the Member in the same payment type.
sessionStatus(sessionInfo)
String
Session status of the user. It takes ACTIVE or PASSIVE values.
memberIdentifier(sessionInfo)
String
Member unique key information. This key is used for member information in payment transactions.
paymentType(sessionInfo)
String
Specifies the payment type. It can return FUND or CARD_PAYMENT. FUND Balance Payment CARD_PAYMENT: Card Payment
callbackUrl
String
The URL address specified in the request and redirected as a result of the operation.
Last updated