Transfer Listing Service
Receipt Listing Service Request Model;
POST
http://posservice.esnekpos.com/api/services/GetExtractList
JSON File
The parameters to be sent to the service are as follows;
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
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.
{
"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;
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