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.

1. Abone Güncelleme

2. Abone Detayı

3. Abone Listeleme

Abone Güncelleme

Bir abenenin tüm detayları API isteği ile güncellenebilir. Bunun için aboneye ait referans kodu ve güncellemek istenen parametreler ile güncelleme isteği atılması gereklidir.

Abone Güncelleme

POST https://api.iyzipay.com/v2/subscription/customers/{customerReferenceCode}

Request Body

Name	Type	Description
conversationId	String	İstek esnasında gönderip, sonuçta alabileceğiniz bir değer, request/response eşleşmesi yapmak için kullanılabilir.
locale	String	iyzico istek sonucunda dönen metinlerin dilini ayarlamak için kullanılır. Varsayılan değeri TR.
name*	String	Abone adı.
customerReferenceCode*	String	Abone referans kodu.
billingAddress.zipCode	String	Fatura posta kodu.
billingAddress.address*	String	Fatura adresi.
billingAddress.country*	String	Fatura ülkesi.
billingAddress.city*	String	Fatura iletişim ismi.
billingAddress.contactName*	String	Fatura iletişim ismi.
identitynumber*	String	Abone kimlik numarası.
surname*	String	Abone soyadı.
shippingAddress.zipCode	String	Kargo posta kodu.
shippingAddress.address*	String	Kargo adresi.
shippingAddress.country*	String	Kargo ülkesi.
shippingAddress.city*	String	Kargo şehri.
shippingAddress.contactName*	String	Kargo iletişim ismi.

200: OK

{
    "status":"success",
    "systemTime":1687815662201,
    "data":{
        "referenceCode":"e2378434-3192-426d-a821-59c49583b6d4",
        "createdDate":1687815595481,
        "status":"ACTIVE",
        "name":"John",
        "surname":"Doe",
        "identityNumber":"11111111111",
        "email":"[e-mail]",
        "gsmNumber":"[phone]",
        "contactEmail":"[e-mail]",
        "contactGsmNumber":"[phone]",
        "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"
        }
    }
}

Abone Güncelleme Dönen Parametreler

Parametre ismi	Tip	Açıklama
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.
referenceCode	String	Abone için oluşturulan eşsiz referans kodu.
createdDate	Long	Abone oluşturma tarihi.
status	String	Abone durumu. Varsayılan olarak ACTIVE.
name	String	Abone adı.
surname	String	Abone soyadı.
identityNumber	String	Abone kimlik numarası.
email	String	Abone email adresi.
gsmNumber	String	Abone telefon numarası.
billingAddress.contactName	String	Fatura iletişim ismi.
billingAddress.city	String	Fatura şehri.
billingAddress.country	String	Fatura ülkesi.
billingAddress.address	String	Fatura adresi.
billingAddress.zipCode	Number	Fatura zip kodu.
shippingAddress.contactName	String	Kargo iletişim ismi.
shippingAddress.city	String	Kargo şehri.
shippingAddress.country	String	Kargo ülkesi.
shippingAddress.address	String	Kargo adresi.
shippingAddress.zipCode	Number	Kargo zip kodu.

Abone Detayı

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

Abone Detayı

GET https://api.iyzipay.com/v2/subscription/customers/{customerReferenceCode}

Request Body

Name	Type	Description
customerReferenceCode*	String	Abone referans kodu.

200: OK

{
    "status":"success",
    "systemTime":1687816688973,
    "data":{
        "referenceCode":"e2378434-3192-426d-a821-59c49583b6d4",
        "createdDate":1687815595481,
        "status":"ACTIVE",
        "name":"John",
        "surname":"Doe",
        "identityNumber":"11111111111",
        "email":"[e-mail]",
        "gsmNumber":"[phone]",
        "contactEmail":"[e-mail]",
        "contactGsmNumber":"[phone]",
        "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"
        }
    }
}

Abone Detayı Dönen Parametreler

Parametre ismi	Tip	Açıklama
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.
referenceCode	String	Abone için oluşturulan eşsiz referans kodu.
createdDate	Long	Abone oluşturma tarihi.
status	String	Abone durumu. Varsayılan olarak ACTIVE.
name	String	Abone adı.
surname	String	Abone soyadı.
identityNumber	String	Abone kimlik numarası.
email	String	Abone email adresi.
gsmNumber	String	Abone telefon numarası.
billingAddress.contactName	String	Fatura iletişim ismi.
billingAddress.city	String	Fatura şehri.
billingAddress.country	String	Fatura ülkesi.
billingAddress.address	String	Fatura adresi.
billingAddress.zipCode	Number	Fatura zip kodu.
shippingAddress.contactName	String	Kargo iletişim ismi.
shippingAddress.city	String	Kargo şehri.
shippingAddress.country	String	Kargo ülkesi.
shippingAddress.address	String	Kargo adresi.
shippingAddress.zipCode	Number	Kargo zip kodu.

Abone Listeleme

Tüm aboneleri ve detaylarını bu istek ile listeleyebilirsiniz

Abone Listeleme

GET https://api.iyzipay.com/v2/subscription/customers

Request Body

Name	Type	Description
page*	Integer	Belirtilen sayfa için tüm aboneleri getirir.
count*	Integer	Sayfa başına kaç abone listelenceğini belirtir.

200: OK

{
    "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":"[e-mail]",
                "gsmNumber":"[phone]",
                "contactEmail":"[e-mail]",
                "contactGsmNumber":"[phone]",
                "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":"[e-mail]",
                "gsmNumber":"[phone]",
                "contactEmail":"[e-mail]",
                "contactGsmNumber":"[phone]",
                "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"
                }
            }
        ]
    }
}

Abone Listeleme Dönen Parametreler

Parametre ismi	Tip	Açıklama
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.
totalCount	String	Toplam kaç tane sonuç geldiğini belirtir.
currentPage	Integer	Hangi sayfa için listeleme yapıldığını belirtir.
pageCount	Integer	Toplam kaç sayfa sonuç geldiğini belirtir.
items	Array Object	Abone detaylarını içeren dizidir.