Link Search Menu Expand Document

Constructor: messageActionPaymentRefunded

Back to constructors index

Describes a payment refund (service message received by both users and bots).

Attributes:

NameTypeRequiredDescription
peerlongYesIdentifier of the peer that returned the funds.
currencystringYesCurrency, XTR for Telegram Stars.
total_amountlongYesTotal 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).
payloadbytesOptionalBot specified invoice payload (only received by bots).
chargePaymentChargeYesProvider payment identifier

Type: MessageAction

Example:

$messageActionPaymentRefunded = ['_' => 'messageActionPaymentRefunded', 'peer' => long, 'currency' => 'string', 'total_amount' => long, 'payload' => 'bytes', 'charge' => PaymentCharge];