Submerchant Update

This service allows you to update submerchant accounts by providing their necessary details.

In the process of updating submerchants, it's important to note that you cannot change the submerchant type. Once a submerchant is created with a specific type, it cannot be modified to a different type. Therefore, it's crucial to ensure that the correct submerchant type is selected during the initial setup.

All of the submerchant types are capable of update operations;

• Individual

• Sole Proprietorship

• Limited/Incorporated Company

Individual Submerchant Update Request

PUT https://api.iyzipay.com/onboarding/submerchant

Request Body

Name	Type	Description
locale	String	Language (default: tr)
conversationId	String	If set, conversation ID to match request and response
address*	String	Address of submerchant
contactName*	String	Contact name of submerchant
contactSurname*	String	Surname of submerchant
email*	String	Email of submerchant
name	String	Name of submerchant
iban*	String	IBAN of submerchant. Its expected that contactName and contactSurname matches with IBAN. Even if it left blank while creating the submerchant, it must be filled before approving the payment.
identityNumber	String	ID of submerchant
currency	String	Default is TL. Alternatives; USD, EUR, GBP, CHF and NOK
subMerchantKey	String	Key of submerchant

200: OK

Sole Proprietorship Submerchant Update Request

PUT https://api.iyzipay.com/onboarding/submerchant

Request Body

Name	Type	Description
locale	String	Language (default: tr)
conversationId	String	If set, conversation ID to match request and response
address*	String	Address of submerchant
contactName*	String	Contact name of submerchant
contactSurname*	String	Surname of submerchant
email*	String	Email of submerchant
name	String	Name of submerchant
iban*	String	IBAN of submerchant. Its expected that contactName and contactSurname matches with IBAN. Even if it left blank while creating the submerchant, it must be filled before approving the payment.
identityNumber	String	ID of submerchant
currency	String	Default is TL. Alternatives; USD, EUR, GBP, CHF and NOK
subMerchantKey	String	Key of submerchant
taxOffice*	String	Tax office of submerchant
legalCompanyTitle*	String	Legal Company Title of submerchant

200: OK

Limited/Incorporated Company Submerchant Update Request

PUT https://api.iyzipay.com/onboarding/submerchant

Request Body

Name	Type	Description
locale	String	Language (default: tr)
conversationId	String	If set, conversation ID to match request and response
address*	String	Address of submerchant
contactName*	String	Contact name of submerchant
contactSurname*	String	Surname of submerchant
email*	String	Email of submerchant
name	String	Name of submerchant
iban*	String	IBAN of submerchant. Its expected that contactName and contactSurname matches with IBAN. Even if it left blank while creating the submerchant, it must be filled before approving the payment.
identityNumber	String	ID of submerchant
currency	String	Default is TL. Alternatives; USD, EUR, GBP, CHF and NOK
subMerchantKey*	String	Key of submerchant
taxOffice*	String	Tax office of submerchant
legalCompanyTitle*	String	Legal Company Title of submerchant

200: OK

Submerchant Update Response

Output Name	Type	Description
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

Submerchant Update Sample Codes

Individual Submerchant Update Request;

PHP

$request = new \Iyzipay\Request\UpdateSubMerchantRequest();
    $request->setLocale(\Iyzipay\Model\Locale::TR);
    $request->setConversationId("123456789");
    $request->setSubMerchantKey("sub merchant key");
    $request->setIban("TR630006200027700006678204");
    $request->setAddress("Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1");
    $request->setContactName("Jane");
    $request->setContactSurname("Doe");
    $request->setEmail("[e-mail]");
    $request->setGsmNumber("[phone]");
    $request->setName("Jane's market");
    $request->setIdentityNumber("31300864726");
    $request->setCurrency(\Iyzipay\Model\Currency::TL);

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

.NET

UpdateSubMerchantRequest request = new UpdateSubMerchantRequest();
request.Locale = Locale.TR.ToString();
request.ConversationId = "123456789";
request.SubMerchantKey = "sub merchant key";
request.Address = "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1";
request.TaxOffice = "Tax office";
request.ContactName = "John";
request.ContactSurname = "Doe";
request.Email = "[e-mail]";
request.GsmNumber = "[phone]";
request.Name = "Jane's market";
request.Iban = "TR180006200119000006672315";
request.Currency = Currency.TRY.ToString();

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

JAVA

UpdateSubMerchantRequest request = new UpdateSubMerchantRequest();
request.setLocale(Locale.TR.getValue());
request.setConversationId("123456789");
request.setSubMerchantKey("sub merchant key");
request.setAddress("Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1");
request.setContantName("John");
request.setContactSurname("Doe");
request.setEmail("[e-mail]");
request.setGsmNumber("[phone]");
request.setName("Jane's market");
request.setIban("TR180006200119000006672315");
request.setIdentityNumber("31300864726");
request.setCurrency(Currency.TRY.name());

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

NodeJS

iyzipay.subMerchant.update({
    locale: Iyzipay.LOCALE.TR,
    conversationId: '123456789',
    subMerchantKey: 'sub merchant key',
    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
    contactName: 'John',
    contactSurname: 'Doe',
    email: '[e-mail]',
    gsmNumber: '[phone]',
    name: 'Jane\'s market',
    iban: 'TR180006200119000006672315',
    identityNumber: '31300864726',
    currency: Iyzipay.CURRENCY.TRY
}, function (err, result) {
    console.log(err, result);
    done();
});

Python

request = dict([('locale', 'tr')])
request['conversationId'] = '123456789'
request['subMerchantKey'] = 'sub merchant key'
request['address'] = 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1'
request['contactName'] = 'John'
request['contactSurname'] = 'Doe'
request['email'] = '[e-mail]'
request['gsmNumber'] = '[phone]'
request['name'] = 'John\'s market'
request['iban'] = 'TR180006200119000006672315'
request['identityNumber'] = '31300864726'
request['currency'] = 'TRY'

sub_merchant = iyzipay.SubMerchant()
sub_merchant_response = sub_merchant.update(request, options)

Ruby

request = {
    locale: 'tr',
    conversationId: '123456789',
    subMerchantExternalId: 'S49222',
    subMerchantKey: 'sub merchant key',
    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
    contactName: 'John',
    contactSurname: 'Doe',
    email: '[e-mail]',
    gsmNumber: '[phone]',
    name: 'Jane\'s market',
    iban: 'TR180006200119000006672315',
    identityNumber: '31300864726',
    currency: Iyzipay::Model::Currency::TRY
}
sub_merchant = Iyzipay::Model::SubMerchant.new.update(request, @options)

JSON

//Request
{
    "locale": "tr",
    "conversationId": "123456789",
    "name": "Jane's market",
    "email": "[e-mail]",
    "gsmNumber": "[phone]",
    "address": "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
    "iban": "TR180006200119000006672315",
    "contactName": "John",
    "contactSurname": "Doe",
    "currency": "TRY",
    "subMerchantKey": "PPFFZPedVQSvaOqZu5xpvpLEqmc=",
    "identityNumber": "31300864726"
}

//Response
{
    "status": "success",
    "locale": "tr",
    "systemTime": 1470732942251,
    "conversationId": "123456789"
}

Sole Proprietorship Submerchant Update Request;

PHP

$request = new \Iyzipay\Request\UpdateSubMerchantRequest();
$request->setLocale(\Iyzipay\Model\Locale::TR);
$request->setConversationId("123456789");
$request->setSubMerchantKey("sub merchant key");
$request->setIban("TR630006200027700006678204");
$request->setAddress("Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1");
$request->setContactName("Jane");
$request->setContactSurname("Doe");
$request->setEmail("[e-mail]");
$request->setGsmNumber("[phone]");
$request->setName("Jane's market");
$request->setIdentityNumber("31300864726");
$request->setCurrency(\Iyzipay\Model\Currency::TL);

$subMerchant = \Iyzipay\Model\SubMerchant::update($request, Config::options());

.NET

UpdateSubMerchantRequest request = new UpdateSubMerchantRequest();
request.Locale = Locale.TR.ToString();
request.ConversationId = "123456789";
request.SubMerchantKey = "sub merchant key";
request.Address = "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1";
request.TaxOffice = "Tax office";
request.LegalCompanyTitle = "Jane Doe inc";
request.Email = "[e-mail]";
request.GsmNumber = "[phone]";
request.Name = "Jane's market";
request.Iban = "TR180006200119000006672315";
request.IdentityNumber = "31300864726";
request.Currency = Currency.TRY.ToString();

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

JAVA

UpdateSubMerchantRequest request = new UpdateSubMerchantRequest();
request.setLocale(Locale.TR.getValue());
request.setConversationId("123456789");
request.setSubMerchantKey("sub merchant key");
request.setAddress("Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1");
request.setTaxOffice("Tax office");
request.setLegalCompanyTitle("Jane Doe inc");
request.setEmail("[e-mail]");
request.setGsmNumber("[phone]");
request.setName("Jane's market");
request.setIban("TR180006200119000006672315");
request.setIdentityNumber("31300864726");
request.setCurrency(Currency.TRY.name());

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

NodeJS

iyzipay.subMerchant.update({
    locale: Iyzipay.LOCALE.TR,
    conversationId: '123456789',
    subMerchantKey: 'sub merchant key',
    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
    taxOffice: 'Tax office',
    legalCompanyTitle: 'Jane Doe inc',
    email: '[e-mail]',
    gsmNumber: '[phone]',
    name: 'Jane\'s market',
    iban: 'TR180006200119000006672315',
    identityNumber: '31300864726',
    currency: Iyzipay.CURRENCY.TRY
}, function (err, result) {
    console.log(err, result);
    done();
});

Python

request = dict([('locale', 'tr')])
request['conversationId'] = '123456789'
request['subMerchantKey'] = 'sub merchant key'
request['address'] = 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1'
request['taxOffice'] = 'Tax Office'
request['legalCompanyTitle'] = 'John Doe inc'
request['email'] = '[e-mail]'
request['gsmNumber'] = '[phone]'
request['name'] = 'John\'s market'
request['iban'] = 'TR180006200119000006672315'
request['identityNumber'] = '31300864726'
request['currency'] = 'TRY'

sub_merchant = iyzipay.SubMerchant()
sub_merchant_response = sub_merchant.update(request, options)

Ruby

request = {
    locale: 'tr',
    conversationId: '123456789',
    subMerchantExternalId: 'S49222',
    subMerchantKey: 'sub merchant key',
    address: 'Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1',
    taxOffice: 'Tax office',
    legalCompanyTitle: 'Jane Doe inc',
    email: '[e-mail]',
    gsmNumber: '[phone]',
    name: 'Jane\'s market',
    iban: 'TR180006200119000006672315',
    identityNumber: '31300864726',
    currency: Iyzipay::Model::Currency::TRY
}
sub_merchant = Iyzipay::Model::SubMerchant.new.update(request, @options)

JSON

//Request
{
    "locale": "tr",
    "conversationId": "123456789",
    "name": "Jane's market",
    "email": "[e-mail]",
    "gsmNumber": "[phone]",
    "address": "Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1",
    "iban": "TR180006200119000006672315",
    "taxOffice": "Tax office",
    "legalCompanyTitle": "Jane Doe inc",
    "currency": "TRY",
    "subMerchantKey": "PPFFZPedVQSvaOqZu5xpvpLEqmc=",
    "identityNumber": "31300864726"
}

//Response
{
    "status": "success",
    "locale": "tr",
    "systemTime": 1470732942251,
    "conversationId": "123456789"
}

Limited/Incorporated Company Submerchant Update Request;

PHP

$request = new \Iyzipay\Request\UpdateSubMerchantRequest();
$request->setLocale(\Iyzipay\Model\Locale::TR);
$request->setConversationId("123456789");
$request->setSubMerchantKey("sub merchant key");
$request->setAddress("Nidakule Göztepe, Merdivenköy Mah. Bora Sok. No:1");
$request->setTaxOffice("Tax office");
$request->setTaxNumber("9261877");
$request->setLegalCompanyTitle("ABC inc");
$request->setEmail("[e-mail]");
$request->setGsmNumber("[phone]");
$request->setName("Jane's market");
$request->setIban("TR180006200119000006672315");
$request->setCurrency(\Iyzipay\Model\Currency::TL);

$subMerchant = \Iyzipay\Model\SubMerchant::update($request, Config::options());