The client_secret of the associated PaymentIntent.
An optional object that contains data related to the payment method used to confirm this payment. If no object is provided (undefined), then it is assumed that the payment method has already been attached to the Payment Intent.
An optional object that contains options for this payment method.
A promise that resolves to an object containing either a paymentIntent
field, or an error
field.
Handles any nextAction required to authenticate the PaymentIntent. Call this method if you are using manual confirmation. See https://stripe.com/docs/payments/accept-a-payment?platform=react-native&ui=custom
The client secret associated with the PaymentIntent.
An optional return URL so the Stripe SDK can redirect back to your app after authentication. This should match the return_url
you specified during PaymentIntent confirmation.
You must call this method when the user logs out from your app. This will ensure that any persisted authentication state in the PaymentSheet, such as authentication cookies, is also cleared during logout.
Use collectBankAccountToken in the Add a Financial Connections Account to a US Custom Connect account flow. When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account for payouts.
The client_secret of the Financial Connections Session.
A promise that resolves to an object containing either session
and token
fields, or an error field.
Use collectFinancialConnectionsAccounts in the Collect an account to build data-powered products flow. When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account.
The client_secret of the Financial Connections Session.
A promise that resolves to an object containing either a session
field, or an error field.
Check if the app & device support adding this card to the native wallet.
An object containing fields for primaryAccountIdentifier
, cardLastFour
, and testEnv
.
A promise resolving to an object of type CanAddCardToWalletResult. Check the canAddCard
field, if it's true, you should show the <AddToWalletButton />
Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.
A boolean indicating whether or not the native wallet is supported.
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe SetupIntent.
The client secret of the SetupIntent.
an object describing the Apple Pay and Google Pay configurations.
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both setupIntent
and paymentMethod
fields.
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe PaymentIntent.
The client secret of the PaymentIntent.
an object describing the Apple Pay and Google Pay configurations.
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both paymentIntent
and paymentMethod
fields.
iOS only, this will always return false on Android. Dismisses the Apple Pay sheet if it is open.
A boolean indicating whether or not the sheet was successfully closed. Will return false if the Apple Pay sheet was not open.
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe PaymentMethod.
an object describing the Apple Pay and Google Pay configurations.
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with a paymentMethod
field.
an object describing the Apple Pay and Google Pay configurations.
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with a token
field.
iOS only. Update different items on the Apple Pay sheet, including the summary items, the shipping methods, and any errors shown. iOS only, this is a no-op on Android.
an object describing the Apple Pay configuration, with the following fields:
An object with an optional 'error' field, which is only populated if something went wrong.
iOS only, this is a no-op on Android. Use this method to move users to the interface for adding credit cards. This method transfers control to the Wallet app on iPhone or to the Settings app on iPad. For devices that don’t support Apple Pay, this method does nothing.
useApplePay hook
useConfirmPayment hook
useConfirmSetupIntent hook
React hook for accessing functions on the Financial Connections sheet.
Retuns the collectBankAccountToken
and collectFinancialConnectionsAccounts
functions, and a loading
boolean that you can use
to display loading state (like showing a spinner).
useGooglePay hook
usePaymentSheet hook
usePlatformPay hook. Access all Apple and Google Pay functionality with this hook.
useStripe hook
Add to wallet button
Props
JSX.Element
Props
JSX.Element
Apple Pay Button Component
Props
JSX.Element
BECS Debit form component
Props
JSX.Element
Google Pay Button Component
Props
JSX.Element
PlatformPayButton Component. Display the platform-specific native wallet pay button: Apple Pay on iOS, and Google Pay on Android.
Props
JSX.Element
StripeContainer Component
Props
JSX.Element
StripeProvider Component
Props
JSX.Element
Card Field Component
Card Form Component
Stripe Provider Component Props
The customer's full name.
The customer's address.
The customer's phone number.
Whether or not the checkbox is initally selected. Defaults to false. Note: The checkbox is displayed below the other fields when additionalFields.checkboxLabel is set.
The primary_account_identifier
value from the issued card. Can be an empty string.
Last 4 digits of the card number. Required for Android.
iOS only. Set this to true
until shipping through TestFlight || App Store. If false, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios
iOS only. Set this to true
if: your user has an Apple Watch device currently paired, and you want to check that device for the presence of the specified card.
Android only, defaults to true
. Set this to false
if you'd like to allow users without NFC-enabled devices to add cards to the wallet. NFC is required for paying in stores.
Generated using TypeDoc
Confirm and, if necessary, authenticate a PaymentIntent.