class SuccessfulPayment

This object contains basic information about a successful payment.

Methods

__construct(string $currency, int $total_amount, string $invoice_payload, string $telegram_payment_charge_id, string $provider_payment_charge_id, string|null $shipping_option_id = null, OrderInfo|null $order_info = null)

No description

string
getCurrency()

Three-letter ISO 4217 currency code.

int
getTotalAmount()

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

string
getInvoicePayload()

Bot specified invoice payload.

string
getTelegramPaymentChargeId()

Telegram payment identifier.

string
getProviderPaymentChargeId()

Provider payment identifier.

string|null
getShippingOptionId()

Optional. Identifier of the shipping option chosen by the user.

OrderInfo|null
getOrderInfo()

Optional. Order information provided by the user.

Details

at line 19
__construct(string $currency, int $total_amount, string $invoice_payload, string $telegram_payment_charge_id, string $provider_payment_charge_id, string|null $shipping_option_id = null, OrderInfo|null $order_info = null)

No description

Parameters

string $currency
int $total_amount
string $invoice_payload
string $telegram_payment_charge_id
string $provider_payment_charge_id
string|null $shipping_option_id
OrderInfo|null $order_info

at line 33
string getCurrency()

Three-letter ISO 4217 currency code.

Return Value

string

at line 41
int getTotalAmount()

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

Return Value

int

at line 49
string getInvoicePayload()

Bot specified invoice payload.

Return Value

string

at line 57
string getTelegramPaymentChargeId()

Telegram payment identifier.

Return Value

string

at line 65
string getProviderPaymentChargeId()

Provider payment identifier.

Return Value

string

at line 73
string|null getShippingOptionId()

Optional. Identifier of the shipping option chosen by the user.

Return Value

string|null

at line 81
OrderInfo|null getOrderInfo()

Optional. Order information provided by the user.

Return Value

OrderInfo|null