Retrieve Submerchant

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

Get Submerchant Detail

post

Returns submerchant details by external ID (subMerchantExternalId).

Header parameters

AuthorizationstringRequired

Authorization header; a signed hash value that starts with IYZWSv2 and is generated in Base64 format.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

Request body content type.

Example: application/json

Body

localestring · enumOptionalExample: enPossible values:

conversationIdstringOptionalExample: 123456789

subMerchantExternalIdstringRequired

ExternalId of the submerchant to query.

Example: S49222

Responses

200

Successful response

application/json

statusstring · enumOptionalExample: successPossible values:

localestring · enumOptionalExample: enPossible values:

systemTimeintegerOptionalExample: 1686439210683

conversationIdstringOptionalExample: 123456789

namestringOptionalExample: Jane's market

emailstringOptionalExample: [email protected]

gsmNumberstringOptionalExample: +905350000000

addressstringOptionalExample: Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul

ibanstringOptionalExample: TR180006200119000006672315

bankCountrystringOptionalExample: TR

currencystringOptionalExample: TRY

taxOfficestringOptionalExample: Tax office

legalCompanyTitlestringOptionalExample: Jane Doe inc

subMerchantExternalIdstringOptionalExample: S49222

identityNumberstringOptional

National ID (TCKN).

Example: 11111111111

subMerchantTypestringOptionalExample: PRIVATE_COMPANY

subMerchantKeystringOptionalExample: //1GpuCHXkofxapmacyoimf6u/o=

400

Error response

application/json

post

/onboarding/submerchant/detail

POST https://api.iyzipay.com/onboarding/submerchant/detail
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "en",
  "conversationId": "123456789",
  "subMerchantExternalId": "S49222"
}

{
  "status": "success",
  "locale": "en",
  "systemTime": 1686439210683,
  "conversationId": "123456789",
  "name": "Jane's market",
  "email": "[email protected]",
  "gsmNumber": "+905350000000",
  "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
  "iban": "TR180006200119000006672315",
  "bankCountry": "TR",
  "currency": "TRY",
  "taxOffice": "Tax office",
  "legalCompanyTitle": "Jane Doe inc",
  "subMerchantExternalId": "S49222",
  "identityNumber": "11111111111",
  "subMerchantType": "PRIVATE_COMPANY",
  "subMerchantKey": "//1GpuCHXkofxapmacyoimf6u/o="
}