Transaction Listing Service

Transaction Listing Service Request Model;

Method	API URL	Parameter
POST	https://posservice.esnekpos.com/api/services/GetPaymentList	JSON File

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

Parameters	Type	Compulsory	Description
MERCHANT	string	Evet	It is a unique credential created specifically for the member business.
MERCHANT_KEY	string	Evet	It is the key information created specifically for the member business.
START_DATE	string	Evet	The start date for the query.
END_DATE	string	Evet	The end date for the query.

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

                                            
{
      "MERCHANT": "TEST1234" , 
      "MERCHANT_KEY": "4oK26hK8MOXrIV1bzTRVPA==" ,
      "START_DATE" : "01-06-2020",
      "END_DATE" : "05-06-2020"
}
                                        

Transaction Listing Service Reply Message;

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

Transaction Listing Service Reply Message Parameters

Parameters	Type	Compulsory	Description
ID	int	Yes	It is the id information created by the system for payment.
MERCHANT	string	Yes	It is the unique name information created specifically for the member business.
DEALERID	int	Yes	It is the unique id information created specifically for the member business.
DEALER_CODE	int	Yes	It is the unique code information created specifically for the member business.
INSERT_DATETIME	string	Yes	It is the time information when the payment is recorded in the system.
CARD_TYPE	string	Yes	Card type information.
CARD_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.
CARD_NAME	string	Yes	Card name information.
CARD_BANK_NAME	string	Yes	It is the bank information that the card belongs to.
CARD_FAMILY	string	Yes	Card family information.
CURRENCY	string	Yes	Payment currency information. Currently, only “TRY, USD, EUR, GBP” is used.
VIRTUALPOS_NAME	string	Yes	Virtual pos name information.
STATUS_NAME	string	Yes	It is status information.
INSTALLMENT	int	Yes	It is the installment information of the payment transaction.
AMOUNT	string	Yes	It is the amount information of the payment transaction.
COMMISSION_AMOUNT	double	Yes	Commission amount information.
VIRTUAL_POS_COMMISSION_AMOUNT	double	Yes	Virtual pos commission amount information.
DEALER_PAYMENT_REF_CODE	string	Yes	Merchant payment reference code information.
COMMISSION_RATE	double	Yes	Commission rate information.
CUSTOMER_NAME	string	Yes	Customer name information.
CUSTOMER_GSM	string	Yes	Customer phone information.
USER_NAME	string	Yes	Username information.
CANCEL_REQUEST	string	Yes	It is the information of whether there is a cancellation request or not.
DEALER_NAME	string	Yes	member business name information
STATUS_ID	int	Yes	Status id information
JSONDATE	string	Yes	Json date information.
JSONPAYMENT	string	Yes	Json payment information
CC_HASH	string	Yes	Credit card hash information.
PAYMENT_BANK_CODE	string	Yes	It is the payment code information returned for the payment transaction from the bank.
TRANSACTIONS	array	Yes	It is a Json object array that contains the transaction details of all transaction transactions of the payment transaction.
PHYSICAL_POS_ID	int	Yes	The unique number of the pos where the payment is made.
PHYSICAL_POS_TITLE	string	Yes	The name of the pos where the payment transaction took place.
PAYMENT_WAY	string	Yes	The method of execution of the payment transaction.

TRANSACTION

Parameters	Type	Compulsory	Description
TRANSACTION_ID	int	Yes	It is the unique id of the subprocess transaction.
STATUS_NAME	string	Yes	It is the status information of the subprocess transaction.
STATUS_ID	int	Yes	It is the status id information of the subprocess transaction.
AMOUNT	string	Yes	It is the amount information of the sub-process transaction.
DATE	string	Yes	It is the date information of the subprocess transaction.
MERCHANT_AMOUNT_TRANSFER_DETAIL	string	Yes	In this section, the transfer detail information of the amount in the sub-transaction transaction related to the payment transaction is given.
SUB_MERCHANT_DETAILS	array	Yes	This section will only be filled for marketplace member businesses. For other merchants, the information in this field is returned as "null". It is the information of how much of the amount realized in the payment transaction is sent or will be sent to which stores of the marketplace.

SUB_MERCHANT_DETAILS

Parameters	Type	Compulsory	Description
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 portion of the amount in the payment transaction that will be sent or sent to the store.
DATE	string	Yes	It is the date of the transaction.
SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL	string	Yes	In this section, the transfer detail information of the amount in the transaction movement of the store is given.

SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL

Parameters	Type	Compulsory	Description
EXTRACT_ID	int	Evet	It is the subprocess transfer number.
SENDED_AMOUNT	string	Evet	Transferred amount information.
SENDED_DATE	string	Evet	The transferred date information.
RETURN_CODE	string	Yes	The status of the receipt listing process is the code information.
RETURN_MESSAGE	string	Yes	The status of the receipt listing process is the code information.
STATUS	string	Yes	It is the status information of the result of the receipt listing process.

PRODUCTS

Parameters	Type	Compulsory	Description
PAYMENT_ID	int	No	It is the payment ID information of the relevant transaction.
PRODUCT_ID	string	Yes	It is the ID information of the product.
PRODUCT_NAME	string	Yes	It is the name information 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	decimal	No	It is the amount information of the product.

                                            
{
    "paymentList": [
        {
            "ID": 000001,
            "MERCHANT": "TEST1234",
            "DEALERID": 1,
            "DEALER_CODE": 1,
            "INSERT_DATETIME": "/Date(1591127723720)/",
            "CARD_TYPE": "DEBIT",
            "CARD_NUMBER": "654321******1234",
            "CARD_NAME": "Name Surname",
            "CARD_BANK_NAME": "turkekonomibankasia.s.",
            "CARD_FAMILY": null,
            "CURRENCY": "TRY",
            "VIRTUALPOS_NAME": "İş Bankası",
            "STATUS_NAME": "Ödeme - Başarılı",
            "STATUS_ID": 3,
            "INSTALLMENT": 1,
            "AMOUNT": 88.50,
            "COMMISSION_AMOUNT": 1.9912500,
            "VIRTUAL_POS_COMMISSION_AMOUNT": 0.9027000,
            "DEALER_PAYMENT_REF_CODE": "20202020202020",
            "COMMISSION_RATE": 0.02250,
            "CUSTOMER_NAME": "Name Surname",
            "CUSTOMER_GSM": "5435434343",
            "USER_NAME": null,
            "CANCEL_REQUEST": false,
            "DEALER_NAME": null,
            "JSONDATE": null,
            "JSONPAYMENT": null,
            "CC_HASH": null,
            "PAYMENT_BANK_CODE": "444444",
            "TRANSACTIONS": [
                {
                    "TRANSACTION_ID": 343666,
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3,
                    "AMOUNT": "88,50",
                    "DATE": "19.04.2020 18:35:09",
                    "MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                        "EXTRACT_ID": 5715,
                        "SENDED_AMOUNT": "7,42",
                        "SENDED_DATE": "4.05.2020 11:58:11"
                    },
                    "SUB_MERCHANT_DETAILS": [
                        {
                            "EXTERNAL_ID": "999999",
                            "AMOUNT": "79,09",
                            "DATE": "19.04.2020 18:35:09",
                            "SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                                "EXTRACT_ID": 5779,
                                "SENDED_AMOUNT": "79,09",
                                "SENDED_DATE": "4.05.2020 11:57:28"
                            }
                        }
                    ]
                }
            ]
        },
        {
            "ID": 000002,
            "MERCHANT": "TEST1234",
            "DEALERID": 1,
            "DEALER_CODE": 1,
            "INSERT_DATETIME": "/Date(1591127580893)/",
            "CARD_TYPE": "DEBIT",
            "CARD_NUMBER": "123456******9876",
            "CARD_NAME": "Name Surname",
            "CARD_BANK_NAME": "ziraat",
            "CARD_FAMILY": null,
            "CURRENCY": "TRY",
            "VIRTUALPOS_NAME": "Ziraatbank",
            "STATUS_NAME": "Payment - Unsuccessful",
            "STATUS_ID": 3,
            "INSTALLMENT": 1,
            "AMOUNT": 47.89,
            "COMMISSION_AMOUNT": 1.0775250,
            "VIRTUAL_POS_COMMISSION_AMOUNT": 0.4884780,
            "DEALER_PAYMENT_REF_CODE": "30303030303030",
            "COMMISSION_RATE": 0.02250,
            "CUSTOMER_NAME": "Name Surname",
            "CUSTOMER_GSM": "5435434343",
            "USER_NAME": null,
            "CANCEL_REQUEST": false,
            "DEALER_NAME": null,
            "JSONDATE": null,
            "JSONPAYMENT": null,
            "CC_HASH": null,
            "PAYMENT_BANK_CODE": "222222",
            "TRANSACTIONS": [
                {
                    "TRANSACTION_ID": 343666,
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3,
                    "AMOUNT": "47,89",
                    "DATE": "19.04.2020 18:35:09",
                    "MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                        "EXTRACT_ID": 5715,
                        "SENDED_AMOUNT": "2,88",
                        "SENDED_DATE": "4.05.2020 11:58:11"
                    },
                    "SUB_MERCHANT_DETAILS": [
                        {
                            "EXTERNAL_ID": "999999",
                            "AMOUNT": "43,93",
                            "DATE": "19.04.2020 18:35:09",
                            "SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                                "EXTRACT_ID": 5779,
                                "SENDED_AMOUNT": "43,93",
                                "SENDED_DATE": "4.05.2020 11:57:28"
                            }
                        }
                    ]
                }
            ],
            "PRODUCTS": [
                {
                    "PAYMENT_ID": 123456,
                    "PRODUCT_ID": 25,
                    "PRODUCT_NAME": "Electronic Home Appliances",
                    "PRODUCT_CATEGORY": "Home Appliances",
                    "PRODUCT_DESCRIPTION": "Home Appliances Sales",
                    "PRODUCT_AMOUNT": 100.00
                }
            ]
        }
    ],
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "STATUS": "SUCCESS"
}
                                        

The return of STATUS parameter as SUCCESS and RETURN_CODE parameter as 0 in the process status query response message indicates that the process status query was successful.

Payment and Payment Sub-Transaction Status Codes and Explanations;

The details of the STATUS_NAME and STATUS_ID statements returned in the details of Payment and Payment Sub-Transactions are as follows;

STATUS_ID	STATUS_NAME	DESCRIPTION
3	Payment - Successfull	It is the status information returned as a result of successful payments and sub-transactions.
4	Payment - Unsuccessfull	It is the status information returned as a result of unsuccessful payments and sub-transactions.
5	Cancel - Successful	It is the status information returned as a result of successful cancellation payments and sub-transactions.
6	Cancel - Unsuccessful	It is the status information returned as a result of unsuccessful cancellation payments and sub-transactions.
7	Return - Successful	It is the status information returned as a result of successful refund payments and sub-transactions.
8	Return - Unsuccessful	It is the status information returned as a result of unsuccessful refund payments and sub-transactions.