StaticGramBot API

createInvoiceLinkПоддерживается

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

Особенности StaticGram

Stars only; subscription_period 2592000 (renewed by RunBotStarSubscriptionRenewals); link <public base>/invoice/<slug> → inputInvoiceSlug; business_connection_id rejected

Параметры

business_connection_idStringнеобязательный
Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
titleStringобязательный
Product name, 1-32 characters
descriptionStringобязательный
Product description, 1-255 characters
payloadStringобязательный
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
provider_tokenStringнеобязательный
Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currencyStringобязательный
Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
pricesArray of LabeledPriceобязательный
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
subscription_periodIntegerнеобязательный
The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
max_tip_amountIntegerнеобязательный
The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggested_tip_amountsArray of Integerнеобязательный
A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
provider_dataStringнеобязательный
JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photo_urlStringнеобязательный
URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photo_sizeIntegerнеобязательный
Photo size in bytes
photo_widthIntegerнеобязательный
Photo width
photo_heightIntegerнеобязательный
Photo height
need_nameBooleanнеобязательный
Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
need_phone_numberBooleanнеобязательный
Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
need_emailBooleanнеобязательный
Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
need_shipping_addressBooleanнеобязательный
Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
send_phone_number_to_providerBooleanнеобязательный
Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
send_email_to_providerBooleanнеобязательный
Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
is_flexibleBooleanнеобязательный
Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.

Пример запроса

curl
curl "https://api.staticgram.top/bot$TOKEN/createInvoiceLink" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Название",
    "description": "Описание",
    "payload": "order-42",
    "currency": "XTR",
    "prices": [
      {
        "label": "Товар",
        "amount": 100
      }
    ]
  }'
aiogram 3
from aiogram import Bot
from aiogram.client.session.aiohttp import AiohttpSession
from aiogram.client.telegram import TelegramAPIServer

session = AiohttpSession(api=TelegramAPIServer.from_base("https://api.staticgram.top"))
bot = Bot(TOKEN, session=session)

result = await bot.create_invoice_link(
    title="Название",
    description="Описание",
    payload="order-42",
    currency="XTR",
    prices=[{"label": "Товар", "amount": 100}],
)
JavaScript
const res = await fetch(`https://api.staticgram.top/bot${TOKEN}/createInvoiceLink`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "title": "Название",
    "description": "Описание",
    "payload": "order-42",
    "currency": "XTR",
    "prices": [
      {
        "label": "Товар",
        "amount": 100
      }
    ]
  }),
});
const data = await res.json();

Ответ (String)

JSON
{
  "ok": true,
  "result": "..."
}

Описания методов и типов взяты из официальной документации Telegram Bot API (Bot API 10.3). Адрес API: https://api.staticgram.top