Options
All
  • Public
  • Public/Protected
  • All
Menu

@stripe/stripe-react-native

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables Other

Variables ReactComponents

Functions Other

Functions ReactComponents

Type aliases

ApplePayResult: { error?: undefined; paymentMethod: PaymentMethod.Result } | { error: StripeError<ApplePayError>; paymentMethod?: undefined }
CollectBankAccountForPaymentResult: { error?: undefined; paymentIntent: PaymentIntent.Result } | { error: StripeError<CollectBankAccountError>; paymentIntent?: undefined }
CollectBankAccountForSetupResult: { error?: undefined; setupIntent: SetupIntent.Result } | { error: StripeError<CollectBankAccountError>; setupIntent?: undefined }
ConfirmPaymentResult: { error?: undefined; paymentIntent: PaymentIntent.Result } | { error: StripeError<ConfirmPaymentError>; paymentIntent?: undefined }
ConfirmPaymentSheetPaymentResult: { error?: StripeError<PaymentSheetError> }

Type declaration

ConfirmSetupIntentResult: { error?: undefined; setupIntent: SetupIntent.Result } | { error: StripeError<ConfirmSetupIntentError>; setupIntent?: undefined }
CreateGooglePayPaymentMethodResult: { error?: undefined; paymentMethod: PaymentMethod.Result } | { error: StripeError<GooglePayError>; paymentMethod?: undefined }
CreatePaymentMethodResult: { error?: undefined; paymentMethod: PaymentMethod.Result } | { error: StripeError<CreatePaymentMethodError>; paymentMethod?: undefined }
CreateTokenForCVCUpdateResult: { error?: undefined; tokenId: string } | { error: StripeError<ConfirmSetupIntentError>; tokenId?: undefined }
CreateTokenResult: { error?: undefined; token: Token.Result } | { error: StripeError<CreateTokenError>; token?: undefined }
ErrorType: "api_connection_error" | "api_error" | "authentication_error" | "card_error" | "idempotency_error" | "invalid_request_error" | "rate_limit_error"
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: { error?: undefined } | { error: StripeError<GooglePayError> }
HandleNextActionResult: { error?: undefined; paymentIntent: PaymentIntent.Result } | { error: StripeError<CardActionError>; paymentIntent?: undefined }
InitPaymentSheetResult: { error?: undefined; paymentOption?: PaymentOption } | { error: StripeError<PaymentSheetError>; paymentOption?: undefined }
IsCardInWalletResult: { error?: undefined; isInWallet: boolean; token?: GooglePayCardToken } | { error: StripeError<GooglePayError>; isInWallet?: undefined; token?: undefined }
OpenApplePaySetupResult: { error?: undefined } | { error: StripeError<ApplePayError> }
PayWithGooglePayResult: { error?: undefined } | { error: StripeError<GooglePayError> }
PresentPaymentSheetResult: { error?: undefined; paymentOption?: undefined } | { error?: undefined; paymentOption?: PaymentOption } | { error: StripeError<PaymentSheetError>; paymentOption?: undefined }
RetrievePaymentIntentResult: { error?: undefined; paymentIntent: PaymentIntent.Result } | { error: StripeError<RetrievePaymentIntentError>; paymentIntent?: undefined }
RetrieveSetupIntentResult: { error?: undefined; setupIntent: SetupIntent.Result } | { error: StripeError<RetrieveSetupIntentError>; setupIntent?: undefined }
StripeProviderProps: InitStripeParams & { children: React.ReactElement | React.ReactElement[] }

Stripe Provider Component Props

VerifyMicrodepositsForPaymentResult: { error?: undefined; paymentIntent: PaymentIntent.Result } | { error: StripeError<VerifyMicrodepositsError>; paymentIntent?: undefined }
VerifyMicrodepositsForSetupResult: { error?: undefined; setupIntent: SetupIntent.Result } | { error: StripeError<VerifyMicrodepositsError>; setupIntent?: undefined }
VerifyMicrodepositsParams: { amounts: number[]; descriptorCode?: undefined } | { amounts?: undefined; descriptorCode: string }

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

Other Functions

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

  • StripeProvider Component

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

    Parameters

    Returns Element

    JSX.Element

Generated using TypeDoc