SetupPaymentSheetParameters class

Parameters used to setup a Payment sheet.

For more info about the payment sheet see: https://stripe.com/docs/payments/accept-a-payment.

Annotations
  • @freezed

Constructors

SetupPaymentSheetParameters({@Default(false) bool customFlow, String? customerId, String? primaryButtonLabel, String? customerEphemeralKeySecret, String? paymentIntentClientSecret, String? setupIntentClientSecret, IntentConfiguration? intentConfiguration, String? merchantDisplayName, PaymentSheetApplePay? applePay, @JsonKey(toJson: UserInterfaceStyleKey.toJson) ThemeMode? style, PaymentSheetGooglePay? googlePay, @Default(false) bool allowsDelayedPaymentMethods, PaymentSheetAppearance? appearance, @JsonKey(name: 'defaultBillingDetails') BillingDetails? billingDetails, String? returnURL, BillingDetailsCollectionConfiguration? billingDetailsCollectionConfiguration, String? removeSavedPaymentMethodMessage, @JsonKey(toJson: _cardBrandListToJson) List<CardBrand>? preferredNetworks})
const
factory
SetupPaymentSheetParameters.fromJson(Map<String, dynamic> json)
factory

Properties

allowsDelayedPaymentMethods bool
Flag that allows payment methods that do not move money at the send of the checkout.
no setterinherited
appearance PaymentSheetAppearance?
Appearance of the paymentsheet.
no setterinherited
applePay PaymentSheetApplePay?
Configuration related to Apple Pay If set, PaymentSheet displays Apple Pay as a payment option
no setterinherited
billingDetails BillingDetails?
Default billing information of the customer.
no setterinherited
billingDetailsCollectionConfiguration BillingDetailsCollectionConfiguration?
Configuration for how billing details are collected during checkout.
no setterinherited
copyWith → $SetupPaymentSheetParametersCopyWith<SetupPaymentSheetParameters>
no setterinherited
customerEphemeralKeySecret String?
A temp key can be used for API operations that require a secret key.
no setterinherited
customerId String?
The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id
no setterinherited
customFlow bool
Whether or not to use a custom flow.
no setterinherited
googlePay PaymentSheetGooglePay?
Configuration related to Google Pay If set, PaymentSheet displays Google Pay as a payment option
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
intentConfiguration IntentConfiguration?
Use this when you want to collect payment information before creating a setupintent or payment intent.
no setterinherited
merchantDisplayName String?
Display name of the merchant
no setterinherited
paymentIntentClientSecret String?
Secret used for client-side retrieval using a publishable key.
no setterinherited
preferredNetworks List<CardBrand>?
The list of preferred networks that should be used to process payments made with a co-branded card. This value will only be used if your user hasn't selected a network themselves.
no setterinherited
primaryButtonLabel String?
The label to use for the primary button. If not set, Payment Sheet will display suitable default labels for payment and setup intents
no setterinherited
removeSavedPaymentMethodMessage String?
Optional configuration to display a custom message when a saved payment method is removed. iOS only.
no setterinherited
returnURL String?
Return URL is required for IDEAL, Klarna and few other payment methods
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
setupIntentClientSecret String?
The client secret of this SetupIntent
no setterinherited
style ThemeMode?
iOS only style options for colors in PaymentSheet
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
inherited
toString() String
A string representation of this object.
inherited

Operators

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