flutter_stripe_web library

Classes

AccountBalance
information related to the bank account
Address
Address information
AddressDetails
Information regarding the Address sheet field
AddressSheetAdditionalFields
AddressSheetParams
AddToWalletDetails
The Details object that provides some additional result
AddToWalletResult
The result when asking the Stripe sdk to add a card to wallet
AppInfo
ApplePayCartSummaryItem
Object that can be used to explain the different charges on the Apple Pay sheet.
ApplePayContactName
Contact name data for Apple pay
ApplePayErrorAddressField
ApplePayMultiMerchant
Data record for multimerchant payment
ApplePayParams
ApplePayPostalAddress
Postal address data for Apple pay
ApplePayPresentParams
ApplePaySheetError
ApplePayShippingMethod
Shipping method details regarding apple pay
AuBecsDebit
AubecsDebit data associated with the payment method
AubecsFormInputDetails
Input details that will be returned from the form.
AubecsFormStyle
Styling information for the AubecsFormField
BacsDebit
BacsDebit data associated with the payment method
BalanceRefresh
BankAccount
Bank account data related to the token
BankAccountTokenParams
parameters needed to create a token for bank account
BillingAddressConfig
Billing address collection config for Google Pay.
BillingDetails
Billing information associated with the payment method.
BillingDetailsCollectionConfiguration
BillingDetailsFields
CanAddCardToDetails
The details if card can be added.
CanAddCardToWalletParams
The params for checking if a card is in the wallet.
CanAddCardToWalletResult
The result of checking if a card can be added to the wallet.
Card
Card data associated with the payment method
CardData
Card data associated with the token
CardDetails
Credit Card Details
CardEditController
CardFieldFocusName
Used to communicate with the card handler on the native platform side when focus changes.
CardFieldInputDetails
User input details.
CardFormStyle
Styiling information for the cardfield.
CardPlaceholder
Localized text for the placeholders of the card fields.
CardStyle
Styiling information for the cardfield.
CardTokenParams
parameters that are used to create a token for a card.
CollectAddressResult
CollectBankAccountParams
Parameters that provide additional information for collecting the bankaccount for ACH payment
CollectBankAccountPaymentMethodData
Specific payment method data needed for collecting the bank account of an payment method
ConfirmPaymentElementOptions
ConfirmPaymentParams
ConfirmSetupElementOptions
ConfirmSetupParams
CreateGooglePayPaymentParams
Parameters to create a google pay payment.
CreateTokenParams
parameters that are used to create a token.
CustomerSheetInitParams
Parameters to setup a Customer sheet
CustomerSheetPresentParams
CustomerSheetResult
DeferredSummaryItem
ElementAppearance
Appareance options for the Payment Element and other elements. https://stripe.com/docs/elements/appearance-api
ExpressCheckoutElement
ExpressCheckoutLayout
Layout parameters of the express checkout element
FinancialConnectionAccount
Data linked to an account
FinancialConnectionBankAccountToken
Data related to the session retrieved from the financial connection.
FinancialConnectionSession
Data related to the session retrieved from the financial connection.
FinancialConnectionSessionResult
FinancialConnectionTokenResult
Fpx
GooglePayBillingAddressConfig
GooglePayCardToken
Tokenized token for Google Pay.
GooglePayInitParams
Config parameters used to intialize google pay.
GooglePayParams
GooglePayPaymentMethodParams
Payment method parameters for google pay
GooglePayShippingAddressConfig
Ideal
Ideal data associated with the payment method
ImmediateCartSummaryItem
IntentConfiguration
IntentCreationCallbackParams
IntentMode
IsCardInWalletResult
The result of checking if a card is in the wallet.
IsGooglePaySupportedParams
LastSetupError
Incormation about the error that has occured since last payment confirmation.
LocalizedErrorMessage
Provides details about the error
MandateData
A Mandate is a record of the permission a customer has given you to debit their payment method.
MandateDataCustomerAcceptance
Information about the online mandate
MandateDataOnlineData
Information about the online mandate
NextAction
Description of the possible next action that must be handled to complete the PaymentIntent.
PaymentElement
PaymentElementAddressFields
PaymentElementApplePayAutoReloadPaymentRequest
PaymentElementApplePayDeferredPaymentProperties
PaymentElementApplePayDeferredPaymentRequest
PaymentElementApplePayOptions
PaymentElementApplePayReloadPaymentProperties
PaymentElementAppleRecurringRequest
PaymentElementBillingDetails
PaymentElementBillingDetailsAddress
PaymentElementBusiness
PaymentElementCardDefaults
PaymentElementDefaultValues
PaymentElementFields
PaymentElementIdealDefaults
PaymentElementLayout
Specify the layout for the Payment Element. If you only pass a layout type ('accordion' or ‘tabs’) without any additional parameters, t he Payment Element renders using that layout and the default values associated with it.
PaymentElementOptions
PaymentElementOptionsTerms
Control how mandates or other legal agreements are displayed in the Payment Element. The default setting is auto, which causes legal agreements to only be shown when necessary.
PaymentElementPaymentMethodDefaults
PaymentElementRecurringPaymentProperties
PaymentElementWalletOptions
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.
PaymentIntent
A payment intent represents the interaction between the user and the payment form.
PaymentMethod
Representation of the payment instruments. See https://stripe.com/docs/payments/payment-methods for more info.
PaymentMethodData
Generic payment method data object that holds the billingdetails.
PaymentMethodDataAfterPay
Payment method data object for Afterpay / clearpay payment method.
PaymentMethodDataAubecs
Payment method data object for Aubecs payment method.
PaymentMethodDataCardFromMethod
Payment method data object for card from payment method.
PaymentMethodDataCardFromToken
Payment method data object for card with token payment method.
PaymentMethodDataFpx
Payment method data object for Fpx payment method.
PaymentMethodDataIdeal
Payment method data object for ideal payment method.
PaymentMethodDataSepa
Payment method data object for Sepa debit payment method.
PaymentMethodDataSofort
Payment method data object for Sofort payment method.
PaymentMethodDataUsBank
Payment method data object forUsbankaccount payment method.
PaymentMethodOptions
Data object that holds the payment options for a payment method.
PaymentMethodParams
Parameters that specify the desired configuration of a specific payment method.
PaymentRequestType
Request for a one time payment.
PaymentSheetAppearance
Parameters that change the appearance of the payment sheet.
PaymentSheetAppearanceColors
Color settings for the Paymentsheet.
PaymentSheetApplePay
Parameters related to the Payment sheet Apple Pay config.
PaymentSheetGooglePay
Parameters related to the Payment sheet Google Pay config.
PaymentSheetPaymentOption
PaymentSheetPresentOptions
PaymentSheetPrimaryButtonAppearance
PaymentSheetPrimaryButtonShape
PaymentSheetPrimaryButtonTheme
PaymentSheetPrimaryButtonThemeColors
PaymentSheetShadowOffset
Shadow config parameters
PaymentSheetShadowParams
Shadow config parameters
PaymentSheetShape
Parameters that change the appearance of the payment sheet.
PIITokenParams
Parameters that are used to create a token for a personally identifiable information (PII).
PlatformPayConfirmParams
PlatformPayConfirmParamsApplePay
PlatformPayConfirmParamsGooglePay
PlatformPayConfirmParamsWeb
PlatformPayOrderDetails
Parameters related to order details with Apple pay
PlatformPayPaymentMethod
Result object when creating a payment method through apple pay or google pay.
PlatformPayPaymentMethodParams
PlatformPayPaymentMethodParamsApplePay
PlatformPayPaymentMethodParamsGooglePay
PlatformPayPaymentMethodParamsWeb
PlatformPaySheetUpdateParams
Parameters related to updating the platform pay sheet
PlatformPayShippingContact
Entered Shipping contact data
PlatformPayWebPaymentItem
PlatformPayWebPaymentRequestCreateOptions
PlatformPayWebShippingOption
PresentGooglePayParams
Parameters needed for presenting Google Pay.
PresentPaymentSheetParameters
Parameters used to display the payment sheet.
RecurringCartSummaryItem
SepaDebit
SepaDebit data associated with the payment method
SetupIntent
SetupIntent information.
SetupPaymentSheetParameters
Parameters used to setup a Payment sheet.
ShippingDetails
Shipping information
Sofort
Sofort data associated with the payment method
StripePlatform
ThreeDSecureButtonThemeData
Styling info related to the 3d secure button.
ThreeDSecureConfigurationParams
Parameters to configure the 3d secure screen.
ThreeDSecureLabelThemeData
Styling info related to the 3d secure label.
ThreeDSecureNavigationBarThemeData
Styling info related to the 3d secure navigation bar.
ThreeDSecureTextFieldThemeData
Styling info related to the 3d secure text field.
ThreeDSecureUsage
TokenData
Data that provides information about the token
Upi
Upi data associated with the payment method.
UsBankAccount
Data associated with the payment method Us bank account.
UserInterfaceStyleKey
VerifyMicroDepositsParams
Parameters that provide additional information for verifyting microdeposits
WebCardField
WebStripe
An implementation of StripePlatform that uses method channels.

Enums

AccountCategory
AccountPermission
AccountStatus
AccountSubcategory
AddressCollectionMode
Types of how to collect the address.
AddressSheetAnimationStyle
How the address sheet should animate
AddressSheetError
AddressSheetPhoneNumberField
The style of how the phone number should be presented
AddressSheetPresentationStyle
The style of how the address sheet should be presented
ApplePayContactFieldsType
Enum representing the different fields that can be added to the Apple Pay sheet.
ApplePayIntervalUnit
ApplePayMerchantCapability
ApplePayRecurringPaymentTimeInterVal
ApplePayShippingMethodType
Enum that represent the support shipping method for Apple pay
ApplePayShippingType
A type that indicates how to ship purchased items
BalanceRefreshStatus
BalanceType
BankAccountHolderType
Entity that is holder of the account
BankAccountStatus
Verfication status of the bankaccount.
BillingAddressFormat
CanAddCardToWalletStatus
The can add card to wallet status.
CanAddToWalletErrorStatus
Add to wallet error status
CaptureMethod
Defines how the money will be captured from the customer's account.
CardBrand
The card brand. This is used to declare the preferred network in the UI
CardFieldName
Enum representing the different fiels on the card field.
CardValidationState
CollectionMode
Types of how to collect non address fields
ConfirmationMethod
Defines how the payment will be confirmed.
CreateTokenError
CustomerSheetAnimationStyle
CustomerSheetError
CustomerSheetPresentationStyle
ElementAppearanceLabels
Enables switching between labels above form fields and floating labels within the form fields
ElementTheme
FailureCode
FinancialConnectionsPaymentMethodType
FinancialConnectSheetError
GooglePayCardTokenStatus
The google pay card token status.
IntentFutureUsage
The type of payment method to attach to a Customer.
InvalidShippingField
NextActionType
The type of followup action the customer needs to do in order to complete the payment.
PaymentConfirmationRedirect
By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method.
PaymentElementFieldRequired
PaymentElementLayoutType
PaymentElementShowTerms
PaymentIntentError
PaymentIntentsFutureUsage
Indicates how future payments will be handled.
PaymentIntentsStatus
Status of the payment intent.
PaymentMethodType
Enum that specifies the payment type.
PaymentSheetError
PlatformButtonStyle
Property to style buttons.
PlatformButtonType
Determine the style for the platform button
PlatformPayWebWalletType
SetupConfirmationRedirect
By default, stripe.confirmPayment will always redirect to your return_url after a successful confirmation. If you set redirect: "if_required", then stripe.confirmPayment will only redirect if your user chooses a redirect-based payment method.
TokenType
Type of token
UsBankAccountType

Extensions

CanMakePayment on PaymentRequest

Typedefs

CardChangedCallback = void Function(CardFieldInputDetails? details)
CardFocusCallback = void Function(CardFieldName? focusedField)
ConfirmHandler = void Function(PaymentMethod result, bool shouldSavePaymentMethod)
OnAddressSheetError = FutureOr<void> Function(StripeException error)
OnAddressSheetSubmit = FutureOr<void> Function(CollectAddressResult result)
OnCouponCodeEntered = FutureOr<void> Function(String couponCode)
OnDidSetShippingContact = FutureOr<void> Function(PlatformPayShippingContact contact)
OnDidSetShippingMethod = FutureOr<void> Function(ApplePayShippingMethod method)
OnOrderTracking = FutureOr<void> Function()
PaymentElementTheme = ElementTheme

Exceptions / Errors

StripeConfigException
StripeError<T>
Wrapper class that represents an error with the Stripe platform.
StripeException
Exception retrieved from the Stripe platform.
WebUnsupportedError