@stripe/stripe-react-native 0.3.0 → 0.6.0

package/src/NativeStripeSdk.tsx

@@ -9,7 +9,7 @@ import type {
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   ConfirmPaymentResult,
-  HandleCardActionResult,
+  HandleNextActionResult,
   ConfirmSetupIntentResult,
   CreateTokenForCVCUpdateResult,
   InitPaymentSheetResult,
@@ -23,6 +23,8 @@ import type {
   GooglePay,
   OpenApplePaySetupResult,
   CreateTokenParams,
+  VerifyMicrodepositsParams,
+  CollectBankAccountParams,
 } from './types';
 
 type NativeStripeSdkType = {
@@ -31,9 +33,9 @@ type NativeStripeSdkType = {
     data: PaymentMethodCreateParams.Params,
     options: PaymentMethodCreateParams.Options
   ): Promise<CreatePaymentMethodResult>;
-  handleCardAction(
+  handleNextAction(
     paymentIntentClientSecret: string
-  ): Promise<HandleCardActionResult>;
+  ): Promise<HandleNextActionResult>;
   confirmPayment(
     paymentIntentClientSecret: string,
     data: PaymentMethodCreateParams.Params,
@@ -77,6 +79,16 @@ type NativeStripeSdkType = {
     params: GooglePay.CreatePaymentMethodParams
   ): Promise<CreateGooglePayPaymentMethodResult>;
   openApplePaySetup(): Promise<OpenApplePaySetupResult>;
+  verifyMicrodeposits(
+    type: 'payment' | 'setup',
+    clientSecret: string,
+    params: VerifyMicrodepositsParams
+  ): Promise<ConfirmSetupIntentResult | ConfirmPaymentResult>;
+  collectBankAccount(
+    type: 'payment' | 'setup',
+    clientSecret: string,
+    params: CollectBankAccountParams
+  ): Promise<ConfirmSetupIntentResult | ConfirmPaymentResult>;
 };
 
 const { StripeSdk } = NativeModules;

package/src/components/StripeProvider.tsx

@@ -2,12 +2,7 @@ import React, { useEffect } from 'react';
 
 import NativeStripeSdk from '../NativeStripeSdk';
 import { isAndroid, shouldAttributeExpo } from '../helpers';
-import type {
-  AppInfo,
-  ThreeDSecureConfigurationParams,
-  InitStripeParams,
-  InitialiseParams,
-} from '../types';
+import type { AppInfo, InitStripeParams, InitialiseParams } from '../types';
 import pjson from '../../package.json';
 
 const EXPO_PARTNER_ID = 'pp_partner_JBN7LkABco2yUu';
@@ -15,15 +10,9 @@ const EXPO_PARTNER_ID = 'pp_partner_JBN7LkABco2yUu';
 /**
  *  Stripe Provider Component Props
  */
-export interface Props {
-  publishableKey: string;
-  merchantIdentifier?: string;
-  threeDSecureParams?: ThreeDSecureConfigurationParams;
-  stripeAccountId?: string;
+export type Props = InitStripeParams & {
   children: React.ReactElement | React.ReactElement[];
-  urlScheme?: string;
-  setUrlSchemeOnAndroid?: boolean;
-}
+};
 
 const repository: any = pjson.repository;
 
@@ -69,6 +58,7 @@ export function StripeProvider({
   threeDSecureParams,
   stripeAccountId,
   urlScheme,
+  setReturnUrlSchemeOnAndroid,
   setUrlSchemeOnAndroid,
 }: Props) {
   useEffect(() => {
@@ -82,7 +72,8 @@ export function StripeProvider({
         stripeAccountId,
         threeDSecureParams,
         urlScheme,
-        setUrlSchemeOnAndroid,
+        setReturnUrlSchemeOnAndroid:
+          setReturnUrlSchemeOnAndroid || setUrlSchemeOnAndroid,
       });
     } else {
       NativeStripeSdk.initialise({
@@ -100,6 +91,7 @@ export function StripeProvider({
     stripeAccountId,
     threeDSecureParams,
     urlScheme,
+    setReturnUrlSchemeOnAndroid,
     setUrlSchemeOnAndroid,
   ]);
 

package/src/functions.ts

@@ -6,6 +6,8 @@ import {
   ApplePayError,
   ApplePayResult,
   ConfirmPaymentResult,
+  ConfirmPaymentError,
+  ConfirmSetupIntentError,
   ConfirmPaymentSheetPaymentResult,
   ConfirmSetupIntent,
   ConfirmSetupIntentResult,
@@ -13,7 +15,7 @@ import {
   CreateTokenForCVCUpdateResult,
   CreateTokenResult,
   GooglePayInitResult,
-  HandleCardActionResult,
+  HandleNextActionResult,
   InitPaymentSheetResult,
   PaymentMethodCreateParams,
   PaymentSheet,
@@ -26,10 +28,14 @@ import {
   CreateGooglePayPaymentMethodResult,
   OpenApplePaySetupResult,
   CreateTokenParams,
+  VerifyMicrodepositsParams,
+  CollectBankAccountParams,
 } from './types';
 
 const APPLE_PAY_NOT_SUPPORTED_MESSAGE =
   'Apple pay is not supported on this device';
+const PAYMENT_INTENT = 'payment';
+const SETUP_INTENT = 'setup';
 
 export const createPaymentMethod = async (
   data: PaymentMethodCreateParams.Params,
@@ -239,11 +245,36 @@ export const confirmApplePayPayment = async (
   }
 };
 
+export const handleNextAction = async (
+  paymentIntentClientSecret: string
+): Promise<HandleNextActionResult> => {
+  try {
+    const { paymentIntent, error } = await NativeStripeSdk.handleNextAction(
+      paymentIntentClientSecret
+    );
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      paymentIntent: paymentIntent!,
+    };
+  } catch (error) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
+/**
+ * @deprecated This method is deprecated, you should use `handleNextAction` as a drop-in replacement instead.
+ */
 export const handleCardAction = async (
   paymentIntentClientSecret: string
-): Promise<HandleCardActionResult> => {
+): Promise<HandleNextActionResult> => {
   try {
-    const { paymentIntent, error } = await NativeStripeSdk.handleCardAction(
+    const { paymentIntent, error } = await NativeStripeSdk.handleNextAction(
       paymentIntentClientSecret
     );
     if (error) {
@@ -314,6 +345,76 @@ export const handleURLCallback = async (url: string): Promise<boolean> => {
   return stripeHandled;
 };
 
+export const verifyMicrodepositsForPayment = async (
+  clientSecret: string,
+  params: VerifyMicrodepositsParams
+): Promise<ConfirmPaymentResult> => {
+  if (isAndroid) {
+    return {
+      error: createError({
+        code: ConfirmPaymentError.Failed,
+        message:
+          'verifyMicrodepositsForPayment is only supported on iOS on this version of @stripe/stripe-react-native. Please verify with paymentIntent.nextAction.redirectUrl',
+      }),
+    };
+  }
+  try {
+    const { paymentIntent, error } = (await NativeStripeSdk.verifyMicrodeposits(
+      PAYMENT_INTENT,
+      clientSecret,
+      params
+    )) as ConfirmPaymentResult;
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      paymentIntent: paymentIntent!,
+    };
+  } catch (error) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
+export const verifyMicrodepositsForSetup = async (
+  clientSecret: string,
+  params: VerifyMicrodepositsParams
+): Promise<ConfirmSetupIntentResult> => {
+  if (isAndroid) {
+    return {
+      error: createError({
+        code: ConfirmSetupIntentError.Failed,
+        message:
+          'verifyMicrodepositsForSetup is only supported on iOS on this version of @stripe/stripe-react-native. Please verify with setupIntent.nextAction.redirectUrl',
+      }),
+    };
+  }
+  try {
+    const { setupIntent, error } = (await NativeStripeSdk.verifyMicrodeposits(
+      SETUP_INTENT,
+      clientSecret,
+      params
+    )) as ConfirmSetupIntentResult;
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      setupIntent: setupIntent!,
+    };
+  } catch (error) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
 export const initPaymentSheet = async (
   params: PaymentSheet.SetupParams
 ): Promise<InitPaymentSheetResult> => {
@@ -453,3 +554,73 @@ export const openApplePaySetup = async (): Promise<OpenApplePaySetupResult> => {
     };
   }
 };
+
+export const collectBankAccountForPayment = async (
+  clientSecret: string,
+  params: CollectBankAccountParams
+): Promise<ConfirmPaymentResult> => {
+  if (isAndroid) {
+    return {
+      error: createError({
+        code: ConfirmPaymentError.Failed,
+        message:
+          'collectBankAccountForPayment is only supported on iOS on this version of @stripe/stripe-react-native.',
+      }),
+    };
+  }
+  try {
+    const { paymentIntent, error } = (await NativeStripeSdk.collectBankAccount(
+      PAYMENT_INTENT,
+      clientSecret,
+      params
+    )) as ConfirmPaymentResult;
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      paymentIntent: paymentIntent!,
+    };
+  } catch (error) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
+export const collectBankAccountForSetup = async (
+  clientSecret: string,
+  params: CollectBankAccountParams
+): Promise<ConfirmSetupIntentResult> => {
+  if (isAndroid) {
+    return {
+      error: createError({
+        code: ConfirmSetupIntentError.Failed,
+        message:
+          'collectBankAccountForSetup is only supported on iOS on this version of @stripe/stripe-react-native.',
+      }),
+    };
+  }
+  try {
+    const { setupIntent, error } = (await NativeStripeSdk.collectBankAccount(
+      SETUP_INTENT,
+      clientSecret,
+      params
+    )) as ConfirmSetupIntentResult;
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      setupIntent: setupIntent!,
+    };
+  } catch (error) {
+    return {
+      error: createError(error),
+    };
+  }
+};

package/src/hooks/useStripe.tsx

@@ -6,7 +6,7 @@ import type {
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   ConfirmPaymentResult,
-  HandleCardActionResult,
+  HandleNextActionResult,
   ConfirmSetupIntentResult,
   CreateTokenForCVCUpdateResult,
   ApplePayResult,
@@ -23,6 +23,8 @@ import type {
   CreateGooglePayPaymentMethodResult,
   OpenApplePaySetupResult,
   CreateTokenParams,
+  VerifyMicrodepositsParams,
+  CollectBankAccountParams,
 } from '../types';
 import { useCallback, useEffect, useState } from 'react';
 import { isiOS } from '../helpers';
@@ -35,7 +37,7 @@ import {
   confirmApplePayPayment,
   confirmSetupIntent,
   createTokenForCVCUpdate,
-  handleCardAction,
+  handleNextAction,
   handleURLCallback,
   presentApplePay,
   updateApplePaySummaryItems,
@@ -48,6 +50,10 @@ import {
   createGooglePayPaymentMethod,
   presentGooglePay,
   openApplePaySetup,
+  collectBankAccountForPayment,
+  collectBankAccountForSetup,
+  verifyMicrodepositsForPayment,
+  verifyMicrodepositsForSetup,
 } from '../functions';
 
 /**
@@ -139,11 +145,11 @@ export function useStripe() {
     []
   );
 
-  const _handleCardAction = useCallback(
+  const _handleNextAction = useCallback(
     async (
       paymentIntentClientSecret: string
-    ): Promise<HandleCardActionResult> => {
-      return handleCardAction(paymentIntentClientSecret);
+    ): Promise<HandleNextActionResult> => {
+      return handleNextAction(paymentIntentClientSecret);
     },
     []
   );
@@ -229,12 +235,53 @@ export function useStripe() {
       return openApplePaySetup();
     }, []);
 
+  const _collectBankAccountForPayment = useCallback(
+    async (
+      clientSecret: string,
+      params: CollectBankAccountParams
+    ): Promise<ConfirmPaymentResult> => {
+      return collectBankAccountForPayment(clientSecret, params);
+    },
+    []
+  );
+
+  const _collectBankAccountForSetup = useCallback(
+    async (
+      clientSecret: string,
+      params: CollectBankAccountParams
+    ): Promise<ConfirmSetupIntentResult> => {
+      return collectBankAccountForSetup(clientSecret, params);
+    },
+    []
+  );
+
+  const _verifyMicrodepositsForPayment = useCallback(
+    async (
+      clientSecret: string,
+      params: VerifyMicrodepositsParams
+    ): Promise<ConfirmPaymentResult> => {
+      return verifyMicrodepositsForPayment(clientSecret, params);
+    },
+    []
+  );
+
+  const _verifyMicrodepositsForSetup = useCallback(
+    async (
+      clientSecret: string,
+      params: VerifyMicrodepositsParams
+    ): Promise<ConfirmSetupIntentResult> => {
+      return verifyMicrodepositsForSetup(clientSecret, params);
+    },
+    []
+  );
+
   return {
     retrievePaymentIntent: _retrievePaymentIntent,
     retrieveSetupIntent: _retrieveSetupIntent,
     confirmPayment: _confirmPayment,
     createPaymentMethod: _createPaymentMethod,
-    handleCardAction: _handleCardAction,
+    handleNextAction: _handleNextAction,
+    handleCardAction: _handleNextAction,
     isApplePaySupported: isApplePaySupported,
     presentApplePay: _presentApplePay,
     confirmApplePayPayment: _confirmApplePayPayment,
@@ -251,5 +298,9 @@ export function useStripe() {
     presentGooglePay: _presentGooglePay,
     createGooglePayPaymentMethod: _createGooglePayPaymentMethod,
     openApplePaySetup: _openApplePaySetup,
+    collectBankAccountForPayment: _collectBankAccountForPayment,
+    collectBankAccountForSetup: _collectBankAccountForSetup,
+    verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,
+    verifyMicrodepositsForSetup: _verifyMicrodepositsForSetup,
   };
 }

package/src/types/Card.ts

@@ -38,6 +38,7 @@ export namespace Card {
   }
 
   export interface Params {
+    id: string;
     country: string;
     brand: Card.Brand;
     currency?: string;

package/src/types/NextAction.ts

@@ -0,0 +1,44 @@
+export type NextAction =
+  | VerifyWithMicrodepositsAction
+  | UrlRedirectAction
+  | WeChatRedirectAction
+  | AlipayRedirectAction
+  | BoletoVoucherAction
+  | OxxoVoucherAction;
+
+export type VerifyWithMicrodepositsAction = {
+  type: 'verifyWithMicrodeposits';
+  redirectUrl: string;
+  microdepositType: string;
+  arrivalDate: string;
+};
+
+export type UrlRedirectAction = {
+  type: 'urlRedirect';
+  redirectUrl: string;
+};
+
+export type WeChatRedirectAction = {
+  type: 'weChatRedirect';
+  redirectUrl: string;
+};
+
+export type AlipayRedirectAction = {
+  type: 'alipayRedirect';
+  redirectUrl: string;
+  nativeRedirectUrl: string;
+};
+
+export type BoletoVoucherAction = {
+  type: 'boletoVoucher';
+  expiration: number;
+  voucherURL: string;
+  voucherNumber: string;
+};
+
+export type OxxoVoucherAction = {
+  type: 'oxxoVoucher';
+  expiration: number;
+  voucherURL: string;
+  voucherNumber: string;
+};

package/src/types/PaymentIntents.ts

@@ -1,4 +1,5 @@
 import type { Nullable, StripeError } from '.';
+import type { NextAction } from './NextAction';
 import type { PaymentMethod } from './PaymentMethods';
 
 export interface PaymentIntent {
@@ -17,6 +18,7 @@ export interface PaymentIntent {
   confirmationMethod: 'Automatic' | 'Manual';
   lastPaymentError: Nullable<PaymentIntents.LastPaymentError>;
   shipping: Nullable<PaymentIntents.ShippingDetails>;
+  nextAction: NextAction | null;
 }
 
 export namespace PaymentIntents {

package/src/types/PaymentMethods.ts

@@ -1,7 +1,7 @@
 import type { AuBECSDebitFormComponent } from './components/AuBECSDebitForm';
 import type { Card } from './Card';
 import type { PaymentIntents } from './PaymentIntents';
-
+import type { BankAcccountHolderType, BankAcccountType } from './index';
 export interface PaymentMethod {
   id: string;
   liveMode: boolean;
@@ -33,8 +33,10 @@ export namespace PaymentMethodCreateParams {
     | GrabPayParams
     | FPXParams
     | AfterpayClearpayParams
+    | KlarnaParams
     // | WeChatPayParams
-    | BancontactParams;
+    | BancontactParams
+    | USBankAccountParams;
 
   export type BillingDetails = {
     email?: string;
@@ -124,6 +126,12 @@ export namespace PaymentMethodCreateParams {
     shippingDetails: ShippingDetails;
   }
 
+  export type KlarnaParams = {
+    type: 'Klarna';
+    billingDetails: Pick<Required<BillingDetails>, 'email' | 'addressCountry'> &
+      BillingDetails;
+  };
+
   export interface EpsParams extends Required<BaseParams> {
     type: 'Eps';
   }
@@ -141,6 +149,21 @@ export namespace PaymentMethodCreateParams {
     type: 'AuBecsDebit';
     formDetails: AuBECSDebitFormComponent.FormDetails;
   }
+
+  /** Before using this payment method type, ensure you have already collected the bank information
+   * for this intent with `collectBankAccountForPayment`. Otherwise, you will need to pass in the bank account
+   * details manually.*/
+  export type USBankAccountParams = {
+    type: 'USBankAccount';
+    billingDetails?: Pick<Required<BillingDetails>, 'name'> & BillingDetails;
+    accountNumber?: string;
+    routingNumber?: string;
+    /** Defaults to Individual */
+    accountHolderType?: BankAcccountHolderType;
+    /** Defaults to Checking */
+    accountType?: BankAcccountType;
+    setupFutureUsage?: PaymentIntents.FutureUsage;
+  };
 }
 
 export declare namespace PaymentMethods {
@@ -206,6 +229,18 @@ export declare namespace PaymentMethods {
     vpa?: string;
   }
 
+  export type USBankAccount = {
+    routingNumber?: string;
+    accountHolderType?: BankAcccountHolderType;
+    accountType?: BankAcccountType;
+    last4?: string;
+    bankName?: string;
+    linkedAccount?: string;
+    fingerprint?: string;
+    preferredNetwork?: string;
+    supportedNetworks?: string[];
+  };
+
   export type Types =
     | 'AfterpayClearpay'
     | 'Card'
@@ -224,5 +259,6 @@ export declare namespace PaymentMethods {
     | 'Oxxo'
     | 'Sofort'
     | 'Upi'
+    | 'USBankAccount'
     | 'Unknown';
 }

package/src/types/SetupIntent.ts

@@ -1,6 +1,11 @@
 import type { Nullable, StripeError } from '.';
 import type { AuBECSDebitFormComponent } from './components/AuBECSDebitForm';
-import type { PaymentMethod, PaymentMethods } from './PaymentMethods';
+import type { NextAction } from './NextAction';
+import type {
+  PaymentMethod,
+  PaymentMethods,
+  PaymentMethodCreateParams,
+} from './PaymentMethods';
 
 export interface SetupIntent {
   id: string;
@@ -13,6 +18,7 @@ export interface SetupIntent {
   paymentMethodTypes: PaymentMethods.Types[];
   usage: SetupIntents.FutureUsage;
   description: Nullable<string>;
+  nextAction: NextAction | null;
 }
 
 export namespace ConfirmSetupIntent {
@@ -26,7 +32,8 @@ export namespace ConfirmSetupIntent {
     | BancontactParams
     | SofortParams
     | AuBecsDebitParams
-    | SepaParams;
+    | SepaParams
+    | PaymentMethodCreateParams.USBankAccountParams;
 
   export interface Options {}
 

package/src/types/index.ts

@@ -13,7 +13,10 @@ import type {
   StripeError,
 } from './Errors';
 import type { PaymentIntent } from './PaymentIntents';
-import type { PaymentMethod } from './PaymentMethods';
+import type {
+  PaymentMethod,
+  PaymentMethodCreateParams,
+} from './PaymentMethods';
 import type { PaymentSheet } from './PaymentSheet';
 import type { SetupIntent } from './SetupIntent';
 import type { ThreeDSecureConfigurationParams } from './ThreeDSecure';
@@ -91,7 +94,7 @@ export type ConfirmPaymentResult =
       error: StripeError<ConfirmPaymentError>;
     };
 
-export type HandleCardActionResult =
+export type HandleNextActionResult =
   | {
       paymentIntent: PaymentIntent;
       error?: undefined;
@@ -171,10 +174,14 @@ export type ApplePayResult =
 
 export interface InitStripeParams {
   publishableKey: string;
-  stripeAccountId?: string;
-  threeDSecureParams?: ThreeDSecureConfigurationParams;
   merchantIdentifier?: string;
+  threeDSecureParams?: ThreeDSecureConfigurationParams;
+  stripeAccountId?: string;
   urlScheme?: string;
+  setReturnUrlSchemeOnAndroid?: boolean;
+  /**
+   * @deprecated Use setReturnUrlSchemeOnAndroid instead
+   */
   setUrlSchemeOnAndroid?: boolean;
 }
 
@@ -224,10 +231,13 @@ export type CreateTokenCardParams = {
   type: 'Card';
   address?: Card.Address;
   name?: string;
+  currency?: string;
 };
 
 export type BankAcccountHolderType = 'Company' | 'Individual';
 
+export type BankAcccountType = 'Checking' | 'Savings';
+
 export type CreateTokenBankAccountParams = {
   type: 'BankAccount';
   accountHolderName?: string;
@@ -237,3 +247,21 @@ export type CreateTokenBankAccountParams = {
   currency: string;
   routingNumber?: string;
 };
+
+export type VerifyMicrodepositsParams =
+  | {
+      amounts: number[];
+      descriptorCode?: undefined;
+    }
+  | {
+      amounts?: undefined;
+      descriptorCode: string;
+    };
+
+export type CollectBankAccountParams =
+  PaymentMethodCreateParams.USBankAccountParams & {
+    billingDetails: {
+      name: string;
+      email?: string;
+    };
+  };

package/stripe-react-native.podspec

@@ -10,11 +10,12 @@ Pod::Spec.new do |s|
   s.license      = package['license']
   s.authors      = package['author']
 
-  s.platforms    = { ios: '11.0' }
+  s.platforms    = { ios: '12.0' }
   s.source       = { git: 'https://github.com/stripe/stripe-react-native.git', tag: s.version.to_s }
 
   s.source_files = 'ios/**/*.{h,m,mm,swift}'
 
   s.dependency 'React-Core'
-  s.dependency 'Stripe', '~> 21.12.0'
+  s.dependency 'Stripe', '~> 22.0.0'
+  s.dependency 'StripeConnections', '~> 22.0.0'
 end