@stripe/stripe-react-native 0.41.0 → 0.42.0

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

@@ -58,12 +58,16 @@ export declare type MandateData = {
         };
     };
 };
+declare type MetaData = {
+    [key: string]: string;
+};
 export declare type CardParams = {
     paymentMethodType: 'Card';
     paymentMethodData?: {
         token?: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 } | {
     paymentMethodType: 'Card';
@@ -72,6 +76,7 @@ export declare type CardParams = {
         cvc?: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export interface IdealParams {
@@ -80,6 +85,7 @@ export interface IdealParams {
         bankName?: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface FPXParams {
@@ -87,12 +93,14 @@ export interface FPXParams {
     paymentMethodData?: {
         testOfflineBank?: boolean;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface AlipayParams {
     paymentMethodType: 'Alipay';
     paymentMethodData?: {
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface OxxoParams {
@@ -100,6 +108,7 @@ export interface OxxoParams {
     paymentMethodData: {
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface SofortParams {
@@ -108,6 +117,7 @@ export interface SofortParams {
         country: string;
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface GrabPayParams {
@@ -115,6 +125,7 @@ export interface GrabPayParams {
     paymentMethodData?: {
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface BancontactParams {
@@ -122,6 +133,7 @@ export interface BancontactParams {
     paymentMethodData: {
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface SepaParams {
@@ -130,6 +142,7 @@ export interface SepaParams {
         iban: string;
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface GiropayParams {
@@ -137,6 +150,7 @@ export interface GiropayParams {
     paymentMethodData: {
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface AfterpayClearpayParams {
@@ -145,6 +159,7 @@ export interface AfterpayClearpayParams {
         shippingDetails: BillingDetails;
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export declare type KlarnaParams = {
@@ -155,6 +170,7 @@ export declare type KlarnaParams = {
         } & BillingDetails;
         shippingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export interface EpsParams {
@@ -162,6 +178,7 @@ export interface EpsParams {
     paymentMethodData: {
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface P24Params {
@@ -169,6 +186,7 @@ export interface P24Params {
     paymentMethodData: {
         billingDetails: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface WeChatPayParams {
@@ -177,6 +195,7 @@ export interface WeChatPayParams {
         appId: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 }
 export interface AuBecsDebitParams {
@@ -193,6 +212,7 @@ export declare type AffirmParams = {
         shippingDetails?: BillingDetails;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 /**
@@ -210,6 +230,7 @@ export declare type USBankAccountParams = {
         /** Defaults to Checking */
         accountType?: BankAcccountType;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export declare type PayPalParams = {
@@ -217,6 +238,7 @@ export declare type PayPalParams = {
     paymentMethodData?: {
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export declare type CashAppParams = {
@@ -224,6 +246,7 @@ export declare type CashAppParams = {
     paymentMethodData?: {
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export declare type RevolutPayParams = {
@@ -231,6 +254,7 @@ export declare type RevolutPayParams = {
     paymentMethodData?: {
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
 export declare type CollectBankAccountParams = {
@@ -241,5 +265,7 @@ export declare type CollectBankAccountParams = {
             email?: string;
         };
         mandateData?: MandateData;
+        metadata?: MetaData;
     };
 };
+export {};

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

@@ -2,6 +2,7 @@ import type { FormDetails } from './components/AuBECSDebitFormComponent';
 import type { CardBrand, BankAcccountHolderType, BankAcccountType } from './Token';
 import type { FutureUsage } from './PaymentIntent';
 import type { Address, BillingDetails } from './Common';
+import type { FinancialConnectionsEvent } from './FinancialConnections';
 export interface Result {
     id: string;
     liveMode: boolean;
@@ -234,4 +235,10 @@ export declare type CollectBankAccountParams = {
             email?: string;
         };
     };
+    /** An optional event listener to receive @type {FinancialConnectionEvent} for specific events during the process of a user connecting their financial accounts. */
+    onEvent?: (event: FinancialConnectionsEvent) => void;
+};
+export declare type CollectBankAccountTokenParams = {
+    /** An optional event listener to receive @type {FinancialConnectionEvent} for specific events during the process of a user connecting their financial accounts. */
+    onEvent?: (event: FinancialConnectionsEvent) => void;
 };

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

@@ -4,7 +4,7 @@ import type { ButtonType, RecurringPaymentRequest, AutomaticReloadPaymentRequest
 import type { FutureUsage } from './PaymentIntent';
 import type { Result } from './PaymentMethod';
 import type { StripeError } from './Errors';
-declare type SetupParamsBase = IntentParams & {
+export declare type SetupParamsBase = IntentParams & {
     /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
     merchantDisplayName: string;
     /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.41.0",
+  "version": "0.42.0",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",
@@ -20,7 +20,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 --sort source-order",
-    "run-example-ios": "cd example;react-native run-ios --configuration Release --simulator \"iPhone 15\"",
+    "run-example-ios": "cd example;react-native run-ios --configuration Release --simulator \"iPhone 15 (17.2)\"",
     "run-example-android": "cd example;react-native run-android --variant=release",
     "test:e2e:ios": "bash ./scripts/run-maestro-tests ios",
     "test:e2e:android": "bash ./scripts/run-maestro-tests android",
@@ -148,6 +148,5 @@
   },
   "resolutions": {
     "simple-plist": "1.3.1"
-  },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  }
 }

package/src/NativeStripeSdk.tsx

@@ -84,7 +84,7 @@ type NativeStripeSdkType = {
   collectBankAccount(
     isPaymentIntent: boolean,
     clientSecret: string,
-    params: PaymentMethod.CollectBankAccountParams
+    params: Omit<PaymentMethod.CollectBankAccountParams, 'onEvent'>
   ): Promise<ConfirmSetupIntentResult | ConfirmPaymentResult>;
   getConstants(): { API_VERSIONS: { CORE: string; ISSUING: string } };
   canAddCardToWallet(

package/src/functions.ts

@@ -38,6 +38,8 @@ import {
   NativeModules,
   EmitterSubscription,
 } from 'react-native';
+import type { CollectFinancialConnectionsAccountsParams } from './types/FinancialConnections';
+import type { CollectBankAccountTokenParams } from './types/PaymentMethod';
 
 export const createPaymentMethod = async (
   params: PaymentMethod.CreateParams,
@@ -356,6 +358,7 @@ export const verifyMicrodepositsForSetup = async (
 const eventEmitter = new NativeEventEmitter(NativeModules.StripeSdk);
 let confirmHandlerCallback: EmitterSubscription | null = null;
 let orderTrackingCallbackListener: EmitterSubscription | null = null;
+let financialConnectionsEventListener: EmitterSubscription | null = null;
 
 export const initPaymentSheet = async (
   params: PaymentSheet.SetupParams
@@ -468,6 +471,15 @@ export const collectBankAccountForPayment = async (
   clientSecret: string,
   params: PaymentMethod.CollectBankAccountParams
 ): Promise<CollectBankAccountForPaymentResult> => {
+  financialConnectionsEventListener?.remove();
+
+  if (params.onEvent) {
+    financialConnectionsEventListener = eventEmitter.addListener(
+      'onFinancialConnectionsEvent',
+      params.onEvent
+    );
+  }
+
   try {
     const { paymentIntent, error } = (await NativeStripeSdk.collectBankAccount(
       true,
@@ -475,6 +487,8 @@ export const collectBankAccountForPayment = async (
       params
     )) as CollectBankAccountForPaymentResult;
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -484,6 +498,7 @@ export const collectBankAccountForPayment = async (
       paymentIntent: paymentIntent!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -494,6 +509,15 @@ export const collectBankAccountForSetup = async (
   clientSecret: string,
   params: PaymentMethod.CollectBankAccountParams
 ): Promise<CollectBankAccountForSetupResult> => {
+  financialConnectionsEventListener?.remove();
+
+  if (params.onEvent) {
+    financialConnectionsEventListener = eventEmitter.addListener(
+      'onFinancialConnectionsEvent',
+      params.onEvent
+    );
+  }
+
   try {
     const { setupIntent, error } = (await NativeStripeSdk.collectBankAccount(
       false,
@@ -501,6 +525,8 @@ export const collectBankAccountForSetup = async (
       params
     )) as CollectBankAccountForSetupResult;
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -510,6 +536,7 @@ export const collectBankAccountForSetup = async (
       setupIntent: setupIntent!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -520,15 +547,28 @@ export const collectBankAccountForSetup = async (
  * Use collectBankAccountToken in the [Add a Financial Connections Account to a US Custom Connect](https://stripe.com/docs/financial-connections/connect-payouts) account flow.
  * When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account for payouts.
  * @param {string} clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @param {CollectBankAccountTokenParams} params Optional parameters.
  * @returns A promise that resolves to an object containing either `session` and `token` fields, or an error field.
  */
 export const collectBankAccountToken = async (
-  clientSecret: string
+  clientSecret: string,
+  params: CollectBankAccountTokenParams = {}
 ): Promise<FinancialConnections.TokenResult> => {
+  financialConnectionsEventListener?.remove();
+
+  if (params.onEvent) {
+    financialConnectionsEventListener = eventEmitter.addListener(
+      'onFinancialConnectionsEvent',
+      params.onEvent
+    );
+  }
+
   try {
     const { session, token, error } =
       await NativeStripeSdk.collectBankAccountToken(clientSecret);
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -539,6 +579,7 @@ export const collectBankAccountToken = async (
       token: token!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -549,15 +590,28 @@ export const collectBankAccountToken = async (
  * Use collectFinancialConnectionsAccounts in the [Collect an account to build data-powered products](https://stripe.com/docs/financial-connections/other-data-powered-products) flow.
  * When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account.
  * @param {string} clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @param {CollectFinancialConnectionsAccountsParams} params Optional parameters.
  * @returns A promise that resolves to an object containing either a `session` field, or an error field.
  */
 export const collectFinancialConnectionsAccounts = async (
-  clientSecret: string
+  clientSecret: string,
+  params: CollectFinancialConnectionsAccountsParams = {}
 ): Promise<FinancialConnections.SessionResult> => {
+  financialConnectionsEventListener?.remove();
+
+  if (params.onEvent) {
+    financialConnectionsEventListener = eventEmitter.addListener(
+      'onFinancialConnectionsEvent',
+      params.onEvent
+    );
+  }
+
   try {
     const { session, error } =
       await NativeStripeSdk.collectFinancialConnectionsAccounts(clientSecret);
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -567,6 +621,7 @@ export const collectFinancialConnectionsAccounts = async (
       session: session!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };

package/src/hooks/useFinancialConnectionsSheet.tsx

@@ -1,5 +1,7 @@
 import { useState, useCallback } from 'react';
 import { useStripe } from './useStripe';
+import type { CollectFinancialConnectionsAccountsParams } from 'src/types/FinancialConnections';
+import type { CollectBankAccountTokenParams } from 'src/types/PaymentMethod';
 
 /**
  * React hook for accessing functions on the Financial Connections sheet.
@@ -13,9 +15,9 @@ export function useFinancialConnectionsSheet() {
     useStripe();
 
   const _collectBankAccountToken = useCallback(
-    async (clientSecret: string) => {
+    async (clientSecret: string, params?: CollectBankAccountTokenParams) => {
       setLoading(true);
-      const result = await collectBankAccountToken(clientSecret);
+      const result = await collectBankAccountToken(clientSecret, params);
       setLoading(false);
       return result;
     },
@@ -23,9 +25,15 @@ export function useFinancialConnectionsSheet() {
   );
 
   const _collectFinancialConnectionsAccounts = useCallback(
-    async (clientSecret: string) => {
+    async (
+      clientSecret: string,
+      params?: CollectFinancialConnectionsAccountsParams
+    ) => {
       setLoading(true);
-      const result = await collectFinancialConnectionsAccounts(clientSecret);
+      const result = await collectFinancialConnectionsAccounts(
+        clientSecret,
+        params
+      );
       setLoading(false);
       return result;
     },

package/src/hooks/useStripe.tsx

@@ -60,6 +60,8 @@ import {
   updatePlatformPaySheet,
   openPlatformPaySetup,
 } from '../functions';
+import type { CollectBankAccountTokenParams } from 'src/types/PaymentMethod';
+import type { CollectFinancialConnectionsAccountsParams } from 'src/types/FinancialConnections';
 
 /**
  * useStripe hook
@@ -225,17 +227,21 @@ export function useStripe() {
   );
 
   const _collectBankAccountToken = useCallback(
-    async (clientSecret: string): Promise<FinancialConnections.TokenResult> => {
-      return collectBankAccountToken(clientSecret);
+    async (
+      clientSecret: string,
+      params?: CollectBankAccountTokenParams
+    ): Promise<FinancialConnections.TokenResult> => {
+      return collectBankAccountToken(clientSecret, params);
     },
     []
   );
 
   const _collectFinancialConnectionsAccounts = useCallback(
     async (
-      clientSecret: string
+      clientSecret: string,
+      params?: CollectFinancialConnectionsAccountsParams
     ): Promise<FinancialConnections.SessionResult> => {
-      return collectFinancialConnectionsAccounts(clientSecret);
+      return collectFinancialConnectionsAccounts(clientSecret, params);
     },
     []
   );

package/src/types/FinancialConnections.ts

@@ -1,6 +1,11 @@
 import type { BankAccount } from './Token';
 import type { StripeError } from './Errors';
 
+export type CollectFinancialConnectionsAccountsParams = {
+  /** An optional event listener to receive @type {FinancialConnectionEvent} for specific events during the process of a user connecting their financial accounts. */
+  onEvent?: (event: FinancialConnectionsEvent) => void;
+};
+
 export type SessionResult =
   | {
       /** The updated Financial Connections Session object. */
@@ -124,3 +129,67 @@ export enum FinancialConnectionsSheetError {
   Failed = 'Failed',
   Canceled = 'Canceled',
 }
+
+export type FinancialConnectionsEvent = {
+  /** The event's name. Represents the type of event that has occurred during the Financial Connections process. */
+  name: FinancialConnectionsEventName;
+  /** Event-associated metadata. Provides further detail related to the occurred event. */
+  metadata: FinancialConnectionsEventMetadata;
+};
+
+export enum FinancialConnectionsEventName {
+  /** Invoked when the sheet successfully opens. */
+  Open = 'open',
+  /** Invoked when the manual entry flow is initiated. */
+  ManualEntryInitiated = 'manual_entry_initiated',
+  /** Invoked when "Agree and continue" is selected on the consent pane. */
+  ConsentAcquired = 'consent_acquired',
+  /** Invoked when the search bar is selected, the user inputs search terms, and receives an API response. */
+  SearchInitiated = 'search_initiated',
+  /** Invoked when an institution is selected, either from featured institutions or search results. */
+  InstitutionSelected = 'institution_selected',
+  /** Invoked when the authorization is successfully completed. */
+  InstitutionAuthorized = 'institution_authorized',
+  /** Invoked when accounts are selected and "confirm" is selected. */
+  AccountsSelected = 'accounts_selected',
+  /** Invoked when the flow is completed and selected accounts are correctly connected to the payment instrument. */
+  Success = 'success',
+  /** Invoked when an error is encountered. Refer to error codes for more details. */
+  Error = 'error',
+  /** Invoked when the flow is cancelled, typically by the user pressing the "X" button. */
+  Cancel = 'cancel',
+  /** Invoked when the modal is launched in an external browser. After this event, no other events will be sent until the completion of the browser session. */
+  FlowLaunchedInBrowser = 'flow_launched_in_browser',
+}
+
+export type FinancialConnectionsEventMetadata = {
+  /** A Boolean value that indicates if the user completed the process through the manual entry flow. */
+  manualEntry?: boolean;
+  /** A String value containing the name of the institution that the user selected. */
+  institutionName?: string;
+  /** An ErrorCode value representing the type of error that occurred. */
+  errorCode?: FinancialConnectionsEventErrorCode;
+};
+
+export enum FinancialConnectionsEventErrorCode {
+  /** The system could not retrieve account numbers for selected accounts. */
+  AccountNumbersUnavailable = 'account_numbers_unavailable',
+  /** The system could not retrieve accounts for the selected institution. */
+  AccountsUnavailable = 'accounts_unavailable',
+  /** For payment flows, no debitable account was available at the selected institution. */
+  NoDebitableAccount = 'no_debitable_account',
+  /** Authorization with the selected institution has failed. */
+  AuthorizationFailed = 'authorization_failed',
+  /** The selected institution is down for expected maintenance. */
+  InstitutionUnavailablePlanned = 'institution_unavailable_planned',
+  /** The selected institution is unexpectedly down. */
+  InstitutionUnavailableUnplanned = 'institution_unavailable_unplanned',
+  /** A timeout occurred while communicating with our partner or downstream institutions. */
+  InstitutionTimeout = 'institution_timeout',
+  /** An unexpected error occurred, either in an API call or on the client-side. */
+  UnexpectedError = 'unexpected_error',
+  /** The client secret that powers the session has expired. */
+  SessionExpired = 'session_expired',
+  /** The hCaptcha challenge failed. */
+  FailedBotDetection = 'failed_bot_detection',
+}