Reporting Service
Reporting service allows users to retrieve detailed transaction information, latest status of the payments, refund results and fraud scenarios before taking the financial decision.
The information you can receive through the reporting API can go back to maximum of 2 years.
Transaction Details service performs separately both paymentConversationId
and paymentId
.
Reporting API - Transaction Detail
Reporting API - Transaction Detail
GET
https://sandbox-api.iyzipay.com/v2/reporting/payment/details
Query Parameters
Name | Type | Description |
---|---|---|
paymentConversationId | String | Conversation ID to match request and response |
paymentId | String | ID of the payment |
Reporting API - Transaction Detail Response;
Output Name | Data Type | Description |
---|---|---|
status | String | It reports the outcome of the request. If it's successful, it returns "success," and if there's an error, it returns "failure." |
systemTime | Long | The returned result is the current Unix timestamp value. |
paymentId | Long | The payment ID must be stored by the merchant. It is essential for canceling payments and for communication with iyzico. |
paymentStatus | Integer | It indicates the status of the payment request. FAILURE(0), SUCCESS(1), INIT_THREEDS(2), CALLBACK_THREEDS(3), BKM_POS_SELECTED(4), CALLBACK_PECCO(5), INIT_APM(6), INIT_BANK_TRANSFER(8), INIT_CONTACTLESS(9) |
paymentRefundStatus | String | NOT_REFUNDED("NOT_REFUNDED"), PARTIALLY_REFUNDED("PARTIALLY_REFUNDED"), TOTALLY_REFUNDED("TOTALLY_REFUNDED ") |
price | Decimal | The payment basket amount. |
paidPrice | Decimal | Final amount (including installment fee) that will be charged to customer’s card. |
installment | Integer | Installment value. For single installment payments it should be 1. (valid values: 1, 2, 3, 6, 9, 12) |
merchantCommissionRate | Decimal | The installment/commission rate applied by the merchant. For example, if the price is 100 and the paid price is 110, the merchant's installment/commission rate is 10%. |
merchantCommissionRateAmount | Decimal | The installment/commission rate applied by the merchant. For example, if the price is 100 and the paid price is 110, the merchant's installment/commission rate is 10%. |
iyziCommissionRateAmount | Decimal | iyzico commission rate amount for payment transaction. |
iyziCommissionFee | Decimal | iyzico commission fee for payment transaction. |
paymentConversationId | String | If set, conversation ID to match request and response. |
fraudStatus | Integer | Fraud risk status for payment request (0 for review / 1 for accept). |
cardType | String | Valid values are CREDIT_CARD, DEBIT_CARD, PREPAID_CARD. |
cardAssociation | String | Valid values are VISA, MASTER_CARD, AMERICAN_EXPRESS, TROY. |
cardFamily | String | Valid values are Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage. |
binNumber | String | First 6 digits of card. |
lastFourDigits | String | Last 4 digits of the card. |
basketId | String | Merchant's basket ID. |
currency | String | Currency of request. |
threeDS | Boolean | Payment method. |
phase | String | Payment phase. Possible values AUTH("AUTH"), PRE_AUTH("PRE_AUTH"), POST_AUTH("POST_AUTH") |
mdStatus | String | " |
createdDate | String | Transaction date. Format; 2022-10-04T13:12:13Z |
ItemTransactions.paymentTransactionId | String | The ID related to the payment installment must be securely stored by the merchant. It is crucial for processing installment refunds, approvals, withdrawal of approvals, and for communication with iyzico. It is recommended to be associated with an itemId for better payment experience. |
ItemTransactions.transactionStatus | Integer | The status of the payment installment. If the payment is in fraud control, it returns a value of 0, and in this case, the fraudStatus value is also 0. If the payment is rejected after fraud control, it returns -1. In the marketplace model, this value is 1 until approval is granted for the product. If the product is approved in the marketplace model, this value becomes 2. Possible values WAITING_FOR_FRAUD_CHECK(0), REJECTED_BY_FRAUD(-1), WAITING_FOR_MERCHANT_APPROVAL(1), APPROVED_BY_MERCHANT(2), PAYOUT_STARTED(20) |
ItemTransactions.price | Decimal | The amount associated with the product in the merchant's shopping cart. |
ItemTransactions.paidPrice | Decimal | Final amount (including installment fee) that will be charged to customer’s card for the specific item. |
ItemTransactions.merchantCommissionRate | Decimal | The installment/commission rate applied by the merchant, distributed on an installment basis. |
ItemTransactions.merchantCommissionRateAmo Decim unt | Decimal | The installment/commission amount applied by the merchant, distributed on an installment basis. |
ItemTransactions.convertedPayout.iyziCommissionRateAmount | Decimal | The iyzico transaction commission amount, distributed on an installment basis. |
ItemTransactions.convertedPayout.iyziCommissionFee | Decimal | The iyzico transaction fee amount, distributed on an installment basis. |
ItemTransactions.blockageRate | Decimal | The installment-specific blocking rate imposed by the merchant. According to the agreement between iyzico and the merchant, a transaction-specific blockage can be applied to the merchant. This blockage is intended to prevent merchant fraud risk, and the funds are held by iyzico during the blocking period, after which they are transferred to the merchant. |
ItemTransactions.blockageRateAmountMerchant | Decimal | The amount of the installment-specific merchant blockage that is reflected in the merchant's account. |
ItemTransactions.blockageResolvedDate | String | The transaction-specific unblocking date and time. It is in the format yyyy-MM-dd HH:mm:ss, for example, 2015-10-19 14:36:52. |
ItemTransactions.subMerchantPrice | Decimal | The submerchants' earning amount for the given item. |
ItemTransactions.subMerchantPayoutRate | Decimal | The submerchants' payoutrate for the given item. |
ItemTransactions.subMerchantPayoutAmount | Decimal | The submerchants' payout amount for the given item. |
ItemTransactions.merchantPayoutAmount | Decimal | The merchants' payout amount for the given item. |
ItemTransactions.convertedPayout.paidPrice | Decimal | The distribution of the collection amount on an installment basis. |
ItemTransactions.convertedPayout.blockageRateAmountMerchant | Decimal | The amount of the merchant's blockage specific to the transaction that is reflected in the merchant's account. |
ItemTransactions.convertedPayout.blockageRateAmountSubMerchant | Decimal | The amount of the submerchant's blockage specific to the transaction that is reflected in the merchant's account. |
ItemTransactions.convertedPayout.subMerchantPayoutAmount | Decimal | For this transaction, the amount to be sent to the submerchant after deducting iyzico transaction fees, commission amounts, and blockages. |
ItemTransactions.convertedPayout.merchantPayoutAmount | Decimal | For this transaction, the amount to be sent to the merchant after deducting iyzico transaction fees, commission amounts, and blockages. |
ItemTransactions.convertedPayout.iyziConversationRate | Decimal | iyzico comission conversation rate |
ItemTransactions.convertedPayout.iyziConversationRateAmount | Decimal | iyzico comission rate amount |
cancels.refundId | Long | Id of the refund. |
cancels.cancelConversationId | String | ConversationId of the cancel. |
cancels.refundPrice | Decimal | Cancelled amount. |
cancels.refundStatus | Integer | Status of the cancel. |
cancels.createdDate | Date | Date of the cancel. |
cancels.currencyCode | String | Currency of the cancel. |
refunds.refundTxId | Long | Transaction id of the refund. |
refunds.refundConversationId | String | ConversationId of the refund. |
refunds.refundPrice | Decimal | Refunded amount. |
refunds.refundStatus | Integer | Status of refund. |
refunds.createdDate | Date | Date of the refund. |
refunds.currencyCode | String | Currency of the refund. |
Last updated