Retrieve Session

This service is used to retrieve the current status of the session created after the payment process. To query a session, the checkoutFormToken of the payment form and the paymentId of the related transaction must be provided.

Instead of returning direct payment details, the service response includes session-related information. In this context, fields such as sessionToken, memberIdentifier, sessionStatus, and paymentType can be used to track the session status and user-related information.

It is recommended to use this service after the payment flow is completed to verify the final state of the session and obtain user session details. This ensures that the payment process can be securely monitored without relying on client-side redirects.

Retrieve Session

POST https://api.iyzipay.com/v1/pay-with-iyzico/third-party-session/retrieve/session

Headers

Name	Value
Content-Type	application/json
Authorization	Authorization

Request

{
  "locale": "tr",
  "conversationId": "123456789",
  "checkoutFormToken": "ab468ec8-c4ab-4449-b15b-69782f7786c6",
  "paymentId": "29414275"
}

Request Parameters

Paremetre	Tip	Zorunluluk	Açıklama
checkoutFormToken	string	Evet	Token value of the payment form associated with the transaction.
locale	string	Hayır	Language value sent in the request. Can be EN or TR.
conversationId	string	Hayır	A value sent within the request and returned in the response, used to match request and response.
paymentId	string	Evet	The payment identifier of the completed transaction.

Response

200

{
    "status": "success",
    "locale": "tr",
    "systemTime": 1775471642206,
    "sessionInfo": {
        "sessionToken": "f2f06a82-6480-4d2b-811d-93168ddce577",
        "sessionStatus": "PASSIVE",
        "memberIdentifier": "702831f3-1cc6-4b25-ad2b-878afc64f408",
        "paymentType": "CARD_PAYMENT"
    }
}

400

{
    "status": "failure",
    "errorCode": "260016",
    "errorMessage": "Session token bulunamadı.",
    "systemTime": 1775471996773
}

Response Parameters

Paremetre	Tip	Açıklama
status	string	Result of the request.
locale	string	The locale value sent in the request.
systemTime	Long	Transaction time (epoch ms).
sessionToken	string	Session key information of the payment transaction performed by the member.
sessionStatus	string	Status of the session. Can be ACTIVE or PASSIVE.
memberIdentifier	string	Unique key of the member.
paymentType	string	Indicates the payment type. Can be FUND or CARD_PAYMENT. FUND: Wallet balance payment CARD_PAYMENT: Card payment