Abonelik Başlatma

Abonelik Başlatma (NON3D)

post

Hazır ödeme formu olmadan, Tarafınıza ait ödeme formu ile NON3D servisi üzerinden abonelik başlatabilirsiniz.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

pricingPlanReferenceCodestringRequired

Aboneliğin başlatılacağı planın referans kodu.

Example: 7515f763-5da3-4a35-8f7f-d425ae44ac04

conversationIdstringOptional

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.

Example: 123456789

subscriptionInitialStatusstring · enumRequired

Abonelik başlangıç durumu. PENDING gönderilirse abonelik başlamaz ve tekrar aktif edilmesi gerekir.

Example: ACTIVEPossible values:

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

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

Possible values:

systemTimeintegerOptional

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

400

Başarısız yanıt

application/json

post

/v2/subscription/initialize

HTTPcURL

POST https://api.iyzipay.com/v2/subscription/initialize
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "locale": "tr",
  "pricingPlanReferenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
  "conversationId": "conv-1001",
  "subscriptionInitialStatus": "ACTIVE",
  "customer": {
    "name": "John",
    "surname": "Stone",
    "email": "[email protected]",
    "gsmNumber": "[phone]",
    "identityNumber": "1234567890",
    "billingAddress": {
      "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
      "contactName": "contactName",
      "city": "Istanbul",
      "country": "Türkiye"
    },
    "shippingAddress": {
      "address": "address",
      "zipCode": "zipCode",
      "contactName": "contactName",
      "city": "city",
      "country": "country"
    }
  },
  "paymentCard": {
    "cardHolderName": "John Doe",
    "cardNumber": "5528790000000008",
    "expireMonth": "12",
    "expireYear": "2030",
    "cvc": "123"
  }
}

{
  "status": "success",
  "systemTime": 1755598000000,
  "data": {
    "referenceCode": "8d06cc19-98fb-47a6-ae1f-47f20c4797b4",
    "parentReferenceCode": "535094d2-9257-401b-8e38-f08308e37098",
    "pricingPlanReferenceCode": "515f763-5da3-4a35-8f7f-d425ae44ac04",
    "customerReferenceCode": "775ba402-41f0-4674-968b-43cc787d9366",
    "subscriptionStatus": "ACTIVE",
    "trialDays": 5,
    "trialStartDate": 1755599766595,
    "trialEndDate": 1756031766595,
    "createdDate": 1755599766595,
    "startDate": 1755599766595,
    "endDate": 1787567766595
  }
}

Abonelik Başlatma (iyzico Ödeme Formu)

post

iyzico Ödeme formu (Checkout Form) ile abonelik başlatmak için kullanılır. Ödeme formuna ait content ve token değeri döner.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

localestring · enumOptional

Dil kodu. Varsayılan; tr. Ödeme formunun İngilizce oluşturulması için "en" gönderilmelidir.

Example: trPossible values:

callbackUrlstringRequired

Ödeme sonucunun gönderileceği callback adresi.

Example: https://callbackUrl.com

pricingPlanReferenceCodestringRequired

Aboneliğin başlatılacağı planın referans kodu.

Example: 7515f763-5da3-4a35-8f7f-d425ae44ac04

subscriptionInitialStatusstring · enumRequired

Abonelik başlangıç durumu. PENDING gönderilirse abonelik başlamaz ve tekrar aktif edilmesi gerekir.

Example: ACTIVEPossible values:

conversationIdstringOptional

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.

Example: 123456789

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

İşlem sonucu.

Possible values:

localestring · enumOptional

Yanıt dili.

Possible values:

systemTimeintegerOptional

İşlem zamanı (epoch ms).

Example: 1755596201712

conversationIdstringOptional

İstek sırasında gönderilen değer aynen geri döner.

Example: 123456789

tokenstringOptional

Ödeme formuna ait token değeri.

Example: a9f91f36-2110-4c55-848e-bdd2c7016171

checkoutFormContentstringOptional

Ödeme formuna ait htmlContent değeri.

tokenExpireTimeintegerOptional

Token geçerlilik süresi (saniye).

Example: 1800

400

Başarısız yanıt

application/json

post

/v2/subscription/checkoutform/initialize

HTTPcURL

POST https://api.iyzipay.com/v2/subscription/checkoutform/initialize
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "callbackUrl": "https://callbackUrl.com",
  "pricingPlanReferenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
  "subscriptionInitialStatus": "ACTIVE",
  "conversationId": "conversationId",
  "customer": {
    "name": "John",
    "surname": "Stone",
    "email": "[email protected]",
    "gsmNumber": "[phone]",
    "identityNumber": "1234567890",
    "billingAddress": {
      "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
      "zipCode": "34345",
      "contactName": "contactName",
      "city": "Istanbul",
      "country": "Türkiye"
    },
    "shippingAddress": {
      "address": "Altunizade Mah. İnci Çıkmazı Sokak No: 3 İç Kapı No: 10 Üsküdar İstanbul",
      "zipCode": "34345",
      "contactName": "contactName",
      "city": "Istanbul",
      "country": "Türkiye"
    }
  }
}

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1755596201712,
  "conversationId": "conversationId",
  "token": "a9f91f36-2110-4c55-848e-bdd2c7016171",
  "checkoutFormContent": "<script type=\"text/javascript\">if (typeof iyziInit == 'undefined') {var iyziInit = {currency:\"TRY\",token:\"a9f91f36-2110-4c55-848e-bdd2c7016171\",price:1.00,...}};</script>",
  "tokenExpireTime": 1800
}

Ödeme Formu Sonucunu Alma

get

Checkout form akışı tamamlandıktan sonra ödeme formuna token ile abonelik başlatma sonucunu sorgulanır.

Path parameters

tokenstringRequired

Checkout form initialize ile dönen, ilgili işleme ait token.

Query parameters

conversationIdstringOptional

İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptionalPossible values:

localestring · enumOptionalPossible values:

systemTimeintegerOptional

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

Example: 1755600509451

conversationIdstringOptional

İstek esnasında gönderilen veri aynen geri döner.

Example: 123456789

tokenstringOptional

Ödeme formuna ait token değeri.

Example: 8e86b16e-9c0f-450d-a09d-0fd8a27e5197

400

Başarısız yanıt

application/json

get

/v2/subscription/checkoutform/{token}

HTTPcURL

GET https://api.iyzipay.com/v2/subscription/checkoutform/1590292b-bed2-4909-8833-6c6f85d7ec17
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1755597000000,
  "token": "a9f91f36-2110-4c55-848e-bdd2c7016171",
  "data": {
    "referenceCode": "8d06cc19-98fb-47a6-ae1f-47f20c4797b4",
    "parentReferenceCode": "535094d2-9257-401b-8e38-f08308e37098",
    "pricingPlanReferenceCode": "515f763-5da3-4a35-8f7f-d425ae44ac04",
    "customerReferenceCode": "775ba402-41f0-4674-968b-43cc787d9366",
    "subscriptionStatus": "ACTIVE",
    "trialDays": 5,
    "trialStartDate": 1755599766595,
    "trialEndDate": 1756031766595,
    "createdDate": 1755599766595,
    "startDate": 1755599766595,
    "endDate": 1787567766595
  }
}

Abonelik Başlatma (Existing Customer)

post

Abonelik başlatılmak istenen kullanıcının hali hazırda aktif bir aboneliği bulunuyorsa, customerReferenceCode ile yeni bir abonelik başlatılabilir. Eğer kullanıcının aktif bir aboneliği bulunmuyorsa custormerReferenceCode ile yeni bir abonelik başlatılmamaktadır.

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

application/json

subscriptionInitialStatusstring · enumRequired

Abonelik başlangıç durumu. PENDING gönderilirse abonelik başlamaz ve tekrar aktif edilmesi gerekir.

Example: ACTIVEPossible values:

pricingPlanReferenceCodestringRequired

Aboneliğin başlatılacağı planın referans kodu.

Example: 7515f763-5da3-4a35-8f7f-d425ae44ac04

customerReferenceCodestringRequired

Mevcut müşterinin referans kodu. Aktif bir aboneliği olmalıdır.

Example: 279bb493-6fda-45e9-9368-2373ea43ff8d

Responses

200

Başarılı yanıt

application/json

statusstring · enumOptional

İşlem sonucu.

Possible values:

systemTimeintegerOptional

İşlem zamanı (epoch ms).

400

Başarısız yanıt

application/json

post

/v2/subscription/initialize/with-customer

HTTPcURL

POST https://api.iyzipay.com/v2/subscription/initialize/with-customer
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "subscriptionInitialStatus": "ACTIVE",
  "pricingPlanReferenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
  "customerReferenceCode": "279bb493-6fda-45e9-9368-2373ea43ff8d"
}

{
  "status": "success",
  "systemTime": 1755606762264,
  "data": {
    "referenceCode": "009dac1a-00dc-41e8-a92f-2c24b18e27b9",
    "parentReferenceCode": "f4bb665b-a48a-4100-917f-d7a46b16e586",
    "pricingPlanReferenceCode": "7515f763-5da3-4a35-8f7f-d425ae44ac04",
    "customerReferenceCode": "279bb493-6fda-45e9-9368-2373ea43ff8d",
    "subscriptionStatus": "ACTIVE",
    "trialDays": 5,
    "trialStartDate": 1755606762238,
    "trialEndDate": 1756038762238,
    "createdDate": 1755606762238,
    "startDate": 1755606762238,
    "endDate": 1787574762238
  }
}