Link Search Menu Expand Document

Constructor: messageActionPaymentSentMe

Back to constructors index

A user just sent a payment to me (a bot)

Attributes:

NameTypeRequiredDescription
recurring_initBoolOptionalWhether this is the first payment of a recurring payment we just subscribed to
recurring_usedBoolOptionalWhether this payment is part of a recurring payment
currencystringYesThree-letter ISO 4217 currency code
total_amountlongYesPrice of the product 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).
payloadbytesYesBot specified invoice payload
infoPaymentRequestedInfoOptionalOrder info provided by the user
shipping_option_idstringOptionalIdentifier of the shipping option chosen by the user
chargePaymentChargeYesProvider payment identifier

Type: MessageAction

Example:

$messageActionPaymentSentMe = ['_' => 'messageActionPaymentSentMe', 'recurring_init' => Bool, 'recurring_used' => Bool, 'currency' => 'string', 'total_amount' => long, 'payload' => 'bytes', 'info' => PaymentRequestedInfo, 'shipping_option_id' => 'string', 'charge' => PaymentCharge];