@stripe/stripe-react-native 0.5.0 → 0.6.0

package/lib/typescript/src/types/PaymentMethods.d.ts

@@ -1,6 +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;
@@ -17,7 +18,7 @@ export interface PaymentMethod {
     Upi: PaymentMethods.Upi;
 }
 export declare namespace PaymentMethodCreateParams {
-    type Params = CardParams | IdealParams | OxxoParams | P24Params | AlipayParams | GiropayParams | SepaParams | EpsParams | AuBecsDebitParams | SofortParams | GrabPayParams | FPXParams | AfterpayClearpayParams | KlarnaParams | BancontactParams;
+    type Params = CardParams | IdealParams | OxxoParams | P24Params | AlipayParams | GiropayParams | SepaParams | EpsParams | AuBecsDebitParams | SofortParams | GrabPayParams | FPXParams | AfterpayClearpayParams | KlarnaParams | BancontactParams | USBankAccountParams;
     type BillingDetails = {
         email?: string;
         name?: string;
@@ -109,6 +110,20 @@ export declare 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.*/
+    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 {
     interface BillingDetails {
@@ -163,5 +178,16 @@ export declare namespace PaymentMethods {
     interface Upi {
         vpa?: string;
     }
-    type Types = 'AfterpayClearpay' | 'Card' | 'Alipay' | 'GrabPay' | 'Ideal' | 'Fpx' | 'CardPresent' | 'SepaDebit' | 'AuBecsDebit' | 'BacsDebit' | 'Giropay' | 'P24' | 'Eps' | 'Bancontact' | 'Oxxo' | 'Sofort' | 'Upi' | 'Unknown';
+    type USBankAccount = {
+        routingNumber?: string;
+        accountHolderType?: BankAcccountHolderType;
+        accountType?: BankAcccountType;
+        last4?: string;
+        bankName?: string;
+        linkedAccount?: string;
+        fingerprint?: string;
+        preferredNetwork?: string;
+        supportedNetworks?: string[];
+    };
+    type Types = 'AfterpayClearpay' | 'Card' | 'Alipay' | 'GrabPay' | 'Ideal' | 'Fpx' | 'CardPresent' | 'SepaDebit' | 'AuBecsDebit' | 'BacsDebit' | 'Giropay' | 'P24' | 'Eps' | 'Bancontact' | 'Oxxo' | 'Sofort' | 'Upi' | 'USBankAccount' | 'Unknown';
 }

package/lib/typescript/src/types/SetupIntent.d.ts

@@ -1,6 +1,7 @@
 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;
     clientSecret: string;
@@ -12,12 +13,13 @@ export interface SetupIntent {
     paymentMethodTypes: PaymentMethods.Types[];
     usage: SetupIntents.FutureUsage;
     description: Nullable<string>;
+    nextAction: NextAction | null;
 }
 export declare namespace ConfirmSetupIntent {
     type LastPaymentError = StripeError<string> & {
         paymentMethod: PaymentMethod;
     };
-    type Params = CardParams | IdealParams | BancontactParams | SofortParams | AuBecsDebitParams | SepaParams;
+    type Params = CardParams | IdealParams | BancontactParams | SofortParams | AuBecsDebitParams | SepaParams | PaymentMethodCreateParams.USBankAccountParams;
     interface Options {
     }
     interface BaseParams {

package/lib/typescript/src/types/index.d.ts

@@ -1,7 +1,7 @@
 import type { Card } from './Card';
 import type { ApplePayError, CardActionError, ConfirmPaymentError, ConfirmSetupIntentError, CreatePaymentMethodError, CreateTokenError, GooglePayError, PaymentSheetError, RetrievePaymentIntentError, RetrieveSetupIntentError, 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';
@@ -162,6 +162,7 @@ export declare type CreateTokenCardParams = {
     currency?: string;
 };
 export declare type BankAcccountHolderType = 'Company' | 'Individual';
+export declare type BankAcccountType = 'Checking' | 'Savings';
 export declare type CreateTokenBankAccountParams = {
     type: 'BankAccount';
     accountHolderName?: string;
@@ -171,3 +172,16 @@ export declare type CreateTokenBankAccountParams = {
     currency: string;
     routingNumber?: string;
 };
+export declare type VerifyMicrodepositsParams = {
+    amounts: number[];
+    descriptorCode?: undefined;
+} | {
+    amounts?: undefined;
+    descriptorCode: string;
+};
+export declare type CollectBankAccountParams = PaymentMethodCreateParams.USBankAccountParams & {
+    billingDetails: {
+        name: string;
+        email?: string;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",
@@ -29,7 +29,7 @@
     "bootstrap": "yarn example && yarn && yarn pods",
     "bootstrap-no-pods": "yarn example && yarn",
     "docs": "yarn typedoc ./src/index.tsx --out ./docs/api-reference --tsconfig ./tsconfig.json --readme none",
-    "run-example-ios": "cd example;ENVFILE=.env.ci react-native run-ios --configuration Release --simulator \"iPhone 12\"",
+    "run-example-ios": "cd example;ENVFILE=.env.ci react-native run-ios --configuration Release --simulator \"iPhone 13 (15.2)\"",
     "run-example-android": "cd example;ENVFILE=.env.ci react-native run-android --variant=release",
     "test:ios": "mkdir -p .tmp/screenshots && node ./run-appium-tests.js ios",
     "test:android": "mkdir -p .tmp/screenshots && node ./run-appium-tests.js android"
@@ -58,7 +58,7 @@
     "@wdio/mocha-framework": "^7.16.15",
     "@wdio/spec-reporter": "^7.16.14",
     "@wdio/sync": "^7.16.15",
-    "appium": "^1.22.1",
+    "appium": "^1.22.2",
     "appium-chromedriver": "4.26.2",
     "eslint": "^7.14.0",
     "eslint-config-prettier": "^6.11.0",

package/src/NativeStripeSdk.tsx

@@ -23,6 +23,8 @@ import type {
   GooglePay,
   OpenApplePaySetupResult,
   CreateTokenParams,
+  VerifyMicrodepositsParams,
+  CollectBankAccountParams,
 } from './types';
 
 type NativeStripeSdkType = {
@@ -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/functions.ts

@@ -6,6 +6,8 @@ import {
   ApplePayError,
   ApplePayResult,
   ConfirmPaymentResult,
+  ConfirmPaymentError,
+  ConfirmSetupIntentError,
   ConfirmPaymentSheetPaymentResult,
   ConfirmSetupIntent,
   ConfirmSetupIntentResult,
@@ -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,
@@ -339,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> => {
@@ -478,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

@@ -23,6 +23,8 @@ import type {
   CreateGooglePayPaymentMethodResult,
   OpenApplePaySetupResult,
   CreateTokenParams,
+  VerifyMicrodepositsParams,
+  CollectBankAccountParams,
 } from '../types';
 import { useCallback, useEffect, useState } from 'react';
 import { isiOS } from '../helpers';
@@ -48,6 +50,10 @@ import {
   createGooglePayPaymentMethod,
   presentGooglePay,
   openApplePaySetup,
+  collectBankAccountForPayment,
+  collectBankAccountForSetup,
+  verifyMicrodepositsForPayment,
+  verifyMicrodepositsForSetup,
 } from '../functions';
 
 /**
@@ -229,6 +235,46 @@ 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,
@@ -252,5 +298,9 @@ export function useStripe() {
     presentGooglePay: _presentGooglePay,
     createGooglePayPaymentMethod: _createGooglePayPaymentMethod,
     openApplePaySetup: _openApplePaySetup,
+    collectBankAccountForPayment: _collectBankAccountForPayment,
+    collectBankAccountForSetup: _collectBankAccountForSetup,
+    verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,
+    verifyMicrodepositsForSetup: _verifyMicrodepositsForSetup,
   };
 }

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;
@@ -35,7 +35,8 @@ export namespace PaymentMethodCreateParams {
     | AfterpayClearpayParams
     | KlarnaParams
     // | WeChatPayParams
-    | BancontactParams;
+    | BancontactParams
+    | USBankAccountParams;
 
   export type BillingDetails = {
     email?: string;
@@ -148,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 {
@@ -213,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'
@@ -231,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';
@@ -233,6 +236,8 @@ export type CreateTokenCardParams = {
 
 export type BankAcccountHolderType = 'Company' | 'Individual';
 
+export type BankAcccountType = 'Checking' | 'Savings';
+
 export type CreateTokenBankAccountParams = {
   type: 'BankAccount';
   accountHolderName?: string;
@@ -242,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.13.0'
+  s.dependency 'Stripe', '~> 22.0.0'
+  s.dependency 'StripeConnections', '~> 22.0.0'
 end