Store Inquiry

Marketplace Store Inquiry Service Request Model;

Method	API URL	Parameter
POST	https://posservice.esnekpos.com/api/services/SubMerchantQuery	JSON File

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

Marketplace Store Inquery Service Request Message Parameters

Parameters	Type	IsMandatory?	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).
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. This information is the unique information of this store to be used in other request parameters.

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

{
   "MERCHANT":"TEST1234",
   "MERCHANT_KEY":"4oK12326hK8MOXrIV1bzTRVPA==",,
   "EXTERNAL_ID":"a5s1239f6465s1-s164g4r6q"
}

Marketplace Store Inquiry Service Response Message;

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

Parameters	Type	IsMandatory?	Description
STATUS	string	Yes	Status information
RETURN_CODE	string	Yes	The status of the balance query is the code information.
RETURN_MESSAGE	string	Yes	It is the status message information as a result of the balance inquiry process.
SUBMERCHANT_DETAIL	array	Yes	It is the detailed information of the Store (submerchant).

SUBMERCHANT_DETAIL

Parameters	Type	IsMandatory?	Description
NAME	string	Yes	It is the name information of the member workplace (Marketplace).
OWNER_NAME	string	Yes	It is the name information of the store (submerchant) owner.
OWNER_SURNAME	string	Yes	It is the surname of the store (submerchant) owner.
OWNER_IDENTITY_NUMBER	string	Yes	Store (submerchant) owner's T.C. Identity Number information.
EMAIL	string	Yes	It is the e-mail information of the store (submerchant) owner.
GSM	string	Yes	It is the phone information of the owner of the store (submerchant).
COMPANY_NAME	string	Yes	Store(submerchant) name information.
TAX_OFFICE	string	Yes	Store (submerchant) tax office information.
TAX_NUMBER	string	Yes	Store (submerchant) tax number information.
BANK_NAME	string	Yes	It is the name of the account holder or the name of the company of the account to which the payments will be made for the store (submerchant).
TYPE	string	Yes	It is the type information of the store (submerchant) in the marketplace (merchant). It will be defined as PERSONAL or PERSONAL_COMPANY or COMPANY. Select PERSONAL for individual stores, PERSONAL_COMPANY for sole proprietorships, COMPANY for companies.
IS_ACTIVE	bool?	Yes	It is the activity status information of the store (submerchant).

{
    "MERCHANT_DETAIL": {
        "NAME": "ELEKSE",
        "OWNER_NAME": "TEST NAME",
        "OWNER_SURNAME": "TEST SURNAME",
        "OWNER_IDENTITY_NUMBER": "12345678910",
        "EMAIL": "[email protected]",
        "GSM": "5345552583",
        "COMPANY_NAME": "ELEKSE ÖDEME KURULUŞU VE PARA A.Ş.",
        "TAX_OFFICE": "Kağıthane",
        "TAX_NUMBER": "",
        "BANK_NAME": "kuveytturk",
        "TYPE": "PERSONAL",
        "IS_ACTIVE": true,
        "BANK_ACCOUNTS": [
            {
                "IBAN": "TR111111111111111111111111",
                "CURRENCY": "TRY"
            }
        ]
    },
    "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.