createInvoiceLink
متداز این متد برای ساخت لینک یک صورتحساب استفاده کنید. در صورت موفقیت لینک صورتحساب ساخته‌شده را به‌صورت String برمی‌گرداند.
خروجی: String
پارامترها
| نام | نوع | الزام | توضیحات |
|---|---|---|---|
| business_connection_id | String | اختیاری | شناسهٔ یکتای اتصال کسب‌وکاری که لینک از طرف آن ساخته می‌شود. فقط برای پرداخت با ستارهٔ تلگرام. |
| title | String | الزامی | نام محصول؛ ۱ تا ۳۲ نویسه |
| description | String | الزامی | توضیح محصول؛ ۱ تا ۲۵۵ نویسه |
| payload | String | الزامی | payload صورتحساب که ربات تعیین می‌کند؛ ۱ تا ۱۲۸ بایت. به کاربر نمایش داده نمی‌شود و برای فرایندهای داخلی شما کاربرد دارد. |
| provider_token | String | اختیاری | توکن ارائه‌دهندهٔ پرداخت که از @BotFather گرفته می‌شود. برای پرداخت با ستارهٔ تلگرام رشتهٔ خالی بدهید. |
| currency | String | الزامی | کد سه‌حرفی ارز بر پایهٔ ISO 4217؛ دربارهٔ ارزها بیشتر بخوانید. برای پرداخت با ستارهٔ تلگرام «XTR» بدهید. |
| prices | Array of LabeledPrice | الزامی | تفکیک قیمت؛ فهرست JSON از اجزا (مثلاً قیمت محصول، مالیات، تخفیف، هزینهٔ ارسال، مالیات ارسال، پاداش و غیره). برای پرداخت با ستارهٔ تلگرام باید دقیقاً یک مورد داشته باشد. |
| subscription_period | Integer | اختیاری | تعداد ثانیه‌هایی که اشتراک تا پرداخت بعدی فعال خواهد بود. اگر این پارامتر استفاده شود، ارز باید «XTR» (ستارهٔ تلگرام) باشد. در حال حاضر اگر مشخص شود همیشه باید ۲۵۹۲۰۰۰ (۳۰ روز) باشد. هر تعداد اشتراک می‌تواند هم‌زمان برای یک ربات فعال باشد، از جمله چند اشتراک هم‌زمان از یک کاربر. قیمت اشتراک نباید از ۱۰۰۰۰ ستارهٔ تلگرام بیشتر شود. |
| max_tip_amount | Integer | اختیاری | بیشترین مبلغ انعام (tip) پذیرفته‌شده به کوچک‌ترین واحد ارز (عدد صحیح، نه اعشاری). مثلاً برای حداکثر انعام ۱٫۴۵ دلار آمریکا max_tip_amount = 145 بدهید. پارامتر exp را در currencies.json ببینید؛ تعداد ارقام بعد از ممیز هر ارز را نشان می‌دهد (برای بیشتر ارزها ۲). پیش‌فرض ۰. برای پرداخت با ستارهٔ تلگرام پشتیبانی نمی‌شود. |
| suggested_tip_amounts | Array of Integer | اختیاری | آرایهٔ JSON از مبالغ پیشنهادی انعام به کوچک‌ترین واحد ارز (عدد صحیح، نه اعشاری). حداکثر ۴ مبلغ انعام پیشنهادی می‌توان مشخص کرد. مبالغ پیشنهادی باید مثبت و با ترتیب اکیداً صعودی باشند و از max_tip_amount بیشتر نشوند. |
| provider_data | String | اختیاری | داده‌های سریالایز‌شده به JSON دربارهٔ صورتحساب که با ارائه‌دهندهٔ پرداخت به اشتراک گذاشته می‌شود. توضیح دقیق فیلدهای موردنیاز را باید ارائه‌دهندهٔ پرداخت بدهد. |
| photo_url | String | اختیاری | آدرس عکس محصول برای صورتحساب. می‌تواند عکس کالا یا تصویر تبلیغاتی یک خدمت باشد. |
| photo_size | Integer | اختیاری | حجم عکس به بایت |
| photo_width | Integer | اختیاری | عرض عکس |
| photo_height | Integer | اختیاری | ارتفاع عکس |
| need_name | Boolean | اختیاری | اگر برای تکمیل سفارش به نام کامل کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| need_phone_number | Boolean | اختیاری | اگر برای تکمیل سفارش به شمارهٔ تلفن کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| need_email | Boolean | اختیاری | اگر برای تکمیل سفارش به آدرس ایمیل کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| need_shipping_address | Boolean | اختیاری | اگر برای تکمیل سفارش به نشانی ارسال کاربر نیاز دارید، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| send_phone_number_to_provider | Boolean | اختیاری | اگر شمارهٔ تلفن کاربر باید برای ارائه‌دهنده فرستاده شود، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| send_email_to_provider | Boolean | اختیاری | اگر آدرس ایمیل کاربر باید برای ارائه‌دهنده فرستاده شود، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |
| is_flexible | Boolean | اختیاری | اگر قیمت نهایی به روش ارسال بستگی دارد، True بدهید. برای پرداخت با ستارهٔ تلگرام نادیده گرفته می‌شود. |