Transfer Listing Service

Receipt Listing Service Request Model;

Method
API URL
Parameter

POST

http://posservice.esnekpos.com/api/services/GetExtractList

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"
}
                                        

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

Parameters
Type
Compulsory
Description

EXTRACT_ID

array

Yes

The transaction receipt number.

MERCHANT_ID

string

Yes

It is the unique id information created specifically for the member business.

SUB_MERCHANT_EXTERNAL_ID

string

Yes

It is the unique id information created for the stores belonging to the marketplaces.

MERCHANT_DISPLAY_NAME

string

Yes

Member workplace name information.

SALES_COUNT

string

Yes

It is the sales (transaction) quantity information for the current receipt (payment).

RETURN_COUNT

string

Yes

is the number of returns

RETURN_AMOUNT

string

Yes

is the refund amount

TRANSFERRED_AMOUNT

string

Yes

Transferred amount information.

CURRENCY

string

Yes

Transfer currency information. Currently, only “TRY, USD, EUR, GBP” is used.

STATUS_NAME

string

Yes

The status of the transfer is the name information.

STATUS_ID

string

Yes

It is the status id information of the transfer.

TRANSFERRED_DATE

string

Yes

It is the date information of the transfer.

TRANSACTIONS

array

Yes

It is the Json array containing the transaction transactions of the receipt.

PAYMENT_ID

string

Yes

It is the payment id information for the transaction transaction.

TRANSACTION_ID

string

Yes

Transaction transaction id information.

TRANSACTION_DETAIL_ID

string

Yes

Transaction transaction detail id information.

ORDER_REF_NUMBER

array

Yes

It is the reference number information of the request given by the merchant in the payment request.

DATE

array

Yes

Transaction date information.

PAYMENT_AMOUNT

array

Yes

It is the payment amount information of the transaction transaction.

AMOUNT

array

Yes

It is the payment amount information of the transaction transaction.

STATUS_NAME

array

Yes

The status of the transaction is the name information.

STATUS_ID

array

Yes

It is the status id information of the transaction transaction.

RETURN_CODE

string

Yes

The status of the receipt listing process is the code information.

RETURN_MESSAGE

string

Yes

It is the status message information as a result of the receipt listing process.

STATUS

string

Yes

It is the status information of the result of the receipt listing process.

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 - Successful

It is the status information returned as a result of successful payments and sub-transactions.

4

Payment - Unsuccessful

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.

Last updated