Class SuccessfulPayment

Hierarchy (view full)

  • Base
    • SuccessfulPayment

Constructors

constructor

Properties

currency orderInfo? payload providedPaymentId shippingId? telegramPaymentId totalAmount

Accessors

client

Methods

_clone _patch _update refundStarPayment valueOf

Constructors

constructor

Properties

currency

currency: string

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

OptionalorderInfo

orderInfo?: OrderInfo

Order information provided by the user

payload

payload: string

Bot specified invoice payload

providedPaymentId

providedPaymentId: string

Provider payment identifier

OptionalshippingId

shippingId?: string

Identifier of the shipping option chosen by the user

telegramPaymentId

telegramPaymentId: string

Telegram payment identifier

totalAmount

totalAmount: 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).

Accessors

client

Methods

Protected_clone

Protected_patch

  • _patch(data): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

refundStarPayment

  • refundStarPayment(userId): Promise<true>

  • Refunds a successful payment in Telegram Stars.

    Parameters

    • userId: string | number

      Identifier of the user whose payment will be refunded

    Returns Promise<true>

    Returns True on success.

valueOf

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods