@stripe/stripe-react-native 0.16.0 → 0.18.1

package/src/functions.ts

@@ -35,6 +35,7 @@ import {
   IsCardInWalletResult,
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
+  FinancialConnections,
 } from './types';
 
 const APPLE_PAY_NOT_SUPPORTED_MESSAGE =
@@ -138,9 +139,17 @@ export const retrieveSetupIntent = async (
   }
 };
 
+/**
+ * Confirm and, if necessary, authenticate a PaymentIntent.
+ *
+ * @param paymentIntentClientSecret The client_secret of the associated [PaymentIntent](https://stripe.com/docs/api/payment_intents).
+ * @param params 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](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method).
+ * @param options An optional object that contains options for this payment method.
+ * @returns A promise that resolves to an object containing either a `paymentIntent` field, or an `error` field.
+ */
 export const confirmPayment = async (
   paymentIntentClientSecret: string,
-  params: PaymentIntent.ConfirmParams,
+  params?: PaymentIntent.ConfirmParams,
   options: PaymentIntent.ConfirmOptions = {}
 ): Promise<ConfirmPaymentResult> => {
   try {
@@ -567,6 +576,63 @@ 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 clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @returns A promise that resolves to an object containing either `session` and `token` fields, or an error field.
+ */
+export const collectBankAccountToken = async (
+  clientSecret: string
+): Promise<FinancialConnections.TokenResult> => {
+  try {
+    const { session, token, error } =
+      await NativeStripeSdk.collectBankAccountToken(clientSecret);
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      session: session!,
+      token: token!,
+    };
+  } catch (error: any) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
+/**
+ * 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 clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @returns A promise that resolves to an object containing either a `session` field, or an error field.
+ */
+export const collectFinancialConnectionsAccounts = async (
+  clientSecret: string
+): Promise<FinancialConnections.SessionResult> => {
+  try {
+    const { session, error } =
+      await NativeStripeSdk.collectFinancialConnectionsAccounts(clientSecret);
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      session: session!,
+    };
+  } catch (error: any) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
 export const canAddCardToWallet = async (
   params: CanAddCardToWalletParams
 ): Promise<CanAddCardToWalletResult> => {

package/src/hooks/useConfirmPayment.tsx

@@ -1,5 +1,5 @@
 import { useCallback, useState } from 'react';
-import type { PaymentMethod } from '../types';
+import type { PaymentIntent } from '../types';
 import { useStripe } from './useStripe';
 
 /**
@@ -12,8 +12,8 @@ export function useConfirmPayment() {
   const _confirmPayment = useCallback(
     async (
       paymentIntentClientSecret: string,
-      data: PaymentMethod.ConfirmParams,
-      options: PaymentMethod.ConfirmOptions = {}
+      data?: PaymentIntent.ConfirmParams,
+      options: PaymentIntent.ConfirmOptions = {}
     ) => {
       setLoading(true);
 

package/src/hooks/useFinancialConnectionsSheet.tsx

@@ -0,0 +1,34 @@
+import { useState } from 'react';
+import { useStripe } from './useStripe';
+
+/**
+ * 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).
+ */
+export function useFinancialConnectionsSheet() {
+  const [loading, setLoading] = useState(false);
+  const { collectBankAccountToken, collectFinancialConnectionsAccounts } =
+    useStripe();
+
+  const _collectBankAccountToken = async (clientSecret: string) => {
+    setLoading(true);
+    const result = await collectBankAccountToken(clientSecret);
+    setLoading(false);
+    return result;
+  };
+
+  const _collectFinancialConnectionsAccounts = async (clientSecret: string) => {
+    setLoading(true);
+    const result = await collectFinancialConnectionsAccounts(clientSecret);
+    setLoading(false);
+    return result;
+  };
+
+  return {
+    collectBankAccountToken: _collectBankAccountToken,
+    collectFinancialConnectionsAccounts: _collectFinancialConnectionsAccounts,
+    loading,
+  };
+}

package/src/hooks/useStripe.tsx

@@ -1,5 +1,6 @@
 import type {
   PaymentMethod,
+  PaymentIntent,
   ApplePay,
   PaymentSheet,
   CreatePaymentMethodResult,
@@ -30,6 +31,7 @@ import type {
   CollectBankAccountForPaymentResult,
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
+  FinancialConnections,
 } from '../types';
 import { useCallback, useEffect, useState } from 'react';
 import { isiOS } from '../helpers';
@@ -60,6 +62,8 @@ import {
   verifyMicrodepositsForPayment,
   verifyMicrodepositsForSetup,
   canAddCardToWallet,
+  collectBankAccountToken,
+  collectFinancialConnectionsAccounts,
 } from '../functions';
 
 /**
@@ -114,8 +118,8 @@ export function useStripe() {
   const _confirmPayment = useCallback(
     async (
       paymentIntentClientSecret: string,
-      data: PaymentMethod.ConfirmParams,
-      options: PaymentMethod.ConfirmOptions = {}
+      data?: PaymentIntent.ConfirmParams,
+      options: PaymentIntent.ConfirmOptions = {}
     ): Promise<ConfirmPaymentResult> => {
       return confirmPayment(paymentIntentClientSecret, data, options);
     },
@@ -290,6 +294,22 @@ export function useStripe() {
     []
   );
 
+  const _collectBankAccountToken = useCallback(
+    async (clientSecret: string): Promise<FinancialConnections.TokenResult> => {
+      return collectBankAccountToken(clientSecret);
+    },
+    []
+  );
+
+  const _collectFinancialConnectionsAccounts = useCallback(
+    async (
+      clientSecret: string
+    ): Promise<FinancialConnections.SessionResult> => {
+      return collectFinancialConnectionsAccounts(clientSecret);
+    },
+    []
+  );
+
   return {
     retrievePaymentIntent: _retrievePaymentIntent,
     retrieveSetupIntent: _retrieveSetupIntent,
@@ -317,5 +337,7 @@ export function useStripe() {
     verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,
     verifyMicrodepositsForSetup: _verifyMicrodepositsForSetup,
     canAddCardToWallet: _canAddCardToWallet,
+    collectBankAccountToken: _collectBankAccountToken,
+    collectFinancialConnectionsAccounts: _collectFinancialConnectionsAccounts,
   };
 }

package/src/index.tsx

@@ -5,6 +5,7 @@ export { useStripe } from './hooks/useStripe';
 export { useApplePay, Props as UseApplePayProps } from './hooks/useApplePay';
 export { usePaymentSheet } from './hooks/usePaymentSheet';
 export { useGooglePay } from './hooks/useGooglePay';
+export { useFinancialConnectionsSheet } from './hooks/useFinancialConnectionsSheet';
 
 //components
 export {

package/src/types/FinancialConnections.ts

@@ -0,0 +1,126 @@
+import type { BankAccount } from './Token';
+import type { StripeError } from './Errors';
+
+export type SessionResult =
+  | {
+      /** The updated Financial Connections Session object. */
+      session: Session;
+      error?: undefined;
+    }
+  | {
+      session?: undefined;
+      error: StripeError<FinancialConnectionsSheetError>;
+    };
+
+export type TokenResult =
+  | {
+      /** The updated Financial Connections Session object. */
+      session: Session;
+      /** The Stripe token object associated with the bank account. */
+      token: BankAccountToken;
+      error?: undefined;
+    }
+  | {
+      session?: undefined;
+      token?: undefined;
+      error: StripeError<FinancialConnectionsSheetError>;
+    };
+
+export type Session = {
+  /** A unique ID for this session. */
+  id: string;
+  /** The client secret for this session. */
+  clientSecret: string;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  /** The accounts that were collected as part of this Session. */
+  accounts: Array<Account>;
+};
+
+export type BankAccountToken = {
+  /** Bank account details. */
+  bankAccount: BankAccount | null;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  /** A unique ID for this token. */
+  id: string | null;
+  used: boolean;
+  type: 'BankAccount';
+  /** The UNIX timestamp (in milliseconds) of the date this token was created. */
+  created: number | null;
+};
+
+export type Account = {
+  /** A unique ID for this Financial Connections Account. */
+  id: string;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  displayName: string | null;
+  /** The current status of the account. Either active, inactive, or disconnected. */
+  status: AccountStatus;
+  institutionName: string;
+  last4: string | null;
+  /** The UNIX timestamp (in milliseconds) of the date this account was created. */
+  created: number;
+  /** The balance of this account. */
+  balance: Balance | null;
+  /** The last balance refresh. Includes the timestamp and the status. */
+  balanceRefresh: BalanceRefresh | null;
+  /** The category of this account, either cash, credit, investment, or other. */
+  category: Category;
+  /** The subcategory of this account, either checking, credit_card, line_of_credit, mortgage, savings, or other. */
+  subcategory: Subcategory;
+  /** Permissions requested for accounts collected during this session. */
+  permissions: Array<Permission> | null;
+  /** The supported payment method types for this account. */
+  supportedPaymentMethodTypes: Array<PaymentMethodType>;
+};
+
+export type AccountStatus = 'active' | 'inactive' | 'disconnected';
+
+export type Category = 'cash' | 'credit' | 'investment' | 'other';
+
+export type PaymentMethodType = 'us_bank_account' | 'link';
+
+export type Subcategory =
+  | 'checking'
+  | 'credit_card'
+  | 'line_of_credit'
+  | 'mortgage'
+  | 'other'
+  | 'savings';
+
+export type Permission =
+  | 'balances'
+  | 'ownership'
+  | 'payment_method'
+  | 'transactions'
+  | 'account_numbers';
+
+export type Balance = {
+  /** The UNIX timestamp (in milliseconds) of time that the external institution calculated this balance. */
+  asOf: number;
+  /** The type of this balance, either cash or credit. */
+  type: BalanceType;
+  /** The funds available to the account holder. Typically this is the current balance less any holds.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is an integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  cash: { available: Map<String, number> | null };
+  /** The credit that has been used by the account holder.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  credit: { used: Map<String, number> | null };
+  /** The balances owed to (or by) the account holder.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  current: Map<String, number>;
+};
+
+export type BalanceRefresh = {
+  status: BalanceRefreshStatus;
+  /** The UNIX timestamp (in milliseconds) of the time at which the last refresh attempt was initiated. */
+  lastAttemptedAt: number;
+};
+
+export type BalanceType = 'cash' | 'credit';
+
+export type BalanceRefreshStatus = 'failed' | 'pending' | 'succeeded';
+
+export enum FinancialConnectionsSheetError {
+  Failed = 'Failed',
+  Canceled = 'Canceled',
+}

package/src/types/PaymentIntent.ts

@@ -7,6 +7,7 @@ import type * as PaymentMethod from './PaymentMethod';
 export interface Result {
   id: string;
   amount: number;
+  /** The UNIX timestamp (in milliseconds) of the date this PaymentIntent was created. */
   created: string;
   currency: string;
   status: Status;

package/src/types/SetupIntent.ts

@@ -6,6 +6,7 @@ export interface Result {
   id: string;
   clientSecret: string;
   lastSetupError: LastPaymentError | null;
+  /** The UNIX timestamp (in milliseconds) of the date this Setup Intent was created. */
   created: string | null;
   livemode: boolean;
   paymentMethodId: string | null;

package/src/types/Token.ts

@@ -20,6 +20,7 @@ export type Type =
 
 export interface Result {
   id: string;
+  /** The UNIX timestamp (in milliseconds) of the date this token was created. */
   created: string;
   type: Type;
   used: boolean;
@@ -29,15 +30,31 @@ export interface Result {
 }
 
 export interface BankAccount {
-  bankName: string;
-  accountHolderName: string;
-  accountHolderType: BankAcccountHolderType;
-  currency: string;
-  country: string;
-  routingNumber: string;
-  status: 'Errored' | 'New' | 'Validated' | 'VerificationFailed' | 'Verified';
+  /** A unique ID for this bank account. */
+  id: string;
+  /** The name of the associated bank. */
+  bankName: string | null;
+  /** The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object. */
+  accountHolderName: string | null;
+  /** The type of entity that holds the account. */
+  accountHolderType: BankAcccountHolderType | null;
+  /** The currency the bank account is in. This must be a country/currency pairing that Stripe supports. */
+  currency: string | null;
+  /** The country in which the bank account is located. */
+  country: string | null;
+  routingNumber: string | null;
+  status: BankAccountStatus | null;
+  fingerprint: string | null;
+  last4: string | null;
 }
 
+export type BankAccountStatus =
+  | 'Errored'
+  | 'New'
+  | 'Validated'
+  | 'VerificationFailed'
+  | 'Verified';
+
 export interface Card {
   country: string;
   brand: CardBrand;

package/src/types/index.ts

@@ -25,6 +25,7 @@ import * as AuBECSDebitFormComponent from './components/AuBECSDebitFormComponent
 import * as CardFieldInput from './components/CardFieldInput';
 import * as CardFormView from './components/CardFormView';
 import * as Token from './Token';
+import * as FinancialConnections from './FinancialConnections';
 
 export {
   ApplePay,
@@ -39,6 +40,7 @@ export {
   CardFieldInput,
   CardFormView,
   Token,
+  FinancialConnections,
 };
 
 export * from './Errors';

package/stripe-react-native.podspec

@@ -1,7 +1,7 @@
 require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
-stripe_version = '~> 22.5.1'
+stripe_version = '~> 22.7.0'
 
 Pod::Spec.new do |s|
   s.name         = 'stripe-react-native'