> For the complete documentation index, see [llms.txt](https://developer-eng.esnekpos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer-eng.esnekpos.com/esnekpos-developer-environment/recurring-payment-service/transaction-listing-service.md).

# Transaction Listing Service

### Transaction Listing Service Request Model**;**

<table><thead><tr><th width="102.33333333333331">Method</th><th width="540">API URL</th><th>Parameters</th></tr></thead><tbody><tr><td>POST</td><td>https://posservice.esnekpos.com/api/services/GetRecurringPaymentList</td><td>JSON File</td></tr></tbody></table>

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

#### &#x20;Transaction Listing Service Request Message Parameters

<table><thead><tr><th width="184">Parameters</th><th width="86">Type</th><th width="86">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>MERCHANT</td><td>string</td><td>Yes</td><td>It is a unique credential created specifically for the member business.</td></tr><tr><td>MERCHANT_KEY</td><td>string</td><td>Yes</td><td>It is the key information created specifically for the member business.</td></tr><tr><td>START_DATE</td><td>string</td><td>Yes</td><td>The start date for the query.</td></tr><tr><td>END_DATE</td><td>string</td><td>Yes</td><td>The end date for the query.</td></tr></tbody></table>

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

```json
                                            
{
    "MERCHANT": "TEST1234", 
    "MERCHANT_KEY": "4oK26hK8MOXrIV1bzTRVPA==",
    "START_DATE" : "01-12-2021",
    "END_DATE" : "05-07-2022"
}
                                        
```

#### Transaction Listing Service Reply Messag&#x65;**;**

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

#### &#x20;Transaction Listing Service Reply Message Parameters

<table><thead><tr><th width="238">Parameters</th><th width="81">Type</th><th width="73">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>RETURN_CODE</td><td>string</td><td>Yes</td><td>The status of the recurring payment listing process is the code information.</td></tr><tr><td>RETURN_MESSAGE</td><td>string</td><td>Yes</td><td>It is the status message information as a result of the recurring payment listing process.</td></tr><tr><td>STATUS</td><td>string</td><td>Yes</td><td>It is the status message information as a result of the recurring payment listing process.</td></tr><tr><td>RECURRING_PAYMENTS</td><td>array</td><td>Yes</td><td></td></tr></tbody></table>

<br>

**RECURRING\_PAYMENTS**

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

<br>

**RECURRING\_PAYMENT\_TRANSACTIONS**

<table><thead><tr><th width="177">Parameters</th><th width="97">Type</th><th width="81">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>RECURRING_NO</td><td>int</td><td>Yes</td><td>N. repeat</td></tr><tr><td>PAYMENT_DATE</td><td>string</td><td>Yes</td><td>Replay date</td></tr><tr><td>REF_NO</td><td>int</td><td>Yes</td><td>The reference number information of the repeat. The payment process can be used in inquiry and re-cancellation service.</td></tr><tr><td>STATUS</td><td>string</td><td>Yes</td><td>Status information</td></tr><tr><td>TRIES_COUNT</td><td>string</td><td>Yes</td><td>The number of retry attempts.</td></tr><tr><td>SUCCES_DATE</td><td>string</td><td>Yes</td><td>The date the repeat was successful.</td></tr><tr><td>PAYMENT_ID</td><td>array</td><td>Yes</td><td>If successful again, payment id information.</td></tr><tr><td>IS_ACTIVE</td><td>array</td><td>Yes</td><td>Replay activity status</td></tr></tbody></table>

<br>

**RECURRING\_PAYMENT\_TRIES**

<table><thead><tr><th width="166">Parameters</th><th width="89">Type</th><th width="77">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>PAYMENT_ID</td><td>string</td><td>Yes</td><td>Payment Id Information</td></tr><tr><td>STATUS</td><td>string</td><td>Yes</td><td>Retry status.</td></tr><tr><td>DESCRIPTION</td><td>string</td><td>Yes</td><td>Description of the retry.</td></tr><tr><td>TRY_DATE</td><td>string</td><td>Yes</td><td>The date the retry was made.</td></tr></tbody></table>

```json
                                            
{
    "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": "test@test.com",
            "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.