Struct telegram_bot_api::methods::SendInvoice

pub struct SendInvoice {

    pub chat_id: ChatId,
    pub title: String,
    pub description: String,
    pub payload: String,
    pub provider_token: String,
    pub currency: String,
    pub prices: Vec<LabeledPrice>,
    pub max_tip_amount: Option<i64>,
    pub suggested_tip_amounts: Option<Vec<i64>>,
    pub start_parameter: Option<String>,
    pub provider_data: Option<String>,
    pub photo_url: Option<String>,
    pub photo_size: Option<i64>,
    pub photo_width: Option<i64>,
    pub photo_height: Option<i64>,
    pub need_name: Option<bool>,
    pub need_phone_number: Option<bool>,
    pub need_email: Option<bool>,
    pub need_shipping_address: Option<bool>,
    pub send_phone_number_to_provider: Option<bool>,
    pub send_email_to_provider: Option<bool>,
    pub is_flexible: Option<bool>,
    pub disable_notification: Option<bool>,
    pub protect_content: Option<bool>,
    pub reply_to_message_id: Option<i64>,
    pub allow_sending_without_reply: Option<bool>,
    pub reply_markup: Option<InlineKeyboardMarkup>,
}

Use this method to send invoices. On success, the sent Message is returned.

Fields

chat_id: ChatId

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

title: String

Product name, 1-32 characters

description: String

Product description, 1-255 characters

payload: String

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

provider_token: String

Payment provider token, obtained via @BotFather

currency: String

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

prices: Vec<LabeledPrice>

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

max_tip_amount: Option<i64>

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

suggested_tip_amounts: Option<Vec<i64>>

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.

start_parameter: Option<String>

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

provider_data: Option<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.

photo_url: Option<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.

photo_size: Option<i64>

Photo size in bytes

photo_width: Option<i64>

Photo width

photo_height: Option<i64>

Photo height

need_name: Option<bool>

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

need_phone_number: Option<bool>

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

need_email: Option<bool>

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

need_shipping_address: Option<bool>

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

send_phone_number_to_provider: Option<bool>

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

send_email_to_provider: Option<bool>

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

is_flexible: Option<bool>

Pass True if the final price depends on the shipping method

disable_notification: Option<bool>

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

protect_content: Option<bool>

Protects the contents of the sent message from forwarding and saving

reply_to_message_id: Option<i64>

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

allow_sending_without_reply: Option<bool>

Pass True if the message should be sent even if the specified replied-to message is not found

reply_markup: Option<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.

Implementations

impl SendInvoice

pub fn new(
    chat_id: ChatId,
    title: String,
    description: String,
    payload: String,
    provider_token: String,
    currency: String,
    prices: Vec<LabeledPrice>
) -> Self

Trait Implementations

impl Clone for SendInvoice

fn clone(&self) -> SendInvoice

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendInvoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SendInvoice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Methods for SendInvoice

fn endpoint(&self) -> String

fn files(&self) -> HashMap<String, InputFile>

impl Serialize for SendInvoice

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.