SuccessfulPayment class abstract

This object contains basic information about a successful payment.

Available extensions
Annotations
  • @freezed

Constructors

SuccessfulPayment({@JsonKey.new(name: 'currency') required String currency, @JsonKey.new(name: 'total_amount') required int totalAmount, @JsonKey.new(name: 'invoice_payload') required String invoicePayload, @JsonKey.new(name: 'shipping_option_id') String? shippingOptionId, @JsonKey.new(name: 'order_info') OrderInfo? orderInfo, @JsonKey.new(name: 'telegram_payment_charge_id') required String telegramPaymentChargeId, @JsonKey.new(name: 'provider_payment_charge_id') required String providerPaymentChargeId, @JsonKey.new(name: 'is_recurring') bool? isRecurring, @JsonKey.new(name: 'is_first_recurring') bool? isFirstRecurring})
Constructs a SuccessfulPayment object
const
factory
SuccessfulPayment.fromJson(Map<String, dynamic> json)
Creates a SuccessfulPayment object from a JSON object
factory

Properties

copyWith → $SuccessfulPaymentCopyWith<SuccessfulPayment>
Create a copy of SuccessfulPayment with the given fields replaced by the non-null parameter values.
no setterinherited
currency → String
Three-letter ISO 4217 currency code
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
invoicePayload → String
Bot specified invoice payload
no setterinherited
isFirstRecurring → bool?
Optional. True, if the payment is the first payment for a subscription
no setterinherited
isRecurring → bool?
Optional. True, if the payment is a recurring payment for a subscription
no setterinherited
orderInfo → OrderInfo?
Optional. Order info provided by the user
no setterinherited
providerPaymentChargeId → String
Provider payment identifier
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shippingOptionId → String?
Optional. Identifier of the shipping option chosen by the user
no setterinherited
telegramPaymentChargeId → String
Telegram payment identifier
no setterinherited
totalAmount → int
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).
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_SuccessfulPayment value)) → TResult

Available on SuccessfulPayment, provided by the SuccessfulPaymentPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_SuccessfulPayment value)?) → TResult?

Available on SuccessfulPayment, provided by the SuccessfulPaymentPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_SuccessfulPayment value)?, {required TResult orElse()}) → TResult

Available on SuccessfulPayment, provided by the SuccessfulPaymentPatterns extension

A variant of map that fallback to returning orElse.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this SuccessfulPayment to a JSON map.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited