Options
All
  • Public
  • Public/Protected
  • All
Menu

@stripe/stripe-react-native

Index

Interfaces

Functions Other

Functions ReactComponents

Variables Other

Variables ReactComponents

Type aliases

Namespaces

Enumerations

Other Functions

  • 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(): Promise<boolean>
  • deprecated

    Use isPlatformPaySupported instead.

    Returns Promise<boolean>

  • handleURLCallback(url: string): Promise<boolean>
  • resetPaymentSheetCustomer(): Promise<null>
  • 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>

  • collectBankAccountToken(clientSecret: string): Promise<TokenResult>
  • collectFinancialConnectionsAccounts(clientSecret: string): Promise<SessionResult>
  • Check if the app & device support adding this card to the native wallet.

    Parameters

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

  • Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.

    Parameters

    Returns Promise<boolean>

    A boolean indicating whether or not the native wallet is supported.

  • Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe SetupIntent.

    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.

  • 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(): Promise<boolean>
  • 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.

  • Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe PaymentMethod and token.

    Parameters

    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.

  • openPlatformPaySetup(): Promise<void>
  • 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>

  • useFinancialConnectionsSheet(): { collectBankAccountToken: (clientSecret: string) => Promise<TokenResult>; collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>; loading: boolean }
  • 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>
    • collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<SessionResult>
    • loading: boolean

ReactComponents Functions

  • 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

    Returns Element

    JSX.Element

  • BECS Debit form component

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

    Parameters

    Returns Element

    JSX.Element

  • 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

    Returns Element

    JSX.Element

  • StripeProvider Component

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

    Parameters

    Returns Element

    JSX.Element

Other Variables

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

Type declaration

  • API_VERSIONS: { CORE: string; ISSUING: string }
    • CORE: string
    • ISSUING: string
MissingRoutingNumber: { code: Failed; message: string } = ...

Type declaration

ReactComponents Variables

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

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: InitStripeParams & { children: React.ReactElement | React.ReactElement[] }

Stripe Provider Component Props

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: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error"
GooglePayCardToken: { id: string; cardLastFour: string; network: number; serviceProvider: number; issuer: string; status: GooglePayCardTokenStatus }

Type declaration

IsCardInWalletResult: { isInWallet: boolean; token?: GooglePayCardToken; error?: undefined } | { isInWallet?: undefined; token?: undefined; error: StripeError<GooglePayError> }
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: { canAddCard: boolean; details?: { token?: GooglePayCardToken; status?: CanAddCardToWalletStatus }; error?: undefined } | { canAddCard?: undefined; details?: undefined; error: StripeError<GooglePayError> }
CreatePaymentMethodResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<CreatePaymentMethodError> }
RetrievePaymentIntentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<RetrievePaymentIntentError> }
RetrieveSetupIntentResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<RetrieveSetupIntentError> }
ConfirmPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<ConfirmPaymentError> }
HandleNextActionResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<CardActionError> }
ConfirmSetupIntentResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<ConfirmSetupIntentError> }
CreateTokenForCVCUpdateResult: { tokenId: string; error?: undefined } | { tokenId?: undefined; error: StripeError<ConfirmSetupIntentError> }
InitPaymentSheetResult: { paymentOption?: PaymentOption; error?: undefined } | { paymentOption?: undefined; error: StripeError<PaymentSheetError> }
PresentPaymentSheetResult: { paymentOption?: PaymentOption; error?: StripeError<PaymentSheetError> }

Type declaration

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

Type declaration

ApplePayResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<ApplePayError> }
GooglePayInitResult: { error?: undefined } | { error: StripeError<GooglePayError> }
PayWithGooglePayResult: { error?: undefined } | { error: StripeError<GooglePayError> }
CreateGooglePayPaymentMethodResult: { paymentMethod: PaymentMethod.Result; error?: undefined } | { paymentMethod?: undefined; error: StripeError<GooglePayError> }
OpenApplePaySetupResult: { error?: undefined } | { error: StripeError<ApplePayError> }
VerifyMicrodepositsParams: { amounts: number[]; descriptorCode?: undefined } | { amounts?: undefined; descriptorCode: string }
VerifyMicrodepositsForPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<VerifyMicrodepositsError> }
VerifyMicrodepositsForSetupResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<VerifyMicrodepositsError> }
CollectBankAccountForPaymentResult: { paymentIntent: PaymentIntent.Result; error?: undefined } | { paymentIntent?: undefined; error: StripeError<CollectBankAccountError> }
CollectBankAccountForSetupResult: { setupIntent: SetupIntent.Result; error?: undefined } | { setupIntent?: undefined; error: StripeError<CollectBankAccountError> }

Generated using TypeDoc