Documentation - v0.27.0
    Preparing search index...

    Interface ActionPaymentReceived

    A payment was received from a user (bot)

    interface ActionPaymentReceived {
        amount: Long;
        charge?: RawPaymentCharge;
        currency: string;
        info?: RawPaymentRequestedInfo;
        payload: Uint8Array;
        shippingOptionId?: string;
        subscriptionUntilDate?: Date;
        type: "payment_received";
    }
    Index

    Properties

    amount: Long

    Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, amount = 145

    Payment provider ID

    currency: string

    Three-letter ISO 4217 currency code

    Order information provided by the user

    payload: Uint8Array

    Bot specified invoice payload

    shippingOptionId?: string

    ID of the shipping option chosen by the user

    subscriptionUntilDate?: Date

    If this is a subscription being bought, the date when the subscription will expire

    type: "payment_received"