iyzico Link API

The services included in the iyzico Link API are listed below.

1. Create iyzico Link

2. Create Fast Link

3. Update iyzico Link

4. Get Details iyzico Link

5. List of iyzico Link

6. Update Link Status

7. Delete Update iyzico Link

Create iyzico Link

post

Used to create a new iyzico Link. On success, returns the link URL. You can share the returned URL with your customers.

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Body

application/json

conversationIdstringOptional

Value sent for request/response correlation.

Example: 123456

localestring · enumOptional

Response language. Default tr.

Example: enPossible values:

namestringRequired

The product name that will be visible to the customer.

Example: Sample Product

descriptionstringRequired

The product description that will be visible to the customer.

Example: 10 Books

pricestring · decimalRequired

Product price.

Example: 50.00

currencyCodestring · enumRequired

Currency code.

Example: TRYPossible values:

encodedImageFilestringRequired

Base64-encoded product image.

Example: a/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3k...

addressIgnorableboolean · enumOptional

Do not request address at checkout (true) / request address (false).

Example: truePossible values:

installmentRequestedboolean · enumOptional

Enable/disable installment sales.

Example: falsePossible values:

stockEnabledboolean · enumOptional

Enable/disable stock control.

Example: truePossible values:

stockCountintegerOptional

Stock quantity.

Example: 25,

flexibleLinkboolean · enumOptional

Lets the customer complete the payment with one of three preset amounts or a custom amount. This feature must be enabled on the merchant account.

Example: truePossible values:

presetPriceValuesinteger · enumOptional

Preset amounts shown for FlexibleLink.

Example: 10Possible values:

categoryTypestring · enumOptional

Product category type. Default value is "UNKNOWN".

Example: PHONEPossible values:

Responses

200

Successful creation response.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

post

/v2/iyzilink/products

HTTP

POST /v2/iyzilink/products
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "conversationId": "123456",
  "locale": "en",
  "name": "Sample Product",
  "description": "10 Books",
  "price": "50.00",
  "currencyCode": "TRY",
  "encodedImageFile": "/9j/4AAQSkZJRgABAQEAYABgAAD...",
  "addressIgnorable": true,
  "installmentRequested": false,
  "stockEnabled": true,
  "stockCount": 25,
  "flexibleLink": true,
  "presetPriceValues": [10.00, 20.00],
  "categoryType": "UNKNOWN"
}

200

Successful creation response.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1687827915258,
  "conversationId": "123456",
  "data": {
    "token": "WxI",
    "url": "https://sandbox.iyzi.link/WxI",
    "imageUrl": "https://sandbox-img.iyzi.link/Wx/I.jpg"
  }
}

Sample Codes

PHP

Java

.Net

Python

Postman

Create Fast Link

post

Creates a Fast Link. Fast Link is a solution that enables quick and easy collection for payments up to 750 TRY. A Fast Link can be used only once. To create a Fast Link, you must first have an approved iyzico link.

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Body

application/json

conversationIdstringOptional

Value sent for request/response correlation.

Example: 123456

localestring · enumOptional

Response language. Default tr.

Example: enPossible values:

descriptionstringOptional

Link description shown to the customer.

Example: 10 Books

pricestring · decimalRequired

Product price.

Example: 75.00

currencyCodestring · enumRequired

Currency code.

Example: TRYPossible values:

Responses

200

Successful creation response.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

post

/v2/iyzilink/fast-link/products

HTTP

POST /v2/iyzilink/fast-link/products
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "conversationId": "123456",
  "locale": "en",
  "description": "10 Books",
  "price": "75.00",
  "currencyCode": "TRY"
}

200

Successful creation response.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1687827915258,
  "conversationId": "123456",
  "data": {
    "token": "WxI",
    "url": "https://sandbox.iyzi.link/WxI",
    "imageUrl": "https://sandbox-img.iyzi.link/Wx/I.jpg"
  }
}

Sample Codes

PHP

Postman

Update iyzico Link

put

Update an existing iyzico Link by using the token returned at creation time.

Path parameters

tokenstringRequired

Token value of the iyzico Link to be updated.

Example: WxI

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Body

application/json

Fields that can be sent for link update (token is sent in the path).

conversationIdstringOptional

Value used for request/response correlation.

Example: 123456

localestring · enumOptional

Response language.

Example: enPossible values:

namestringRequired

Product name.

Example: Updated Product

descriptionstringRequired

Product description.

Example: 10 Books

pricestring · decimalRequired

Product price.

Example: 60.00

currencyCodestring · enumRequired

Currency code.

Example: TRYPossible values:

encodedImageFilestringOptional

Base64-encoded product image.

Example: a/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3k...

addressIgnorableboolean · enumOptional

Do not request/request address.

Example: falsePossible values:

installmentRequestedboolean · enumOptional

Enable/disable installment sales.

Example: truePossible values:

stockEnabledboolean · enumOptional

Enable/disable stock control.

Example: truePossible values:

stockCountintegerOptional

Stock quantity.

Example: 12

categoryTypestring · enumOptional

Product category type. Default value is "UNKNOWN".

Example: PHONEPossible values:

Responses

200

Successful update response.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

put

/v2/iyzilink/products/{token}

HTTP

PUT /v2/iyzilink/products/WxI
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "conversationId": "123456",
  "name": "Updated Product",
  "description": "10 Books",
  "price": "60.00",
  "currencyCode": "TRY",
  "encodedImageFile": "/9j/4AAQSkZJRgABAQEAYABgAAD...",
  "addressIgnorable": false,
  "installmentRequested": true,
  "stockEnabled": true,
  "stockCount": 12
}

200

Successful update response.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1687827915258,
  "conversationId": "123456",
  "data": {
    "token": "WxI",
    "url": "https://sandbox.iyzi.link/WxI",
    "imageUrl": "https://sandbox-img.iyzi.link/Wx/I.jpg"
  }
}

Sample Codes

PHP

Java

.Net

Python

Postman

Get iyzico Link

get

Query a single link by token. Returns the iyzico Link details for the given token.

Path parameters

tokenstringRequired

Token value of the iyzico Link to query.

Example: WxI

Query parameters

localestringOptional

Response language (default en).

Example: en

conversationIdstringOptional

Request/response correlation value.

Example: 123456

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Responses

200

Product detail response.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

get

/v2/iyzilink/products/{token}

HTTP

GET /v2/iyzilink/products/WxI?locale=en&conversationId=123456
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

200

Product detail response.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1687827915258,
  "conversationId": "123456",
  "data": {
    "name": "sample-name",
    "conversationId": "1123456789",
    "description": "10 Books",
    "price": "50.00000000",
    "currencyId": 3,
    "currencyCode": "USD",
    "token": "Wx0",
    "productType": "IYZILINK",
    "productStatus": "ACTIVE",
    "merchantId": 376927,
    "url": "https://sandbox.iyzi.link/Wx0",
    "imageUrl": "https://sandbox-img.iyzi.link/Wx/0.jpg",
    "addressIgnorable": false,
    "soldCount": 0,
    "installmentRequested": false,
    "stockEnabled": false,
    "stockCount": 0,
    "presetPriceValues": [
      "50.00",
      "75.00",
      "100.00"
    ],
    "flexibleLink": false,
    "categoryType": "PHONE"
  }
}

Sample Codes

PHP

Java

.Net

Python

Postman

List iyzico Links

get

Lists all created iyzico Links with pagination.

Query parameters

localestringOptional

Response language.

Example: en

pageinteger · min: 1Optional

Page number.

Example: 1

countinteger · min: 1 · max: 100Optional

Number of items per page.

Example: 10

conversationIdstringOptional

Free-form field for request/response correlation.

Example: test

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Responses

200

Listing response.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

get

/v2/iyzilink/products

HTTP

GET /v2/iyzilink/products?locale=en&page=1&count=10&conversationId=test
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

200

Listing response.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1756284905529,
  "conversationId": "123456789",
  "data": {
    "listingReviewed": true,
    "totalCount": 11,
    "currentPage": 1,
    "pageCount": 11,
    "items": [
      {
        "name": "link",
        "conversationId": "conversationId",
        "description": "description",
        "price": "80.00000000",
        "currencyId": 1,
        "currencyCode": "TRY",
        "token": "AAF9Bw",
        "productType": "IYZILINK",
        "productStatus": "ACTIVE",
        "merchantId": 3410007,
        "url": "https://sandbox.iyzi.link/AAF9Bw",
        "imageUrl": "https://sandbox-img.iyzi.link/AA/F9Bw+V3.jpg",
        "addressIgnorable": true,
        "soldCount": 1,
        "installmentRequested": false,
        "stockEnabled": true,
        "stockCount": 3,
        "presetPriceValues": [],
        "flexibleLink": false,
        "categoryType": "UNKNOWN"
      }
    ]
  }
}

Sample Codes

PHP

Java

.Net

Python

Postman

Update Link Status

patch

Sets an iyzico link’s status to ACTIVE or PASSIVE. Requires the link token and the new status value.

Path parameters

tokenstringRequired

Token of the iyzico link.

Example: WxI

statusstring · enumRequired

New status to set.

Example: PASSIVEPossible values:

Query parameters

localestringOptional

Response language (default en).

Example: en

conversationIdstringOptional

Request/response correlation value.

Example: 123456

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Responses

200

Status update result.

application/json

statusstring · enumOptional

Request result.

Example: successPossible values:

localestring · enumOptional

Response language.

Example: enPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687827915258

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

patch

/v2/iyzilink/products/{token}/status/{status}

HTTP

PATCH /v2/iyzilink/products/WxI/status/PASSIVE?locale=en&conversationId=123456
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

200

Status update result.

{
  "status": "success",
  "locale": "en",
  "systemTime": 1687827915258,
  "conversationId": "123456"
}

Sample Codes

PHP

Postman

Delete iyzico Link

delete

Deletes an iyzico Link.

Path parameters

tokenstringRequired

Token of the link to delete.

Example: WxI

Query parameters

localestringOptional

Response language (default en).

Example: en

conversationIdstringOptional

Request/response correlation value.

Example: 123456

Header parameters

AuthorizationstringRequired

Signature value starting with IYZWSv2 (Base64).

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-Typestring · enumRequired

Request body content type.

Example: application/jsonPossible values:

Responses

200

Deletion result.

application/json

statusstring · enumOptional

Operation result.

Example: successPossible values:

systemTimeintegerOptional

Unix timestamp (ms).

Example: 1687825929316

localestring · enumOptional

Response language.

Example: enPossible values:

conversationIdstringOptional

Echoed back if sent with the request.

Example: 123456

delete

/v2/iyzilink/products/{token}

HTTP

DELETE /v2/iyzilink/products/WxI?locale=en&conversationId=123456
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

200

Deletion result.

{
  "status": "success",
  "systemTime": 1687825929316,
  "locale": "en",
  "conversationId": "123456"
}

Sample Codes

PHP

Java

.Net

Python

Postman