Transaction Inquiry Service
POST
https://posservice.esnekpos.com/api/services/ProcessQuery
JSON File
The parameters to be sent to the service are as follows;
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.
ORDER_REF_NUMBER
string
Yes
It is the reference number information given by the merchant when sending the payment transaction request. The transaction is carried out by matching the payment transaction to be made to the reference number of the relevant merchant.
Here is a sample JSON file to send to the service;
Transaction Status Inquiry Service Reply Message;
While some of the parameters of the reply message sent from the service after the transaction are used for all merchants, some parameters are filled only for merchants defined to the system as a marketplace. These parameters and their explanations are as follows;
Transaction Status Inquiry Service Response Message Parameters
STATUS
string
Yes
The result of the payment transaction is the status information.
RETURN_CODE
string
Yes
The status of the payment process is the code information.
RETURN_MESSAGE
string
Yes
The status message is the result of the payment process.
DATE
string
Yes
It is the transaction date information for the query operation.
PAYMENT_DATE
string
Yes
It is the transaction date information for the payment transaction.
REFNO
string
Yes
It is the reference number information given by the Esnekpso system for the payment transaction.
AMOUNT
string
Yes
It is the transaction amount information of the payment transaction.
ORDER_REF_NUMBER
string
Yes
It is the reference number information of the request given by the merchant in the payment request.
INSTALLMENT
string
Yes
It is the information of the number of installments requested for the payment process. “1” information is returned for single shot operations.
SUCCESS_TRANSACTION_ID
int
Yes
When the payment transaction is successful, TRANSACTION ID information of this payment transaction is returned.
TRANSACTIONS
array
Yes
It is a Json object array that contains the transaction details of all transaction transactions of the payment transaction.
PHYSICAL_POS_ID
int
Yes
The unique number of the pos where the payment is made.
PHYSICAL_POS_TITLE
string
Yes
The name of the pos where the payment transaction took place.
PAYMENT_WAY
string
Yes
The method of execution of the payment transaction.
TRANSACTION
TRANSACTION_ID
string
Yes
The unique credential of the subprocess transaction.
STATUS_NAME
string
Yes
It is the status information of the subprocess transaction.
AMOUNT
string
Yes
It is the amount information of the sub-process transaction.
DATE
string
Yes
It is the date information of the subprocess transaction.
MERCHANT_AMOUNT_TRANSFER_DETAIL
string
Yes
In this section, the transfer detail information of the amount in the sub-transaction transaction related to the payment transaction is given.
SUB_MERCHANT_DETAILS
array
Yes
This section will only be filled for marketplace member businesses. For other merchants, the information in this field is returned as "null". It is the information of how much of the amount realized in the payment transaction is sent or will be sent to which stores of the marketplace.
SUB_MERCHANT_DETAILS
EXTERNAL_ID
string
Yes
It is the ID information of the store (submerchant) in the marketplace (merchant) system. This information is assigned by the marketplace.
AMOUNT
string
Yes
It is the portion of the amount in the payment transaction that will be sent or sent to the store.
DATE
string
Yes
It is the date of the transaction.
SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL
string
Yes
In this section, the transfer detail information of the amount in the transaction movement of the store is given.
MERCHANT_AMOUNT_TRANSFER_DETAIL, SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL
EXTRACT_ID
string
Yes
It is the subprocess transfer number.
SENDED_AMOUNT
string
Yes
Transferred amount information.
SENDED_DATE
string
Yes
The transferred date information.
In the transaction status inquiry response message, if the transaction type is "Payment - Successful" (Ödeme-Başarılı) or "Return - Successful" (İade - Başarılı), the value of the STATUS parameter is SUCCESS and the value of the RETURN_CODE parameter is "0", indicating that the transaction status inquiry has been completed successfully.
If the transaction type is "Cancel - Successful" (İptal- Başarılı), the value of the STATUS parameter is "ORDER_CANCEL" and the value of the RETURN_CODE parameter is "300", indicating that the transaction status inquiry 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