Extradition request

Marketplace Return Request Service Request Model;

Method
API URL
Parameter

POST

https://posservice.esnekpos.com/api/services/OrderReturn

JSON File

SubMerchantDetails field must be filled to specify which store's payment should be refunded in the refund request.

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

Parameters
Type
Compoltye
Description

MERCHANT

string

Yes

It is a unique credential created specifically for the merchant (Marketplace).

MERCHANT_KEY

string

Yes

It is the key information created specifically for the merchant (Marketplace).

ORDER_REF_NUMBER

int

Yes

It is the reference number information given by the merchant (Marketplace) when sending the payment transaction request. The payment transaction to be canceled is matched with the reference number of the relevant merchant, and the transaction is carried out.

AMOUNT

string

Yes

It is the Cancellation/Refund amount information of the reference number to be processed.

EXTERNAL_ID

string

Yes

It is the ID information in the marketplace (merchant) system of the store (submerchant). This information is assigned by the marketplace.

AMOUNT

string

Yes

It is the amount information to be deducted from the store (submerchant).

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

                                            
{
    "MERCHANT": "TEST1234",
    "MERCHANT_KEY": "4oK26hK8MOXrIV1bzTRVPA==",
    "ORDER_REF_NUMBER": "412",
    "AMOUNT": "5",
    "SubMerchantDetails":[{  
      "EXTERNAL_ID":"EXTERNAL_ID1",
      "AMOUNT":"5.00" 
     }]
}
                                        

Marketplace Return Request Service Reply Message;

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

Parameters
Type
Compulsory
Description

RETURN_CODE

string

Yes

The status of the return process is the code information.

RETURN_MESSAGE

string

Yes

The status of the return process is the code information.

STATUS

string

Yes

The result of the return process is the status information.

ORDER_REF_NUMBER

string

Yes

It is the reference number information given for the request in the payment request by the merchant (Marketplace).

REFNO

string

Yes

It is the reference number information given by the Esnekpos system for the return transaction.

                                            
{
    "RETURN_CODE": "00",
    "RETURN_MESSAGE": "₺5,00 iade talebiniz alınmıştır.",
    "STATUS": "ORDER_CANCEL",
    "ORDER_REF_NUMBER": 412,
    "REFNO": null
}
                                        

Returning the value of STATUS parameter to ORDER_CANCEL and RETURN_CODE parameter to 0 in the marketplace return request response message indicates that the confirmation process was successful.

Last updated