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;

• PERSONAL

• PRIVATE COMPANY

• LIMITED OR JOINT STOCK COMPANY

Update Submerchant

put

Updates an existing submerchant. The request body shape varies by submerchant type; one of three variants must be sent. The subMerchantType field is not included in the update body.

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

application/json

Update fields vary by submerchant type. Do not send subMerchantType in update.

or

or

Responses

200

Successful response

application/json

statusstring · enumOptional

Result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Operation time (epoch ms).

Example: 1755857408023

conversationIdstringOptional

ID sent in the request.

Example: 123456789

400

Error response

application/json

put/onboarding/submerchant

HTTP (Personal)HTTP (Private Company)HTTP (Limited/Joint-Stock)

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

{
  "locale": "en",
  "conversationId": "conversationId",
  "name": "Jane2's market",
  "email": "[e-mail]",
  "gsmNumber": "[phone]",
  "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
  "iban": "TR180006200119000006672315",
  "contactName": "Jane",
  "contactSurname": "Doe",
  "currency": "TRY",
  "identityNumber": "11111111111",
  "subMerchantKey": "wkF6Nkyn01vmTDNErfJtYkNoFAw="
}

{
  "status": "success",
  "locale": "en",
  "systemTime": 1755857408023,
  "conversationId": "123456789"
}

Sample Codes

PHP

Java

.Net

Node.Js

Python

Postman