LogoLogo
GitHubFeedback Form
EN
EN
  • GETTING STARTED
    • Welcome
    • Preliminaries
      • Sandbox
      • Authentication
        • HMACSHA256 Auth
      • Postman Collections
      • Live vs Sandbox
      • Idempotency
      • Limiters
  • Payment Methods
    • PayWithiyzico (PWI)
      • PWI Implementation
        • PWI-Initialize
        • PWI-Retrieve
        • PWI Sample Imp.
    • Direct Charge
      • Non-3DS
        • NON-3DS Implementation
          • Create Payment
          • Retrieve
      • 3DS
        • 3DS Implementation
          • Init 3DS
          • Auth 3DS
      • Checkout Form (CF)
        • CF Implementation
          • CF-Initialize
          • CF-Retrieve
          • CF Sample Imp.
    • PreAuth & Capture
      • Non-3DS
        • Non-3DS Implementation
          • Create PreAuth Payment
          • Create PostAuth Payment
  • Products
    • Online Payment
    • Marketplace
      • Marketplace Implementation
        • Submerchant
          • Submerchant Update
          • Retrieve Submerchant
          • Submerchant Price / Item Update
        • Online Payment
        • Approval
    • Subscription
      • Subscription Implementation
        • Subscription Product
        • Payment Plan
        • Subscription Transactions
        • Subscriber Transactions
    • Bank Transfer
      • Bank Transfer Implementation
        • Bank Transfer Init
        • Bank Transfer Retrieve
      • Bank Transfer FAQ
    • iyzilink
      • iyzilink API
    • Shopping Credit
      • Shopping Credit Implementation
        • Initialize Shopping Credit
        • Retrieve Shopping Credit
        • Shopping Credit Sample Imp.
  • Advanced
    • Card Storage
    • Reporting Service
    • Refund & Cancel
    • Webhook
    • SFTP
    • Settlement Files
    • Fraud Notifications
    • Installment & BIN Service
    • Refund to Balance
    • Retrieve Payment
    • Response Signature Validation
  • Platforms
    • Woocommerce
    • Opencart
    • Prestashop
    • Magento
    • IdeaSoft
    • Ticimax
    • T-Soft
    • Shopify
    • WIX
  • Add-ons
    • Error Codes
      • Bank Error Codes
    • Test Cards
    • Integration Checklist
    • iyzico Logo Pack
Powered by GitBook
LogoLogo

Company

  • About
  • Career
  • Social
  • Youtube

Community

  • Github
  • Medium

Integration

  • Brand Guide
  • Solution Partners
  • Open Source

Contact

  • Contact Us
  • Support Center
On this page
  • Create iyzilink
  • Create iyzilink
  • Update iyzilink
  • Update iyzilink
  • Delete iyzilink
  • Delete iyzilink
  • Get Details iyzilink
  • Get Details iyzilink
  • Status Update iyzilink
  • Status Update/Active iyzilink
  • Status Update/Passive iyzilink
  1. Products
  2. iyzilink

iyzilink API

PreviousiyzilinkNextShopping Credit

Last updated 9 months ago

iyzilink API içerisinde yer alan servisler aşağıda listelenmiştir.

  1. List of iyzilink

Create iyzilink

Upon a successful request to create an iyzilink, you can use the returned "url" parameter and share it with your customers. This URL can be used by your customers to access and utilize the iyzilink for making payments.

Create iyzilink

POST https://api.iyzipay.com/v2/iyzilink/products

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId*

String

Conversation ID to match request and response.

currencyCode*

String

Default is TRY. Alternatives are USD, EUR, GBP, IRR.

encodedImageFile*

String

Base64 encoded version of the product image.

description*

String

Description of the iyzilink product.

name*

String

Name of the iyzilink product.

price*

String

Total amount for iyzilink product.

addressIgnorable

String

Address flag.

installmentRequested

String

Installment flag.

buyerName(productBuyerInfo)

String

Name of the product buyer.

buyerSurname(productBuyerInfo)

String

Surname of the product buyer.

buyerCity(productBuyerInfo)

String

City of the product buyer.

buyerCountry(productBuyerInfo)

String

Country of the product buyer.

buyerGsmNumber(productBuyerInfo)

String

GSM of the product buyer.

buyerEmail(productBuyerInfo)

String

Email of the product buyer.

buyerAddress(productBuyerInfo)

String

Address of the product buyer.

stockCount

Integer

Number of the stocks.

stockEnabled

Boolean

Default is false.

Create iyzilink Response

Output Name
Type
Description

status

String

Service response result (success / failure)

systemTime

Long

Response system timestamp value

locale

String

Language (default: tr)

conversationId

String

If set, conversation ID to match request and response

token

String

Unique value created for each checkout form request. This token is used to access the payment result

url

String

URL of iyzico payment page

imageUrl

String

URL of product

Update iyzilink

When you create an iyzilink, you will receive a token value in the response. You can use this token value to update your existing iyzilinks. This allows you to make modifications or adjustments to your iyzilinks as needed, ensuring flexibility and control over your payment processes.

Update iyzilink

PUT https://api.iyzipay.com/v2/iyzilink/products

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId*

String

Conversation ID to match request and response.

currencyCode*

String

Default is TRY. Alternatives are USD, EUR, GBP, IRR.

encodedImageFile

String

Base64 encoded version of the product image.

description*

String

Description of the iyzilink product.

name*

String

Name of the iyzilink product.

price*

String

Total amount for iyzilink product.

addressIgnorable

String

Address flag.

soldLimit

String

Number of stock.

installmentRequested

String

Installment flag.

token

String

Unique value created for each iyzilink request.

Update iyzilink Response

Output Name
Type
Description

status

String

Service response result (success / failure)

systemTime

Long

Response system timestamp value

locale

String

Language (default: tr)

conversationId

String

If set, conversation ID to match request and response

token

String

Unique value created for each checkout form request. This token is used to access the payment result

url

String

URL of iyzico payment page

imageUrl

String

URL of product

Delete iyzilink

When you create an iyzilink, you will receive a token value in the response. You can use this token value to delete your existing iyzilinks.

Delete iyzilink

DELETE https://api.iyzipay.com/v2/iyzilink/products

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId

String

Conversation ID to match request and response.

token*

String

Unique value created for each iyzilink request.

Delete iyzilink Response

Output Name
Type
Description

status

String

Service response result (success / failure)

systemTime

Long

Response system timestamp value

Get Details iyzilink

Get Details iyzilink

GET https://api.iyzipay.com/v2/iyzilink/products

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId

String

Conversation ID to match request and response.

token*

String

Unique value created for each iyzilink request.

Get Details Response

Output Name
Type
Description

status

String

Service response result (success / failure)

systemTime

Long

Response system timestamp value

locale

String

Language (default: tr)

conversationId

String

If set, conversation ID to match request and response

name

String

Name of product

description

String

Description of product

price

String

Price of product

currencyid

String

Currency ID of product

currencyCode

String

Currency of product

token

String

Unique value created for each checkout form request. This token is used to access the payment result

productType

String

iyzico product type

productStatus

String

Status of product

merchantId

String

url

String

URL of iyzico payment page

imageUrl

String

URL of product

Status Update iyzilink

Status Update/Active iyzilink

PATCH https://api.iyzipay.com/v2/iyzilink/products/{token}/status/ACTIVE

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId

String

Conversation ID to match request and response.

Status Update/Passive iyzilink

PATCH https://api.iyzipay.com/v2/iyzilink/products/{token}/status/PASSIVE

Request Body

Name
Type
Description

locale

String

Language(default:tr). Alternative is ‘en’.

conversationId

String

Conversation ID to match request and response.

Status Update Response

Output Name
Type
Description

status

String

Yapılan isteğin sonucunu belirtir. İşlem başarılı ise success değeri döner.

systemTime

Long

Dönen sonucun o anki unix timestamp değeridir.

locale

String

Kullanılan dil.

conversationId

String

İstek esnasında gönderilmişse, sonuçta aynen geri iletilir.

Create iyzilink
Update iyzilink
Delete iyzilink
Get Details iyzilink
Status Update iyzilink