Transaction Listing Service

Transaction Listing Service Request Model;

Method	API URL	Parameters
POST	https://posservice.esnekpos.com/api/services/GetRecurringPaymentList	JSON File

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

Transaction Listing Service Request Message Parameters

Parameters	Type	Compulsory	Description
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.
START_DATE	string	Yes	The start date for the query.
END_DATE	string	Yes	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-12-2021",
    "END_DATE" : "05-07-2022"
}
                                        

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
RETURN_CODE	string	Yes	The status of the recurring payment listing process is the code information.
RETURN_MESSAGE	string	Yes	It is the status message information as a result of the recurring payment listing process.
STATUS	string	Yes	It is the status message information as a result of the recurring payment listing process.
RECURRING_PAYMENTS	array	Yes

RECURRING_PAYMENTS

Parametre	Tip	Compulsory	Açıklama
ID	string	Yes	Recurring payment id information
DATE	string	Yes	It is the transaction date information for the payment transaction.
RECURRING_COUNT	string	Yes	The number of repetitions
TRY_COUNT_LIMIT	int	Yes	Number of repeat attempts
AMOUNT	string	Yes	Recurring payment amount information
CURRENCY	string	Yes	Recurring payment transaction currency.('TRY','USD','EUR')
SUCCES_COUNT	string	Yes	Successful repetition number of recurring payment information
DEALER_REF_NO	string	Yes	It is the reference number information given by the merchant when sending the payment transaction request.
CUSTOMER_GSM	string	Yes	Customer phone information.
CUSTOMER_EMAIL	string	Yes	Customer email information.
COSTUMER_NAME	string	Yes	Customer name information.
COSTUMER_ADRESS	string	Yes	Customer address information.

RECURRING_PAYMENT_TRANSACTIONS

Parameters	Type	Compulsory	Description
RECURRING_NO	int	Yes	N. repeat
PAYMENT_DATE	string	Yes	Replay date
REF_NO	int	Yes	The reference number information of the repeat. The payment process can be used in inquiry and re-cancellation service.
STATUS	string	Yes	Status information
TRIES_COUNT	string	Yes	The number of retry attempts.
SUCCES_DATE	string	Yes	The date the repeat was successful.
PAYMENT_ID	array	Yes	If successful again, payment id information.
IS_ACTIVE	array	Yes	Replay activity status

RECURRING_PAYMENT_TRIES

Parameters	Type	Compulsory	Description
PAYMENT_ID	string	Yes	Payment Id Information
STATUS	string	Yes	Retry status.
DESCRIPTION	string	Yes	Description of the retry.
TRY_DATE	string	Yes	The date the retry was made.

                                            
{
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "STATUS": "SUCCESS",
    "RECURRING_PAYMENTS": [
        {
            "ID": 343666,
            "DATE": "24.06.2022",
            "RECURRING_COUNT": "10",
            "TRY_COUNT_LIMIT": "5",
            "AMOUNT": "1250,00",
            "CURRENCY": "TRY",
            "SUCCESS_COUNT": "3",
            "DEALER_REF_NO": "ORDER_REF_NUMBER",
            "COSTUMER_GSM": "5553332211",
            "COSTUMER_EMAIL": "[email protected]",
            "COSTUMER_NAME": "TEST USER",
            "COSTUMER_ADRESS": "TEST ADRESS",
            "RECURRING_PAYMENT_TRANSACTIONS": [
                { 
                "RECURRING_NO": 1,
                "PAYMENT_DATE": "24.06.2022",
                "REF_NO": "REF_NO_1",
                "STATUS": "Başarılı",
                "TRIES_COUNT": "1",
                "SUCCESS_DATE": "24.06.2022",
                "PAYMENT_ID": "343312",
                "IS_ACTIVE": "true",
                "RECURRING_PAYMENT_TRIES ": [
                        {
                        "PAYMENT_ID": "343312",
                        "STATUS": "Başarılı",
                        "DESCRIPTION": "Başarılı"
                        "TRY_DATE": "24.06.2022"
                        }
                    ]
                },
                { 
                "RECURRING_NO": 2,
                "PAYMENT_DATE": "24.07.2022",
                "REF_NO": "REF_NO_2",
                "STATUS": "Waiting",
                "TRIES_COUNT": "0",
                "SUCCESS_DATE": null,
                "PAYMENT_ID": null,
                "IS_ACTIVE": "true",
                "RECURRING_PAYMENT_TRIES ": []
                }
            ]
        }
    ]
}
                                            
                                        

In the transaction listing service response message, the value of the STATUS parameter is SUCCESS and the RETURN_CODE parameter is 0, indicating that the transaction listing service has been performed successfully.