Retrieve Payment

Details of a transaction recorded in iyzico can be queried later. The payment retrieve service can be used for this.

The parameters that need to be sent to the service are as follows:

iyzico Retrieve Payment

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

Request Body

Name

Type

Description

string

The IP address to which the transaction is sent.

paymentId*

string

The unique payment number assigned to the transaction by iyzico. It is mandatory to send one of the paymentId or paymentConversationId parameters during the request.

locale

string

iyzico is used to set the language of the texts returned as a result of the request. Its default value is tr.

conversationId

string

A value that you can send during the request and receive as a result can be used to make a request/response match.

paymentConversationId*

string

The unique order number assigned to the transaction by the merchant. It is mandatory to send one of the paymentId or paymentConversationId parameters during the request.

{
    "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"
}

Response from Payment Retrieve

{
    "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"
}

Parameters Returned from Payment Retrieve

status

String

Reports the result of the request made. If the operation is successful, success is returned; if it is incorrect, failure is returned.

errorCode

String

If the operation is incorrect, this is the code specified for the error.

errorMessage

String

If the operation is incorrect, this is the specified message regarding the error. It offers language support according to the locale parameter.

errorGroup

String

If the operation is faulty, this is the group specified for the fault.

locale

String

The locale value specified in the request is returned, the default value is tr.

systemTime

Long

It is the current unix timestamp value of the returned result.

conversationId

String

If it was sent at the time of the request, it will eventually be returned verbatim.

paymentId

String

The payment ID must be kept by the member business. It is used for payment cancellation and communication with iyzico.

price

Decimal

Payment cart amount. The total of the breakdown amounts must be equal to the basket amount.

paidPrice

Decimal

Discount, interest, etc. The final amount collected and passed through the calculated POS.

currency

String

Currency in which payment is received.

installment

Integer

Payment installment information returns 1 for a single withdrawal. Valid values: 1, 2, 3, 6, 9, 12.

paymentStatus

String

Shows the result of the operation. Valid values SUCCESS, FAILURE, INIT_THREEDS, CALLBACK_THREEDS, BKM_POS_SELECTED, CALLBACK_PECCO

basketId

String

Cart ID sent by the member merchant.

binNumber

String

The first 6 digits of the payment card.

cardAssociation

String

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

If the payment card is a local card, the family to which the card belongs. Valid values: Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage

cardType

String

If the payment card is a local card, the type of card it belongs to. Valid values: CREDIT_CARD, DEBIT_CARD, PREPAID_CARD

fraudStatus

Integer

Status of the payment transaction according to fraud filters. If the fraud risk score of the payment is low, the payment is approved immediately, in which case the value 1 is returned. If the fraud risk score is high, the payment transaction is rejected and -1 is returned. If the payment transaction will be reviewed and decided later, 0 is returned. Valid values: 0, -1 and 1. The member merchant must ship the product only for transactions with a value of 1, and must wait for notification for transactions with a value of 0.

iyziCommissionFee

Decimal

iyzico transaction fee for the payment.

iyziCommissionRateAmount

Decimal

iyzico transaction commission amount for the payment.

merchantCommissionRate

Decimal

Maturity/commission rate applied by the member business. For example, if price=100, paidPrice=110, the maturity/commission rate of the member merchant is 10%. It is for informational purposes only.

merchantCommissionRateAmount

Decimal

Maturity/commission amount applied by the member business. For example, if price=100, paidPrice=110, the maturity/commission amount of the member business is 10. It is for informational purposes only.

paymentTransactionId (ItemTransactions)

String

The ID of the payment breakdown must be kept by the member business. It is used for payment breakdown refund, approval, withdrawal of approval and communication with iyzico. It should preferably be kept associated with the itemId.

itemId(ItemTransactions)

String

The ID of the product in the basket, transmitted by the member merchant.

price(ItemTransactions)

Decimal

The amount for the product in the basket on the member merchant's side.

paidPrice(ItemTransactions)

Decimal

Distribution of the collection amount on a breakdown basis. It must be kept by the member business.

transactionStatus (ItemTransactions)

Integer

Status of payment breakdown. If the payment is checked for fraud, the value 0 is returned, in which case the fraudStatus value is also 0. If the payment is rejected after a fraud check, -1 is returned. 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.

blockageRate(ItemTransactions)

Decimal

Member merchant blockage rate on a breakdown basis. According to the iyzico-member merchant agreement, it may block the member merchant on a transaction basis. This blockage is to prevent member merchant fraud risk. The money is kept in iyzico during the blocking period and is sent to the member merchant after this period.

blockageRateAmountMerchant(ItemTransactions)

Decimal

The figure of the member business blockage amount reflected in the member business on a breakdown basis. The blocking amount is reflected to the member business as much as possible. If the blocking amount is greater than the member merchant amount, then it is also reflected in the sub-member merchant.

blockageResolvedDate(ItemTransactions)

String

Blockage release date on a transaction basis. yyyy-MM-dd is in the format HH:mm:ss, for example 2015-10-19 14:36:52.

iyziCommissionFee(ItemTransactions)

Decimal

Distributed amount of iyzico transaction fee on a breakdown basis.

iyziCommissionRateAmount(ItemTransactions)

Decimal

Distributed amount of iyzico transaction commission amount on a breakdown basis.

merchantCommissionRate(ItemTransactions)

Decimal

The ratio of the maturity/commission rate applied by the member business on a breakdown basis.

merchantCommissionRateAmount(ItemTransactions)

Decimal

The amount of the maturity/commission amount applied by the member business, distributed on a breakdown basis.

merchantPayoutAmount(ItemTransactions)

Decimal

For this breakdown, the amount to be sent to the member business after deducting the iyzico transaction fee, commission amount and blockages.

paidPrice(ItemTransactions)(convertedPayout)

Decimal

Distribution of the collection amount on a breakdown basis. It must be kept by the member business.

iyziCommissionFee(ItemTransactions)(convertedPayout)

Decimal

Distributed amount of iyzico transaction fee on a breakdown basis.

iyziCommissionRateAmount(ItemTransactions)(convertedPayout)

Decimal

Distributed amount of iyzico transaction commission amount on a breakdown basis.

blockageRateAmountMerchant(ItemTransactions)(convertedPayout)

Decimal

merchantPayoutAmount(ItemTransactions)(convertedPayout)

Decimal

For this breakdown, the amount to be sent to the member business after deducting the iyzico transaction fee, commission amount and blockages.

iyziConversationRate(ItemTransactions)(convertedPayout)

Decimal

For this breakdown, the amount to be sent to the member business after deducting the iyzico transaction fee, commission amount and blockages.

iyziConversationRateAmount(ItemTransactions)(convertedPayout)

Decimal

For this breakdown, the amount to be sent to the member business after deducting the iyzico transaction fee, commission amount and blockages.

currency(ItemTransactions)(convertedPayout)

String

Currency in which payment is received.

PreviousRefund to Balance NextResponse Signature Validation

Last updated 10 months ago