CreateInvoiceLinkReq

Value parameters

currency

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

description

Product description, 1-255 characters

isFlexible

Pass True if the final price depends on the shipping method

maxTipAmount

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

needEmail

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

needName

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

needPhoneNumber

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

needShippingAddress

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

payload

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

photoHeight

Photo height

photoSize

Photo size in bytes

photoUrl

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

photoWidth

Photo width

prices

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

providerData

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.

providerToken

Payment provider token, obtained via BotFather

sendEmailToProvider

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

sendPhoneNumberToProvider

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

suggestedTipAmounts

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.

title

Product name, 1-32 characters

Attributes

Graph

Reset zoomHide graphShow graph

Supertypes

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all