get_payment_form()

Client.get_payment_form()

Get information about a invoice or paid media.

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. Unique identifier for the target chat in form of a t.me/joinchat/ link, identifier (int) or username of the target channel/supergroup (in the format @username).

  • message_id (int | str) – Pass a message identifier or to get the invoice from message. Pass a invoice link in form of a t.me/$… link or slug itself to get the payment form from link.

Returns:

PaymentForm – On success, a payment form is returned.

Example

# get payment form from message
app.get_payment_form(chat_id, 123)
# get payment form from link
app.get_payment_form(chat_id, "https://t.me/$xvbzUtt5sUlJCAAATqZrWRy9Yzk")