API

method initialize(...)

Configures the Stripe SDK. Call this once before using any payment method.

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

method handleURLCallback(...)

Passes an incoming return URL back to the Stripe SDK after redirect-based
authentication.

iOS only. Call this from your app URL handler when Stripe redirects back
to the application.

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

method isApplePayAvailable()

Resolves when Apple Pay is available and rejects when it is unavailable.
Apple Pay is supported on iOS and compatible web browsers, not Android.

isApplePayAvailable() => Promise<void>

method createApplePay(...)

Creates an Apple Pay request. Call this before presentApplePay().

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

method presentApplePay()

Presents the Apple Pay request created by createApplePay().

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

method updateApplePaySheet(...)

Updates the native Apple Pay sheet after a shipping-contact callback.
iOS only; this method is not supported on web.

updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>

method isGooglePayAvailable()

Resolves when Google Pay is available and rejects when it is unavailable.
Google Pay is supported on Android and compatible web browsers, not iOS.

isGooglePayAvailable() => Promise<void>

method createGooglePay(...)

Creates a Google Pay request. Call this before presentGooglePay().

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

method presentGooglePay()

Presents the Google Pay request created by createGooglePay().

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

method createPaymentFlow(...)

Creates a PaymentFlow instance. Use PaymentFlow when the app must collect
payment details first and confirm them in a later step.

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

method presentPaymentFlow()

Presents the PaymentFlow created by createPaymentFlow() and resolves
with the last four digits of the selected card.

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

method confirmPaymentFlow()

Confirms the payment details collected by presentPaymentFlow().

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

method createPaymentSheet(...)

Creates and configures a PaymentSheet instance. Wait for this Promise or
the Loaded event before calling presentPaymentSheet().

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

method presentPaymentSheet()

Presents the PaymentSheet created by createPaymentSheet() and resolves
with its completed, canceled, or failed result.

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

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

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

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

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

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

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

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

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

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

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

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
supplied updateId with updateApplePaySheet().

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

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

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

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

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

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

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

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

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

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

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

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

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

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

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

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

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

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

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

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

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

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

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

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

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

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
card number contains only the last four digits.

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

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

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

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

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

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

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

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

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

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

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

interface StripeInitializationOptions

interface StripeURLHandlingOptions

interface CreatePaymentSheetOption

interface CreatePaymentFlowOption

interface CreateApplePayOption

interface CreateGooglePayOption

interface PaymentSummaryItem

interface DefaultBillingDetails

interface Address

interface AddressDetails

interface BillingDetailsCollectionConfiguration

Controls which billing details PaymentSheet collects from the customer.

interface DidSelectShippingContact

Apple Pay shipping-contact data.

interface DidCreatePaymentMethod

interface ShippingContact

interface PluginListenerHandle

type alias PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

type alias PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

type alias ApplePayResultInterface

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

type alias GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

type alias CollectionMode

'automatic' | 'always' | 'never'

type alias AddressCollectionMode

'automatic' | 'full' | 'never'

enum PaymentSheetEventsEnum

enum PaymentFlowEventsEnum

enum ApplePayEventsEnum

enum GooglePayEventsEnum