POSTTeqpay Common Payment

Together with the Teqpay Co-Payment Page, different forms of payment were collected under one roof.

Service address:/paywithcommonpage

Attention! The request must be in JSON format. While ApiKey and SecretKey values ​​are added to headera, PaymentRequest values ​​must be sent to body.

Request

Header
Parameter Name Parametrer Type Explanation
ApiKey

Requerid

 string API Key info that is provided by Teqpay to the merchant

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

SecretKey

Requerid

 string SecretKey info that is provided by Teqpay to the merchant.

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


Body Parameter
Parameter Name Parametrer Type Explanation
customerName

Requerid

 string Customer name
customerSurname

Requerid

 string Customer surname
customerIpAddress

Requerid

 string Customer ip address
customerCitizenNo

Requerid

 string Customer citizen number
customerEmail

Requerid

 string Customer email address
customerPhone

Requerid

 string Customer phone number. Should be in 5555555555 format
price

Requerid

 decimal Amount of payment. A point is used for decimal separation. For Example 10.00
currency

optional

 string Currency to use TRY: Turkish lira EUR: Euro
conversationId

Requerid

 string This is the parameter that you use in your request and also receive in responses. The most common form of use is the order number of the merchant. Must be unique value.
callbackUrl

Requerid

 string Spesifies the page that the customer will be re-directed after the performed payments.
language

optional

 string Values it can take "TR"-EN".The default language is "TR".
isPreAuth

optional

 integer It should be used for transactions that will be prepaid (True/False).
You can reach this process by using the Pre-Provision Close service.
paymentMethodId

optional

 string Payment Method ID. If Sent Blank, the OrderId is 0. If Empty is not sent, it returns the OrderId on its return.
Payment Method Id information Payment Method List by using the service.
products

Requerid

 List<class> Products Informations.The following Products Informations table describes the internal parameters.
billing

Requerid

 class Billing Informations.The following Billing Informations table describes the internal parameters.
shipping

Requerid

 class Shipping Informations.The following Shipping Informations table describes the internal parameters.
installments

optional

 List<string> It is the installment information specified by the member merchant only for the payment by credit card. NOTE: If the installment information is not sent, a single withdrawal will be made.

Products
Parameter Name Parametrer Type Explanation
merchantItemId

Requerid

 string It is the ID number of the product on merchant side.
itemType

Requerid

 string Item Type.
itemCategory

Requerid

 string Item Category
itemName

Requerid

 string Item Name
itemQuantity

Requerid

 integer Item Quantity Ürün adet bilgisi.
itemPrice

Requerid

 decimal Price value for each item.

Billing
Parameter Name Parametrer Type Explanation
billingName

Requerid

 string Contact name of billing address
billingCity

Requerid

 string City name of billing address
billingCountry

Requerid

 string Country name of billing address
billingAddress

Requerid

 string Address details of billing address

Shipping
Parameter Name Parametrer Type Explanation
shippingContactName

Requerid

 string Contact name of shipping adress.
shippingCity

Requerid

 string City name of shipping address.
shippingCountry

Requerid

 string Country name of shipping address.
shippingAddress

Requerid

 string Address details of shipping address.

Installments
Parameter Name Parametrer Type Explanation
1

optional

 string Installment
2

optional

 string Installment

Request Sample
    {
        "customerName": "Teqpay User",
        "customerIpAddress": "10.20.30.40",
        "customerCitizenNo": "12345678900",
        "customerEmail": "test@teqpay.com",
        "customerPhone": "1234567890",
        "price": 1.00,
        "currency": "TRY",
        "details": "string",
        "conversationId": "147852398",
        "callbackUrl": "https://merchant-test.teqpay.com/payment-callback",
        "language": "TR", 
        "isPreAuth": "false",
        "paymentMethodId": "",
        "products": [
            {
                "merchantItemId": "1",
                "itemType": "Sanal",
                "itemCategory": "Oyun Pini",
                "itemName": "PubG",
                "itemQuantity": 1,
                "itemPrice": 1.00
            }
        ],
        "billing": {
            "billingName": "Ali Öztürk",
            "billingCity": "İstanbul",
            "billingCountry": "Türkiye",
            "billingAddress": "Bayrampaşa"
        },
        "shipping": {
            "shippingContactName": "Ali Öztürk",
            "shippingCity": "İstanbul",
            "shippingCountry": "Türkiye",
            "shippingAddress": "Bayrampaşa"
        },
        "installments": [
            "1",
            "2",
            "3"
            ]
    }

Response

Response Parameter
Parameter Name Parametrer Type Explanation
Result boolen Operation result
ResultCode integer Teqpay result code of the payment transaction.
ResultMessage string Description of ResultCode value.
PaymentData class Returning information by Teqpay to complete the payment process.

PaymentData
Parameter Name Parametrer Type Explanation
ConversationId string "The conversationId" information sent by the merchant when initiating the payment request.
Price decimal Transaction amount
PaymentUrl string Secure Payment Page where payment will be made.
TransactionDate string The date the payment process started. (yyyy-mm-dd hh:mm:ss)

Response Sample
 
{   
 "Result": true,
 "ResultCode": 10000,
 "ResultMessage": "Başarıyla tamamlandı.",       
 "PaymentData": {
      "ConversationId": "147852398",
      "Price": 1.00,
      "PaymentUrl": "https://payment-test.teqpay.com/tr/payment-methods-MnJNdGxEZE9qUzhLMVlaY0NxbFNwWlluTFM1U2I0bUVyWk9jektPSU1HST0=",
      "TransactionDate": "2021-09-06 10:06:27"
    }            
}

Attention ! For the payments made with the common payment method, the following values ​​will be sent by Teqpay as Post to the address you specified in the callbackUrl parameter automatically when the verification is performed.

Payment Result

Response Parameter
Parameter Name Parametrer Type Explanation
Result boolen Operation result
ResultCode integer Teqpay result code of the payment transaction.
ResultMessage string Description of ResultCode value.
OrderId integer Unique id of the payment transaction This value is set automatically by Teqpay services.
ConversationId string ConversationId information sent by the merchant while initiating the payment request.
PaymentMethodId int Payment Method Id
PaymentMethodName string Payment Method Name
Price decimal Transaction amount
Installment string Installment information
Token string Token information of the payment transaction. It is used to verify that the payment response is received by Teqpay. Please check Token Check page to verify token information.
PaymentMethodStatus string (Json) Contains detailed information on error codes related to the Payment Method and is delivered in JSON format.
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,
    "Installment": "1",
    "Token": "7cb77378a0749f2a9b7e09ea62ffb13febf3759f",
    "PaymentMethodStatus": {
        "StatusCode": "00",
        "StatusMessage": "Başarılı"
    },
    "Extra": {
        "BankName": "AKBANK",
        "BankCode": "0046",
        "ClientId": "123456789",
        "TerminalId": "123456789",
        "AuthCode": "12345",
        "HostRefNo": "123456789123456789",
        "BankOrderId": "1205"
    }