@stripe/stripe-react-native

Index

Namespaces

Enumerations

Interfaces

Type aliases

ReactComponents Variables

Other Functions

ReactComponents Functions

Type aliases

ApplePayResult

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

ConfirmPaymentResult

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

ConfirmPaymentSheetPaymentResult

ConfirmPaymentSheetPaymentResult: { error?: StripeError<PaymentSheetError> }

Type declaration

Optional error?: StripeError<PaymentSheetError>

ConfirmSetupIntentResult

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

CreateGooglePayPaymentMethodResult

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

CreatePaymentMethodResult

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

CreateTokenForCVCUpdateResult

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

CreateTokenResult

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

ErrorType

GooglePayInitResult

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

HandleCardActionResult

HandleCardActionResult: { error?: undefined; paymentIntent: PaymentIntent } | { error: StripeError<CardActionError>; paymentIntent?: undefined }

InitPaymentSheetResult

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

OpenApplePaySetupResult

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

PayWithGooglePayResult

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

PresentPaymentSheetResult

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

RetrievePaymentIntentResult

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

RetrieveSetupIntentResult

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

ReactComponents Variables

Const CardField

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

Card Field Component

example

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

param

Props

returns

JSX.Element

Const CardForm

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

Card Form Component

example

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

param

Props

returns

JSX.Element

Other Functions

Const confirmApplePayPayment

- Defined in src/functions.ts:210
Parameters
- clientSecret: string

Const confirmPayment

- Defined in src/functions.ts:121
Parameters
- paymentIntentClientSecret: string
- data: Params
- options: Options = {}

Const confirmPaymentSheetPayment

- Defined in src/functions.ts:348

Const confirmSetupIntent

- Defined in src/functions.ts:253
Parameters
- paymentIntentClientSecret: string
- data: Params
- options: Options = {}

Const createGooglePayPaymentMethod

- Defined in src/functions.ts:401
Parameters
- params: CreatePaymentMethodParams

Const createPaymentMethod

- Defined in src/functions.ts:33
Parameters
- data: Params
- options: Options = {}

Const createToken

- Defined in src/functions.ts:57
Parameters
- params: CreateTokenParams

Const createTokenForCVCUpdate

- Defined in src/functions.ts:279
Parameters
- cvc: string

Const handleCardAction

- Defined in src/functions.ts:231
Parameters
- paymentIntentClientSecret: string

Const handleURLCallback

- Defined in src/functions.ts:301
Parameters
- url: string

Const initGooglePay

- Defined in src/functions.ts:365
Parameters
- params: InitParams

Const initPaymentSheet

- Defined in src/functions.ts:306
Parameters
- params: SetupParams

Const retrievePaymentIntent

- Defined in src/functions.ts:78
Parameters
- clientSecret: string

Const retrieveSetupIntent

- Defined in src/functions.ts:99
Parameters
- clientSecret: string

Const updateApplePaySummaryItems

- Defined in src/functions.ts:180
Parameters
- summaryItems: CartSummaryItem[]
- errorAddressFields: { field: AddressFields; message?: string }[] = []

useApplePay

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

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

useConfirmPayment

- Defined in src/hooks/useConfirmPayment.tsx:8
useConfirmPayment hook
- confirmPayment: (paymentIntentClientSecret: string, data: Params, options?: Options) => Promise<ConfirmPaymentResult>
  - - (paymentIntentClientSecret: string, data: Params, options?: Options): Promise<ConfirmPaymentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: Params
      - options: Options = {}
- loading: boolean

useConfirmSetupIntent

- Defined in src/hooks/useConfirmSetupIntent.tsx:8
useConfirmSetupIntent hook
- confirmSetupIntent: (paymentIntentClientSecret: string, data: Params, options?: Options) => Promise<ConfirmSetupIntentResult>
  - - (paymentIntentClientSecret: string, data: Params, options?: Options): Promise<ConfirmSetupIntentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: Params
      - options: Options = {}
- loading: boolean

useGooglePay

- Defined in src/hooks/useGooglePay.tsx:8
useGooglePay hook
- createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>
  - - (params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>
    - Parameters
      - params: CreatePaymentMethodParams
- initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>
  - - (params: InitParams): Promise<GooglePayInitResult>
    - Parameters
      - params: InitParams
- loading: boolean
- presentGooglePay: (params: PresentGooglePayParams) => Promise<PayWithGooglePayResult>
  - - (params: PresentGooglePayParams): Promise<PayWithGooglePayResult>
    - Parameters
      - params: PresentGooglePayParams

usePaymentSheet

- Defined in src/hooks/usePaymentSheet.tsx:8
usePaymentSheet hook
- confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>
  - - (): Promise<ConfirmPaymentSheetPaymentResult>
- initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>
  - - (params: SetupParams): Promise<InitPaymentSheetResult>
    - Parameters
      - params: SetupParams
- loading: boolean
- presentPaymentSheet: () => Promise<PresentPaymentSheetResult>
  - - (): Promise<PresentPaymentSheetResult>

useStripe

- Defined in src/hooks/useStripe.tsx:55
useStripe hook
- confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (clientSecret: string): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - clientSecret: string
- confirmPayment: (paymentIntentClientSecret: string, data: Params, options?: Options) => Promise<ConfirmPaymentResult>
  - - (paymentIntentClientSecret: string, data: Params, options?: Options): Promise<ConfirmPaymentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: Params
      - options: Options = {}
- confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>
  - - (): Promise<ConfirmPaymentSheetPaymentResult>
- confirmSetupIntent: (paymentIntentClientSecret: string, data: Params, options?: Options) => Promise<ConfirmSetupIntentResult>
  - - (paymentIntentClientSecret: string, data: Params, options?: Options): Promise<ConfirmSetupIntentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: Params
      - options: Options = {}
- createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>
  - - (params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>
    - Parameters
      - params: CreatePaymentMethodParams
- createPaymentMethod: (data: Params, options?: Options) => Promise<CreatePaymentMethodResult>
  - - (data: Params, options?: Options): Promise<CreatePaymentMethodResult>
    - Parameters
      - data: Params
      - options: Options = {}
- createToken: (params: CreateTokenParams) => Promise<CreateTokenResult>
  - - (params: CreateTokenParams): Promise<CreateTokenResult>
    - Parameters
      - params: CreateTokenParams
- createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>
  - - (cvc: string): Promise<CreateTokenForCVCUpdateResult>
    - Parameters
      - cvc: string
- handleCardAction: (paymentIntentClientSecret: string) => Promise<HandleCardActionResult>
  - - (paymentIntentClientSecret: string): Promise<HandleCardActionResult>
    - Parameters
      - paymentIntentClientSecret: string
- handleURLCallback: (url: string) => Promise<boolean>
  - - (url: string): Promise<boolean>
    - Parameters
      - url: string
- initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>
  - - (params: InitParams): Promise<GooglePayInitResult>
    - Parameters
      - params: InitParams
- initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>
  - - (params: SetupParams): Promise<InitPaymentSheetResult>
    - Parameters
      - params: SetupParams
- isApplePaySupported: null | boolean
- openApplePaySetup: () => Promise<OpenApplePaySetupResult>
  - - (): Promise<OpenApplePaySetupResult>
- presentApplePay: (params: PresentParams) => Promise<ApplePayResult>
  - - (params: PresentParams): Promise<ApplePayResult>
    - Parameters
      - params: PresentParams
- presentGooglePay: (params: PresentGooglePayParams) => Promise<PayWithGooglePayResult>
  - - (params: PresentGooglePayParams): Promise<PayWithGooglePayResult>
    - Parameters
      - params: PresentGooglePayParams
- presentPaymentSheet: () => Promise<PresentPaymentSheetResult>
  - - (): Promise<PresentPaymentSheetResult>
- retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>
  - - (clientSecret: string): Promise<RetrievePaymentIntentResult>
    - Parameters
      - clientSecret: string
- retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>
  - - (clientSecret: string): Promise<RetrieveSetupIntentResult>
    - Parameters
      - clientSecret: string
- updateApplePaySummaryItems: (summaryItems: CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (summaryItems: CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - summaryItems: CartSummaryItem[]
      - errorAddressFields: { field: AddressFields; message?: string }[] = []

ReactComponents Functions

ApplePayButton

Apple Pay Button Component

example

 <ApplePayButton
   onPress={pay}
   type="plain"
   buttonStyle="black"
   borderRadius={4}
   style={styles.payButton}
 />

Parameters

__namedParameters: ApplePayButtonProps

Props

JSX.Element

AuBECSDebitForm

BECS Debit form component

example

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

Parameters

__namedParameters: AuBECSDebitFormProps

Props

JSX.Element

GooglePayButton

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

StripeContainer

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

Parameters
- __namedParameters: StripeContainerProps
  
  Props
JSX.Element

StripeProvider

StripeProvider Component

example

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

Parameters

__namedParameters: StripeProviderProps

Props

JSX.Element

Generated using TypeDoc

Index

Namespaces

Enumerations

Interfaces

Type aliases

ReactComponents Variables

Other Functions

ReactComponents Functions

Type aliases

ApplePayResult

ConfirmPaymentResult

ConfirmPaymentSheetPaymentResult

Type declaration

Optional error?: StripeError<PaymentSheetError>

ConfirmSetupIntentResult

CreateGooglePayPaymentMethodResult

CreatePaymentMethodResult

CreateTokenForCVCUpdateResult

CreateTokenResult

ErrorType

GooglePayInitResult

HandleCardActionResult

InitPaymentSheetResult

OpenApplePaySetupResult

PayWithGooglePayResult

PresentPaymentSheetResult

RetrievePaymentIntentResult

RetrieveSetupIntentResult

ReactComponents Variables

Const CardField

Const CardForm

Other Functions

Const confirmApplePayPayment

Parameters

clientSecret: string

Const confirmPayment

Parameters

paymentIntentClientSecret: string

data: Params

options: Options = {}

Const confirmPaymentSheetPayment

Const confirmSetupIntent

Parameters

paymentIntentClientSecret: string

data: Params

options: Options = {}

Const createGooglePayPaymentMethod

Parameters

params: CreatePaymentMethodParams

Const createPaymentMethod

Parameters

data: Params

options: Options = {}

Const createToken

Parameters

params: CreateTokenParams

Const createTokenForCVCUpdate

Parameters

cvc: string

Const handleCardAction

Parameters

paymentIntentClientSecret: string

Const handleURLCallback

Parameters

url: string

Const initGooglePay

Parameters

params: InitParams

Const initPaymentSheet

Parameters

params: SetupParams

Const initStripe

Parameters

params: InitStripeParams

Const isApplePaySupported

Const openApplePaySetup

Const presentApplePay

Parameters

params: PresentParams

Const presentGooglePay