TgKit library and website are still in early development!

InvoiceLinkCreateOptions Interface

Properties

currencydescriptionisFlexiblemaxTipAmountneedEmailneedNameneedPhoneNumberneedShippingAddresspayloadphotoHeightphotoSizephotoUrlphotoWidthpricesproviderDataproviderTokensendEmailToProvidersendPhoneNumberToProvidersuggestedTipAmountstitle

Properties

currency string

Three-letter ISO 4217 currency code

See the code

description string

Product description, 1-255 characters

See the code

isFlexible boolean

Pass *true*, if the final price depends on the shipping method

See the code

maxTipAmount number

The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float). For example, for a maximum tip of

See the code

needEmail boolean

Pass *true*, if you require the user's email address to complete the order

See the code

needName boolean

Pass *true*, if you require the user's full name to complete the order

See the code

needPhoneNumber boolean

Pass *true*, if you require the user's phone number to complete the order

See the code

needShippingAddress boolean

Pass *true*, if you require the user's shipping address to complete the order

See the code

payload string

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

See the code

photoHeight number

Photo height

See the code

photoSize number

Photo size in bytes

See the code

photoUrl string

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.

See the code

photoWidth number

Photo width

See the code

prices

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

See the code

providerData string

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.

See the code

providerToken string

Payments provider token, obtained via [@BotFather](https://t.me/botfather)

See the code

sendEmailToProvider boolean

Pass *true*, if user's email address should be sent to provider

See the code

sendPhoneNumberToProvider boolean

Pass *true*, if user's phone number should be sent to provider

See the code

suggestedTipAmounts

An array of suggested amounts of tip in the *smallest units* of the currency (integer, **not** float). 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 *maxTipAmount*.

See the code

title string

Product name, 1-32 characters

See the code