POST Transaction Payment

With Teqpay API, many different payment methods are integrated into one platform. Through Teqpay it is possible to perform payments via vPOS, e-wallets, carrier billing and bank wire transfer.

Service address:/payment

Attention! For vPOS transactions, all payments will be performed by 3D Secure.

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".
paymentMethodId

Requerid

 string Payment Method ID.
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.
cardData

optional

 class Card information. It should be sent only in payments to be made with Virtual Pos. It is not mandatory to send it in other payment types.
moneyTransferData

optional

 class It is only used for payments to be made with ParaTransfer (PayPorter). It is not mandatory to send in other payment types. You can access "Bank Information" by using the service.
mobilePaymentData

optional

 class Class Used for Mobile Payments

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.
CardData
Parameter Name Parametrer Type Explanation
cardNo

Requerid

 string Card Number.
cardHolderName

Requerid

 string Card owner
expDate

Requerid

 string Expiry Date (Month/Year)
cvv

Requerid

 string Security Number
installment

Requerid

 integer Installment information
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.
MoneyTransferData
Parameter Name Parametrer Type Explanation
ibanNo

Requerid

 string Iban number of the bank to which the money transfer will be made.
moneyTransferCode

Requerid

 string Description Code to be used in the money transfer transaction.
MoneyPaymentData
Parameter Name Parametrer Type Explanation
phoneNumber

Requerid

 string Phone Number to Pay

Request Sample
    {
    "customerName": "Teqpay User",
    "customerIpAddress": "10.20.30.40",
    "customerCitizenNo": "12345678900",
    "customerEmail": "test@teqpay.com",
    "customerPhone": "1234567890",
    "price": 1.00,
    "currency": "TRY",
    "conversationId": "147852398",
    "callbackUrl": "https://merchant-test.teqpay.com/payment-callback",
    "language": "TR",
    "paymentMethodId": "1",
    
    "products": [
        {
            "merchantItemId": "1",
            "itemType": "Sanal",
            "itemCategory": "Oyun Pini",
            "itemName": "PubG",
            "itemQuantity": 1,
            "itemPrice": 1.00
        }
    ],
    "billing": {
        "billingName": "Teqpay User",
        "billingCity": "İstanbul",
        "billingCountry": "Türkiye",
        "billingAddress": "Bayrampaşa"
    },
    "shipping": {
        "shippingContactName": "Teqpay User",
        "shippingCity": "İstanbul",
        "shippingCountry": "Türkiye",
        "shippingAddress": "Bayrampaşa"
    },
    "cardData": {
        "cardNo": "5269111122223332",
        "cardHolderName": "Test User",
        "expDate": "12/22",
        "cvv": "000",
        "installment": 1,
        "isPreAuth": "false",
        "paymentSecurity": 1
    },   
    "moneyTransferData": {
        "ibanNo": "",
        "moneyTransferCode": """
    },
    "mobilePaymentData": [
        {
            "phoneNumber": ""
        }
    ],
}

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
OrderId integer Unique id of the payment transaction This value is set automatically by Teqpay services.
ConversationId string The conversationId information sent by the merchant when initiating the payment request. Must be unique value.
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",
      "OrderId": "15795263",
      "Price": 1.00,
      "PaymentUrl": "https://payment-test.teqpay.com/tr/payment-methods-MnJNdGxEZE9qUzhLMVlaY0NxbFNwWlluTFM1U2I0bUVyWk9jektPSU1HST0=",
      "TransactionDate": "2021-09-06 10:06:27"
    }            
}

Attention ! For payments made by Api payment method, if the payment is successful, the following values will be sent by Teqpay to the address you specified in the CallbackUrl parameter as Post.

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.
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",
 "Extra":{
            "BankName":"AKBANK",
            "BankCode":"0046",
            "ClientId":"123456789",
            "TerminalId":"123456789",
            "AuthCode":"12345",
            "HostRefNo":"123456789123456789",
            "BankOrderId":"1205"
         }