SendInvoice

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

chatId: Integer Yes Unique identifier for the target private chat
title: String Yes Product name
description: String Yes Product description
payload: String Yes Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
providerToken: String Yes Payments provider token, obtained via Botfather
startParameter: String Yes Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
currency: String Yes Three-letter ISO 4217 currency code, see more on currencies
prices: Array of LabeledPrice Yes Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
providerData: String Optional JSON-encoded 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.
photoUrl: String Optional 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.
photoSize: Integer Optional Photo size
photoWidth: Integer Optional Photo width
photoHeight: Integer Optional Photo height
needName: Bool Optional Pass True, if you require the user's full name to complete the order
needPhoneNumber: Boolean Optional Pass True, if you require the user's phone number to complete the order
needEmail: Bool Optional Pass True, if you require the user's email to complete the order
needShippingAddress: Boolean Optional Pass True, if you require the user's shipping address to complete the order
isFlexible: Boolean Optional Pass True, if the final price depends on the shipping method
disableNotification: Boolean Optional Sends the message silently. Users will receive a notification with no sound.
replyToMessageId: Integer Optional If the message is a reply, ID of the original message
replyMarkup: InlineKeyboardMarkup Optional 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.

Linear Supertypes

Serializable, Serializable, Product, Equals, JsonRequest[Message], Request[Message], AnyRef, Any

Instance Constructors

new SendInvoice(chatId: Long, title: String, description: String, payload: String, providerToken: String, startParameter: String, currency: Currency, prices: Array[LabeledPrice], providerData: Option[String] = None, photoUrl: Option[String] = None, photoSize: Option[Int] = None, photoWidth: Option[Int] = None, photoHeight: Option[Int] = None, needName: Option[Boolean] = None, needPhoneNumber: Option[Boolean] = None, needEmail: Option[Boolean] = None, needShippingAddress: Option[Boolean] = None, isFlexible: Option[Boolean] = None, disableNotification: Option[Int] = None, replyToMessageId: Option[Long] = None, replyMarkup: Option[InlineKeyboardMarkup] = None)

chatId
Integer Yes Unique identifier for the target private chat
title
String Yes Product name
description
String Yes Product description
payload
String Yes Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
providerToken
String Yes Payments provider token, obtained via Botfather
startParameter
String Yes Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
currency
String Yes Three-letter ISO 4217 currency code, see more on currencies
prices
Array of LabeledPrice Yes Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
providerData
String Optional JSON-encoded 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.
photoUrl
String Optional 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.
photoSize
Integer Optional Photo size
photoWidth
Integer Optional Photo width
photoHeight
Integer Optional Photo height
needName
Bool Optional Pass True, if you require the user's full name to complete the order
needPhoneNumber
Boolean Optional Pass True, if you require the user's phone number to complete the order
needEmail
Bool Optional Pass True, if you require the user's email to complete the order
needShippingAddress
Boolean Optional Pass True, if you require the user's shipping address to complete the order
isFlexible
Boolean Optional Pass True, if the final price depends on the shipping method
disableNotification
Boolean Optional Sends the message silently. Users will receive a notification with no sound.
replyToMessageId
Integer Optional If the message is a reply, ID of the original message
replyMarkup
InlineKeyboardMarkup Optional 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.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val chatId: Long

Integer Yes Unique identifier for the target private chat
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val currency: Currency

String Yes Three-letter ISO 4217 currency code, see more on currencies
val description: String

String Yes Product description
val disableNotification: Option[Int]

Boolean Optional Sends the message silently.
Boolean Optional Sends the message silently. Users will receive a notification with no sound.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val isFlexible: Option[Boolean]

Boolean Optional Pass True, if the final price depends on the shipping method
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def methodName: String

Extract request URL from class name.
Extract request URL from class name.

Definition Classes
Request
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val needEmail: Option[Boolean]

Bool Optional Pass True, if you require the user's email to complete the order
val needName: Option[Boolean]

Bool Optional Pass True, if you require the user's full name to complete the order
val needPhoneNumber: Option[Boolean]

Boolean Optional Pass True, if you require the user's phone number to complete the order
val needShippingAddress: Option[Boolean]

Boolean Optional Pass True, if you require the user's shipping address to complete the order
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val payload: String

String Yes Bot-defined invoice payload, 1-128 bytes.
String Yes Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
val photoHeight: Option[Int]

Integer Optional Photo height
val photoSize: Option[Int]

Integer Optional Photo size
val photoUrl: Option[String]

String Optional URL of the product photo for the invoice.
String Optional 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.
val photoWidth: Option[Int]

Integer Optional Photo width
val prices: Array[LabeledPrice]

Array of LabeledPrice Yes Price breakdown, a list of components (e.g.
Array of LabeledPrice Yes Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
val providerData: Option[String]

String Optional JSON-encoded data about the invoice, which will be shared with the payment provider.
String Optional JSON-encoded 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.
val providerToken: String

String Yes Payments provider token, obtained via Botfather
val replyMarkup: Option[InlineKeyboardMarkup]

InlineKeyboardMarkup Optional A JSON-serialized object for an inline keyboard.
InlineKeyboardMarkup Optional 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.
val replyToMessageId: Option[Long]

Integer Optional If the message is a reply, ID of the original message
val startParameter: String

String Yes Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val title: String

String Yes Product name
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package methods

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val chatId: Long

def clone(): AnyRef

val currency: Currency

val description: String

val disableNotification: Option[Int]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val isFlexible: Option[Boolean]

final def isInstanceOf[T0]: Boolean

def methodName: String

final def ne(arg0: AnyRef): Boolean

val needEmail: Option[Boolean]

val needName: Option[Boolean]

val needPhoneNumber: Option[Boolean]

val needShippingAddress: Option[Boolean]

final def notify(): Unit

final def notifyAll(): Unit

val payload: String

val photoHeight: Option[Int]

val photoSize: Option[Int]

val photoUrl: Option[String]

val photoWidth: Option[Int]

val prices: Array[LabeledPrice]

val providerData: Option[String]

val providerToken: String

val replyMarkup: Option[InlineKeyboardMarkup]

val replyToMessageId: Option[Long]

val startParameter: String

final def synchronized[T0](arg0: ⇒ T0): T0

val title: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from JsonRequest[Message]

Inherited from Request[Message]

Inherited from AnyRef

Inherited from Any

Ungrouped