Retrieve Submerchant

In the marketplace solution, you can use the following services to query the documents of your members.

Retrieve Submerchant

POST https://api.iyzipay.com/onboarding/submerchant/detail

Request Body

Name	Type	Description
locale	String	Language (default: tr)
conversationId	String	If set, conversation ID to match request and response
subMerchantExternalId*	String	Merchant identification number on your system

200: OK

{
"status":"success",
"locale":"tr",
"systemTime":1686439210683,
"conversationId":"123456789",
"name":"Jane's market",
"email":"[e-mail]",
"gsmNumber":"[phone]",
"address":"Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
"iban":"TR180006200119000006672315",
"bankCountry":"TR",
"currency":"TRY",
"taxOffice":"Tax office",
"legalCompanyTitle":"Jane Doe inc",
"subMerchantExternalId":"S492gn22",
"identityNumber":"31300864726",
"subMerchantType":"PRIVATE_COMPANY",
"subMerchantKey":"//1GpuCHXkofxapmacyoimf6u/o="
}

Retrieve Submerchant Response

Input Name	Data Type	Description
name	String	Name of submerchant
gsmNumber	String	GSM number of submerchant
taxOffice	String	Tax office of submerchant
taxNumber	String	Tax number of submerchant
legalCompanyTitle	String	Legal Company Title of submerchant
email	String	Email of submerchant
address	String	Address of submerchant
iban	String	IBAN number of submerchant
subMerchantExternalId	String	Merchant provided of submerchant
subMerchantKey	String	Key of submerchant must be
status	String	Service response result (success / failure)
errorCode	String	Error code if service response status is failure
errorMessage	String	Error message if service response status is failure
errorGroup	String	Error group if service response status is failure
locale	String	Language (default: tr)
systemTime	Integer	Response system timestamp value
conversationId	String	If set, conversation ID to match request and response

Retrieve Submerchant Sample Requests

PHP

$request = new \Iyzipay\Request\RetrieveSubMerchantRequest();
$request->setLocale(\Iyzipay\Model\Locale::TR);
$request->setConversationId("123456789");
$request->setSubMerchantExternalId("AS49224");

# make request
$subMerchant = \Iyzipay\Model\SubMerchant::retrieve($request, Config::options());

.NET

RetrieveSubMerchantRequest request = new RetrieveSubMerchantRequest();
request.Locale = Locale.TR.ToString();
request.ConversationId = "123456789";
request.SubMerchantExternalId = "AS49224";

SubMerchant subMerchant = SubMerchant.Retrieve(request, options);

PrintResponse<SubMerchant>(subMerchant);

JAVA

RetrieveSubMerchantRequest request = new RetrieveSubMerchantRequest();
request.setLocale(Locale.TR.getValue());
request.setConversationId("123456789");
request.setSubMerchantExternalId("AS49224");

SubMerchant subMerchant = SubMerchant.retrieve(request, options);

NodeJS

iyzipay.subMerchant.retrieve({
    locale: Iyzipay.LOCALE.TR,
    conversationId: '123456789',
    subMerchantExternalId: 'AS49224'
}, function (err, result) {
    console.log(err, result);
    done();
});

Python

request = {
    'locale': 'tr',
    'conversationId': '123456789',
    'subMerchantExternalId': 'AS49224'
}

sub_merchant = iyzipay.SubMerchant().retrieve(request, options)

JSON

//Request
{
    "locale": "tr",
    "conversationId": "123456789",
    "subMerchantExternalId": "S49222"
}

//Response
{
"status":"success",
"locale":"tr",
"systemTime":1686439210683,
"conversationId":"123456789",
"name":"Jane's market",
"email":"[e-mail]",
"gsmNumber":"[phone]",
"address":"Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
"iban":"TR180006200119000006672315",
"bankCountry":"TR",
"currency":"TRY",
"taxOffice":"Tax office",
"legalCompanyTitle":"Jane Doe inc",
"subMerchantExternalId":"S49222",
"identityNumber":"31300864726",
"subMerchantType":"PRIVATE_COMPANY",
"subMerchantKey":"//1GpuCHXkofxapmacyoimf6u/o="
}