Invoice

The 💠component responsible for the Telegram invoices.

Checking Support

To check if invoices are supported by the current Telegram Mini Apps version, the isSupported method is used:

Variable

import { invoice } from '@telegram-apps/sdk';

invoice.isSupported(); // boolean

Functions

import { isInvoiceSupported } from '@telegram-apps/sdk';

isInvoiceSupported(); // boolean

Opening

To open an invoice, it is required to use the open method. This method allows opening invoices using their URLs or slugs.

Opening an invoice in URL mode requires passing the second argument equal to url, so the method will interpret the passed value as a URL.

Calling the method updates the isOpened signal property value.

Variable

import { invoice } from '@telegram-apps/sdk';

if (invoice.open.isAvailable()) {
  invoice.isOpened(); // false
  const promise = invoice.open('abIIks213');
  invoice.isOpened(); // true
  const status = await promise;
  invoice.isOpened(); // false

  // Or in URL mode:
  await invoice.open('https://t.me/invoice/abIIks213', 'url');
}

Functions

import { openInvoice, isInvoiceOpened } from '@telegram-apps/sdk';

if (openInvoice.isAvailable()) {
  isInvoiceOpened(); // false
  const promise = openInvoice('abIIks213');
  isInvoiceOpened(); // true
  const status = await promise;
  isInvoiceOpened(); // false

  // Or in URL mode:
  await openInvoice('https://t.me/invoice/abIIks213', 'url');
}