URL

Link oluşturmak için kullanılan endpoint ve http metod bilgisi aşağıda verilmiştir.

HTTP Metod URL
POST /tokenlink/v1/products

İstek Parametreleri

Yeni bir link oluşturmak için yapılacak isteklerde gönderilmesi beklenen parametreler aşağıdaki tablo ve alt başlıklar altında listelenmiştir.

Parametre Adı Tipi Zorunlu Açıklama
name string Evet Link'e verilen isim
description string Hayır Link'e ait detaylı açıklama. Ödeme sayfasında kullanıcıyı bilgilendirmek için kullanabilirsiniz.
price decimal Hayır Link üzerinden alınacak ödemenin fiyatı. Gönderilmediği taktirde ödeme formunda kullanıcı fiyat girebilir.
stock number Hayır Eğer stoklu bir ürün satıyorsanız, stok adedini gönderebilirsiniz.
expireDate date Hayır Link'e belirli bir tarihten sonra geçersiz kılmak istiyorsanız link'e ait geçerlilik süresini gönderebilirsiniz.
enabledInstallments string Hayır Sadece belirlediğiniz taksitler ile ödeme almak istiyorsanız bu alanı kullanabilirsiniz. Örnek; 1,2,3,6

Dönüş Parametreleri

Link oluşturma işleminin sonucunda dönen parametreler de API dokümantasyonu giriş sayfasındaki Dönüş Formatları bölümünde belirtilen kurallara tabidir. Sistemsel ya da kurgusal bir hata bulunmadığı durumda data parametresinde dönen objenin alt parametreleri aşağıdaki gibidir:

Parametre Adı Tipi Her Zaman Mevcut Açıklama
id long Evet Link ID değeri
status Status Evet Link durumunu gösteren değerdir. Aktif linkler için ACTIVE, pasif durumundakiler için PASSIVE döner. Link oluşturma işlemi sonrası oluşturulan link her zaman ACTIVE durumundadır.
token string Evet Link'e verilen, 4 karekterden oluşan eşsiz bir anahtardır.
url string Evet Link'e url bilgisidir. Bu link'i paylaşabilir, kullanıcılarınızdan ödeme alabilirsiniz.
qrCodeUrl string Evet Link'e QR kod linkidir. QR kodu okutarak ödeme linkine gidebilirsiniz.

Örnek Kodlar

Açık kaynak kodlu ÖderoPay API client'larındaki örnek kodları inceleyebilirsiniz