POSTIPN Service (Instant Payment Notification)

When any successful order is made from the Teqpay system, if the IPN service is activated, it will send a notification with the details of the order to the address in the "CallbackUrl" parameter that you sent during the payment phase. This notification is sent with the HTTP POST method. The system will continue to send this request periodically until the response returns and confirms that the notification has arrived.

Important ! The IPN service is progressing in two stages. First, the service sends you a post request with the parameters below. You are expected to confirm that you have received this post request with the "IPN Check" service. In response to the transaction confirmed by the "IPN Check" service, an information including the customer, product and payment details of the payment transaction is returned.

Services Address:/ipncheck

IPN Notification

Response Parameter
Parametre Adı Parametre Tipi Description
Result boolen Operation result
ResultCode integer The code of the transaction result determined by Teqpay.
ResultMessage string Description of the ResultCode value.
OrderId integer It is the unique id value given by Teqpay of the payment transaction.
ConversationId string The unique value you send during the payment request.
PaymentMethodId int Payment Method Id
PaymentMethodName string Payment Method Name
Price decimal Price
Token string Token
Extra string (Json) Extra field information. If the merchant uses its own virtual pos account, this field is returned. Virtual POS details are transmitted in its content. The value is sent in Json format.


Response Sample
 
"Result": true,
 "ResultCode": 10000,
 "ResultMessage": "Başarıyla tamamlandı.",
 "OrderId": 1205,
 "ConversationId": "12345",
 "PaymentMethodId": 25,
 "PaymentMethodName": PAPARA,
 "Price": 100.00,
 "Token": "7cb77378a0749f2a9b7e09ea62ffb13febf3759f",
 "Extra":{
            "BankName":"AKBANK",
            "BankCode":"0046",
            "ClientId":"123456789",
            "TerminalId":"123456789",
            "AuthCode":"12345",
            "HostRefNo":"123456789123456789",
            "BankOrderId":"1205"
         }

IPN Notification Confirmation Service

Important ! A request containing the following parameters is sent to the "IPN Check" service to confirm that you have received the IPN notification. In the IPN service, the detailed information about the operation is returned.

Important ! The request made must be in JSON format. While Api Key and Secret Key values are added to the heade, OrderId and Language value should be sent in the body.

Request

Header
Parametre Adı Parametre Tipi Description
ApiKey

Required

 string It is the ApiKey information given by Teqpay of the dealer who will make the payment transaction.

for Example ; 3f0126be-****-****-****-06025352594a

SecretKey

Required

 string It is the ApiKey information given by Teqpay of the dealer who will make the payment transaction.

for Example ; 3f0126be-****-****-****-06025352594a


Body Parameter
Parametre Adı Parametre Tipi Description
OrderId

Required

 string It is the unique id value given by Teqpay of the payment transaction.
Language

Optional

 string Language option
Request Sample
    {
    "orderId":"6814",
    "language":"TR"
    }

Response

Response Parameter
Parametre Adı Parametre Tipi Description
Result boolen Operation result
ResultCode integer The code of the transaction result determined by Teqpay.
ResultMessage string Description of the ResultCode value.
TransactionList TransactionList Class Class containing details of the operation performed

TransactionList Class
Parametre Adı Parametre Tipi Description
Merchant string Member merchant name
OrderId integer It is the unique id value given by Teqpay of the payment transaction.
ConversationId string The unique value you send during the payment request.
CustomerName string The end user name that made the payment
CustomerEmail string End user e-mail address
CustomerPhone string End user phone number that processes the payment
TotalAmount decimal Commission calculated total transaction amount (TL)
TransactionDate string Transaction date (dd.mm.yyyy)
TransactionTime string Transaction time (hh:mm:ss)
PaymentDetail class Class with payment information
ProductDetail[] class Class with product information

PaymentDetail Class Parameters
Parametre Adı Parametre Tipi Description
PaymentType string Type of payment made *VIRTUALPOS *E-WALLET *MOBILE *OTHER
PaymentMethod string Payment method name
AccountNo string Account information paid (Card number in virtual pos transactions, phone number in mobile payment transactions)
ValorDate string Date when the payment will be deposited to the merchant
PaymentStatus string Status of the payment transaction ("Successful" returns for successful transactions)

ProductDetail[] Class Parameter
Parametre Adı Parametre Tipi Description
ProductType string Product type
ProductCategory string Product category
ProductName string Product name
ProductQuantity integer Product quantity
ProductAmount decimal Product amount

Response Sample
 
{
    "Result": true,
    "ResultCode": 10000,
    "ResultMessage": "Başarıyla tamamlandı.",
    "TransactionList": {
        "Merchant": "Teqpay Ödeme Sistemleri",
        "OrderId": 1234,
        "ConversationId": "987654321",
        "CustomerName": "A** S**",
        "CustomerEmail": "demo@teqpay.com",
        "CustomerPhone": "(123) 123-4567",
        "TotalAmount": 10.00,
        "TransactionDate": "01.06.2020",
        "TransactionTime": "11:52:19",
        "PaymentDetail": {
            "PaymentType": "SANALPOS",
            "PaymentMethod": "PARAFIX",
            "AccountNo": "4546 71** **** 7894",
            "ValorDate": "02.06.2020",
            "PaymentStatus": "Successful"
        },
        "ProductDetail": [
            {
                "ProductType": "Oyun",
                "ProductCategory": "Kullanıcı Testleri",
                "ProductName": "Angry Birds",
                "ProductQuantity": 1,
                "ProductAmount": 10.00
            }
        ]
    }
}