Abone İşlemleri

Her abonelik ödemesi sonucunda detayları verilen müşteri için varsayılan olarak bir customerReferenceCode oluşur. Şu an için bu referans kodu sadece müşteri bilgisini getirmek ve güncellemek için kullanılabilir.

Müşteriler email parametresi baz alınarak oluşturulur veya güncellenir. Örneğin, X maili ile abonelik oluşturulan bir müşteri için eşşsiz A referans kodu üretilir. X maili başka bir abonelikte kullanılır ise istekte gönderilen müşteri detayları güncellenir ve yine eşşiz A referans kodu üretilir.

Aboneler üzerinde kullanılabilecek 3 farklı metod vardır.

Abone Güncelleme

post

Bir abonenin tüm detayları API isteği ile güncellenebilir. Bunun için aboneye ait customerReferenceCode path parametresi ve güncellenecek alanlar request body içinde gönderilmelidir. Gönderilen parametreler üzerinden güncelleme yapılır; en az bir alan gönderilmesi zorunludur.

Path parameters

customerReferenceCodestringRequired

Müşteri referans kodu.

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

Header parameters

AuthorizationstringRequired

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

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Body

Güncellenecek alanlar. Tüm alanlar opsiyoneldir ancak gövde en az bir alan içermelidir.

namestringOptional

Kullanıcı adı.

Example: John

surnamestringOptional

Kullanıcı soyadı.

Example: Doe

emailstringOptional

Kullanıcı e-posta adresi.

Example: [email protected]

gsmNumberstringOptional

GSM numarası. +90 formatında gönderilmesi önerilir.

Example: +905554443333

identityNumberstringOptional

T.C. Kimlik Numarası.

Example: 11111111111

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

post

POST https://api.iyzipay.com/v2/subscription/customers/279bb493-6fda-45e9-9368-2373ea43ff8d
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "name": "John",
  "surname": "Doe",
  "email": "[email protected]",
  "gsmNumber": "+905554443333",
  "identityNumber": "11111111111",
  "billingAddress": {
    "address": "address1",
    "zipCode": "34940",
    "contactName": "John Doe",
    "city": "İstanbul",
    "district": "Semt",
    "country": "Türkiye"
  },
  "shippingAddress": {
    "address": "address",
    "zipCode": "34940",
    "contactName": "John Doe",
    "city": "İstanbul",
    "country": "Türkiye"
  }
}

{
  "status": "success",
  "systemTime": 1755693772785,
  "data": {
    "referenceCode": "7e966c81-7f09-4bce-b0eb-7467086d7a50",
    "createdDate": 1755693138286,
    "status": "ACTIVE",
    "name": "John",
    "surname": "Doe",
    "identityNumber": "11111111111",
    "email": "[email protected]",
    "gsmNumber": "+905554443333",
    "contactEmail": "[email protected]",
    "contactGsmNumber": "+905554443333",
    "billingAddress": {
      "address": "address1",
      "zipCode": "34940",
      "contactName": "John Doe",
      "district": "Semt",
      "city": "İstanbul",
      "country": "Türkiye"
    },
    "shippingAddress": {
      "address": "address",
      "zipCode": "34940",
      "contactName": "John Doe",
      "district": null,
      "city": "İstanbul",
      "country": "Türkiye"
    }
  }
}

Örnek Kodlar

Abone Detayı

get

Bir abonenin tüm detayları, aboneye ait referans kodu ile çağrılabilir.

Path parameters

customerReferenceCodestringRequired

Müşteri referans kodu.

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

Header parameters

AuthorizationstringRequired

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

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

get

GET https://api.iyzipay.com/v2/subscription/customers/7e966c81-7f09-4bce-b0eb-7467086d7a50
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1755695274336,
  "data": {
    "referenceCode": "7e966c81-7f09-4bce-b0eb-7467086d7a50",
    "createdDate": 1755693138286,
    "status": "ACTIVE",
    "name": "John",
    "surname": "Doe",
    "identityNumber": "11111111111",
    "email": "[email protected]",
    "gsmNumber": "+905554443333",
    "contactEmail": "[email protected]",
    "contactGsmNumber": "+905554443333",
    "billingAddress": {
      "address": "address1",
      "zipCode": "34940",
      "contactName": "John Doe",
      "district": "Semt",
      "city": "İstanbul",
      "country": "Türkiye"
    },
    "shippingAddress": {
      "address": "address",
      "zipCode": "34940",
      "contactName": "John Doe",
      "district": "",
      "city": "İstanbul",
      "country": "Türkiye"
    }
  }
}

Örnek Kodlar

Abone Listeleme

get

Tüm aboneleri ve temel detaylarını listeler.

Query parameters

pageintegerOptional

Belirtilen sayfa için aboneleri getirir.

Example: 1

countintegerOptional

Sayfa başına kaç abone listeleneceğini belirtir.

Example: 1

Header parameters

AuthorizationstringRequired

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

Example: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=

Content-TypestringRequired

İstek içeriğinin formatı.

Example: application/json

Responses

200

Başarılı yanıt

application/json

400

Başarısız yanıt

application/json

get

GET https://api.iyzipay.com/v2/subscription/customers?page=1&count=1
Authorization: IYZWSv2 YXBpS2V5OnNhbmRib....E0OGI1MTE=
Content-Type: application/json

{
  "status": "success",
  "systemTime": 1687817022470,
  "data": {
    "totalCount": 2,
    "currentPage": 1,
    "pageCount": 1,
    "items": [
      {
        "referenceCode": "e2378434-3192-426d-a821-59c49583b6d4",
        "createdDate": 1687815595481,
        "status": "ACTIVE",
        "name": "John",
        "surname": "Doe",
        "identityNumber": "11111111111",
        "email": "[email protected]",
        "gsmNumber": "+905555555555",
        "contactEmail": "[email protected]",
        "contactGsmNumber": "+905555555111",
        "billingAddress": {
          "address": "Uskudar Burhaniye Mahallesi iyzico A.S",
          "zipCode": "34660",
          "contactName": "John Doe",
          "district": "altunizade",
          "city": "Istanbul",
          "country": "Turkey"
        },
        "shippingAddress": {
          "address": "Uskudar Burhaniye Mahallesi iyzico A.S",
          "zipCode": "34660",
          "contactName": "John Doe",
          "district": "altunizade",
          "city": "Istanbul",
          "country": "Turkey"
        }
      },
      {
        "referenceCode": "deeb305d-053e-412e-bead-bc507f771223",
        "createdDate": 1687379184912,
        "status": "ACTIVE",
        "name": "John",
        "surname": "Doe",
        "identityNumber": "11111111111",
        "email": "[email protected]",
        "gsmNumber": "+905555555555",
        "contactEmail": "[email protected]",
        "contactGsmNumber": "+905555555111",
        "billingAddress": {
          "address": "Uskudar Burhaniye Mahallesi iyzico A.S",
          "zipCode": "34660",
          "contactName": "John Doe",
          "district": "altunizade",
          "city": "Istanbul",
          "country": "Turkey"
        },
        "shippingAddress": {
          "address": "Uskudar Burhaniye Mahallesi iyzico A.S",
          "zipCode": "34660",
          "contactName": "John Doe",
          "district": "altunizade",
          "city": "Istanbul",
          "country": "Turkey"
        }
      }
    ]
  }
}

Örnek Kodlar

Last updated 1 hour ago