PaymentElementWalletOptions class abstract

By default, the Payment Element will display all the payment methods that the underlying Payment Intent was created with. However, wallets like Apple Pay and Google Pay are not payment methods per the Payment Intent API. They will show when the Payment Intent has the card payment method and the customer is using a supported platform and have an active card in their account. This is the auto behavior, and it is the default for choice for all wallets. If you do not want to show a given wallet as a payment option, you can set its property in wallets to never.

Available extensions
Annotations
  • @freezed

Properties

applePay PaymentElementFieldRequired?
Apple pay required options
no setterinherited
copyWith → $PaymentElementWalletOptionsCopyWith<PaymentElementWalletOptions>
Create a copy of PaymentElementWalletOptions with the given fields replaced by the non-null parameter values.
no setterinherited
googlePay PaymentElementFieldRequired?
Google pay required options
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

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

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

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

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

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

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(PaymentElementFieldRequired? applePay, PaymentElementFieldRequired? googlePay)?, {required TResult orElse()}) → TResult

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serializes this PaymentElementWalletOptions to a JSON map.
inherited
toString() String
A string representation of this object.
inherited
when<TResult extends Object?>(TResult $default(PaymentElementFieldRequired? applePay, PaymentElementFieldRequired? googlePay)) → TResult

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(PaymentElementFieldRequired? applePay, PaymentElementFieldRequired? googlePay)?) → TResult?

Available on PaymentElementWalletOptions, provided by the PaymentElementWalletOptionsPatterns extension

A variant of when that fallback to returning null

Operators

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