Class RefundedPayment

Hierarchy (view full)

Constructors

constructor

Properties

currency invoicePayload providerChargeId? telegramChargeId totalAmount

Accessors

client

Methods

_clone _patch _update refundStarPayment toJSON valueOf

Constructors

constructor

Properties

currency

currency: string

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

invoicePayload

invoicePayload: string

Bot-specified invoice payload

OptionalproviderChargeId

providerChargeId?: string

Provider payment identifier

telegramChargeId

telegramChargeId: string

Telegram payment identifier

totalAmount

totalAmount: number

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

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

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.

toJSON

  • toJSON(propsRecursive?, ...props): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • Rest...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods