Generated using TypeDoc
Generated using TypeDoc
This device doesn't support adding a card to the native wallet.
+This card already exists on this device and any paired devices.
+This card already exists on this device, but not on the paired device.
+This card already exists on the paired device, but not on this device.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Only the fields required by the Payment Method will be collected, which may be none.
+Billing address will never be collected. If the Payment Method requires a billing address, you must provide it as part of defaultBillingDetails
.
Collect the full billing address, regardless of the Payment Method's requirements.
+Generated using TypeDoc
Controls when the funds will be captured. Seealso: https://stripe.com/docs/api/payment_intents/create#create_payment_intent-capture_method
+(Default) Stripe automatically captures funds when the customer authorizes the payment.
+Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.)
+Asynchronously capture funds when the customer authorizes the payment.
+CaptureMethod.Automatic
due to improved latency, but may require additional integration changes.Generated using TypeDoc
The field may or may not be collected depending on the Payment Method's requirements.
+The field will never be collected. If this field is required by the Payment Method, you must provide it as part of defaultBillingDetails
.
The field will always be collected, even if it isn't required for the Payment Method.
+Generated using TypeDoc
Generated using TypeDoc
Required. This value must be supplied.
+Optional. If present, only transactions that are categorized as credit cards are allowed.
+Optional. If present, only transactions that are categorized as debit cards are allowed.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
iOS only.
+A white button with black lettering.
+A white button with black lettering and a black outline.
+A black button with white lettering.
+Default. A button that automatically changes its appearance when the user switches between Light Mode and Dark Mode.
+Generated using TypeDoc
A button with the Apple Pay or Google Pay logo only, useful when an additional call to action isn't needed.
+A button useful for product purchases.
+A button useful for booking trips, flights, or other experiences.
+A button useful for purchase experiences that include other payment buttons that start with “Check out”.
+A button used by approved nonprofit organization that lets people make donations.
+A button useful for placing orders for such as like meals or flowers.
+A button useful for purchasing a subscription such as a gym membership or meal-kit delivery service.
+iOS only. A button useful for prompting the user to set up a card.
+iOS only. A button useful for paying bills or invoices.
+iOS only. A button useful for adding money to a card, account, or payment system.
+iOS only. A button useful for adding money to a card, account, or payment system.
+iOS only. A button useful for adding money to a card, account, or payment system.
+iOS only. A button useful for renting items such as cars or scooters.
+iOS only. A button useful supporting people give money to projects, causes, organizations, and other entities.
+iOS only. A button useful to help people contribute money to projects, causes, organizations, and other entities.
+iOS only. A button useful useful for letting people tip for goods or services.
+iOS only. A button useful for general purchases.
+Android only. A button useful for general payments.
+Android only. The Google Pay payment button without the additional text.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Confirm and, if necessary, authenticate a PaymentIntent.
+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.
Handles any nextAction required to authenticate the SetupIntent. +Call this method if you are confirming the SetupIntent on your backend and get a status of requires_action.
+The client secret associated with the SetupIntent.
+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.
Call this method in your app whenever you receive a URL for a Stripe callback. +For convenience, you can pass all URLs you receive to this method first, and +check the return value to easily determine whether it is a callback URL that Stripe will handle +or if your app should process it normally. This is iOS-only, and will always return false on Android.
+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.
+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).
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
+BECS Debit form 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
+The Customer Sheet is a prebuilt UI component that lets your customers manage their saved payment methods.
+A component wrapper around the Customer Sheet functions. Upon passing true
to the visible
prop,
+Customer Sheet will call initialize
and present
, and the result(s) will be passed through to the
+onResult callback.
Props
+JSX.Element
+Initialize an instance of Customer Sheet with your desired configuration.
+Launches the Customer Sheet UI.
+You can use this to obtain the selected payment method without presenting the CustomerSheet.
+This will return an error if you have not called .initialize
Card Field Component
+Card Form Component
+Props
+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 color styling to use for PaymentSheet UI. Defaults to 'automatic'. iOS only.
+Configuration for the look and feel of the UI.
+Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps.
+The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id
+A short-lived token that allows the SDK to access a Customer's payment methods.
+Your customer-facing business name. The default value is the name of your app.
+Optional configuration for setting the header text of the Payment Method selection screen
+CustomerSheet pre-populates fields with the values provided. If billingDetailsCollectionConfiguration.attachDefaultsToPaymentMethod
is true
, these values will be attached to the payment method even if they are not collected by the CustomerSheet UI.
Describes how billing details should be collected. All values default to AUTOMATIC
. If NEVER
is used for a required field for the Payment Method, you must provide an appropriate value as part of defaultBillingDetails
.
A URL that redirects back to your app that CustomerSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2
+Optional configuration to display a custom message when a saved payment method is removed. iOS only.
+Whether to show Apple Pay as an option. Defaults to false.
+Whether to show Google Pay as an option. Defaults to false.
+Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if +you would prefer retrieving and updating your Stripe customer object via your own backend instead. +WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
+Controls how the modal is presented (after animation). iOS only. Defaults to popover
. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info.
Controls how the modal animates. iOS only.
+Time (in milliseconds) before the Customer Sheet will automatically dismiss.
+The users selected payment option, if one exists.
+The Stripe PaymentMethod associated with the paymentOption, if it exists.
+The error that occurred.
+The token reference ID.
+Last four digits of the FPAN
+Last four digits of the DPAN
+The name of the issuer.
+The GooglePayCardTokenStatus.
+Deprecated. Use fpanLastFour or dpanLastFour.
+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
Add to wallet button component props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+Sets the Apple Wallet/Google Pay button style. If the button is placed over a dark background, set this to 'onDarkBackground', otherwise set to 'onLightBackground'.
+The image asset to use as the Google Pay button. Downloadable from https://developers.google.com/static/pay/issuers/apis/push-provisioning/android/downloads/flutter/2022_googlepay_flutter_buttons.zip
+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
Details of the Issued Card you'd like added to the device's wallet
+The primary_account_identifier
value from the issued card.
The card holder name (used only on iOS)
+A user-facing description of the card. Required on Android.
+Last 4 digits of the card, only used on iOS
+Optional, only used on iOS
+Used by stripe to securely obtain card info of the card being provisioned.
+When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Called when the flow completes. If the error
field is null
, then the card was successfully added to the user's native wallet.
Generated using TypeDoc
Generated using TypeDoc
Props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+Whether the sheet is visible. Defaults to false.
+Controls how the modal is presented (after animation). iOS only. Defaults to popover
. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info.
Controls how the modal animates. iOS only.
+Configuration for the look and feel of the UI.
+The values to prepopulate the sheet's fields with.
+Configuration for additional fields besides the physical address
+Determines whether the phone number is hidden, required, or optional. Defaults to hidden.
+The label of a checkbox displayed below other fields. If null or undefined, the checkbox is not displayed.
+A list of two-letter country codes representing countries the customers can select. If the list is empty (the default), we display all countries.
+A list of two-letter country codes representing countries that support address autocomplete. Defaults to a list of countries that Stripe has audited to ensure a good autocomplete experience.
+The title of the primary button displayed at the bottom of the screen. Defaults to "Save Address".
+Title displayed at the top of the sheet. Defaults to "Address".
+Android only. Google Places api key used to provide autocomplete suggestions. When null, autocomplete is disabled on Android.
+When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Called when the user submits their information
+Called when the user taps the button to close the sheet before submitting their information, or when an error occurs.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
BECS Debit Form Component Props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Generated using TypeDoc
Generated using TypeDoc
WARNING: Full card details are only returned when the dangerouslyGetFullCardDetails
prop
+on the CardField
component is set to true
.
+Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+Make sure that you're not mistakenly logging or storing full card details!
+See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Card Field Component Props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+Controls if a postal code entry field can be displayed to the user. If true, the type of code entry shown is controlled by the set countryCode prop. Some country codes may result in no postal code entry being shown if those countries do not commonly use postal codes. If false, no postal code entry will ever be displayed. Defaults to true.
+Controls the postal code entry shown (if the postalCodeEnabled prop is set to true). Defaults to the device's default locale.
+Applies a disabled state such that user input is not accepted. Defaults to false.
+WARNING: If set to true
the full card number will be returned in the onCardChange
handler.
+Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+Make sure that you're not mistakenly logging or storing full card details!
+See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Generated using TypeDoc
Card Form Component Props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+Applies a disabled state such that user input is not accepted. Defaults to false.
+All styles except backgroundColor, cursorColor, borderColor, and borderRadius are Android only
+Android only
+Android only
+WARNING: If set to true
the full card number will be returned in the onFormComplete
handler.
+Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+Make sure that you're not mistakenly logging or storing full card details!
+See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Generated using TypeDoc
WARNING: Full card details are only returned when the dangerouslyGetFullCardDetails
prop
+on the CardField
component is set to true
.
+Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+Make sure that you're not mistakenly logging or storing full card details!
+See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Retrieves a list of Payment Methods attached to a customer. +If you are implementing your own CustomerAdapter: +Call the list method ( https://stripe.com/docs/api/payment_methods/list ) +with the Stripe customer. Return the list of payment methods in JSON format.
+Adds a Payment Method to a customer. +If you are implementing your own CustomerAdapter: +On your backend, retrieve the Stripe customer associated with your logged-in user. +Then, call the Attach method on the Payment Method with that customer's ID +( https://stripe.com/docs/api/payment_methods/attach ).
+Deletes the given Payment Method from the customer. +If you are implementing your own CustomerAdapter: +Call the Detach method ( https://stripe.com/docs/api/payment_methods/detach ) +on the Payment Method.
+Set the last selected payment method for the customer.
+To unset the default payment method, null
is passed as the paymentOption
.
+If you are implementing your own CustomerAdapter:
+Save a representation of the passed paymentOption
as the customer's default payment method.
Retrieve the last selected payment method for the customer. +If you are implementing your own CustomerAdapter: +Return a CustomerPaymentOption for the customer's default selected payment method. +If no default payment method is selected, return null.
+Creates a SetupIntent configured to attach a new payment method to a customer, +then returns the client secret for the created SetupIntent.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
PlatformPayButton Component Props
+When true, indicates that the view is an accessibility element. +By default, all the touchable elements are accessible.
+Provides an array of custom actions available for accessibility.
+Overrides the text that's read by the screen reader when the user interacts with the element. By default, the +label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
+Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
+Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
+An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
+Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, +it contains range information (minimum, current, and maximum).
+In some cases, we also want to alert the end user of the type of selected component (i.e., that it is a “button”). +If we were using native buttons, this would work automatically. Since we are using javascript, we need to +provide a bit more context for TalkBack. To do so, you must specify the ‘accessibilityComponentType’ property +for any UI component. For instances, we support ‘button’, ‘radiobutton_checked’ and ‘radiobutton_unchecked’ and so on.
+Indicates to accessibility services whether the user should be notified when this view changes. +Works for Android API >= 19 only. +See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.
+Controls how view is important for accessibility which is if it fires accessibility events +and if it is reported to accessibility services that query the screen. +Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.
+Possible values: + 'auto' - The system determines whether the view is important for accessibility - default (recommended). + 'yes' - The view is important for accessibility. + 'no' - The view is not important for accessibility. + 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.
+A Boolean value indicating whether the accessibility elements contained within this accessibility element +are hidden to the screen reader.
+Accessibility traits tell a person using VoiceOver what kind of element they have selected. +Is this element a label? A button? A header? These questions are answered by accessibilityTraits.
+A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
+Sets the text displayed by the button.
+Sets the coloring of the button.
+Sets the border radius of the button.
+Set to true
to disable the button from being pressed & apply a slight opacity to indicate that it is unpressable. Defaults to false.
When accessible
is true, the system will try to invoke this function when the user performs an accessibility custom action.
When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
+When accessible
is true, the system will try to invoke this function when the user performs accessibility tap gesture.
When accessible is true, the system will invoke this function when the user performs the magic tap gesture.
+Function called whenever the button is pressed.
+This callback is triggered whenever the user selects a shipping method in the Apple Pay sheet.
+It receives one parameter: an event
object with a shippingMethod
field. You MUST
+update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+Apple Pay sheet will hang and the payment flow will automatically cancel.
This callback is triggered whenever the user selects a shipping contact in the Apple Pay sheet IF
+ContactField.PostalAddress was included in the requiredShippingAddressFields array.
+It receives one parameter: an event
object with a shippingContact
field. You MUST
+update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+Apple Pay sheet will hang and the payment flow will automatically cancel.
This callback is triggered whenever the user inputs a coupon code in the Apple Pay sheet.
+It receives one parameter: an event
object with a couponCode
field. You MUST
+update the Apple Pay sheet in your callback using the updatePlatformPaySheet function, otherwise the
+Apple Pay sheet will hang and the payment flow will automatically cancel.
Callback function for setting the order details (retrieved from your server) to give users the
+ability to track and manage their purchases in Wallet. Stripe calls your implementation after the
+payment is complete, but before iOS dismisses the Apple Pay sheet. You must call the completion
+function, or else the Apple Pay sheet will hang.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
A unique ID for this bank account.
+The name of the associated bank.
+The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object.
+The type of entity that holds the account.
+The currency the bank account is in. This must be a country/currency pairing that Stripe supports.
+The country in which the bank account is located.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Use this type for a payment that occurs in the future, such as a pre-order. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem.
+The unix timestamp of the date, in the future, of the payment. Measured in seconds.
+Use this type for payments that will occur immediately.
+When creating items for estimates or charges whose final value is not yet known, set this to true.
+Use this type for payments that occur more than once, such as a subscription. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem.
+The amount of time – in calendar units such as day, month, or year – that represents a fraction of the total payment interval. For example, if you set the intervalUnit to 'month' and intervalCount to 3, then the payment interval is three months.
+The number of interval units that make up the total payment interval. For example, if you set the intervalUnit to 'month' and intervalCount to 3, then the payment interval is three months.
+The unix timestamp of the start date. Measured in seconds.
+The unix timestamp of the end date. Measured in seconds.
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
A unique ID for this session.
+The client secret for this session.
+Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+The accounts that were collected as part of this Session.
+Bank account details.
+Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+A unique ID for this token.
+The UNIX timestamp (in milliseconds) of the date this token was created.
+A unique ID for this Financial Connections Account.
+Has the value true if the object exists in live mode or the value false if the object exists in test mode.
+The current status of the account. Either active, inactive, or disconnected.
+The UNIX timestamp (in milliseconds) of the date this account was created.
+The balance of this account.
+The last balance refresh. Includes the timestamp and the status.
+The category of this account, either cash, credit, investment, or other.
+The subcategory of this account, either checking, credit_card, line_of_credit, mortgage, savings, or other.
+Permissions requested for accounts collected during this session.
+The supported payment method types for this account.
+The UNIX timestamp (in milliseconds) of time that the external institution calculated this balance.
+The type of this balance, either cash or credit.
+The funds available to the account holder. Typically this is the current balance less any holds. Each key is a three-letter ISO currency code, in lowercase. Each value is an integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+The credit that has been used by the account holder. Each key is a three-letter ISO currency code, in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+The balances owed to (or by) the account holder. Each key is a three-letter ISO currency code, in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+The UNIX timestamp (in milliseconds) of the time at which the last refresh attempt was initiated.
+Generated using TypeDoc
Affirm requires that shipping is present for the payment to succeed because it significantly helps with loan approval rates. Shipping details can either be provided here or via the Payment Intent- https://stripe.com/docs/api/payment_intents/create#create_payment_intent-shipping.
+If paymentMethodData is null, it is assumed that the bank account details have already been attached
+via collectBankAccountForPayment
or collectBankAccountForSetup
.
Defaults to Individual
+Defaults to Checking
+Generated using TypeDoc
Affirm requires that shipping is present for the payment to succeed because it significantly helps with loan approval rates. Shipping details can either be provided here or via the Payment Intent- https://stripe.com/docs/api/payment_intents/create#create_payment_intent-shipping.
+If paymentMethodData is null, it is assumed that the bank account details have already been attached
+via collectBankAccountForPayment
or collectBankAccountForSetup
.
Defaults to Individual
+Defaults to Checking
+Generated using TypeDoc
The two-letter ISO 3166 code of the country of your business, e.g. "US"
+An array of CartSummaryItem item objects that summarize the amount of the payment. If you're using a SetupIntent +for a recurring payment, you should set this to display the amount you intend to charge.
+Sets the text displayed by the call to action button in the Apple Pay sheet.
+A typical request is for a one-time payment. To support different types of payment requests, include a PaymentRequestType. Only supported on iOS 16 and up.
+Callback function for setting the order details (retrieved from your server) to give users the
+ability to track and manage their purchases in Wallet. Stripe calls your implementation after the
+payment is complete, but before iOS dismisses the Apple Pay sheet. You must call the completion
+function, or else the Apple Pay sheet will hang.
The two-letter ISO 3166 code of the country of your business, e.g. "US"
+The three-letter ISO 4217 alphabetic currency code, e.g. "USD" or "EUR". Required in order to support Google Pay when processing a Setup Intent.
+Whether or not to use the Google Pay test environment. Set to true
until you have applied for and been granted access to the Production environment.
An optional label to display with the amount. Google Pay may or may not display this label depending on its own internal logic. Defaults to a generic label if none is provided.
+An optional amount to display for setup intents. Google Pay may or may not display this amount depending on its own internal logic. Defaults to 0 if none is provided.
+Used to customize the appearance of your PaymentSheet
+The font used for regular text. PaymentSheet will attempt to use medium and bold versions of this font if they exist.
+On iOS, this should be the "PostScript name" found in Font Book after installing the font. +On Android, this should be the name of the font file (containing only lowercase alphanumeric characters) in android/app/src/main/res/font
+The scale factor for all fonts in your PaymentSheet. This value is required to be greater than 0. Font sizes are multiplied by this value before being displayed. For example, setting this to 1.2 increases the size of all text by 20%.
+The color of the shadow.
+The alpha or opacity of the shadow.
+The positioning of the shadow relative to the component. For example, a negative x and y will result in a shadow placed below and to the left of the component.
+The blur radius of the shadow.
+A primary color used throughout your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used for the background of your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used for the background of inputs, tabs, and other components in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used for the external border of inputs, tabs, and other components in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used for the internal border (meaning the border is shared with another component) of inputs, tabs, and other components in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color of the header text in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color of the label text of input fields, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color of the input text in your PaymentSheet components, such as the user's card number or zip code, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color of the placeholder text of input fields, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used for icons in your Payment Sheet, such as the close or back icons, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color used to indicate errors or destructive actions in your Payment Sheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The font family used specifically for the primary button.
+The colors used specifically for the primary button. Provide either a base config, or both light
and dark
configs, which will be useed based on whether the user is in Light or Dark mode.
Describes the border and shadow of the primary button.
+The border radius used for the primary button in your PaymentSheet
+The border width used for the primary button in your PaymentSheet
+iOS only. The shadow used for the primary button in your PaymentSheet
+The background color used for the primary button in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The color of the text for the primary button in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The border color used for the primary button in your PaymentSheet, represented as a hex string with format #RRGGBB or #AARRGGBB.
+The number of milliseconds (after presenting) before the Payment Sheet closes automatically, at which point
+presentPaymentSheet
will resolve with an error.code
of PaymentSheetError.Timeout
. The default is no timeout.
How to collect the name field. Defaults to CollectionMode.automatic
.
How to collect the phone field. Defaults to CollectionMode.automatic
.
How to collect the email field. Defaults to CollectionMode.automatic
.
How to collect the billing address. Defaults to CollectionMode.automatic
.
Whether the values included in Configuration.defaultBillingDetails
should be attached to the payment method, this includes fields that aren't displayed in the form. If false
(the default), those values will only be used to prefill the corresponding fields in the form.
Generated using TypeDoc
ISO 3166-1 alpha-2 country code where the transaction is processed.
+ISO 4217 alphabetic currency code.
+The SDK accepts Amex, Mastercard, Visa, and Discover for Apple Pay by default. Set this property to enable other card networks, for example: ["JCB", "barcode", "chinaUnionPay"]. A full list of possible networks can be found at https://developer.apple.com/documentation/passkit/pkpaymentnetwork.
+The list of items that describe a purchase. For example: total, tax, discount, and grand total.
+The list of fields that you need for a shipping contact in order to process the transaction. If you include ContactField.PostalAddress in this array, you must implement the PlatformPayButton component's onShippingContactSelected
callback and call updatePlatformPaySheet
from there.
The list of fields that you need for a billing contact in order to process the transaction.
+An array of shipping method objects that describe the supported shipping methods. If provided, you must implement the PlatformPayButton component's onShippingMethodSelected
callback and call updatePlatformPaySheet
from there.
Set the payment capabilities you support. If set, 3DS is required.
+An optional value that indicates how to ship purchased items. Defaults to 'Shipping'.
+A list of two-letter ISO 3166 country codes for limiting payment to cards from specific countries or regions.
+A typical request is for a one-time payment. To support different types of payment requests, include a PaymentRequestType. Only supported on iOS 16 and up.
+Use this for a recurring payment, typically a subscription.
+A description that you provide of the recurring payment and that Apple Pay displays to the user in the sheet.
+A URL to a web page where the user can update or delete the payment method for the recurring payment.
+The regular billing cycle for the payment, including start and end dates, an interval, and an interval count.
+Same as the billing property, but use this if the purchase has a trial period.
+A localized billing agreement that the sheet displays to the user before the user authorizes the payment.
+A URL you provide to receive life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment. +For more information about handling merchant token life-cycle notifications, see Receiving and handling merchant token notifications.
+Use this for an automatic reload or refill payment, such as a store card top-up.
+A description that you provide of the recurring payment and that Apple Pay displays to the user in the sheet.
+A URL to a web page where the user can update or delete the payment method for the recurring payment.
+A short, localized description of the item.
+This is the amount that is automatically applied to the account when the account balance drops below the threshold amount.
+The balance an account reaches before you apply the automatic reload amount.
+A localized billing agreement that the sheet displays to the user before the user authorizes the payment.
+A URL you provide to receive life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment. +For more information about handling merchant token life-cycle notifications, see Receiving and handling merchant token notifications.
+Use this to indicate payments for multiple merchants.
+Set this value to true to display the coupon code field, or pass the 'couponCode' field to autofill with a coupon code. Defaults to false. If true, you must implement the PlatformPayButton component's onCouponCodeEntered
callback and call updatePlatformPaySheet
from there.
Set this value to autofill with a coupon code. If provided, you must implement the PlatformPayButton component's onCouponCodeEntered
callback and call updatePlatformPaySheet
from there.
Set to true to run in a test environment with relaxed application / merchant requirements. This environment is suggested for early development and for easily testing SDK.
+ISO 3166-1 alpha-2 country code where the transaction is processed.
+ISO 4217 alphabetic currency code.
+Your merchant name, displayed in the Google Pay sheet.
+Set to true to request an email address. Defaults to false.
+Set to false if you don't support credit cards. Defaults to true.
+If true, Google Pay is considered "available" if the customer's Google Pay wallet has an existing payment method. Defaults to false.
+Describes the configuration for billing address collection in the Google Pay sheet.
+Set to true if billing address is required for payment. Defaults to false.
+Set to true if phone number is required for payment. Defaults to false.
+Defines what address fields to collect. Defaults to BillingAddressFormat.Min
+An optional label to display with the amount. Google Pay may or may not display this label depending on its own internal logic. Defaults to a generic label if none is provided.
+An optional amount to display for setup intents. Google Pay may or may not display this amount depending on its own internal logic. Defaults to 0 if none is provided. Provide this value in the currency’s smallest unit.
+Describes the configuration for shipping address collection in the Google Pay sheet.
+Set to true if shipping address is required for payment. Defaults to false.
+Set to true if phone number is required for payment. Defaults to false.
+Set of ISO 3166-1 alpha-2 country code values of the countries where shipping is allowed. Defaults to all shipping address countries.
+Defines Google Pay behavior. Android only.
+Defines Apple Pay behavior. iOS only.
+Defines Google Pay behavior. Android only.
+Defines Apple Pay behavior. iOS only.
+iOS only.
+iOS only. Use this type for a payment that occurs in the future, such as a pre-order. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem.
+The unix timestamp of the date, in the future, of the payment. Measured in seconds.
+iOS only. Use this type for payments that will occur immediately.
+When creating items for estimates or charges whose final value is not yet known, set this to true.
+iOS only. Use this type for payments that occur more than once, such as a subscription. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem.
+The amount of time – in calendar units such as Day, Month, or Year – that represents a fraction of the total payment interval. For example, if you set the intervalUnit to 'Month' and intervalCount to 3, then the payment interval is three months.
+The number of interval units that make up the total payment interval. For example, if you set the intervalUnit to 'Month' and intervalCount to 3, then the payment interval is three months.
+The unix timestamp of the start date. Measured in seconds.
+The unix timestamp of the end date. Measured in seconds.
+iOS only.
+A short, localized description.
+The cost associated with this shipping option.
+When creating items for estimates or charges whose final value is not yet known, set this to true.
+A unique identifier for the shipping method.
+A user-readable description of the shipping method. For example “Ships in 24 hours.” Don't repeat the content of the 'label' property.
+The unix timestamp of the start date of the expected range of delivery or shipping dates for a package, or the time range when an item is available for pickup. Measured in seconds.
+The unix timestamp of the end date of the expected range of delivery or shipping dates for a package, or the time range when an item is available for pickup. Measured in seconds.
+Android only.
+Set to true to run in a test environment with relaxed application / merchant requirements. This environment is suggested for early development and for easily testing SDK. Defaults to false.
+If true
, Google Pay is considered ready if the customer's Google Pay wallet
+has an existing payment method. Defaults to false.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Creates a single-use token that represents a credit card’s details. Use this in combination with either the CardField or CardForm components. This token can be used in place of a credit card object with any API method. See https://stripe.com/docs/api/tokens/create_card
+Creates a single-use token that represents a bank account’s details. This token can be used with any API method in place of a bank account object. See https://stripe.com/docs/api/tokens/create_bank_account
+Creates a single-use token that represents the details of personally identifiable information (PII). See https://stripe.com/docs/api/tokens/create_pii
+The user's personal ID number
+Generated using TypeDoc
You are missing configuration required for Push Provisioning. Make sure you've completed all steps at https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native.
+