Submerchant Price / Item Update

Marketplace product offers;

• change the submerchant of the product in an order whose payment has been completed

• or update the amount to be transferred to the submerchant

with in the help of following API.

Submerchant Item/Price Update

put

This service is used to modify the payout amount of the submerchant or update the submerchant information based on a single paymentTransaction

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

localestring · enumOptionalExample: enPossible values:

conversationIdstringOptionalExample: 123456789

paymentTransactionIdstringRequired

Payment split id.

Example: 20947104

subMerchantKeystringRequired

Submerchant key.

Example: favC6OGPAVHb97HwXG5GPKd4KuE=

subMerchantPricenumberRequired

Amount to be transferred to the submerchant.

Example: 11

Responses

200

Successful response

application/json

statusstring · enumOptionalExample: successPossible values:

localestring · enumOptionalExample: enPossible values:

systemTimeintegerOptionalExample: 1686442628687

conversationIdstringOptionalExample: 123456789

itemIdstringOptionalExample: BI102

paymentTransactionIdstringOptionalExample: 20947104

transactionStatusintegerOptionalExample: 1

pricenumberOptionalExample: 50

paidPricenumberOptionalExample: 50

merchantCommissionRatenumberOptionalExample: 0

merchantCommissionRateAmountnumberOptionalExample: 0

iyziCommissionRateAmountnumberOptionalExample: 2

iyziCommissionFeenumberOptionalExample: 0.125

blockageRatenumberOptionalExample: 0

blockageRateAmountMerchantnumberOptionalExample: 0

blockageRateAmountSubMerchantnumberOptionalExample: 0

blockageResolvedDatestringOptionalExample: 2023-06-19 00:00:00

subMerchantKeystringOptionalExample: favC6OGPAVHb97HwXG5GPKd4KuE=

subMerchantPricenumberOptionalExample: 11

subMerchantPayoutRatenumberOptionalExample: 22

subMerchantPayoutAmountnumberOptionalExample: 11

merchantPayoutAmountnumberOptionalExample: 36.875

400

Error response

application/json

put

/payment/item

HTTPcURL

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

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

{
  "status": "success",
  "locale": "en",
  "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"
  }
}

Sample Codes

PHP

Java

.Net

Node.Js

Postman