Link Oluşturma | Odero Documentation

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`

Endpoint hem application/json hem de görsel yüklemek için multipart/form-data kabul eder. Başarılı istek 201 Created döner.

İstek Parametreleri

name 1–255 karakterle zorunludur; description en fazla 255 karakterdir. price pozitif ve en fazla iki ondalık basamaklı, expireDate gelecekte bir ISO tarih-saat olmalıdır; items en fazla 250 kayıt kabul eder. 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`
`subMerchantId`	`long`	Hayır	TokenPay sözleşmesindeki `subMerchantId` alanı.
`paymentGroup`	`PaymentGroup`	Hayır	TokenPay sözleşmesindeki `paymentGroup` alanı.
`subMerchantPrice`	`decimal`	Hayır	TokenPay sözleşmesindeki `subMerchantPrice` alanı.
`conversationId`	`string`	Hayır	TokenPay sözleşmesindeki `conversationId` alanı.
`enabledBanks`	`string`	Hayır	TokenPay sözleşmesindeki `enabledBanks` alanı.
`posType`	`PosBlockageResolveType`	Hayır	TokenPay sözleşmesindeki `posType` alanı.
`externalId`	`string`	Hayır	TokenPay sözleşmesindeki `externalId` alanı.
`subExternalId`	`string`	Hayır	TokenPay sözleşmesindeki `subExternalId` alanı.
`externalProductUniqueId`	`string`	Hayır	TokenPay sözleşmesindeki `externalProductUniqueId` alanı.
`enabledInstForCommercial`	`string`	Hayır	TokenPay sözleşmesindeki `enabledInstForCommercial` alanı.
`kvkkUrl`	`string`	Hayır	TokenPay sözleşmesindeki `kvkkUrl` alanı.
`paymentDocumentType`	`string`	Hayır	TokenPay sözleşmesindeki `paymentDocumentType` alanı.
`merchantBranchName`	`string`	Hayır	TokenPay sözleşmesindeki `merchantBranchName` alanı.
`paymentPhase`	`PaymentPhase`	Hayır	Ödeme fazı; varsayılan değer `AUTH`.
`currency`	`Currency`	Hayır	TokenPay sözleşmesindeki `currency` alanı.
`items`	`PaymentItem[]`	Hayır	Ödeme kırılımları; en fazla 250 kayıt.
`language`	`string`	Hayır	TokenPay sözleşmesindeki `language` alanı.
`productSpecificationType`	`ProductSpecificationType`	Hayır	TokenPay sözleşmesindeki `productSpecificationType` alanı.
`chippinPhoneNumber`	`string`	Hayır	TokenPay sözleşmesindeki `chippinPhoneNumber` alanı.
`linkType`	`LinkType`	Hayır	TokenPay sözleşmesindeki `linkType` alanı.
`rapidUserId`	`string`	Hayır	TokenPay sözleşmesindeki `rapidUserId` alanı.
`chippinBranchType`	`string`	Hayır	TokenPay sözleşmesindeki `chippinBranchType` alanı.
`merchantUserEmail`	`string`	Hayır	TokenPay sözleşmesindeki `merchantUserEmail` alanı.
`customerEmail`	`string`	Hayır	TokenPay sözleşmesindeki `customerEmail` alanı.
`customerPhone`	`string`	Hayır	TokenPay sözleşmesindeki `customerPhone` alanı.
`autoPostAuthDateCount`	`string`	Hayır	TokenPay sözleşmesindeki `autoPostAuthDateCount` alanı.
`exchangePrice`	`string`	Hayır	TokenPay sözleşmesindeki `exchangePrice` alanı.
`taxNumber`	`string`	Hayır	TokenPay sözleşmesindeki `taxNumber` alanı.
`makeReceiptQueryEnabled`	`boolean`	Hayır	Dekont sorgulamayı açar; varsayılan `false`.
`specificDistribution`	`boolean`	Hayır	Özel dağıtımı açar; varsayılan `false`.

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.
`name`	`string`	Hayır	TokenPay sözleşmesindeki `name` alanı.
`description`	`string`	Hayır	TokenPay sözleşmesindeki `description` alanı.
`price`	`decimal`	Hayır	TokenPay sözleşmesindeki `price` alanı.
`stock`	`integer`	Hayır	TokenPay sözleşmesindeki `stock` alanı.
`soldCount`	`integer`	Hayır	TokenPay sözleşmesindeki `soldCount` alanı.
`enabledInstallments`	`string`	Hayır	TokenPay sözleşmesindeki `enabledInstallments` alanı.
`expireDate`	`date-time`	Hayır	TokenPay sözleşmesindeki `expireDate` alanı.
`paymentIdList`	`long[]`	Hayır	Link üzerinden oluşan ödeme kimlikleri.
`paymentPhase`	`PaymentPhase`	Hayır	Ödeme fazı; varsayılan değer `AUTH`.

Örnek Kodlar

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