Retrieve
To retrieve the details of a transaction registered in iyzico, you can use the payment inquiry service.
The parameters that need to be sent to the service are as follows:
Retrieve Payment Result Request
POST https://api.iyzipay.com/payment/detail
Request Body
| Name | Type | Description |
|---|---|---|
paymentId* | String | ID of the payment. Merchants should keep payment ID in their system (this ID will be used for cancel requests) |
ip* | string | IP that transaction have been send. |
conversationId | String | Conversation ID to match request and response |
locale | String | Language (default: tr) |
paymentConversationId | String | Conversation ID of the payment. |
Retrieve Payment Result Response
| Output Name | Type | Description |
|---|---|---|
status | String | Service response result (success / failure) |
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 |
locale | String | Language (default: tr) |
systemTime | Long | Response system timestamp value |
conversationId | String | If set, conversation ID to match request and response |
paymentId | String | ID of the payment. Merchants should keep payment ID in their system (this ID will be used for cancel requests) |
price | Decimal | Total amount of basket. The sum of basket items’ amount must be equal to the price 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 |
currency | String | Currency of request |
installment | Integer | Installment number of payment, for single payments it returns 1. Valid values are 1, 2, 3, 6, 9, 12 |
paymentStatus | String | Result of the payment. Possible values SUCCESS, FAILURE, INIT_THREEDS, CALLBACK_THREEDS, BKM_POS_SELECTED, CALLBACK_PECCO |
basketId | String | Merchant's basket ID |
binNumber | String | First 6 digit of card |
cardAssociation | String | Valid values are VISA, MASTER_CARD, AMERICAN_EXPRESS, TROY |
cardFamily | String | Valid values are Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage |
cardType | String | Valid values are CREDIT_CARD, DEBIT_CARD, PREPAID_CARD |
fraudStatus | Integer | Fraud risk status for payment request (0 for review / 1 for accept) |
iyziCommissionFee | Decimal | iyzico commission fee for payment transaction |
iyziCommissionRateAmount | Decimal | iyzico commission rate amount for payment transaction |
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) |
paymentTransactionId (ItemTransactions) | String | ID of basket item. Merchants should keep payment ID in their system (this ID will be used for cancel requests) |
itemId(ItemTransactions) | String | Item ID of each item in basket |
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 |
transactionStatus (ItemTransactions) | Integer | Status of a payment transaction. (0 for waiting / -1 for rejected by fraud / 1 for waiting for approval / 2 for approved |
blockageRate(ItemTransactions) | Decimal | Blockage rate based on each item. |
blockageRateAmountMerchant(ItemTransactions) | Decimal | Blockage rate amount for merchant based on each item |
blockageResolvedDate(ItemTransactions) | String | Blockage resolve date based on each item. Date format should be “2015-10-19 14:36:52” |
iyziCommissionFee(ItemTransactions) | Decimal | iyzico commission fee based on each item |
iyziCommissionRateAmount(ItemTransactions) | Decimal | iyzico commission rate amount based on each item |
merchantCommissionRate(ItemTransactions) | Decimal | Merchant commission rate (e.g. price=100 & paidPrice=110, then merchant commission rate = 10) |
merchantCommissionRateAmount(ItemTransactions) | Decimal | Merchant commission rate amount (e.g. price=100 & paidPrice=110, then merchant commission rate amount = 10) |
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(ItemTransactions)(convertedPayout) | Decimal | Converted charged amount to card based on each item. Merchants should keep paidPrice in their system. |
iyziCommissionFee(ItemTransactions)(convertedPayout) | Decimal | Converted iyzico commission fee based on each item |
iyziCommissionRateAmount(ItemTransactions)(convertedPayout) | Decimal | Converted iyzico commission rate amount based on each item |
blockageRateAmountMerchant(ItemTransactions)(convertedPayout) | Decimal | Converted blockage rate amount for merchant based on each item |
merchantPayoutAmount(ItemTransactions)(convertedPayout) | Decimal | Converted payout amount for each item transaction. This the amount that remains after substracting iyzicoCommissionRateAmount, iyzicoCommissionFee and blockageRateAmountMerchant from paidPrice(ItemTransactions) |
iyziConversationRate(ItemTransactions)(convertedPayout) | Decimal | iyzico conversation rate |
iyziConversationRateAmount(ItemTransactions)(convertedPayout) | Decimal | iyzico conversation rate amount |
currency(ItemTransactions)(convertedPayout) | String | Currency for payout conversion |
Last updated
