Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@capacitor-community/stripe

capacitor-community13.1kMIT7.2.0TypeScript support: included

Stripe SDK bindings for Capacitor Applications

capacitor, plugin, native

readme

@capacitor-community/stripe

Stripe SDK bindings for Capacitor Applications

Install

npm install @capacitor-community/stripe
npx cap sync

How to use

Learn at the official @capacitor-community/stripe documentation.

日本語版をご利用の際は ja.stripe.capacitorjs.jp をご確認ください。

API

<docgen-index> </docgen-index> <docgen-api>

initialize(...)

initialize(opts: StripeInitializationOptions) => Promise<void>
Param Type
opts StripeInitializationOptions

handleURLCallback(...)

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

iOS Only

Param Type
opts StripeURLHandlingOptions

isApplePayAvailable()

isApplePayAvailable() => Promise<void>

createApplePay(...)

createApplePay(options: CreateApplePayOption) => Promise<void>
Param Type
options CreateApplePayOption

presentApplePay()

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

Returns: Promise<{ paymentResult: ApplePayResultInterface; }>

addListener(ApplePayEventsEnum.Loaded, ...)

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.Loaded
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.FailedToLoad, ...)

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.FailedToLoad
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.Completed, ...)

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.Completed
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.Canceled, ...)

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.Canceled
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.Failed, ...)

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.Failed
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.DidSelectShippingContact
listenerFunc (data: DidSelectShippingContact) => void

Returns: Promise<PluginListenerHandle>

addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>
Param Type
eventName ApplePayEventsEnum.DidCreatePaymentMethod
listenerFunc (data: DidSelectShippingContact) => void

Returns: Promise<PluginListenerHandle>

isGooglePayAvailable()

isGooglePayAvailable() => Promise<void>

createGooglePay(...)

createGooglePay(options: CreateGooglePayOption) => Promise<void>
Param Type
options CreateGooglePayOption

presentGooglePay()

presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>

Returns: Promise<{ paymentResult: GooglePayResultInterface; }>

addListener(GooglePayEventsEnum.Loaded, ...)

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName GooglePayEventsEnum.Loaded
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(GooglePayEventsEnum.FailedToLoad, ...)

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName GooglePayEventsEnum.FailedToLoad
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(GooglePayEventsEnum.Completed, ...)

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName GooglePayEventsEnum.Completed
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(GooglePayEventsEnum.Canceled, ...)

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName GooglePayEventsEnum.Canceled
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(GooglePayEventsEnum.Failed, ...)

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName GooglePayEventsEnum.Failed
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

createPaymentFlow(...)

createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>
Param Type
options CreatePaymentFlowOption

presentPaymentFlow()

presentPaymentFlow() => Promise<{ cardNumber: string; }>

Returns: Promise<{ cardNumber: string; }>

confirmPaymentFlow()

confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>

Returns: Promise<{ paymentResult: PaymentFlowResultInterface; }>

addListener(PaymentFlowEventsEnum.Loaded, ...)

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Loaded
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.FailedToLoad
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.Opened, ...)

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Opened
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.Completed, ...)

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Completed
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.Canceled, ...)

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Canceled
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.Failed, ...)

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Failed
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentFlowEventsEnum.Created, ...)

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentFlowEventsEnum.Created
listenerFunc (info: { cardNumber: string; }) => void

Returns: Promise<PluginListenerHandle>

createPaymentSheet(...)

createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>
Param Type
options CreatePaymentSheetOption

presentPaymentSheet()

presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>

Returns: Promise<{ paymentResult: PaymentSheetResultInterface; }>

addListener(PaymentSheetEventsEnum.Loaded, ...)

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentSheetEventsEnum.Loaded
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentSheetEventsEnum.FailedToLoad
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentSheetEventsEnum.Completed, ...)

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentSheetEventsEnum.Completed
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentSheetEventsEnum.Canceled, ...)

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentSheetEventsEnum.Canceled
listenerFunc () => void

Returns: Promise<PluginListenerHandle>

addListener(PaymentSheetEventsEnum.Failed, ...)

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>
Param Type
eventName PaymentSheetEventsEnum.Failed
listenerFunc (error: string) => void

Returns: Promise<PluginListenerHandle>

Interfaces

StripeInitializationOptions

Prop Type Description
publishableKey string
stripeAccount string Optional. Making API calls for connected accounts

StripeURLHandlingOptions

Prop Type
url string

CreateApplePayOption

Prop Type
paymentIntentClientSecret string
paymentSummaryItems { label: string; amount: number; }[]
merchantIdentifier string
countryCode string
currency string
requiredShippingContactFields ('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]
allowedCountries string[]
allowedCountriesErrorDescription string

PluginListenerHandle

Prop Type
remove () => Promise<void>

DidSelectShippingContact

Prop Type
contact ShippingContact

ShippingContact

Prop Type Description
givenName string Apple Pay only
familyName string Apple Pay only
middleName string Apple Pay only
namePrefix string Apple Pay only
nameSuffix string Apple Pay only
nameFormatted string Apple Pay only
phoneNumber string Apple Pay only
nickname string Apple Pay only
street string Apple Pay only
city string Apple Pay only
state string Apple Pay only
postalCode string Apple Pay only
country string Apple Pay only
isoCountryCode string Apple Pay only
subAdministrativeArea string Apple Pay only
subLocality string Apple Pay only

CreateGooglePayOption

Prop Type Description
paymentIntentClientSecret string
paymentSummaryItems { label: string; amount: number; }[] Web only need stripe-pwa-elements > 1.1.0
merchantIdentifier string Web only need stripe-pwa-elements > 1.1.0
countryCode string Web only need stripe-pwa-elements > 1.1.0
currency string Web only need stripe-pwa-elements > 1.1.0

CreatePaymentFlowOption

Prop Type Description Default
paymentIntentClientSecret string Any documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
setupIntentClientSecret string Any documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
defaultBillingDetails DefaultBillingDetails Optional defaultBillingDetails This is ios/android only. not support web. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details
shippingDetails AddressDetails Optional shippingDetails This is android only. ios requires an address element. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses
billingDetailsCollectionConfiguration BillingDetailsCollectionConfiguration Optional billingDetailsCollectionConfiguration This is ios/android only. not support web. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection
customerEphemeralKeySecret string Any documentation call 'ephemeralKey'
customerId string Any documentation call 'customer'
enableApplePay boolean If you set payment method ApplePay, this set true false
applePayMerchantId string If set enableApplePay false, Plugin ignore here.
enableGooglePay boolean If you set payment method GooglePay, this set true false
GooglePayIsTesting boolean | false,
countryCode string use ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here. "US"
merchantDisplayName string | "App Name"
returnURL string | ""
style 'alwaysLight' | 'alwaysDark' iOS Only undefined
withZipCode boolean Platform: Web only Show ZIP code field. true
currencyCode string use GooglePay. Required if enableGooglePay is true for setupIntents. "USD"

DefaultBillingDetails

Prop Type
email string
name string
phone string
address Address

Address

Prop Type Description
country string Two-letter country code (ISO 3166-1 alpha-2).
city string
line1 string
line2 string
postalCode string
state string

AddressDetails

Prop Type
name string
address Address
phone string
isCheckboxSelected boolean

BillingDetailsCollectionConfiguration

Prop Type Description
email CollectionMode Configuration for how billing details are collected during checkout.
name CollectionMode
phone CollectionMode
address AddressCollectionMode

CreatePaymentSheetOption

Prop Type Description Default
paymentIntentClientSecret string Any documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
setupIntentClientSecret string Any documentation call 'paymentIntent' Set paymentIntentClientSecret or setupIntentClientSecret
defaultBillingDetails DefaultBillingDetails Optional defaultBillingDetails This is ios/android only. not support web. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details
shippingDetails AddressDetails Optional shippingDetails This is android only. ios requires an address element. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses
billingDetailsCollectionConfiguration BillingDetailsCollectionConfiguration Optional billingDetailsCollectionConfiguration This is ios/android only. not support web. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection
customerEphemeralKeySecret string Any documentation call 'ephemeralKey'
customerId string Any documentation call 'customer'
enableApplePay boolean If you set payment method ApplePay, this set true false
applePayMerchantId string If set enableApplePay false, Plugin ignore here.
enableGooglePay boolean If you set payment method GooglePay, this set true false
GooglePayIsTesting boolean | false,
countryCode string use ApplePay and GooglePay. If set enableApplePay and enableGooglePay false, Plugin ignore here. "US"
merchantDisplayName string | "App Name"
returnURL string | ""
style 'alwaysLight' | 'alwaysDark' iOS Only undefined
withZipCode boolean Platform: Web only Show ZIP code field. true
currencyCode string use GooglePay. Required if enableGooglePay is true for setupIntents. "USD"

Type Aliases

ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod

GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

CollectionMode

Billing details collection options.

'automatic' | 'always' | 'never'

AddressCollectionMode

Billing details collection options.

'automatic' | 'full' | 'never'

PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

Enums

ApplePayEventsEnum

Members Value
Loaded "applePayLoaded"
FailedToLoad "applePayFailedToLoad"
Completed "applePayCompleted"
Canceled "applePayCanceled"
Failed "applePayFailed"
DidSelectShippingContact "applePayDidSelectShippingContact"
DidCreatePaymentMethod "applePayDidCreatePaymentMethod"

GooglePayEventsEnum

Members Value
Loaded "googlePayLoaded"
FailedToLoad "googlePayFailedToLoad"
Completed "googlePayCompleted"
Canceled "googlePayCanceled"
Failed "googlePayFailed"

PaymentFlowEventsEnum

Members Value
Loaded "paymentFlowLoaded"
FailedToLoad "paymentFlowFailedToLoad"
Opened "paymentFlowOpened"
Created "paymentFlowCreated"
Completed "paymentFlowCompleted"
Canceled "paymentFlowCanceled"
Failed "paymentFlowFailed"

PaymentSheetEventsEnum

Members Value
Loaded "paymentSheetLoaded"
FailedToLoad "paymentSheetFailedToLoad"
Completed "paymentSheetCompleted"
Canceled "paymentSheetCanceled"
Failed "paymentSheetFailed"
</docgen-api>

License

@capacitor-community/stripe is MIT licensed.