@capacitor-community/stripe
Capacitor community plugin for native Stripe.
Since version 4.2.0, this plugin requires compileSdkVersion "33". (Capacitor 4's default compileSdkVersion is "32").
Plugin version
compileSdkVersion
4.1.2
32
4.2.0
33
Updated Google Pay button to match new brand guidelines.
[CHANGED]5679 Fix oversized verification_frames payloads leading to failed scans.
See more info: https://github.com/stripe/stripe-android/releases
Most of the time it will be fine, but it may conflict with other plugins. If this, you should use released version. We can't support conflict with other plugins.
✨
Made with contributors-img .
Learn at the official @capacitor-community/stripe documentation .
日本語版をご利用の際は ja.stripe.capacitorjs.jp をご確認ください。
Android
iOS
Web
PaymentSheet
PaymentFlow
ApplePay
Not supported
beta.
GooglePay
Not supported
Identity
Not supported
isApplePayAvailable()createApplePay(...)presentApplePay()addListener(ApplePayEventsEnum.Loaded, ...)addListener(ApplePayEventsEnum.FailedToLoad, ...)addListener(ApplePayEventsEnum.Completed, ...)addListener(ApplePayEventsEnum.Canceled, ...)addListener(ApplePayEventsEnum.Failed, ...)addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)isGooglePayAvailable()createGooglePay(...)presentGooglePay()addListener(GooglePayEventsEnum.Loaded, ...)addListener(GooglePayEventsEnum.FailedToLoad, ...)addListener(GooglePayEventsEnum.Completed, ...)addListener(GooglePayEventsEnum.Canceled, ...)addListener(GooglePayEventsEnum.Failed, ...)createIdentityVerificationSheet(...)presentIdentityVerificationSheet()addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)addListener(IdentityVerificationSheetEventsEnum.Completed, ...)addListener(IdentityVerificationSheetEventsEnum.Canceled, ...)addListener(IdentityVerificationSheetEventsEnum.Failed, ...)createPaymentFlow(...)presentPaymentFlow()confirmPaymentFlow()addListener(PaymentFlowEventsEnum.Loaded, ...)addListener(PaymentFlowEventsEnum.FailedToLoad, ...)addListener(PaymentFlowEventsEnum.Opened, ...)addListener(PaymentFlowEventsEnum.Completed, ...)addListener(PaymentFlowEventsEnum.Canceled, ...)addListener(PaymentFlowEventsEnum.Failed, ...)addListener(PaymentFlowEventsEnum.Created, ...)createPaymentSheet(...)presentPaymentSheet()addListener(PaymentSheetEventsEnum.Loaded, ...)addListener(PaymentSheetEventsEnum.FailedToLoad, ...)addListener(PaymentSheetEventsEnum.Completed, ...)addListener(PaymentSheetEventsEnum.Canceled, ...)addListener(PaymentSheetEventsEnum.Failed, ...)initialize(...)handleURLCallback(...)Interfaces Type Aliases Enums
This is for @capacitor/docgen only.
Not use in product.
isApplePayAvailable ( ) = > Promise < void > createApplePay ( options : CreateApplePayOption ) = > Promise < void > presentApplePay ( ) = > Promise < { paymentResult : ApplePayResultInterface ; } > Returns: Promise<{ paymentResult: ApplePayResultInterface ; }>
addListener ( eventName : ApplePayEventsEnum . Loaded , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . FailedToLoad , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . Completed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . Canceled , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . Failed , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . DidSelectShippingContact , listenerFunc : ( data : DidSelectShippingContact ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : ApplePayEventsEnum . DidCreatePaymentMethod , listenerFunc : ( data : DidSelectShippingContact ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
isGooglePayAvailable ( ) = > Promise < void > createGooglePay ( options : CreateGooglePayOption ) = > Promise < void > presentGooglePay ( ) = > Promise < { paymentResult : GooglePayResultInterface ; } > Returns: Promise<{ paymentResult: GooglePayResultInterface ; }>
addListener ( eventName : GooglePayEventsEnum . Loaded , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : GooglePayEventsEnum . FailedToLoad , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : GooglePayEventsEnum . Completed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : GooglePayEventsEnum . Canceled , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : GooglePayEventsEnum . Failed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
createIdentityVerificationSheet ( options : CreateIdentityVerificationSheetOption ) = > Promise < void > presentIdentityVerificationSheet ( ) = > Promise < { identityVerificationResult : IdentityVerificationSheetResultInterface ; } > Returns: Promise<{ identityVerificationResult: IdentityVerificationSheetResultInterface ; }>
addListener ( eventName : IdentityVerificationSheetEventsEnum . Loaded , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : IdentityVerificationSheetEventsEnum . FailedToLoad , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : IdentityVerificationSheetEventsEnum . Completed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : IdentityVerificationSheetEventsEnum . Canceled , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : IdentityVerificationSheetEventsEnum . Failed , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
createPaymentFlow ( options : CreatePaymentFlowOption ) = > Promise < void > presentPaymentFlow ( ) = > Promise < { cardNumber : string ; } > Returns: Promise<{ cardNumber: string; }>
confirmPaymentFlow ( ) = > Promise < { paymentResult : PaymentFlowResultInterface ; } > Returns: Promise<{ paymentResult: PaymentFlowResultInterface ; }>
addListener ( eventName : PaymentFlowEventsEnum . Loaded , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . FailedToLoad , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . Opened , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . Completed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . Canceled , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . Failed , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentFlowEventsEnum . Created , listenerFunc : ( info : { cardNumber : string ; } ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
createPaymentSheet ( options : CreatePaymentSheetOption ) = > Promise < void > presentPaymentSheet ( ) = > Promise < { paymentResult : PaymentSheetResultInterface ; } > Returns: Promise<{ paymentResult: PaymentSheetResultInterface ; }>
addListener ( eventName : PaymentSheetEventsEnum . Loaded , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentSheetEventsEnum . FailedToLoad , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentSheetEventsEnum . Completed , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentSheetEventsEnum . Canceled , listenerFunc : ( ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
addListener ( eventName : PaymentSheetEventsEnum . Failed , listenerFunc : ( error : string ) = > void ) => PluginListenerHandle Returns: PluginListenerHandle
initialize ( opts : StripeInitializationOptions ) = > Promise < void > handleURLCallback ( opts : StripeURLHandlingOptions ) = > Promise < void > iOS Only
Prop
Type
paymentIntentClientSecretstring
paymentSummaryItems{ label: string; amount: number; }[]
merchantIdentifierstring
countryCodestring
currencystring
requiredShippingContactFields('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]
Prop
Type
remove() => Promise<void>
Prop
Type
Description
givenNamestringApple Pay only
familyNamestringApple Pay only
middleNamestringApple Pay only
namePrefixstringApple Pay only
nameSuffixstringApple Pay only
nameFormattedstringApple Pay only
phoneNumberstringApple Pay only
nicknamestringApple Pay only
streetstringApple Pay only
citystringApple Pay only
statestringApple Pay only
postalCodestringApple Pay only
countrystringApple Pay only
isoCountryCodestringApple Pay only
subAdministrativeAreastringApple Pay only
subLocalitystringApple Pay only
Prop
Type
Description
paymentIntentClientSecretstring
paymentSummaryItems{ label: string; amount: number; }[]Web only need @stripe-elements/stripe-elements > 1.1.0
merchantIdentifierstringWeb only need @stripe-elements/stripe-elements > 1.1.0
countryCodestringWeb only need @stripe-elements/stripe-elements > 1.1.0
currencystringWeb only need @stripe-elements/stripe-elements > 1.1.0
Prop
Type
verificationIdstring
ephemeralKeySecretstring
Prop
Type
Description
Default
paymentIntentClientSecretstringAny documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
setupIntentClientSecretstringAny documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
customerEphemeralKeySecretstringAny documentation call 'ephemeralKey'
customerIdstringAny documentation call 'customer'
enableApplePaybooleanIf you set payment method ApplePay, this set true
false
applePayMerchantIdstringIf set enableApplePay false, Plugin ignore here.
enableGooglePaybooleanIf you set payment method GooglePay, this set true
false
GooglePayIsTestingbooleanfalse,
countryCodestringuse ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here.
"US"
merchantDisplayNamestring"App Name"
returnURLstring""
style'alwaysLight' | 'alwaysDark'iOS Only
undefined
withZipCodebooleanPlatform: Web only Show ZIP code field.
true
Prop
Type
Description
Default
paymentIntentClientSecretstringAny documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
setupIntentClientSecretstringAny documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
customerEphemeralKeySecretstringAny documentation call 'ephemeralKey'
customerIdstringAny documentation call 'customer'
enableApplePaybooleanIf you set payment method ApplePay, this set true
false
applePayMerchantIdstringIf set enableApplePay false, Plugin ignore here.
enableGooglePaybooleanIf you set payment method GooglePay, this set true
false
GooglePayIsTestingbooleanfalse,
countryCodestringuse ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here.
"US"
merchantDisplayNamestring"App Name"
returnURLstring""
style'alwaysLight' | 'alwaysDark'iOS Only
undefined
withZipCodebooleanPlatform: Web only Show ZIP code field.
true
Prop
Type
Description
publishableKeystring
stripeAccountstringOptional. Making API calls for connected accounts
Prop
Type
stripeStripePlugin
isApplePayAvailableboolean
isGooglePayAvailableboolean
ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod
GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed
IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed
PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed
PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed
Members
Value
Loaded"applePayLoaded"
FailedToLoad"applePayFailedToLoad"
Completed"applePayCompleted"
Canceled"applePayCanceled"
Failed"applePayFailed"
DidSelectShippingContact"applePayDidSelectShippingContact"
DidCreatePaymentMethod"applePayDidCreatePaymentMethod"
Members
Value
Loaded"googlePayLoaded"
FailedToLoad"googlePayFailedToLoad"
Completed"googlePayCompleted"
Canceled"googlePayCanceled"
Failed"googlePayFailed"
Members
Value
Loaded"identityVerificationSheetLoaded"
FailedToLoad"identityVerificationSheetFailedToLoad"
Completed"identityVerificationSheetCompleted"
Canceled"identityVerificationSheetCanceled"
Failed"identityVerificationSheetFailed"
Members
Value
Loaded"paymentFlowLoaded"
FailedToLoad"paymentFlowFailedToLoad"
Opened"paymentFlowOpened"
Created"paymentFlowCreated"
Completed"paymentFlowCompleted"
Canceled"paymentFlowCanceled"
Failed"paymentFlowFailed"
Members
Value
Loaded"paymentSheetLoaded"
FailedToLoad"paymentSheetFailedToLoad"
Completed"paymentSheetCompleted"
Canceled"paymentSheetCanceled"
Failed"paymentSheetFailed"
@capacitor-community/stripe is MIT licensed .
