@stripe/stripe-react-native

Index

Namespaces

Enumerations

Interfaces

Variables Other

Variables ReactComponents

Type aliases

ApplePayResult

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

CanAddCardToWalletParams

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

Type declaration

cardLastFour: string

Last 4 digits of the card number.
primaryAccountIdentifier: string | null

The primary_account_identifier value from the issued card. Can be an empty string.
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

CanAddCardToWalletResult

CanAddCardToWalletResult: { canAddCard: boolean; details?: { status?: "MISSING_CONFIGURATION" | "UNSUPPORTED_DEVICE" | "CARD_ALREADY_EXISTS"; token?: GooglePayCardToken }; error?: undefined } | { canAddCard?: undefined; details?: undefined; error: StripeError<GooglePayError> }

CollectBankAccountForPaymentResult

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

CollectBankAccountForSetupResult

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

ConfirmPaymentResult

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

ConfirmPaymentSheetPaymentResult

ConfirmPaymentSheetPaymentResult: { error?: StripeError<PaymentSheetError> }

Type declaration

Optional error?: StripeError<PaymentSheetError>

ConfirmSetupIntentResult

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

CreateGooglePayPaymentMethodResult

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

CreatePaymentMethodResult

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

CreateTokenForCVCUpdateResult

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

CreateTokenResult

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

ErrorType

GooglePayCardToken

GooglePayCardToken: { cardLastFour: string; id: string; issuer: string; network: number; serviceProvider: number; status: "TOKEN_STATE_NEEDS_IDENTITY_VERIFICATION" | "TOKEN_STATE_PENDING" | "TOKEN_STATE_SUSPENDED" | "TOKEN_STATE_ACTIVE" | "TOKEN_STATE_FELICA_PENDING_PROVISIONING" | "TOKEN_STATE_UNTOKENIZED" }

Type declaration

cardLastFour: string
id: string
issuer: string
network: number
serviceProvider: number
status: "TOKEN_STATE_NEEDS_IDENTITY_VERIFICATION" | "TOKEN_STATE_PENDING" | "TOKEN_STATE_SUSPENDED" | "TOKEN_STATE_ACTIVE" | "TOKEN_STATE_FELICA_PENDING_PROVISIONING" | "TOKEN_STATE_UNTOKENIZED"

GooglePayInitResult

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

HandleNextActionResult

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

InitPaymentSheetResult

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

IsCardInWalletResult

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

OpenApplePaySetupResult

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

PayWithGooglePayResult

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

PresentPaymentSheetResult

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

RetrievePaymentIntentResult

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

RetrieveSetupIntentResult

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

StripeProviderProps

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

Stripe Provider Component Props

VerifyMicrodepositsForPaymentResult

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

VerifyMicrodepositsForSetupResult

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

VerifyMicrodepositsParams

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

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

Other Functions

canAddCardToWallet

canAddCardToWallet(params: CanAddCardToWalletParams): Promise<CanAddCardToWalletResult>

- Defined in src/functions.ts:570
Parameters
- params: CanAddCardToWalletParams
Returns Promise<CanAddCardToWalletResult>

collectBankAccountForPayment

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

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

collectBankAccountForSetup

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

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

confirmApplePayPayment

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

- Defined in src/functions.ts:230
Parameters
- clientSecret: string
Returns Promise<{ error?: StripeError<ApplePayError> }>

confirmPayment

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

- Defined in src/functions.ts:141
Parameters
- paymentIntentClientSecret: string
- params: PaymentMethod.CreateParams
- options: CreateOptions = {}
Returns Promise<ConfirmPaymentResult>

confirmPaymentSheetPayment

confirmPaymentSheetPayment(): Promise<ConfirmPaymentSheetPaymentResult>

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

confirmSetupIntent

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

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

createTokenForCVCUpdate

createTokenForCVCUpdate(cvc: string): Promise<CreateTokenForCVCUpdateResult>

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

handleNextAction

handleNextAction(paymentIntentClientSecret: string): Promise<HandleNextActionResult>

- Defined in src/functions.ts:251
Parameters
- paymentIntentClientSecret: string
Returns Promise<HandleNextActionResult>

handleURLCallback

handleURLCallback(url: string): Promise<boolean>

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

initGooglePay

initGooglePay(params: InitParams): Promise<GooglePayInitResult>

- Defined in src/functions.ts:445
Parameters
- params: InitParams
Returns Promise<GooglePayInitResult>

initPaymentSheet

initPaymentSheet(params: SetupParams): Promise<InitPaymentSheetResult>

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

initStripe

initStripe(params: InitStripeParams): Promise<void>

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

isApplePaySupported

isApplePaySupported(): Promise<boolean>

- Defined in src/functions.ts:167
Returns Promise<boolean>

isCardInWallet

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

- Defined in src/functions.ts:593
Parameters
- params: { cardLastFour: string }
  - cardLastFour: string
Returns Promise<IsCardInWalletResult>

isGooglePaySupported

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

- Defined in src/functions.ts:437
Parameters
- Optional params: IsSupportedParams
Returns Promise<boolean>

openApplePaySetup

openApplePaySetup(): Promise<OpenApplePaySetupResult>

- Defined in src/functions.ts:502
Returns Promise<OpenApplePaySetupResult>

presentApplePay

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

- Defined in src/functions.ts:171
Parameters
- params: ApplePay.PresentParams
Returns Promise<ApplePayResult>

presentGooglePay

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

- Defined in src/functions.ts:463
Parameters
- params: GooglePay.PresentParams
Returns Promise<PayWithGooglePayResult>

presentPaymentSheet

presentPaymentSheet(): Promise<PresentPaymentSheetResult>

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

retrievePaymentIntent

retrievePaymentIntent(clientSecret: string): Promise<RetrievePaymentIntentResult>

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

retrieveSetupIntent

retrieveSetupIntent(clientSecret: string): Promise<RetrieveSetupIntentResult>

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

updateApplePaySummaryItems

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

- Defined in src/functions.ts:200
Parameters
- summaryItems: CartSummaryItem[]
- errorAddressFields: { field: AddressFields; message?: string }[] = []
Returns Promise<{ error?: StripeError<ApplePayError> }>

useApplePay

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

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

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

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
      - 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

useGooglePay

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

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

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

usePaymentSheet

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

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

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

useStripe

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

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

Returns { canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>; collectBankAccountForPayment: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForPaymentResult>; collectBankAccountForSetup: (clientSecret: string, params: CollectBankAccountParams) => Promise<CollectBankAccountForSetupResult>; confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>; confirmPayment: (paymentIntentClientSecret: string, data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>; confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>; confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>; createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>; createPaymentMethod: (data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<CreatePaymentMethodResult>; createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>; createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>; handleNextAction: (paymentIntentClientSecret: string) => Promise<HandleNextActionResult>; handleURLCallback: (url: string) => Promise<boolean>; initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>; initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>; isApplePaySupported: null | boolean; isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>; openApplePaySetup: () => Promise<OpenApplePaySetupResult>; presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>; presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>; presentPaymentSheet: () => Promise<PresentPaymentSheetResult>; retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>; retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>; updateApplePaySummaryItems: (summaryItems: CartSummaryItem[], errorAddressFields?: { field: AddressFields; message?: string }[]) => Promise<{ error?: StripeError<ApplePayError> }>; verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForPaymentResult>; verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForSetupResult> }
- canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>
  - - (params: CanAddCardToWalletParams): Promise<CanAddCardToWalletResult>
    - Parameters
      - params: CanAddCardToWalletParams
      Returns Promise<CanAddCardToWalletResult>
- 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>
- confirmApplePayPayment: (clientSecret: string) => Promise<{ error?: StripeError<ApplePayError> }>
  - - (clientSecret: string): Promise<{ error?: StripeError<ApplePayError> }>
    - Parameters
      - clientSecret: string
      Returns Promise<{ error?: StripeError<ApplePayError> }>
- confirmPayment: (paymentIntentClientSecret: string, data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<ConfirmPaymentResult>
  - - (paymentIntentClientSecret: string, data: PaymentMethod.CreateParams, options?: CreateOptions): Promise<ConfirmPaymentResult>
    - Parameters
      - paymentIntentClientSecret: string
      - data: PaymentMethod.CreateParams
      - options: CreateOptions = {}
      Returns Promise<ConfirmPaymentResult>
- confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>
  - - (): Promise<ConfirmPaymentSheetPaymentResult>
    - Returns Promise<ConfirmPaymentSheetPaymentResult>
- 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>
- createGooglePayPaymentMethod: (params: CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>
  - - (params: CreatePaymentMethodParams): Promise<CreateGooglePayPaymentMethodResult>
    - Parameters
      - params: CreatePaymentMethodParams
      Returns Promise<CreateGooglePayPaymentMethodResult>
- createPaymentMethod: (data: PaymentMethod.CreateParams, options?: CreateOptions) => Promise<CreatePaymentMethodResult>
  - - (data: PaymentMethod.CreateParams, options?: CreateOptions): Promise<CreatePaymentMethodResult>
    - Parameters
      - data: PaymentMethod.CreateParams
      - options: CreateOptions = {}
      Returns Promise<CreatePaymentMethodResult>
- createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>
  - - (params: Token.CreateParams): Promise<CreateTokenResult>
    - Parameters
      - params: Token.CreateParams
      Returns Promise<CreateTokenResult>
- createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>
  - - (cvc: string): Promise<CreateTokenForCVCUpdateResult>
    - Parameters
      - cvc: string
      Returns Promise<CreateTokenForCVCUpdateResult>
- handleNextAction: (paymentIntentClientSecret: string) => Promise<HandleNextActionResult>
  - - (paymentIntentClientSecret: string): Promise<HandleNextActionResult>
    - Parameters
      - paymentIntentClientSecret: string
      Returns Promise<HandleNextActionResult>
- handleURLCallback: (url: string) => Promise<boolean>
  - - (url: string): Promise<boolean>
    - Parameters
      - url: string
      Returns Promise<boolean>
- initGooglePay: (params: InitParams) => Promise<GooglePayInitResult>
  - - (params: InitParams): Promise<GooglePayInitResult>
    - Parameters
      - params: InitParams
      Returns Promise<GooglePayInitResult>
- initPaymentSheet: (params: SetupParams) => Promise<InitPaymentSheetResult>
  - - (params: SetupParams): Promise<InitPaymentSheetResult>
    - Parameters
      - params: SetupParams
      Returns Promise<InitPaymentSheetResult>
- isApplePaySupported: null | boolean
- isGooglePaySupported: (params?: IsSupportedParams) => Promise<boolean>
  - - (params?: IsSupportedParams): Promise<boolean>
    - Parameters
      - Optional params: IsSupportedParams
      Returns Promise<boolean>
- openApplePaySetup: () => Promise<OpenApplePaySetupResult>
  - - (): Promise<OpenApplePaySetupResult>
    - Returns Promise<OpenApplePaySetupResult>
- presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>
  - - (params: ApplePay.PresentParams): Promise<ApplePayResult>
    - Parameters
      - params: ApplePay.PresentParams
      Returns Promise<ApplePayResult>
- presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>
  - - (params: GooglePay.PresentParams): Promise<PayWithGooglePayResult>
    - Parameters
      - params: GooglePay.PresentParams
      Returns Promise<PayWithGooglePayResult>
- presentPaymentSheet: () => Promise<PresentPaymentSheetResult>
  - - (): Promise<PresentPaymentSheetResult>
    - Returns Promise<PresentPaymentSheetResult>
- 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>
- 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 }[] = []
      Returns Promise<{ error?: StripeError<ApplePayError> }>
- 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>

verifyMicrodepositsForPayment

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

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

verifyMicrodepositsForSetup

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

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

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

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

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

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables Other

Variables ReactComponents

Functions Other

Functions ReactComponents

Type aliases

ApplePayResult

CanAddCardToWalletParams

Type declaration

cardLastFour: string

primaryAccountIdentifier: string | null

Optional testEnv?: boolean

CanAddCardToWalletResult

CollectBankAccountForPaymentResult

CollectBankAccountForSetupResult

ConfirmPaymentResult

ConfirmPaymentSheetPaymentResult

Type declaration

Optional error?: StripeError<PaymentSheetError>

ConfirmSetupIntentResult

CreateGooglePayPaymentMethodResult

CreatePaymentMethodResult

CreateTokenForCVCUpdateResult

CreateTokenResult

ErrorType

GooglePayCardToken

Type declaration

cardLastFour: string

id: string

issuer: string

network: number

serviceProvider: number

status: "TOKEN_STATE_NEEDS_IDENTITY_VERIFICATION" | "TOKEN_STATE_PENDING" | "TOKEN_STATE_SUSPENDED" | "TOKEN_STATE_ACTIVE" | "TOKEN_STATE_FELICA_PENDING_PROVISIONING" | "TOKEN_STATE_UNTOKENIZED"

GooglePayInitResult

HandleNextActionResult

InitPaymentSheetResult

IsCardInWalletResult

OpenApplePaySetupResult

PayWithGooglePayResult

PresentPaymentSheetResult

RetrievePaymentIntentResult

RetrieveSetupIntentResult

StripeProviderProps

VerifyMicrodepositsForPaymentResult

VerifyMicrodepositsForSetupResult

VerifyMicrodepositsParams

Other Variables

Const Constants

Type declaration

API_VERSIONS: { CORE: string; ISSUING: string }

CORE: string

ISSUING: string

Const MissingRoutingNumber

Type declaration

code: Failed

message: string

ReactComponents Variables

Const CardField

Const CardForm

Other Functions

canAddCardToWallet

Parameters

params: CanAddCardToWalletParams

Returns Promise<CanAddCardToWalletResult>

collectBankAccountForPayment

Parameters

clientSecret: string

params: CollectBankAccountParams

Returns Promise<CollectBankAccountForPaymentResult>

collectBankAccountForSetup

Parameters

clientSecret: string

params: CollectBankAccountParams

Returns Promise<CollectBankAccountForSetupResult>

confirmApplePayPayment

Parameters