Store Identification

Marketplace Store Identification and Update Service Request Model;

Method
API URL
Parameter

POST

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

JSON File

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

Marketplace Store Definition and Update Service Request Message Parameters

Parameters
Type
CompoltyeCompulsory
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).

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).

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.

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.

IBAN

string

Yes

It is the IBAN information of the bank account for the store (submerchant).

CURRENCY

string

Yes

It is the currency information of the bank account for the store (submerchant). Currently, only “TRY, USD, EUR, GBP” can be sent.

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

{
   "MERCHANT":"TEST1234",
   "MERCHANT_KEY":"4oK26hK8MOXrIV1bzTRVPA==",
   "NAME":"NAME",
   "OWNER_NAME":"OWNER_NAME",
   "OWNER_SURNAME":"OWNER_SURNAME",
   "OWNER_IDENTITY_NUMBER":"12365478912",
   "EMAIL":"[email protected]",
   "GSM":"5435434343",
   "COMPANY_NAME":"COMPANY_NAME",
   "TAX_OFFICE":"TAX_OFFICE",
   "TAX_NUMBER":"TAX_NUMBER",
   "BANK_NAME":"ACCOUNT OWNER NAME",
   "EXTERNAL_ID":"a5s9f6465s1-s164g4r6q",
   "TYPE":"PERSONAL_COMPANY",
   "BANK_ACCOUNTS":[
      {
         "IBAN":"TR123456789123456789123456",
         "CURRENCY":"TRY"
      },
      {
         "IBAN":"TR123456789123456789123468",
         "CURRENCY":"USD"
      }
   ]
}

Marketplace Store Identification and Update Service Reply Message;

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

Parameters
Type
CompoltyeCompulsory
Description

Data

string

Yes

It is the data information of the Identification or Update process.

ResultCode

string

Yes

The status of the Identification or Update operation result is code information.

ResultMessage

string

Yes

It is the status message information as a result of the Identification or Update process.

Exception

string

Yes

It is the exception status information that occurs during the operation for the Identify or Update operation.

                                            
{
    "Data": null,
    "ResultCode": "00",
    "ResultMessage": "SUCCESS",
    "Exception": null
}
                                        

In the Store Identification and Update response message, the value of the ResultMessage parameter returns as 0, and the value of the SUCCESS and ResultCode parameter indicates that the identification or update process was successful.

Last updated