@stripe/stripe-react-native

Index

Interfaces

Functions Other

Functions ReactComponents

Variables Other

Variables ReactComponents

Namespaces

Enumerations

Other Functions

initStripe

initStripe(params: InitStripeParams): Promise<void>

- Defined in src/components/StripeProvider.tsx:29
Parameters
- params: InitStripeParams
Returns Promise<void>

createPaymentMethod

createPaymentMethod(params: PaymentMethod.CreateParams, options?: CreateOptions): Promise<CreatePaymentMethodResult>

- Defined in src/functions.ts:47
Parameters
- params: PaymentMethod.CreateParams
- options: CreateOptions = {}
Returns Promise<CreatePaymentMethodResult>

createToken

createToken(params: Token.CreateParams): Promise<CreateTokenResult>

- Defined in src/functions.ts:71
Parameters
- params: Token.CreateParams
Returns Promise<CreateTokenResult>

retrievePaymentIntent

retrievePaymentIntent(clientSecret: string): Promise<RetrievePaymentIntentResult>

- Defined in src/functions.ts:102
Parameters
- clientSecret: string
Returns Promise<RetrievePaymentIntentResult>

retrieveSetupIntent

retrieveSetupIntent(clientSecret: string): Promise<RetrieveSetupIntentResult>

- Defined in src/functions.ts:123
Parameters
- clientSecret: string
Returns Promise<RetrieveSetupIntentResult>

confirmPayment

confirmPayment(paymentIntentClientSecret: string, params?: PaymentMethod.CreateParams, options?: CreateOptions): Promise<ConfirmPaymentResult>

- Defined in src/functions.ts:153
Confirm and, if necessary, authenticate a PaymentIntent.

Parameters
- paymentIntentClientSecret: string
  
  The client_secret of the associated PaymentIntent.
- Optional params: PaymentMethod.CreateParams
  
  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.
- options: CreateOptions = {}
  
  An optional object that contains options for this payment method.
Returns Promise<ConfirmPaymentResult>
A promise that resolves to an object containing either a paymentIntent field, or an error field.

isApplePaySupported

isApplePaySupported(): Promise<boolean>

- Defined in src/functions.ts:180
deprecated
Use isPlatformPaySupported instead.

Returns Promise<boolean>

presentApplePay

presentApplePay(params: ApplePay.PresentParams): Promise<ApplePayResult>

- Defined in src/functions.ts:185
deprecated
Use confirmPlatformPaySetupIntent, confirmPlatformPayPayment, or createPlatformPayPaymentMethod instead.

Parameters
- params: ApplePay.PresentParams
Returns Promise<ApplePayResult>

updateApplePaySummaryItems

updateApplePaySummaryItems(summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]): Promise<{ error?: StripeError<ApplePayError> }>

- Defined in src/functions.ts:215
deprecated
Use updatePlatformPaySheet instead.

Parameters
- summaryItems: ApplePay.CartSummaryItem[]
- errorAddressFields: { field: AddressFields; message?: string }[] = []
Returns Promise<{ error?: StripeError<ApplePayError> }>

confirmApplePayPayment

confirmApplePayPayment(clientSecret: string): Promise<{ error?: StripeError<ApplePayError> }>

- Defined in src/functions.ts:246
deprecated
Use confirmPlatformPaySetupIntent or confirmPlatformPayPayment instead.

Parameters
- clientSecret: string
Returns Promise<{ error?: StripeError<ApplePayError> }>

handleNextAction

handleNextAction(paymentIntentClientSecret: string, returnURL?: string): Promise<HandleNextActionResult>

- Defined in src/functions.ts:273
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

Parameters
- paymentIntentClientSecret: string
  
  The client secret associated with the PaymentIntent.
- Optional returnURL: string
  
  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.
Returns Promise<HandleNextActionResult>

confirmSetupIntent

confirmSetupIntent(paymentIntentClientSecret: string, params: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions): Promise<ConfirmSetupIntentResult>

- Defined in src/functions.ts:300
Parameters
- paymentIntentClientSecret: string
- params: SetupIntent.ConfirmParams
- options: SetupIntent.ConfirmOptions = {}
Returns Promise<ConfirmSetupIntentResult>

createTokenForCVCUpdate

createTokenForCVCUpdate(cvc: string): Promise<CreateTokenForCVCUpdateResult>

- Defined in src/functions.ts:326
Parameters
- cvc: string
Returns Promise<CreateTokenForCVCUpdateResult>

handleURLCallback

handleURLCallback(url: string): Promise<boolean>

- Defined in src/functions.ts:348
Parameters
- url: string
Returns Promise<boolean>

verifyMicrodepositsForPayment

verifyMicrodepositsForPayment(clientSecret: string, params: VerifyMicrodepositsParams): Promise<VerifyMicrodepositsForPaymentResult>

- Defined in src/functions.ts:353
Parameters
- clientSecret: string
- params: VerifyMicrodepositsParams
Returns Promise<VerifyMicrodepositsForPaymentResult>

verifyMicrodepositsForSetup

verifyMicrodepositsForSetup(clientSecret: string, params: VerifyMicrodepositsParams): Promise<VerifyMicrodepositsForSetupResult>

- Defined in src/functions.ts:379
Parameters
- clientSecret: string
- params: VerifyMicrodepositsParams
Returns Promise<VerifyMicrodepositsForSetupResult>

initPaymentSheet

initPaymentSheet(params: SetupParams): Promise<InitPaymentSheetResult>

- Defined in src/functions.ts:405
Parameters
- params: SetupParams
Returns Promise<InitPaymentSheetResult>

presentPaymentSheet

presentPaymentSheet(): Promise<PresentPaymentSheetResult>

- Defined in src/functions.ts:427
Returns Promise<PresentPaymentSheetResult>

confirmPaymentSheetPayment

confirmPaymentSheetPayment(): Promise<ConfirmPaymentSheetPaymentResult>

- Defined in src/functions.ts:447
Returns Promise<ConfirmPaymentSheetPaymentResult>

resetPaymentSheetCustomer

resetPaymentSheetCustomer(): Promise<null>

- Defined in src/functions.ts:469
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.

Returns Promise<null>

isGooglePaySupported

isGooglePaySupported(params?: IsSupportedParams): Promise<boolean>

- Defined in src/functions.ts:474
deprecated
Use isPlatformPaySupported instead.

Parameters
- Optional params: IsSupportedParams
Returns Promise<boolean>

initGooglePay

initGooglePay(params: InitParams): Promise<GooglePayInitResult>

- Defined in src/functions.ts:483
deprecated
Use confirmPlatformPaySetupIntent, confirmPlatformPayPayment, or createPlatformPayPaymentMethod instead.

Parameters
- params: InitParams
Returns Promise<GooglePayInitResult>

presentGooglePay

presentGooglePay(params: GooglePay.PresentParams): Promise<PayWithGooglePayResult>

- Defined in src/functions.ts:502
deprecated
Use confirmPlatformPaySetupIntent, confirmPlatformPayPayment, or createPlatformPayPaymentMethod instead.

Parameters
- params: GooglePay.PresentParams
Returns Promise<PayWithGooglePayResult>

createGooglePayPaymentMethod

createGooglePayPaymentMethod(params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>

- Defined in src/functions.ts:521
deprecated
Use createPlatformPayPaymentMethod instead.

Parameters
- params: CreatePaymentMethodParams
Returns Promise<CreateGooglePayPaymentMethodResult>

openApplePaySetup

openApplePaySetup(): Promise<OpenApplePaySetupResult>

- Defined in src/functions.ts:543
deprecated
Use openNativePaySetup instead.

Returns Promise<OpenApplePaySetupResult>

collectBankAccountForPayment

collectBankAccountForPayment(clientSecret: string, params: CollectBankAccountParams): Promise<CollectBankAccountForPaymentResult>

- Defined in src/functions.ts:559
Parameters
- clientSecret: string
- params: CollectBankAccountParams
Returns Promise<CollectBankAccountForPaymentResult>

collectBankAccountForSetup

collectBankAccountForSetup(clientSecret: string, params: CollectBankAccountParams): Promise<CollectBankAccountForSetupResult>

- Defined in src/functions.ts:585
Parameters
- clientSecret: string
- params: CollectBankAccountParams
Returns Promise<CollectBankAccountForSetupResult>

collectBankAccountToken

collectBankAccountToken(clientSecret: string): Promise<TokenResult>

- Defined in src/functions.ts:617
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.

Parameters
- clientSecret: string
  
  The client_secret of the Financial Connections Session.
Returns Promise<TokenResult>
A promise that resolves to an object containing either session and token fields, or an error field.

collectFinancialConnectionsAccounts

collectFinancialConnectionsAccounts(clientSecret: string): Promise<SessionResult>

- Defined in src/functions.ts:646
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.

Parameters
- clientSecret: string
  
  The client_secret of the Financial Connections Session.
Returns Promise<SessionResult>
A promise that resolves to an object containing either a session field, or an error field.

canAddCardToWallet

canAddCardToWallet(params: CanAddCardToWalletParams): Promise<CanAddCardToWalletResult>

- Defined in src/functions.ts:674
Check if the app & device support adding this card to the native wallet.

Parameters
- params: CanAddCardToWalletParams
  
  An object containing fields for primaryAccountIdentifier, cardLastFour, and testEnv.
Returns Promise<CanAddCardToWalletResult>
A promise resolving to an object of type CanAddCardToWalletResult. Check the canAddCard field, if it's true, you should show the <AddToWalletButton />

isCardInWallet

isCardInWallet(params: { cardLastFour: string }): Promise<IsCardInWalletResult>

- Defined in src/functions.ts:698
deprecated
Please use canAddCardToWallet instead.

Parameters
- params: { cardLastFour: string }
  - cardLastFour: string
Returns Promise<IsCardInWalletResult>

isPlatformPaySupported

isPlatformPaySupported(params?: { googlePay?: IsSupportedParams }): Promise<boolean>

- Defined in src/functions.ts:728
Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.

Parameters
- Optional params: { googlePay?: IsSupportedParams }
  - Optional googlePay?: IsSupportedParams
Returns Promise<boolean>
A boolean indicating whether or not the native wallet is supported.

confirmPlatformPaySetupIntent

confirmPlatformPaySetupIntent(clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmSetupIntentResult>

- Defined in src/functions.ts:740
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe SetupIntent.

Parameters
- clientSecret: string
  
  The client secret of the SetupIntent.
- params: PlatformPay.ConfirmParams
  
  an object describing the Apple Pay and Google Pay configurations.
Returns Promise<PlatformPay.ConfirmSetupIntentResult>
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both setupIntent and paymentMethod fields.

confirmPlatformPayPayment

confirmPlatformPayPayment(clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmPaymentResult>

- Defined in src/functions.ts:771
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe PaymentIntent.

Parameters
- clientSecret: string
  
  The client secret of the PaymentIntent.
- params: PlatformPay.ConfirmParams
  
  an object describing the Apple Pay and Google Pay configurations.
Returns Promise<PlatformPay.ConfirmPaymentResult>
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both paymentIntent and paymentMethod fields.

dismissPlatformPay

dismissPlatformPay(): Promise<boolean>

- Defined in src/functions.ts:800
iOS only, this will always return false on Android. Dismisses the Apple Pay sheet if it is open.

Returns Promise<boolean>
A boolean indicating whether or not the sheet was successfully closed. Will return false if the Apple Pay sheet was not open.

createPlatformPayPaymentMethod

createPlatformPayPaymentMethod(params: PaymentMethodParams): Promise<PaymentMethodResult>

- Defined in src/functions.ts:817
Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe PaymentMethod and token.

Parameters
- params: PaymentMethodParams
  
  an object describing the Apple Pay and Google Pay configurations.
Returns Promise<PaymentMethodResult>
An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both paymentMethod and token fields.

updatePlatformPaySheet

updatePlatformPaySheet(params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }): Promise<{ error?: StripeError<PlatformPayError> }>

- Defined in src/functions.ts:848
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.

Parameters
- params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }
  an object describing the Apple Pay configuration, with the following fields:
  - cartItems An array of payment summary items to display in the Apple Pay sheet.
  - shippingMethods An array of shipping methods to display in the Apple Pay sheet.
  - errors An array of errors associated with the user's input that must be corrected to proceed with payment. These errors will be shown in the Apple Pay sheet.
  - applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] }
    - cartItems: PlatformPay.CartSummaryItem[]
    - shippingMethods: PlatformPay.ShippingMethod[]
    - errors: ApplePaySheetError[]
Returns Promise<{ error?: StripeError<PlatformPayError> }>
An object with an optional 'error' field, which is only populated if something went wrong.

openPlatformPaySetup

openPlatformPaySetup(): Promise<void>

- Defined in src/functions.ts:881
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.

Returns Promise<void>

useApplePay

useApplePay(__namedParameters?: UseApplePayProps): { loading: boolean; presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>; confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>; isApplePaySupported: null | boolean; openApplePaySetup: () => Promise<OpenApplePaySetupResult> }

- Defined in src/hooks/useApplePay.tsx:65
useApplePay hook

Parameters
- __namedParameters: UseApplePayProps = {}
Returns { loading: boolean; presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>; confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>; isApplePaySupported: null | boolean; openApplePaySetup: () => Promise<OpenApplePaySetupResult> }
- loading: boolean
- presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>
  - - (params: ApplePay.PresentParams): Promise<ApplePayResult>
    - Parameters
      - params: ApplePay.PresentParams
      Returns Promise<ApplePayResult>
- confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (clientSecret: string): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - clientSecret: string
      Returns Promise<{ error?: StripeError<ApplePayError> }>
- isApplePaySupported: null | boolean
- openApplePaySetup: () => Promise<OpenApplePaySetupResult>
  - - (): Promise<OpenApplePaySetupResult>
    - Returns Promise<OpenApplePaySetupResult>

useConfirmPayment

useConfirmPayment(): { confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>; loading: boolean }

- Defined in src/hooks/useConfirmPayment.tsx:8
useConfirmPayment hook

Returns { confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>; loading: boolean }
- confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>
  - - (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions): Promise<ConfirmPaymentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - Optional data: PaymentMethod.CreateParams
      - options: CreateOptions = {}
      Returns Promise<ConfirmPaymentResult>
- loading: boolean

useConfirmSetupIntent

useConfirmSetupIntent(): { confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>; loading: boolean }

- Defined in src/hooks/useConfirmSetupIntent.tsx:8
useConfirmSetupIntent hook

Returns { confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>; loading: boolean }
- confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>
  - - (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions): Promise<ConfirmSetupIntentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: SetupIntent.ConfirmParams
      - options: SetupIntent.ConfirmOptions = {}
      Returns Promise<ConfirmSetupIntentResult>
- loading: boolean

useFinancialConnectionsSheet

useFinancialConnectionsSheet(): { collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>; collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>; loading: boolean }

- Defined in src/hooks/useFinancialConnectionsSheet.tsx:10
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).

Returns { collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>; collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>; loading: boolean }
- collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>
  - - (clientSecret: string): Promise<TokenResult>
    - Parameters
      - clientSecret: string
      Returns Promise<TokenResult>
- collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>
  - - (clientSecret: string): Promise<SessionResult>
    - Parameters
      - clientSecret: string
      Returns Promise<SessionResult>
- loading: boolean

useGooglePay

useGooglePay(): { loading: boolean; isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>; initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>; presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>; createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult> }

- Defined in src/hooks/useGooglePay.tsx:8
useGooglePay hook

Returns { loading: boolean; isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>; initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>; presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>; createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult> }
- loading: boolean
- isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>
  - - (params?: IsSupportedParams): Promise<boolean>
    - Parameters
      - Optional params: IsSupportedParams
      Returns Promise<boolean>
- initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>
  - - (params: InitParams): Promise<GooglePayInitResult>
    - Parameters
      - params: InitParams
      Returns Promise<GooglePayInitResult>
- presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>
  - - (params: GooglePay.PresentParams): Promise<PayWithGooglePayResult>
    - Parameters
      - params: GooglePay.PresentParams
      Returns Promise<PayWithGooglePayResult>
- createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>
  - - (params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>
    - Parameters
      - params: CreatePaymentMethodParams
      Returns Promise<CreateGooglePayPaymentMethodResult>

usePaymentSheet

usePaymentSheet(): { loading: boolean; initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>; presentPaymentSheet: () => Promise<PresentPaymentSheetResult>; confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>; resetPaymentSheetCustomer: () => Promise<null> }

- Defined in src/hooks/usePaymentSheet.tsx:8
usePaymentSheet hook

Returns { loading: boolean; initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>; presentPaymentSheet: () => Promise<PresentPaymentSheetResult>; confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>; resetPaymentSheetCustomer: () => Promise<null> }
- loading: boolean
- initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>
  - - (params: SetupParams): Promise<InitPaymentSheetResult>
    - Parameters
      - params: SetupParams
      Returns Promise<InitPaymentSheetResult>
- presentPaymentSheet: () => Promise<PresentPaymentSheetResult>
  - - (): Promise<PresentPaymentSheetResult>
    - Returns Promise<PresentPaymentSheetResult>
- confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>
  - - (): Promise<ConfirmPaymentSheetPaymentResult>
    - Returns Promise<ConfirmPaymentSheetPaymentResult>
- resetPaymentSheetCustomer: () => Promise<null>
  - - (): Promise<null>
    - Returns Promise<null>

usePlatformPay

usePlatformPay(): { loading: boolean; isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>; confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>; confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>; createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>; dismissPlatformPay: () => Promise<boolean>; updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>; canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>; openPlatformPaySetup: () => Promise<void> }

- Defined in src/hooks/usePlatformPay.tsx:12
usePlatformPay hook. Access all Apple and Google Pay functionality with this hook.

Returns { loading: boolean; isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>; confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>; confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>; createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>; dismissPlatformPay: () => Promise<boolean>; updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>; canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>; openPlatformPaySetup: () => Promise<void> }
- loading: boolean
- isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>
  - - (params?: { googlePay?: IsSupportedParams }): Promise<boolean>
    - Parameters
      - Optional params: { googlePay?: IsSupportedParams }
        Optional googlePay?: IsSupportedParams
      Returns Promise<boolean>
- confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>
  - - (clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmSetupIntentResult>
    - Parameters
      - clientSecret: string
      - params: PlatformPay.ConfirmParams
      Returns Promise<PlatformPay.ConfirmSetupIntentResult>
- confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>
  - - (clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmPaymentResult>
    - Parameters
      - clientSecret: string
      - params: PlatformPay.ConfirmParams
      Returns Promise<PlatformPay.ConfirmPaymentResult>
- createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>
  - - (params: PaymentMethodParams): Promise<PaymentMethodResult>
    - Parameters
      - params: PaymentMethodParams
      Returns Promise<PaymentMethodResult>
- dismissPlatformPay: () => Promise<boolean>
  - - (): Promise<boolean>
    - Returns Promise<boolean>
- updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>
  - - (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }): Promise<{ error?: StripeError<PlatformPayError> }>
    - Parameters
      - params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }
        applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] }
        cartItems: PlatformPay.CartSummaryItem[]
        shippingMethods: PlatformPay.ShippingMethod[]
        errors: ApplePaySheetError[]
      Returns Promise<{ error?: StripeError<PlatformPayError> }>
- canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>
  - - (params: CanAddCardToWalletParams): Promise<CanAddCardToWalletResult>
    - Parameters
      - params: CanAddCardToWalletParams
      Returns Promise<CanAddCardToWalletResult>
- openPlatformPaySetup: () => Promise<void>
  - - (): Promise<void>
    - Returns Promise<void>

useStripe

useStripe(): { retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>; retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>; confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>; createPaymentMethod: (data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<CreatePaymentMethodResult>; handleNextAction: (paymentIntentClientSecret: string, returnURL?: string) => Promise<HandleNextActionResult>; isApplePaySupported: null | boolean; presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>; confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>; confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>; createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>; updateApplePaySummaryItems: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>; handleURLCallback: (url: string) => Promise<boolean>; confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>; presentPaymentSheet: () => Promise<PresentPaymentSheetResult>; initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>; createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>; isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>; initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>; presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>; createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>; openApplePaySetup: () => Promise<OpenApplePaySetupResult>; collectBankAccountForPayment: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForPaymentResult>; collectBankAccountForSetup: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForSetupResult>; verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForPaymentResult>; verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForSetupResult>; canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>; collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>; collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>; resetPaymentSheetCustomer: () => Promise<null>; isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>; confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>; confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>; dismissPlatformPay: () => Promise<boolean>; createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>; updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>; openPlatformPaySetup: () => Promise<void> }

- Defined in src/hooks/useStripe.tsx:82
useStripe hook

Returns { retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>; retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>; confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>; createPaymentMethod: (data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<CreatePaymentMethodResult>; handleNextAction: (paymentIntentClientSecret: string, returnURL?: string) => Promise<HandleNextActionResult>; isApplePaySupported: null | boolean; presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>; confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>; confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>; createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>; updateApplePaySummaryItems: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>; handleURLCallback: (url: string) => Promise<boolean>; confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>; presentPaymentSheet: () => Promise<PresentPaymentSheetResult>; initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>; createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>; isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>; initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>; presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>; createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>; openApplePaySetup: () => Promise<OpenApplePaySetupResult>; collectBankAccountForPayment: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForPaymentResult>; collectBankAccountForSetup: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForSetupResult>; verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForPaymentResult>; verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForSetupResult>; canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>; collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>; collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>; resetPaymentSheetCustomer: () => Promise<null>; isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>; confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>; confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>; dismissPlatformPay: () => Promise<boolean>; createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>; updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>; openPlatformPaySetup: () => Promise<void> }
- retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>
  - - (clientSecret: string): Promise<RetrievePaymentIntentResult>
    - Parameters
      - clientSecret: string
      Returns Promise<RetrievePaymentIntentResult>
- retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>
  - - (clientSecret: string): Promise<RetrieveSetupIntentResult>
    - Parameters
      - clientSecret: string
      Returns Promise<RetrieveSetupIntentResult>
- confirmPayment: (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>
  - - (paymentIntentClientSecret: string, data?: PaymentMethod.CreateParams, options?: CreateOptions): Promise<ConfirmPaymentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - Optional data: PaymentMethod.CreateParams
      - options: CreateOptions = {}
      Returns Promise<ConfirmPaymentResult>
- createPaymentMethod: (data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<CreatePaymentMethodResult>
  - - (data: PaymentMethod.CreateParams, options?: CreateOptions): Promise<CreatePaymentMethodResult>
    - Parameters
      - data: PaymentMethod.CreateParams
      - options: CreateOptions = {}
      Returns Promise<CreatePaymentMethodResult>
- handleNextAction: (paymentIntentClientSecret: string, returnURL?: string) => Promise<HandleNextActionResult>
  - - (paymentIntentClientSecret: string, returnURL?: string): Promise<HandleNextActionResult>
    - Parameters
      - paymentIntentClientSecret: string
      - Optional returnURL: string
      Returns Promise<HandleNextActionResult>
- isApplePaySupported: null | boolean
- presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>
  - - (params: ApplePay.PresentParams): Promise<ApplePayResult>
    - Parameters
      - params: ApplePay.PresentParams
      Returns Promise<ApplePayResult>
- confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (clientSecret: string): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - clientSecret: string
      Returns Promise<{ error?: StripeError<ApplePayError> }>
- confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>
  - - (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions): Promise<ConfirmSetupIntentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: SetupIntent.ConfirmParams
      - options: SetupIntent.ConfirmOptions = {}
      Returns Promise<ConfirmSetupIntentResult>
- createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>
  - - (cvc: string): Promise<CreateTokenForCVCUpdateResult>
    - Parameters
      - cvc: string
      Returns Promise<CreateTokenForCVCUpdateResult>
- updateApplePaySummaryItems: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - summaryItems: ApplePay.CartSummaryItem[]
      - errorAddressFields: { field: AddressFields; message?: string }[] = []
      Returns Promise<{ error?: StripeError<ApplePayError> }>
- handleURLCallback: (url: string) => Promise<boolean>
  - - (url: string): Promise<boolean>
    - Parameters
      - url: string
      Returns Promise<boolean>
- confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>
  - - (): Promise<ConfirmPaymentSheetPaymentResult>
    - Returns Promise<ConfirmPaymentSheetPaymentResult>
- presentPaymentSheet: () => Promise<PresentPaymentSheetResult>
  - - (): Promise<PresentPaymentSheetResult>
    - Returns Promise<PresentPaymentSheetResult>
- initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>
  - - (params: SetupParams): Promise<InitPaymentSheetResult>
    - Parameters
      - params: SetupParams
      Returns Promise<InitPaymentSheetResult>
- createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>
  - - (params: Token.CreateParams): Promise<CreateTokenResult>
    - Parameters
      - params: Token.CreateParams
      Returns Promise<CreateTokenResult>
- isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>
  - - (params?: IsSupportedParams): Promise<boolean>
    - Parameters
      - Optional params: IsSupportedParams
      Returns Promise<boolean>
- initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>
  - - (params: InitParams): Promise<GooglePayInitResult>
    - Parameters
      - params: InitParams
      Returns Promise<GooglePayInitResult>
- presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>
  - - (params: GooglePay.PresentParams): Promise<PayWithGooglePayResult>
    - Parameters
      - params: GooglePay.PresentParams
      Returns Promise<PayWithGooglePayResult>
- createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>
  - - (params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>
    - Parameters
      - params: CreatePaymentMethodParams
      Returns Promise<CreateGooglePayPaymentMethodResult>
- openApplePaySetup: () => Promise<OpenApplePaySetupResult>
  - - (): Promise<OpenApplePaySetupResult>
    - Returns Promise<OpenApplePaySetupResult>
- collectBankAccountForPayment: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForPaymentResult>
  - - (clientSecret: string, params: CollectBankAccountParams): Promise<CollectBankAccountForPaymentResult>
    - Parameters
      - clientSecret: string
      - params: CollectBankAccountParams
      Returns Promise<CollectBankAccountForPaymentResult>
- collectBankAccountForSetup: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForSetupResult>
  - - (clientSecret: string, params: CollectBankAccountParams): Promise<CollectBankAccountForSetupResult>
    - Parameters
      - clientSecret: string
      - params: CollectBankAccountParams
      Returns Promise<CollectBankAccountForSetupResult>
- verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForPaymentResult>
  - - (clientSecret: string, params: VerifyMicrodepositsParams): Promise<VerifyMicrodepositsForPaymentResult>
    - Parameters
      - clientSecret: string
      - params: VerifyMicrodepositsParams
      Returns Promise<VerifyMicrodepositsForPaymentResult>
- verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForSetupResult>
  - - (clientSecret: string, params: VerifyMicrodepositsParams): Promise<VerifyMicrodepositsForSetupResult>
    - Parameters
      - clientSecret: string
      - params: VerifyMicrodepositsParams
      Returns Promise<VerifyMicrodepositsForSetupResult>
- canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>
  - - (params: CanAddCardToWalletParams): Promise<CanAddCardToWalletResult>
    - Parameters
      - params: CanAddCardToWalletParams
      Returns Promise<CanAddCardToWalletResult>
- collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>
  - - (clientSecret: string): Promise<TokenResult>
    - Parameters
      - clientSecret: string
      Returns Promise<TokenResult>
- collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>
  - - (clientSecret: string): Promise<SessionResult>
    - Parameters
      - clientSecret: string
      Returns Promise<SessionResult>
- resetPaymentSheetCustomer: () => Promise<null>
  - - (): Promise<null>
    - Returns Promise<null>
- isPlatformPaySupported: (params?: { googlePay?: IsSupportedParams }) => Promise<boolean>
  - - (params?: { googlePay?: IsSupportedParams }): Promise<boolean>
    - Parameters
      - Optional params: { googlePay?: IsSupportedParams }
        Optional googlePay?: IsSupportedParams
      Returns Promise<boolean>
- confirmPlatformPaySetupIntent: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmSetupIntentResult>
  - - (clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmSetupIntentResult>
    - Parameters
      - clientSecret: string
      - params: PlatformPay.ConfirmParams
      Returns Promise<PlatformPay.ConfirmSetupIntentResult>
- confirmPlatformPayPayment: (clientSecret: string, params: PlatformPay.ConfirmParams) => Promise<PlatformPay.ConfirmPaymentResult>
  - - (clientSecret: string, params: PlatformPay.ConfirmParams): Promise<PlatformPay.ConfirmPaymentResult>
    - Parameters
      - clientSecret: string
      - params: PlatformPay.ConfirmParams
      Returns Promise<PlatformPay.ConfirmPaymentResult>
- dismissPlatformPay: () => Promise<boolean>
  - - (): Promise<boolean>
    - Returns Promise<boolean>
- createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>
  - - (params: PaymentMethodParams): Promise<PaymentMethodResult>
    - Parameters
      - params: PaymentMethodParams
      Returns Promise<PaymentMethodResult>
- updatePlatformPaySheet: (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }) => Promise<{ error?: StripeError<PlatformPayError> }>
  - - (params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }): Promise<{ error?: StripeError<PlatformPayError> }>
    - Parameters
      - params: { applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] } }
        applePay: { cartItems: PlatformPay.CartSummaryItem[]; shippingMethods: PlatformPay.ShippingMethod[]; errors: ApplePaySheetError[] }
        cartItems: PlatformPay.CartSummaryItem[]
        shippingMethods: PlatformPay.ShippingMethod[]
        errors: ApplePaySheetError[]
      Returns Promise<{ error?: StripeError<PlatformPayError> }>
- openPlatformPaySetup: () => Promise<void>
  - - (): Promise<void>
    - Returns Promise<void>

ReactComponents Functions

AddToWalletButton

AddToWalletButton(__namedParameters: AddToWalletButtonProps): Element

Add to wallet button

example

 <AddToWalletButton
   testEnv={true}
   style={styles.myButtonStyle}
   iOSButtonStyle="onLightBackground"
   cardDetails={{
     primaryAccountIdentifier: "V-123",
     name: "David Wallace",
     lastFour: "4242",
   }}
   ephemeralKey={myEphemeralKey} // This object is retrieved from your server. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#update-your-backend
   onComplete={(error) => {
     Alert.alert(
       error ? error.code : 'Success',
       error
         ? error.message
         : 'Card was successfully added to the wallet.'
     );
   }}
 />

Parameters

__namedParameters: AddToWalletButtonProps

Props

Returns Element

JSX.Element

AddressSheet

AddressSheet(__namedParameters: AddressSheetProps): Element

- Defined in src/components/AddressSheet.tsx:68
example
```
 <AddressSheet

 />
```
Parameters
- __namedParameters: AddressSheetProps
  
  Props
Returns Element
JSX.Element

ApplePayButton

ApplePayButton(__namedParameters: ApplePayButtonProps): Element

- Defined in src/components/ApplePayButton.tsx:42
Apple Pay Button Component
example
```
 <ApplePayButton
   onPress={pay}
   type="plain"
   buttonStyle="black"
   borderRadius={4}
   style={styles.payButton}
 />
```
Parameters
- __namedParameters: ApplePayButtonProps
  
  Props
Returns Element
JSX.Element

AuBECSDebitForm

AuBECSDebitForm(__namedParameters: AuBECSDebitFormProps): Element

BECS Debit form component

example

 <AuBECSDebitForm
   companyName="Example Company Inc."
   onComplete={value => onComplete(value)}
   style={{ width: '100%', height: 500 }}
 />

Parameters

__namedParameters: AuBECSDebitFormProps

Props

Returns Element

JSX.Element

GooglePayButton

GooglePayButton(__namedParameters: GooglePayButtonProps): Element

- Defined in src/components/GooglePayButton.tsx:38
Google Pay Button Component
example
```
 <GooglePayButton
   onPress={pay}
   style={styles.payButton}
 />
```
Parameters
- __namedParameters: GooglePayButtonProps
  
  Props
Returns Element
JSX.Element

PlatformPayButton

PlatformPayButton(__namedParameters: PlatformPayButtonProps): Element

- Defined in src/components/PlatformPayButton.tsx:83
PlatformPayButton Component. Display the platform-specific native wallet pay button: Apple Pay on iOS, and Google Pay on Android.
example
```
 <PlatformPayButton
   onPress={pay}
   type={PlatformPay.ButtonType.Subscribe}
   appearance={PlatformPay.ButtonStyle.WhiteOutline}
   borderRadius={4}
   disabled={!isApplePaySupported}
   style={styles.payButton}
 />
```
Parameters
- __namedParameters: PlatformPayButtonProps
  
  Props
Returns Element
JSX.Element

StripeContainer

StripeContainer(__namedParameters: StripeContainerProps): Element

- Defined in src/components/StripeContainer.tsx:29
StripeContainer Component

Parameters
- __namedParameters: StripeContainerProps
  
  Props
Returns Element
JSX.Element

StripeProvider

StripeProvider(__namedParameters: StripeProviderProps): Element

StripeProvider Component

example

 <StripeProvider
   publishableKey="_publishableKey"
   merchantIdentifier="merchant.com.stripe.react.native"
   threeDSecureParams={{
     backgroundColor: "#FFF",
     timeout: 5,
   }}
 >
   <App />
 </StripeProvider>

Parameters

__namedParameters: StripeProviderProps

Props

Returns Element

JSX.Element

Other Variables

Const Constants

Constants: { API_VERSIONS: { CORE: string; ISSUING: string } } = ...

Type declaration

API_VERSIONS: { CORE: string; ISSUING: string }
- CORE: string
- ISSUING: string

Const MissingRoutingNumber

MissingRoutingNumber: { code: Failed; message: string } = ...

Type declaration

code: Failed
message: string

ReactComponents Variables

Const CardField

CardField: ForwardRefExoticComponent<CardFieldProps & RefAttributes<CardFieldInput.Methods>> = ...

Card Field Component

example

<CardField
   postalCodeEnabled={false}
   onCardChange={(cardDetails) => {
   console.log('card details', cardDetails);
     setCard(cardDetails);
   }}
   style={{height: 50}}
 />

param __namedParameters

Props

returns

JSX.Element

Const CardForm

CardForm: ForwardRefExoticComponent<CardFormProps & RefAttributes<CardFormView.Methods>> = ...

Card Form Component

example

<CardForm
   onFormComplete={(cardDetails) => {
   console.log('card details', cardDetails);
     setCard(cardDetails);
   }}
   style={{height: 200}}
 />

param __namedParameters

Props

returns

JSX.Element

Type aliases

StripeProviderProps

StripeProviderProps: InitStripeParams & { children: React.ReactElement | React.ReactElement[] }

Stripe Provider Component Props

AddressDetails

AddressDetails: { name?: string; address?: Address; phone?: string; isCheckboxSelected?: boolean }

Type declaration

Optional name?: string

The customer's full name.
Optional address?: Address

The customer's address.
Optional phone?: string

The customer's phone number.
Optional isCheckboxSelected?: boolean

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.

ErrorType

GooglePayCardToken

GooglePayCardToken: { id: string; cardLastFour: string; network: number; serviceProvider: number; issuer: string; status: GooglePayCardTokenStatus }

Type declaration

id: string
cardLastFour: string
network: number
serviceProvider: number
issuer: string
status: GooglePayCardTokenStatus

IsCardInWalletResult

IsCardInWalletResult: { isInWallet: boolean; token?: GooglePayCardToken; error?: undefined } | { isInWallet?: undefined; token?: undefined; error: StripeError<GooglePayError> }

CanAddCardToWalletParams

CanAddCardToWalletParams: { primaryAccountIdentifier: string | null; cardLastFour: string; testEnv?: boolean; hasPairedAppleWatch?: boolean }

Type declaration

primaryAccountIdentifier: string | null

The primary_account_identifier value from the issued card. Can be an empty string.
cardLastFour: string

Last 4 digits of the card number.
Optional testEnv?: boolean

iOS only. Set this to true until shipping through TestFlight || App Store. If true, 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
Optional hasPairedAppleWatch?: boolean

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.

CanAddCardToWalletResult

CanAddCardToWalletResult: { canAddCard: boolean; details?: { token?: GooglePayCardToken; status?: CanAddCardToWalletStatus }; error?: undefined } | { canAddCard?: undefined; details?: undefined; error: StripeError<GooglePayError> }

CreatePaymentMethodResult

CreatePaymentMethodResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<CreatePaymentMethodError> }

RetrievePaymentIntentResult

RetrievePaymentIntentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<RetrievePaymentIntentError> }

RetrieveSetupIntentResult

RetrieveSetupIntentResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<RetrieveSetupIntentError> }

ConfirmPaymentResult

ConfirmPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<ConfirmPaymentError> }

HandleNextActionResult

HandleNextActionResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<CardActionError> }

ConfirmSetupIntentResult

ConfirmSetupIntentResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<ConfirmSetupIntentError> }

CreateTokenForCVCUpdateResult

CreateTokenForCVCUpdateResult: { tokenId: string; error?: undefined } | { tokenId?: undefined; error: StripeError<ConfirmSetupIntentError> }

InitPaymentSheetResult

InitPaymentSheetResult: { paymentOption?: PaymentOption; error?: undefined } | { paymentOption?: undefined; error: StripeError<PaymentSheetError> }

PresentPaymentSheetResult

PresentPaymentSheetResult: { paymentOption?: PaymentOption; error?: StripeError<PaymentSheetError> }

Type declaration

Optional paymentOption?: PaymentOption
Optional error?: StripeError<PaymentSheetError>

CreateTokenResult

CreateTokenResult: { token: Token.Result; error?: undefined } | { token?: undefined; error: StripeError<CreateTokenError> }

ConfirmPaymentSheetPaymentResult

ConfirmPaymentSheetPaymentResult: { error?: StripeError<PaymentSheetError> }

Type declaration

Optional error?: StripeError<PaymentSheetError>

ApplePayResult

ApplePayResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<ApplePayError> }

GooglePayInitResult

GooglePayInitResult: { error?: undefined } | { error: StripeError<GooglePayError> }

PayWithGooglePayResult

PayWithGooglePayResult: { error?: undefined } | { error: StripeError<GooglePayError> }

CreateGooglePayPaymentMethodResult

CreateGooglePayPaymentMethodResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<GooglePayError> }

OpenApplePaySetupResult

OpenApplePaySetupResult: { error?: undefined } | { error: StripeError<ApplePayError> }

VerifyMicrodepositsParams

VerifyMicrodepositsParams: { amounts: number[]; descriptorCode?: undefined } | { amounts?: undefined; descriptorCode: string }

VerifyMicrodepositsForPaymentResult

VerifyMicrodepositsForPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<VerifyMicrodepositsError> }

VerifyMicrodepositsForSetupResult

VerifyMicrodepositsForSetupResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<VerifyMicrodepositsError> }

CollectBankAccountForPaymentResult

CollectBankAccountForPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<CollectBankAccountError> }

CollectBankAccountForSetupResult

CollectBankAccountForSetupResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<CollectBankAccountError> }

Index

Interfaces

Functions Other

Functions ReactComponents

Variables Other

Variables ReactComponents

Type aliases

Namespaces

Enumerations

Other Functions

initStripe

Parameters

params: InitStripeParams

Returns Promise<void>

createPaymentMethod

Parameters

params: PaymentMethod.CreateParams

options: CreateOptions = {}

Returns Promise<CreatePaymentMethodResult>

createToken

Parameters

params: Token.CreateParams

Returns Promise<CreateTokenResult>

retrievePaymentIntent

Parameters

clientSecret: string

Returns Promise<RetrievePaymentIntentResult>

retrieveSetupIntent

Parameters

clientSecret: string

Returns Promise<RetrieveSetupIntentResult>

confirmPayment

Parameters

paymentIntentClientSecret: string

Optional params: PaymentMethod.CreateParams

options: CreateOptions = {}

Returns Promise<ConfirmPaymentResult>

isApplePaySupported

Returns Promise<boolean>

presentApplePay

Parameters

params: ApplePay.PresentParams

Returns Promise<ApplePayResult>

updateApplePaySummaryItems

Parameters

summaryItems: ApplePay.CartSummaryItem[]

errorAddressFields: { field: AddressFields; message?: string }[] = []

Returns Promise<{ error?: StripeError<ApplePayError> }>

confirmApplePayPayment

Parameters

clientSecret: string

Returns Promise<{ error?: StripeError<ApplePayError> }>

handleNextAction

Parameters

paymentIntentClientSecret: string

Optional returnURL: string

Returns Promise<HandleNextActionResult>

confirmSetupIntent

Parameters

paymentIntentClientSecret: string

params: SetupIntent.ConfirmParams

options: SetupIntent.ConfirmOptions = {}

Returns Promise<ConfirmSetupIntentResult>

createTokenForCVCUpdate

Parameters

cvc: string

Returns Promise<CreateTokenForCVCUpdateResult>

handleURLCallback

Parameters

url: string

Returns Promise<boolean>

verifyMicrodepositsForPayment

Parameters

clientSecret: string

params: VerifyMicrodepositsParams

Returns Promise<VerifyMicrodepositsForPaymentResult>

verifyMicrodepositsForSetup

Parameters

clientSecret: string

params: VerifyMicrodepositsParams