Getting Payment

Marketplace Payment Service Request Model;

Method
API URL
Parameters

POST

https://posservice.esnekpos.com/api/pay/EYV3DPay

JSON File

Marketplace Payment Service Transaction Flow;

In order to perform a successful collection using the marketplace payment model, you must complete your integration by following the procedures described below..

Step 1:

The merchant (Pazaryereri) sends the payment request to the Esnekpos 3D payment service using the request model specified above, together with the user, card, basket, payment amount and installment information, and their web address (BACK_URL) to which the payment result is requested, and initiates the payment process.

In addition to the standard payment process, the “SubMerchantDetails” list has been added. The marketplace will let you know which store will charge how much for collection in the list. The total amount to be received by the stores will be deducted from the total amount to be received by the marketplace, and the remaining balance will be transmitted to the marketplace.

The parameters to be sent to the service are as follows;

Marketplace Checkout Service Request Message Parameters

Parameters
Type
CompoltyeCompulsory
Description

MERCHANT

string

Yes

Marketplace Payment Service Request Message Parameters It is a unique credential created specifically for the member business (Marketplace).

MERCHANT_KEY

string

Yes

It is the key information created specifically for the merchant (Marketplace).

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.

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.

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.

CC_NUMBER

string

Yes

It is the 16-digit card number information of the card on which the payment will be made.

EXP_MONTH

string

Yes

It is the month information of the 2-digit expiration date of the card on which the payment will be made.

EXP_YEAR

string

Yes

It is the 4-digit expiry date of the card, on which the payment will be made, and the year.

CC_CVV

string

Yes

It is the 3-digit security code information on the back of the card where the payment will be made.

CC_OWNER

string

Yes

It is the name and surname information of the card holder to whom the payment will be made.

INSTALLMENT_NUMBER

string

Yes

It is the information of the number of installments requested for the payment process. “1” information should be sent for single shot transactions.

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.

MAIL

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.

CLIENT_IP

string

Yes

It is the IP information of the user (customer) performing the transaction.

EXTERNAL_ID

string

Yes

It is the ID information of the store (submerchant) in the marketplace (merchant) system. This information is assigned by the marketplace.

AMOUNT

string

Yes

It is the amount information to be transferred to the store (submerchant).

Here is a sample JSON file to send to the service;

                                            
{  
   "Config":{  
      "MERCHANT":"TEST1234",
      "MERCHANT_KEY":"4oK26hK8MOXrIV1bzTRVPA==",
      "BACK_URL":"http://localhost:51062/Pages/EYV3DPay.aspx",
      "PRICES_CURRENCY":"TRY",
      "ORDER_REF_NUMBER":"412",
      "ORDER_AMOUNT":"10.00"
   },
   "CreditCard":{  
      "CC_NUMBER":"4531444531442283",
      "EXP_MONTH":"08",
      "EXP_YEAR":"2023",
      "CC_CVV":"000",
      "CC_OWNER":"test",
      "INSTALLMENT_NUMBER":"1"
   },
   "Customer":{  
      "FIRST_NAME":"--",
      "LAST_NAME":"-",
      "MAIL":"[email protected]",
      "PHONE":"-",
      "CITY":"-",
      "STATE":"-",
      "ADDRESS":"-",
      "CLIENT_IP":"::1"
   },
   "SubMerchantDetails":[{  
      "EXTERNAL_ID":"EXTERNAL_ID1",
      "AMOUNT":"5.00" 
   },
   {  
      "EXTERNAL_ID":"EXTERNAL_ID2",
      "AMOUNT":"4.00"
   }]
}
                                        

Step 2:

Esnekpos evaluates the information and sends the reply message to the member business (marketplace). (The URL_3DS field is included in the reply message.)

The parameters of the reply message sent from the service after the transaction are as follows;

Marketplace Payment Service Reply Message Parameters

Parameters
Type
Compulsory
Description

ORDER_REF_NUMBER

string

Yes

It is the reference number information given for the request in the payment request by the merchant (Marketplace).

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 phone information of the user (customer) performing the transaction.

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

string

Yes

It is the information of whether the payment process takes place in 3D.

VIRTUAL_POS_VALUES

string

Yes

It is the virtualpos 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.

                                            
{
    "ORDER_REF_NUMBER": "412",
    "STATUS": "SUCCESS",
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "RETURN_MESSAGE_TR": null,
    "ERROR_CODE": null,
    "DATE": "12.08.2020 11:43:34",
    "URL_3DS": "https://posservicetest.esnekpos.com/api/pay/3DSecurity/order/a8790d467f8d3fd718e0ecbb438cccfccd74ddca6a73bcd60a59bbb9ac8d4264",
    "REFNO": "151038",
    "HASH": "a8790d467f8d3fd718e0ecbb438cccfccd74ddca6a73bcd60a59bbb9ac8d4264",
    "CUSTOMER_NAME": "-- -",
    "CUSTOMER_MAIL": "[email protected]",
    "CUSTOMER_PHONE": "-",
    "CUSTOMER_ADDRESS": "-",
    "CUSTOMER_CC_NUMBER": "453144******2283",
    "CUSTOMER_CC_NAME": null,
    "IS_NOT_3D_PAYMENT": false,
    "VIRTUAL_POS_VALUES": null,
    "RETURN_MESSAGE_3D": null
}
                                        

In the Marketplace Payment Receiving transaction response message, the value of STATUS parameter is SUCCESS and the value of RETURN_CODE parameter is 0, indicating that the 3D Payment transaction has been accepted. In the next step, 3D verification will be done from the user to be paid.

Step 3:

If the payment is accepted by evaluating the reply received by the merchant (Pazaryeri), it directs the customer to the URL_3DS address given by Esnekpos.

Step 4:

Esnekpos finalizes the 3D verification processes, and reports the result of the payment to the BACK_URL address of the member merchant (Marketplace) notified 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 (Marketplace), the value of the STATUS parameter is SUCCESS and the RETURN_CODE parameter is 0, indicating that the marketplace payment process has been completed without any problems.

Last updated