Methods

Fields

• sendInvoiceChatId :: ChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendInvoiceMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendInvoiceTitle :: Text

  Product name, 1-32 characters.

• sendInvoiceDescription :: Text

  Product description, 1-255 characters.

• sendInvoicePayload :: Text

  Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

• sendInvoiceProviderToken :: Text

  Payments provider token, obtained via @Botfather. Pass an empty string for payments in Telegram Stars.

• sendInvoiceCurrency :: Text

  Three-letter ISO 4217 currency code, see more on currencies.

• sendInvoicePrices :: [LabeledPrice]

  Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

• sendInvoiceMaxTipAmount :: Maybe Integer

  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.

• sendInvoiceequestSuggestedTipAmounts :: Maybe [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.

• sendInvoiceStartParameter :: Maybe Text

  Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.

• sendInvoiceProviderData :: Maybe Text

  A 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.

• sendInvoicePhotoUrl :: Maybe Text

  URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.

• sendInvoicePhotoSize :: Maybe Int

  Photo size.

• sendInvoicePhotoWidth :: Maybe Int

  Photo width.

• sendInvoicePhotoHeight :: Maybe Int

  Photo height.

• sendInvoiceNeedName :: Maybe Bool

  Pass True, if you require the user's full name to complete the order.

• sendInvoiceNeedPhoneNumber :: Maybe Bool

  Pass True, if you require the user's phone number to complete the order.

• sendInvoiceNeedEmail :: Maybe Bool

  Pass True, if you require the user's email address to complete the order.

• sendInvoiceNeedShippingAddress :: Maybe Bool

  Pass True, if you require the user's shipping address to complete the order.

• sendInvoiceSendPhoneNumberToProvider :: Maybe Bool

  Pass True, if you require the user's phone number to complete the order.

• sendInvoiceSendEmailToProvider :: Maybe Bool

  Pass True, if user's email address should be sent to provider.

• sendInvoiceIsFlexible :: Maybe Bool

  Pass True, if the final price depends on the shipping method.

• sendInvoiceDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendInvoiceProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving.

• sendInvoiceMessageEffectId :: Maybe Text

  Unique identifier of the message effect to be added to the message; for private chats only.

• sendInvoiceReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendInvoiceReplyParameters :: Maybe ReplyParameters

  Description of the message to reply to.

• sendInvoiceReplyMarkup :: Maybe InlineKeyboardMarkup

  A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.

Fields

• createInvoiceLinkTitle :: Text

  Product name, 1-32 characters.

• createInvoiceLinkDescription :: Text

  Product description, 1-255 characters.

• createInvoiceLinkPayload :: Text

  Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

• createInvoiceLinkProviderToken :: Text

  Payments provider token, obtained via @Botfather. Pass an empty string for payments in Telegram Stars.

• createInvoiceLinkCurrency :: Text

  Three-letter ISO 4217 currency code, see more on currencies.

• createInvoiceLinkPrices :: [LabeledPrice]

  Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).

• createInvoiceLinkMaxTipAmount :: Maybe Integer

  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.

• createInvoiceLinkSuggestedTipAmounts :: Maybe [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.

• createInvoiceLinkProviderData :: Maybe Text

  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.

• createInvoiceLinkPhotoUrl :: Maybe Text

  URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.

• createInvoiceLinkPhotoSize :: Maybe Int

  Photo size in bytes.

• createInvoiceLinkPhotoWidth :: Maybe Int

  Photo width.

• createInvoiceLinkPhotoHeight :: Maybe Int

  Photo height

• createInvoiceLinkNeedName :: Maybe Bool

  Pass True if you require the user's full name to complete the order.

• createInvoiceLinkNeedPhoneNumber :: Maybe Bool

  Pass True if you require the user's phone number to complete the order.

• createInvoiceLinkNeedEmail :: Maybe Bool

  Pass True if you require the user's email address to complete the order.

• createInvoiceLinkNeedShippingAddress :: Maybe Bool

  Pass True if you require the user's shipping address to complete the order.

• createInvoiceLinkSendPhoneNumberToProvider :: Maybe Bool

  Pass True if the user's phone number should be sent to the provider.

• createInvoiceLinkSendEmailToProvider :: Maybe Bool

  Pass True if the user's email address should be sent to the provider.

• createInvoiceLinkIsFlexible :: Maybe Bool

  Pass True if the final price depends on the shipping method.

Fields

• answerShippingQueryShippingQueryId :: Text

  Unique identifier for the query to be answered.

• answerShippingQueryOk :: Bool

  Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible).

• answerShippingQueryShippingOptions :: Maybe [ShippingOption]

  Required if ok is True. A JSON-serialized array of available shipping options.

• answerShippingQueryErrorMessage :: Maybe Text

  Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.

Fields

• answerPreCheckoutQueryPreCheckoutQueryId :: Text

  Unique identifier for the query to be answered.

• answerPreCheckoutQueryOk :: Bool

  Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.

• answerPreCheckoutQueryErrorMessage :: Maybe Text

  Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.

Fields

• refundStarPaymentUserId :: UserId

  Identifier of the user whose payment will be refunded.

• refundStarPaymentTelegramPaymentChargeId :: Text

  Telegram payment identifier.