GitHubFeedback FormAPI Reference - Beta

Alt Üye İşyeri

Alt Üye Oluşturma

post

Pazaryeri (marketplace) modelinde alt üye işyerini oluşturur. Bireysel, Şahıs Şirketi ve Limited/Anonim tipleri desteklenir. Oluşturulacak alt üye işyeri tipi, subMerchantType parametresine göre belirlenir.

Header parameters
AuthorizationstringRequired

İmza içeren Authorization değeri.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-TypestringRequired

İstek gövdesi formatı.

Example: application/json
Body
one ofOptional

Oluşturulacak subMerchantType’a göre gövde alanları değişir.

or
or
Responses
200

Başarılı yanıt

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

{
  "locale": "tr",
  "conversationId": "conversationId",
  "name": "John's market Test",
  "email": "[email protected]",
  "gsmNumber": "+905350000000",
  "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
  "iban": "TR180006200119000006672315",
  "contactName": "John",
  "contactSurname": "Doe",
  "currency": "TRY",
  "subMerchantExternalId": "ExternalId",
  "identityNumber": "11111111111",
  "subMerchantType": "PERSONAL"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755847240070,
  "conversationId": "conversationId",
  "subMerchantKey": "wt6aF2hwJpms2w7AhTBTW5le9kM="
}

Alt Üye Sorgulama

post

Dış ID (subMerchantExternalId) ile alt üye işyeri detaylarını döner.

Header parameters
AuthorizationstringRequired

İmza içeren Authorization değeri.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-TypestringRequired

İstek gövdesi formatı.

Example: application/json
Body
localestring · enumOptionalExample: trPossible values:
conversationIdstringOptionalExample: 123456789
subMerchantExternalIdstringRequired

Sorgulanacak alt üye işyerinin "ExternalId" bilgisi.

Example: S49222
Responses
200

Başarılı yanıt

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

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

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

Alt Üye Güncelleme

put

Mevcut alt üye işyerinin bilgilerinin güncellenmesi. Gövde şeması alt üye tipine göre değişir; üç varyanttan biri gönderilmelidir. Güncelleme gövdesinde subMerchantType alanı bulunmaz.

Header parameters
AuthorizationstringRequired

İmza içeren Authorization değeri.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-TypestringRequired

İstek gövdesi formatı.

Example: application/json
Body
one ofOptional

Seçilen alt üye tipine göre güncelleme alanları. subMerchantType alanı gönderilmez.

or
or
Responses
200

Başarılı yanıt

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

{
  "locale": "tr",
  "conversationId": "conversationId",
  "name": "Jane2's market",
  "email": "[email protected]",
  "gsmNumber": "+905350000000",
  "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": "tr",
  "systemTime": 1755857408023,
  "conversationId": "123456789"
}

Alt Üye / Hak Ediş Güncelleme

put

Bu servis, tekil bir paymentTransaction üzerinden alt üye işyerine ait hak ediş tutarını değiştirmek veya alt üye işyerine ait bilgileri güncellemek için kullanılır.

Header parameters
AuthorizationstringRequired

İmza içeren Authorization değeri.

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-TypestringRequired

İstek gövdesi formatı.

Example: application/json
Body
localestring · enumOptionalExample: trPossible values:
conversationIdstringOptionalExample: 123456789
paymentTransactionIdstringRequired

Ödeme kırılımına ait id.

Example: 20947104
subMerchantKeystringRequired

Alt üye işyeri anahtarı.

Example: favC6OGPAVHb97HwXG5GPKd4KuE=
subMerchantPricenumberRequired

Alt üye işyerine aktarılacak tutar.

Example: 11
Responses
200

Başarılı yanıt

application/json
put
/payment/item
PUT https://api.iyzipay.com/payment/item
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "conversationId": "123456789",
  "paymentTransactionId" : "20947104",
  "subMerchantKey" : "favC6OGPAVHb97HwXG5GPKd4KuE=",
  "subMerchantPrice" : "11.0"
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1686442628687,
  "conversationId": "123456789",
  "itemId": "BI102",
  "paymentTransactionId": "20947104",
  "transactionStatus": 1,
  "price": 50,
  "paidPrice": 50,
  "merchantCommissionRate": 0,
  "merchantCommissionRateAmount": 0,
  "iyziCommissionRateAmount": 2,
  "iyziCommissionFee": 0.125,
  "blockageRate": 0,
  "blockageRateAmountMerchant": 0,
  "blockageRateAmountSubMerchant": 0,
  "blockageResolvedDate": "2023-06-19 00:00:00",
  "subMerchantKey": "favC6OGPAVHb97HwXG5GPKd4KuE=",
  "subMerchantPrice": 11,
  "subMerchantPayoutRate": 22,
  "subMerchantPayoutAmount": 11,
  "merchantPayoutAmount": 36.875,
  "convertedPayout": {
    "paidPrice": 50,
    "iyziCommissionRateAmount": 2,
    "iyziCommissionFee": 0.125,
    "blockageRateAmountMerchant": 0,
    "blockageRateAmountSubMerchant": 0,
    "subMerchantPayoutAmount": 11,
    "merchantPayoutAmount": 36.875,
    "iyziConversionRate": 0,
    "iyziConversionRateAmount": 0,
    "currency": "TRY"
  }
}

Last updated