Header

Parameter Name	Parameter Type	Explanation
ApiKey Required	string	It is the ApiKey information given by Teqpay to the merchant. For example; 3f0126be-****-****-****-06025352594a
SecretKey Required	string	It is the SecretKey information given by Teqpay to the merchant. For example ; 3f0126be-****-****-****-06025352594a

Body Parameter

Parameter Name	Parameter Type	Explanation
OrderId or ConversationId Required	integer	The unique number of the payment transaction to be controls.
language Opsiyonal	string	Values it can take "TR"-EN".The default language is "TR".

Request Sample

{
    "orderId": "6679",
    "language": "TR"
}

Response Parameter

Parameter Name	Parameter Type	Explanation
Result	boolen	Process Result
ResultCode	integer	Teqpay result code of the payment transaction
ResultMessage	string	Description of ResultCode value.
Details	class	The details of the internal parameters are explained in the table below.

Details

Parameter Name	Parameter Type	Explanation
CustomerName	string	Customer Name
CitizenNo	string	Citizenship number.
Price	decimal	The amount of payment.
TotalPrice	decimal	Total amount information.
Fee	decimal	Transaction fee
RefundAmount	decimal	Is the refund amount
RemainingRefundAmount	decimal	Is the remaining Refund Amount
Installment	int	Installment information.
Discount	string	Discount amount info.
OrderID	string	The unique Id value of the transaction.
ConversationId	string	The value that you can send and receive at the end of the request. The most common form of use is the order number of the merchant.
DateTime	string	The date of the transaction.
PaymentType	string	Payment types.
PaymentMethodId	int	Payment Method ID
PaymentCompany	string	Payment company.
OrderStatus	string	The payment information message. * Success * Transaction Canceled * Transaction Returned * Spending Objection * Suspicious Transaction * Order is unsuccessful * Incomplete Payment
OrderStatusCode	int	The payment information code.
VPosInfo	string	It shows which bank the member merchants that use their own POS receive payments.
Extra	string	It takes parameters into it according to the payment method.
TransactionList	List<class>	It shows you all the details step by step in the payment process. *Payment Successful -*Partial Refund

Transaction List

ParameterName	ParameterType	Explanation
TransactionCode	integer	Transaction code.
StatusCode	int	The status Code of the payment transaction. *1 *-8
StatusMessage	string	Status message of the payment transaction *Transaction Successful *Partial Refund
TransactionDate	DateTime	dransactionDate
Amount	decimal	Transaction is amount
Description	string	Transaction is description

Response Sample

 {   
    "Details": {
        "CustomerName": "DENEMEAD DENEMESOYAD",
        "CitizenNo": "11111111111",
        "Price": 750.00,
        "TotalPrice": 750.00,
        "Fee": 0.00,
        "RefundAmount": 70.00,
        "RemainingRefundAmount": 680.00,
        "Installment": "1",
        "Discount": "0,00 TL",
        "OrderID": 6679,
        "ConversationId": "PRO02081T21458",
        "DateTime": "22.05.2023 15:41:05",
        "PaymentType": "E-CUZDAN",
        "PaymentMethodId": 1,
        "PaymentCompany": "HASO",
        "OrderStatus": "Kısmi İade",
        "OrderStatusCode": -8,
        "VPosInfo": null,
        "Extra": {
            "HasoCustomerId": ""
        },
         "TransactionList": [
            {
                "TransactionCode": 51,
                "StatusCode": 1,
                "StatusMessage": "Ödeme Başarılı",
                "TransactionDate": "2023-05-22T15:48:05",
                "Amount": 750.00,
                "Description": "Başarıyla tamamlandı."
            },
            {
                "TransactionCode": 56,
                "StatusCode": -8,
                "StatusMessage": "Kısmi İade",
                "TransactionDate": "2023-05-23T12:59:03",
                "Amount": 50.00,
                "Description": "Sipariş Kısmi İade Edilmiştir. Kısmi İade Açıklaması: İptal / İade İşlemi"
            },
            {
                "TransactionCode": 57,
                "StatusCode": -8,
                "StatusMessage": "Kısmi İade",
                "TransactionDate": "2023-05-23T12:59:41",
                "Amount": 20.00,
                "Description": "Sipariş Kısmi İade Edilmiştir. Kısmi İade Açıklaması: İptal / İade İşlemi"
            }
        ]
    },  
    "Result": true,
    "ResultCode": 10000,
    "ResultMessage": "Başarıyla tamamlandı."  
}