Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/grammy_types/mod.ts>SuccessfulPayment

Type declarations of the Telegram Bot API.
Latest
interface SuccessfulPayment
Re-export
import { type SuccessfulPayment } from "https://deno.land/x/grammy_types@v3.16.0/mod.ts";

This object contains basic information about a successful payment.

Properties

currency: string

Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars

total_amount: number

Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).

invoice_payload: string

Bot specified invoice payload

optional
subscription_expiration_date: number

Expiration date of the subscription, in Unix time; for recurring payments only

optional
is_recurring: true

True, if the payment is a recurring payment for a subscription

optional
is_first_recurring: true

True, if the payment is the first payment for a subscription

optional
shipping_option_id: string

Identifier of the shipping option chosen by the user

optional
order_info: OrderInfo

Order information provided by the user

telegram_payment_charge_id: string

Telegram payment identifier

provider_payment_charge_id: string

Provider payment identifier