Common Payment Page
Common Payment Page Request Model;
POST
https://posservice.esnekpos.com/api/pay/CommonPaymentDealer
JSON File
Common Payment Page Service Transaction Flow;
For a successful collection application using the common payment page model, you need to complete your integration by following the detailed items.
Step 1:
The merchant sends the payment request to the secure payment page service of Esnekpos by using the request model specified above, together with his/her own web address (BACK_URL) to which the user wants to be notified of the result of the payment, basket, payment amount information, and initiates the payment process.
All parameters must be sent completely so that transactions can be carried out safely and smoothly and fraud transactions can be prevented.
The parameters to be sent to the service are as follows;
Common Checkout Page Service Request Message Parameters
MERCHANT
string
Yes
It is a unique credential created specifically for the member business.
MERCHANT_KEY
string
Yes
It is the key information created specifically for the member business.
ORDER_REF_NUMBER
string
Yes
It is the reference number information to be given by the member workplace. Payment transactions can be tracked with this reference number. A maximum of 24 characters can be used.
ORDER_AMOUNT
string
Yes
It is the transaction amount information of the payment transaction.
PRICES_CURRENCY
string
Yes
It is the currency information in which the payment transaction will be made. Currently, only “TRY, USD, EUR, GBP” can be sent.
BACK_URL
string
Yes
It is the address information to which the operation result response will be returned by the system. Transaction response will be read from this address by the member business. The result of the process is sent as a form post.
LOCALE
string
Yes
It is the language option information of the payment page. It should be sent as "tr" for Turkish and "en" for English.
FIRST_NAME
string
Yes
It is the name of the user (customer) performing the transaction.
LAST_NAME
string
Yes
It is the surname of the user (customer) who performed the transaction.
string
Yes
It is the e-mail information of the user (customer) performing the transaction.
PHONE
string
Yes
It is the phone information of the user (customer) performing the transaction.
CITY
string
Yes
It is the city information of the user (customer) performing the transaction.
STATE
string
Yes
It is the district information of the user (customer) performing the transaction.
ADDRESS
string
Yes
It is the address information of the user (customer) performing the transaction.
Product
PRODUCT_ID
string
Yes
It is the ID information given to the product by the member merchant.
PRODUCT_NAME
string
Yes
The name of the product.
PRODUCT_CATEGORY
string
Yes
It is the category information of the product.
PRODUCT_DESCRIPTION
string
Yes
It is the description information of the product.
PRODUCT_AMOUNT
string
Yes
It is the amount information of the product.
Here is a sample JSON file to send to the service;
{
"Config" : {
"MERCHANT" : "TEST1234",
"MERCHANT_KEY" : "4oK26hK8MOXrIV1bzTRVPA==",
"ORDER_REF_NUMBER" : "RFN0003",
"ORDER_AMOUNT" : "150",
"PRICES_CURRENCY" : "TRY",
"BACK_URL" : "İşAs a result of the transaction, the return url address that you will specify"
"LOCALE" : "tr"
},
"Customer" : {
"FIRST_NAME" : "Firstname",
"LAST_NAME" : "Lastname",
"MAIL" : "[email protected]",
"PHONE" : "05435434343",
"CITY" : "İstanbul",
"STATE" : "Kağıthane",
"ADDRESS" : "Merkez Mahallesi, Ayazma Cd. No:37/91 Papirus Plaza Kat:5, 34406 Kağıthane / İSTANBUL"
},
"Product" : [
{
"PRODUCT_ID" : "1",
"PRODUCT_NAME" : "Product Name 1",
"PRODUCT_CATEGORY" : "Electronic",
"PRODUCT_DESCRIPTION" : "Product Description",
"PRODUCT_AMOUNT" : "80"
},
{
"PRODUCT_ID" : "2",
"PRODUCT_NAME" : "Product Name 1",
"PRODUCT_CATEGORY" : "Home Textils",
"PRODUCT_DESCRIPTION" : "Product Description",
"PRODUCT_AMOUNT" : "70"
}
]
}
Step 2:
Esnekpos evaluates the information and sends the reply message to the merchant. (There is URL_3DS field in the reply message.)
Secure Payment Page Service Response Message Parameters
ORDER_REF_NUMBER
string
Yes
It is the reference number information of the member used in payment transactions by the merchant.
STATUS
string
Yes
The result of the payment transaction is the status information.
RETURN_CODE
string
Yes
The status of the payment process is the code information.
RETURN_MESSAGE
string
Yes
The status message is the result of the payment process.
RETURN_MESSAGE_TR
string
Yes
It is the Turkish explanation information for the status message as a result of the payment transaction.
ERROR_CODE
string
Yes
Error code information as a result of unsuccessful payment transaction. Bank error codes are also returned within this parameter.
DATE
string
Yes
It is the transaction date information for the payment transaction.
URL_3DS
string
Yes
3D Verification Page URL Address to which the merchant will direct the user
REFNO
string
Yes
The reference number information given by the Esnekpos system for the payment transaction
HASH
string
Yes
Hash information of the payment transaction generated by the Esnekpos system
CUSTOMER_NAME
string
Yes
It is the name and surname of the user (customer) performing the transaction.
CUSTOMER_MAIL
string
Yes
It is the e-mail information of the user (customer) performing the transaction.
CUSTOMER_PHONE
string
Yes
It is the information of the user (customer) performing the transaction on the phone.
CUSTOMER_ADDRESS
string
Yes
It is the address information of the user (customer) performing the transaction.
CUSTOMER_CC_NUMBER
string
Yes
It is the 16-digit card number information of the card on which the payment will be made. Card information is shared in encrypted form.
CUSTOMER_CC_NAME
string
Yes
It is the name and surname information of the card holder to whom the payment will be made.
IS_NOT_3D_PAYMENT
boolean
Yes
It is the information of whether the payment process takes place in 3D.
VIRTUAL_POS_VALUES
string
Yes
It is the esnekpos description information of the payment transaction.
RETURN_MESSAGE_3D
string
Yes
It is the reply message information of the 3D payment transaction received from the bank.
Secure Payment Page Service Response Message Parameters
{
"ORDER_REF_NUMBER": "RFN0003",
"STATUS": "SUCCESS",
"RETURN_CODE": "0",
"RETURN_MESSAGE": "SUCCESS",
"RETURN_MESSAGE_TR": null,
"ERROR_CODE": null,
"DATE": "21.10.2020 09:32:32",
"URL_3DS": "http://pos.esnekpos.com/Pages/CommonPayment.aspx?hash=9f9bde8bafc7389395aa24f47e58905d1063cd77268b791dbc0bcf87a01c2148",
"REFNO": "25057",
"HASH": "9f9bde8bafc7389395aa24f47e58905d1063cd77268b791dbc0bcf87a01c2148",
"CUSTOMER_NAME": null,
"CUSTOMER_MAIL": null,
"CUSTOMER_PHONE": null,
"CUSTOMER_ADDRESS": null,
"CUSTOMER_CC_NUMBER": null,
"CUSTOMER_CC_NAME": null,
"IS_NOT_3D_PAYMENT": false,
"VIRTUAL_POS_VALUES": null,
"RETURN_MESSAGE_3D": null
}
If the value of STATUS parameter is SUCCESS and the value of RETURN_CODE parameter is 0 in the Common Payment Page transaction response message, it means that the Joint Payment Page transaction has been accepted. In the next step, the payment will be made by obtaining the card information and installment information from the user who will make the payment.
Step 3:
If the payment is accepted by evaluating the answer received, the merchant directs the customer to the URL_3DS address given by FlexPos.
Step 4:
Esnekpos receives credit card information and installment information from the user on its own servers using its own security measures and advances the payment process.
Step 5:
FlexPos finalizes the 3D verification process and reports the result of the payment to the BACK_URL address that the member merchant reported in step 1, with the FORM POST method.
<html xmlns=\"http://www.w3.org/1999/xhtml\" >
<head><meta http-equiv=\"Content-Type\" content=\"text/html;charset=iso-8859-9\" /></head>
<body onload='document.forms[0].submit()'>
<form action='" + payment.DEALER_RESPONSE_URL + "' method='post'>
<input type='hidden' name='DATE' value='{0}'>
<input type='hidden' name='HASH' value='{0}'>
<input type='hidden' name='ORDER_REF_NUMBER' value='{0}'>
<input type='hidden' name='REFNO' value='{0}'>
<input type='hidden' name='RETURN_CODE' value='{0}'>
<input type='hidden' name='RETURN_MESSAGE' value='{0}'>
<input type='hidden' name='RETURN_MESSAGE_TR' value='{0}'>
<input type='hidden' name='STATUS' value='{0}'>
<input type='hidden' name='ERROR_CODE' value='{0}'>
<input type='hidden' name='CUSTOMER_NAME' value='{0}'>
<input type='hidden' name='CUSTOMER_MAIL' value='{0}'>
<input type='hidden' name='CUSTOMER_PHONE' value='{0}'>
<input type='hidden' name='CUSTOMER_ADDRESS' value='{0}'>
<input type='hidden' name='CUSTOMER_CC_NUMBER' value='{0}'>
<input type='hidden' name='CUSTOMER_CC_NAME' value='{0}'>
<input type='hidden' name='COMMISSION' value='{0}'>
<input type='hidden' name='AMOUNT' value='{0}'>
<input type='hidden' name='INSTALLMENT' value='{0}'>
</form>
</body>
</html>
In the FORM POST message sent to the merchant, the value of the STATUS parameter is SUCCESS and the RETURN_CODE parameter is 0, indicating that the 3D Payment process has been completed without any problems.
In order to be sure of the payment status, you need to query with the PROCCESS_QUERY method and take into account the answer of the PROCCESS_QUERY method. You need to configure this query as server to server, not client-side.
This PROCCESS_QUERY method you have made in the client browser should not be visible and cannot be followed.
Last updated