> 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/transfer-listing-service.md).

# Transfer Listing Service

### Receipt Listing Service Request Model**;**

<table><thead><tr><th>Method</th><th width="498.3333333333333">API URL</th><th>Parameter</th></tr></thead><tbody><tr><td>POST</td><td>http://posservice.esnekpos.com/api/services/GetExtractList</td><td>JSON File</td></tr></tbody></table>

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

<table><thead><tr><th width="176">Parameters</th><th width="117">Type</th><th width="97">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>MERCHANT</td><td>string</td><td>Evet</td><td>It is a unique credential created specifically for the member business.</td></tr><tr><td>MERCHANT_KEY</td><td>string</td><td>Evet</td><td>It is the key information created specifically for the member business.</td></tr><tr><td>START_DATE</td><td>string</td><td>Evet</td><td>The start date for the query.</td></tr><tr><td>END_DATE</td><td>string</td><td>Evet</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-06-2020",
      "END_DATE" : "05-06-2020"
}
                                        
```

#### Receipt Listing Service Reply Message;

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

#### Receipt Listing Service Reply Message Parameters

<table><thead><tr><th width="284">Parameters</th><th width="80">Type</th><th width="90">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>EXTRACT_ID</td><td>array</td><td>Yes</td><td>The transaction receipt number.</td></tr><tr><td>MERCHANT_ID</td><td>string</td><td>Yes</td><td>It is the unique id information created specifically for the member business.</td></tr><tr><td>SUB_MERCHANT_EXTERNAL_ID</td><td>string</td><td>Yes</td><td>It is the unique id information created for the stores belonging to the marketplaces.</td></tr><tr><td>MERCHANT_DISPLAY_NAME</td><td>string</td><td>Yes</td><td>Member workplace name information.</td></tr><tr><td>SALES_COUNT</td><td>string</td><td>Yes</td><td>It is the sales (transaction) quantity information for the current receipt (payment).</td></tr><tr><td>RETURN_COUNT</td><td>string</td><td>Yes</td><td>is the number of returns</td></tr><tr><td>RETURN_AMOUNT</td><td>string</td><td>Yes</td><td>is the refund amount</td></tr><tr><td>TRANSFERRED_AMOUNT</td><td>string</td><td>Yes</td><td>Transferred amount information.</td></tr><tr><td>CURRENCY</td><td>string</td><td>Yes</td><td>Transfer currency information. Currently, only “TRY, USD, EUR, GBP” is used.</td></tr><tr><td>STATUS_NAME</td><td>string</td><td>Yes</td><td>The status of the transfer is the name information.</td></tr><tr><td>STATUS_ID</td><td>string</td><td>Yes</td><td>It is the status id information of the transfer.</td></tr><tr><td>TRANSFERRED_DATE</td><td>string</td><td>Yes</td><td>It is the date information of the transfer.</td></tr><tr><td>TRANSACTIONS</td><td>array</td><td>Yes</td><td>It is the Json array containing the transaction transactions of the receipt.</td></tr><tr><td>PAYMENT_ID</td><td>string</td><td>Yes</td><td>It is the payment id information for the transaction transaction.</td></tr><tr><td>TRANSACTION_ID</td><td>string</td><td>Yes</td><td>Transaction transaction id information.</td></tr><tr><td>TRANSACTION_DETAIL_ID</td><td>string</td><td>Yes</td><td>Transaction transaction detail id information.</td></tr><tr><td>ORDER_REF_NUMBER</td><td>array</td><td>Yes</td><td>It is the reference number information of the request given by the merchant in the payment request.</td></tr><tr><td>DATE</td><td>array</td><td>Yes</td><td>Transaction date information.</td></tr><tr><td>PAYMENT_AMOUNT</td><td>array</td><td>Yes</td><td>It is the payment amount information of the transaction transaction.</td></tr><tr><td>AMOUNT</td><td>array</td><td>Yes</td><td>It is the payment amount information of the transaction transaction.</td></tr><tr><td>STATUS_NAME</td><td>array</td><td>Yes</td><td>The status of the transaction is the name information.</td></tr><tr><td>STATUS_ID</td><td>array</td><td>Yes</td><td>It is the status id information of the transaction transaction.</td></tr><tr><td>RETURN_CODE</td><td>string</td><td>Yes</td><td>The status of the receipt 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 receipt listing process.</td></tr><tr><td>STATUS</td><td>string</td><td>Yes</td><td>It is the status information of the result of the receipt listing process.</td></tr></tbody></table>

```json
                                            
{
    "EXTRACTS": [
        {
            "EXTRACT_ID": 1111,
            "MERCHANT_ID": 89889,
            "SUB_MERCHANT_EXTERNAL_ID": "null",
            "MERCHANT_DISPLAY_NAME": "DISPLAY NAME",
            "SALES_COUNT": 1,
            "SALES_AMOUNT": "53,53",
            "RETURN_COUNT": 0,
            "RETURN_AMOUNT": "0,00",
            "TRANSFERRED_AMOUNT": "53,53",
            "CURRENCY": "TRY",
            "STATUS_NAME": "Paid",
            "STATUS_ID": 2,
            "TRANSFERRED_DATE": "1.06.2020 13:13:18",
            "TRANSACTIONS": [
                {
                    "PAYMENT_ID": 828282,
                    "TRANSACTION_ID": 222333,
                    "TRANSACTION_DETAIL_ID": 505050,
                    "ORDER_REF_NUMBER": "0.54251300 1595848596|939",
                    "DATE": "7.05.2020 20:47:03",
                    "PAYMENT_AMOUNT": "69,79",
                    "AMOUNT": "53,53",
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3
                }
            ]
        },
        {
            "EXTRACT_ID": 2222,
            "MERCHANT_ID": null,
            "SUB_MERCHANT_EXTERNAL_ID": "99991",
            "MERCHANT_DISPLAY_NAME": "DISPLAY NAME",
            "SALES_COUNT": 3,
            "SALES_AMOUNT": "594,84",
            "RETURN_COUNT": 0,
            "RETURN_AMOUNT": "0,00",
            "TRANSFERRED_AMOUNT": "594,84",
            "CURRENCY": "TRY",
            "STATUS_NAME": "Paid",
            "STATUS_ID": 2,
            "TRANSFERRED_DATE": "1.06.2020 13:11:26",
            "TRANSACTIONS": [
                {
                    "PAYMENT_ID": 767676,
                    "TRANSACTION_ID": 21212121,
                    "TRANSACTION_DETAIL_ID": 4347,
                    "ORDER_REF_NUMBER": "0.54251300 1595848596|935",
                    "DATE": "1.05.2020 09:21:30",
                    "PAYMENT_AMOUNT": "178,24",
                    "AMOUNT": "131,63",
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3
                },
                {
                    "PAYMENT_ID": 81295,
                    "TRANSACTION_ID": 232323,
                    "TRANSACTION_DETAIL_ID": 49494949,
                    "ORDER_REF_NUMBER": "0.54251300 1595848596|936",
                    "DATE": "6.05.2020 19:20:31",
                    "PAYMENT_AMOUNT": "379,99",
                    "AMOUNT": "297,75",
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3
                },
                {
                    "PAYMENT_ID": 818181,
                    "TRANSACTION_ID": 242424,
                    "TRANSACTION_DETAIL_ID": 46464646,
                    "ORDER_REF_NUMBER": "0.54251300 1595848596|937",
                    "DATE": "6.05.2020 20:02:38",
                    "PAYMENT_AMOUNT": "207,59",
                    "AMOUNT": "165,46",
                    "STATUS_NAME": "Payment - Successful",
                    "STATUS_ID": 3
                }
            ]
        }
    ],
    "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;

<table><thead><tr><th width="136">STATUS_ID</th><th width="174.33333333333331">STATUS_NAME</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td>3</td><td>Payment - Successful</td><td>It is the status information returned as a result of successful payments and sub-transactions.</td></tr><tr><td>4</td><td>Payment - Unsuccessful</td><td>It is the status information returned as a result of unsuccessful payments and sub-transactions.</td></tr><tr><td>5</td><td>Cancel - Successful</td><td>It is the status information returned as a result of successful cancellation payments and sub-transactions.</td></tr><tr><td>6</td><td>Cancel - Unsuccessful</td><td>It is the status information returned as a result of unsuccessful cancellation payments and sub-transactions.</td></tr><tr><td>7</td><td>Return - Successful</td><td>It is the status information returned as a result of successful refund payments and sub-transactions.</td></tr><tr><td>8</td><td>Return - Unsuccessful</td><td>It is the status information returned as a result of unsuccessful refund payments and sub-transactions.</td></tr></tbody></table>