URL

Linkin yaradılması üçün istifadə edilən endpoint və http metodu haqqında məlumat aşağıda verilmişdir:

HTTP Metod URL
POST /tokenlink/v1/products

Endpoint həm application/json, həm də şəkil yükləmək üçün multipart/form-data qəbul edir. Uğurlu sorğu 201 Created qaytarır.

Sorğu Parametrləri

name 1–255 simvolla məcburidir; description ən çox 255 simvoldur. price müsbət və ən çox iki onluq mərtəbəli olmalı, expireDate gələcək ISO tarix-saatı olmalıdır; items ən çox 250 qeyd qəbul edir. Yeni link yaratmaq üçün sorğularda göndərilməsi gözlənilən parametrlər aşağıdakı cədvəl və alt başlıqlar altında sadalanmışdır.

Parametrin Adı Növü Məcburi Açıqlama
name string Bəli Link-ə verilən ad
description string Xeyr Linkin ətraflı izahı. Siz ödəniş səhifəsində istifadəçini məlumatlandırmaq üçün istifadə edə bilərsiniz.
price decimal Xeyr Link vasitəsilə alınacaq ödənişin qiyməti. Göndərilmədikdə, istifadəçi ödəniş formasında qiyməti daxil edə bilər.
stock number Xeyr Əgər siz stoklu məhsulu satırsınızsa, stokun miqdarını təqdim edə bilərsiniz.
expireDate date Xeyr Müəyyən tarixdən sonra linki etibarsız etmək istədikdə linkə ait qüvvədə olma müddətini göndərə bilərsiniz.
enabledInstallments string Xeyr Yalnız müəyyən etdiyiniz hissə-hissə ödənişi almaq istəyirsinizsə, bu sahədən istifadə edə bilərsiniz. Nümunə: 1,2,3,6
subMerchantIdlongXeyrTokenPay müqaviləsindəki subMerchantId sahəsi.
paymentGroupPaymentGroupXeyrTokenPay müqaviləsindəki paymentGroup sahəsi.
subMerchantPricedecimalXeyrTokenPay müqaviləsindəki subMerchantPrice sahəsi.
conversationIdstringXeyrTokenPay müqaviləsindəki conversationId sahəsi.
enabledBanksstringXeyrTokenPay müqaviləsindəki enabledBanks sahəsi.
posTypePosBlockageResolveTypeXeyrTokenPay müqaviləsindəki posType sahəsi.
externalIdstringXeyrTokenPay müqaviləsindəki externalId sahəsi.
subExternalIdstringXeyrTokenPay müqaviləsindəki subExternalId sahəsi.
externalProductUniqueIdstringXeyrTokenPay müqaviləsindəki externalProductUniqueId sahəsi.
enabledInstForCommercialstringXeyrTokenPay müqaviləsindəki enabledInstForCommercial sahəsi.
kvkkUrlstringXeyrTokenPay müqaviləsindəki kvkkUrl sahəsi.
paymentDocumentTypestringXeyrTokenPay müqaviləsindəki paymentDocumentType sahəsi.
merchantBranchNamestringXeyrTokenPay müqaviləsindəki merchantBranchName sahəsi.
paymentPhasePaymentPhaseXeyrÖdəniş mərhələsi; standart dəyər AUTH.
currencyCurrencyXeyrTokenPay müqaviləsindəki currency sahəsi.
itemsPaymentItem[]XeyrÖdəniş bölgüləri; ən çox 250 qeyd.
languagestringXeyrTokenPay müqaviləsindəki language sahəsi.
productSpecificationTypeProductSpecificationTypeXeyrTokenPay müqaviləsindəki productSpecificationType sahəsi.
chippinPhoneNumberstringXeyrTokenPay müqaviləsindəki chippinPhoneNumber sahəsi.
linkTypeLinkTypeXeyrTokenPay müqaviləsindəki linkType sahəsi.
rapidUserIdstringXeyrTokenPay müqaviləsindəki rapidUserId sahəsi.
chippinBranchTypestringXeyrTokenPay müqaviləsindəki chippinBranchType sahəsi.
merchantUserEmailstringXeyrTokenPay müqaviləsindəki merchantUserEmail sahəsi.
customerEmailstringXeyrTokenPay müqaviləsindəki customerEmail sahəsi.
customerPhonestringXeyrTokenPay müqaviləsindəki customerPhone sahəsi.
autoPostAuthDateCountstringXeyrTokenPay müqaviləsindəki autoPostAuthDateCount sahəsi.
exchangePricestringXeyrTokenPay müqaviləsindəki exchangePrice sahəsi.
taxNumberstringXeyrTokenPay müqaviləsindəki taxNumber sahəsi.
makeReceiptQueryEnabledbooleanXeyrQəbz sorğusunu aktivləşdirir; standart false.
specificDistributionbooleanXeyrXüsusi bölgünü aktivləşdirir; standart false.

Qayıdış Parametrləri

Linkin yaradılması prosesi nəticəsində qaytarılan parametrlər də API sənədlərinin əsas səhifəsinin Qayıdış Formatları bölməsində göstərilən qaydalara tabedir. Sistematik və ya quruluş bir xəta olmadıqda, data parametrində qaytarılan obyektin alt parametrləri aşağıdakılardır:

Parametrin Adı Növü Hər Zaman Mövcud Açıqlama
id long Bəli Linkin ID dəyəri
status Status Bəli Linkin statusunu göstərən dəyərdir. Aktiv linklər üçün ACTIVE, pasiv statusa malik olanlar üçün PASSIVE çıxır. Link yaratma əməliyyatındakı sonra yaradılan link hər zaman ACTIVE statusundadır.
token string Bəli Linkə verilən, 4 rəqəmdən formalaşan unikal açardır.
url string Bəli Linkin url məlumatıdır. Bu linki paylaşa bilər, istifadəçilərinizdən ödəniş ala bilərsiniz.
qrCodeUrl string Bəli Linkin QR kod linkidir. QR kodu skan edərək ödəniş linkinə daxil ola bilərsiniz.
namestringXeyrTokenPay müqaviləsindəki name sahəsi.
descriptionstringXeyrTokenPay müqaviləsindəki description sahəsi.
pricedecimalXeyrTokenPay müqaviləsindəki price sahəsi.
stockintegerXeyrTokenPay müqaviləsindəki stock sahəsi.
soldCountintegerXeyrTokenPay müqaviləsindəki soldCount sahəsi.
enabledInstallmentsstringXeyrTokenPay müqaviləsindəki enabledInstallments sahəsi.
expireDatedate-timeXeyrTokenPay müqaviləsindəki expireDate sahəsi.
paymentIdListlong[]XeyrLink vasitəsilə yaranan ödəniş identifikatorları.
paymentPhasePaymentPhaseXeyrÖdəniş mərhələsi; standart dəyər AUTH.

Nümunəvi Kodlar

Açıq mənbə kodlu Odero API client-lərindəki nümunəvi kodları nəzərdən keçirə bilərsiniz