@stripe/stripe-react-native 0.41.0 → 0.43.0

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,
@@ -119,9 +121,8 @@ export const retrieveSetupIntent = async (
   clientSecret: string
 ): Promise<RetrieveSetupIntentResult> => {
   try {
-    const { setupIntent, error } = await NativeStripeSdk.retrieveSetupIntent(
-      clientSecret
-    );
+    const { setupIntent, error } =
+      await NativeStripeSdk.retrieveSetupIntent(clientSecret);
     if (error) {
       return {
         error,
@@ -269,9 +270,8 @@ export const createTokenForCVCUpdate = async (
   cvc: string
 ): Promise<CreateTokenForCVCUpdateResult> => {
   try {
-    const { tokenId, error } = await NativeStripeSdk.createTokenForCVCUpdate(
-      cvc
-    );
+    const { tokenId, error } =
+      await NativeStripeSdk.createTokenForCVCUpdate(cvc);
     if (error) {
       return {
         error,
@@ -356,6 +356,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
@@ -420,9 +421,8 @@ export const presentPaymentSheet = async (
   options: PaymentSheet.PresentOptions = {}
 ): Promise<PresentPaymentSheetResult> => {
   try {
-    const { paymentOption, error } = await NativeStripeSdk.presentPaymentSheet(
-      options
-    );
+    const { paymentOption, error } =
+      await NativeStripeSdk.presentPaymentSheet(options);
     if (error) {
       return {
         error,
@@ -468,6 +468,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 +484,8 @@ export const collectBankAccountForPayment = async (
       params
     )) as CollectBankAccountForPaymentResult;
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -484,6 +495,7 @@ export const collectBankAccountForPayment = async (
       paymentIntent: paymentIntent!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -494,6 +506,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 +522,8 @@ export const collectBankAccountForSetup = async (
       params
     )) as CollectBankAccountForSetupResult;
 
+    financialConnectionsEventListener?.remove();
+
     if (error) {
       return {
         error,
@@ -510,6 +533,7 @@ export const collectBankAccountForSetup = async (
       setupIntent: setupIntent!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -520,14 +544,27 @@ 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);
+      await NativeStripeSdk.collectBankAccountToken(clientSecret, params);
+
+    financialConnectionsEventListener?.remove();
 
     if (error) {
       return {
@@ -539,6 +576,7 @@ export const collectBankAccountToken = async (
       token: token!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -549,14 +587,30 @@ 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);
+      await NativeStripeSdk.collectFinancialConnectionsAccounts(
+        clientSecret,
+        params
+      );
+
+    financialConnectionsEventListener?.remove();
 
     if (error) {
       return {
@@ -567,6 +621,7 @@ export const collectFinancialConnectionsAccounts = async (
       session: session!,
     };
   } catch (error: any) {
+    financialConnectionsEventListener?.remove();
     return {
       error: createError(error),
     };
@@ -607,9 +662,8 @@ export const isCardInWallet = async (params: {
   cardLastFour: string;
 }): Promise<IsCardInWalletResult> => {
   try {
-    const { isInWallet, token, error } = await NativeStripeSdk.isCardInWallet(
-      params
-    );
+    const { isInWallet, token, error } =
+      await NativeStripeSdk.isCardInWallet(params);
 
     if (error) {
       return {

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/Common.ts

@@ -38,3 +38,6 @@ export enum CardBrand {
   Visa = 7,
   Unknown = 8,
 }
+
+/** Theme options for colors used in our UI. */
+export type UserInterfaceStyle = 'alwaysLight' | 'alwaysDark' | 'automatic';

package/src/types/CustomerSheet.ts

@@ -47,6 +47,13 @@ export type CustomerSheetInitParams = {
    *  If false, the customer can't delete if they only have one saved payment method remaining.
    */
   allowsRemovalOfLastSavedPaymentMethod?: boolean;
+  /**
+   * By default, CustomerSheet will accept all supported cards by Stripe.
+   * You can specify card brands CustomerSheet should block or allow payment for by providing an array of those card brands.
+   * Note: This is only a client-side solution.
+   * Note: Card brand filtering is not currently supported in Link.
+   */
+  cardBrandAcceptance?: PaymentSheet.CardBrandAcceptance;
 };
 
 export type CustomerSheetPresentParams = {

package/src/types/FinancialConnections.ts

@@ -1,6 +1,14 @@
+import type { UserInterfaceStyle } from './Common';
 import type { BankAccount } from './Token';
 import type { StripeError } from './Errors';
 
+export type CollectFinancialConnectionsAccountsParams = {
+  /** iOS Only. Style options for colors in Financial Connections. By default, the bank account collector will automatically switch between light and dark mode compatible colors based on device settings. */
+  style?: UserInterfaceStyle;
+  /** 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 +132,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',
+}

package/src/types/PaymentIntent.ts

@@ -88,6 +88,10 @@ export type MandateData = {
   };
 };
 
+type MetaData = {
+  [key: string]: string;
+};
+
 export type CardParams =
   | {
       paymentMethodType: 'Card';
@@ -95,6 +99,7 @@ export type CardParams =
         token?: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
       };
     }
   | {
@@ -104,6 +109,7 @@ export type CardParams =
         cvc?: string;
         billingDetails?: BillingDetails;
         mandateData?: MandateData;
+        metadata?: MetaData;
       };
     };
 
@@ -113,18 +119,24 @@ export interface IdealParams {
     bankName?: string;
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
 export interface FPXParams {
   paymentMethodType: 'Fpx';
-  paymentMethodData?: { testOfflineBank?: boolean; mandateData?: MandateData };
+  paymentMethodData?: {
+    testOfflineBank?: boolean;
+    mandateData?: MandateData;
+    metadata?: MetaData;
+  };
 }
 
 export interface AlipayParams {
   paymentMethodType: 'Alipay';
   paymentMethodData?: {
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -133,6 +145,7 @@ export interface OxxoParams {
   paymentMethodData: {
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -142,6 +155,7 @@ export interface SofortParams {
     country: string;
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 export interface GrabPayParams {
@@ -149,6 +163,7 @@ export interface GrabPayParams {
   paymentMethodData?: {
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -157,6 +172,7 @@ export interface BancontactParams {
   paymentMethodData: {
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -166,6 +182,7 @@ export interface SepaParams {
     iban: string;
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -174,6 +191,7 @@ export interface GiropayParams {
   paymentMethodData: {
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -183,6 +201,7 @@ export interface AfterpayClearpayParams {
     shippingDetails: BillingDetails;
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -194,6 +213,7 @@ export type KlarnaParams = {
     } & BillingDetails;
     shippingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -202,6 +222,7 @@ export interface EpsParams {
   paymentMethodData: {
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -210,6 +231,7 @@ export interface P24Params {
   paymentMethodData: {
     billingDetails: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -219,6 +241,7 @@ export interface WeChatPayParams {
     appId: string;
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 }
 
@@ -234,6 +257,7 @@ export type AffirmParams = {
     shippingDetails?: BillingDetails;
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -252,6 +276,7 @@ export type USBankAccountParams = {
     /** Defaults to Checking */
     accountType?: BankAcccountType;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -260,6 +285,7 @@ export type PayPalParams = {
   paymentMethodData?: {
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -268,6 +294,7 @@ export type CashAppParams = {
   paymentMethodData?: {
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -276,6 +303,7 @@ export type RevolutPayParams = {
   paymentMethodData?: {
     billingDetails?: BillingDetails;
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };
 
@@ -287,5 +315,6 @@ export type CollectBankAccountParams = {
       email?: string;
     };
     mandateData?: MandateData;
+    metadata?: MetaData;
   };
 };

package/src/types/PaymentMethod.ts

@@ -5,7 +5,8 @@ import type {
   BankAcccountType,
 } from './Token';
 import type { FutureUsage } from './PaymentIntent';
-import type { Address, BillingDetails } from './Common';
+import type { Address, BillingDetails, UserInterfaceStyle } from './Common';
+import type { FinancialConnectionsEvent } from './FinancialConnections';
 
 export interface Result {
   id: string;
@@ -313,4 +314,15 @@ export type CollectBankAccountParams = {
       email?: string;
     };
   };
+  /** iOS only. Style options for colors in Financial Connections. By default, the bank account collector will automatically switch between light and dark mode compatible colors based on device settings. */
+  style?: UserInterfaceStyle;
+  /** 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 CollectBankAccountTokenParams = {
+  /** iOS only. Style options for colors in Financial Connections. By default, the bank account collector will automatically switch between light and dark mode compatible colors based on device settings. */
+  style?: UserInterfaceStyle;
+  /** 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/src/types/PaymentSheet.ts

@@ -1,4 +1,9 @@
-import type { BillingDetails, AddressDetails, CardBrand } from './Common';
+import type {
+  BillingDetails,
+  AddressDetails,
+  CardBrand,
+  UserInterfaceStyle,
+} from './Common';
 import type { CartSummaryItem } from './ApplePay';
 import type {
   ButtonType,
@@ -10,7 +15,7 @@ import type { FutureUsage } from './PaymentIntent';
 import type { Result } from './PaymentMethod';
 import type { StripeError } from './Errors';
 
-type SetupParamsBase = IntentParams & {
+export 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 */
@@ -23,7 +28,7 @@ type SetupParamsBase = IntentParams & {
   /** Android only. Enable Google Pay in the Payment Sheet by passing a GooglePayParams object.  */
   googlePay?: GooglePayParams;
   /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. */
-  style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+  style?: UserInterfaceStyle;
   /** A URL that redirects back to your app that PaymentSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2 */
   returnURL?: string;
   /** Configuration for how billing details are collected during checkout. */
@@ -70,6 +75,13 @@ type SetupParamsBase = IntentParams & {
    * - Note: Defaults to `Automatic` if not set
    */
   paymentMethodLayout?: PaymentMethodLayout;
+  /**
+   * By default, PaymentSheet will accept all supported cards by Stripe.
+   * You can specify card brands PaymentSheet should block or allow payment for by providing an array of those card brands.
+   * Note: This is only a client-side solution.
+   * Note: Card brand filtering is not currently supported in Link.
+   */
+  cardBrandAcceptance?: CardBrandAcceptance;
 };
 
 export type SetupParams =
@@ -303,8 +315,8 @@ type RecursivePartial<T> = {
   [P in keyof T]?: T[P] extends (infer U)[]
     ? RecursivePartial<U>[]
     : T[P] extends object
-    ? RecursivePartial<T[P]>
-    : T[P];
+      ? RecursivePartial<T[P]>
+      : T[P];
 };
 export interface PaymentOption {
   label: string;
@@ -441,3 +453,51 @@ export enum PaymentMethodLayout {
    */
   Automatic = 'Automatic',
 }
+
+/** Card brand categories that can be allowed or disallowed */
+export enum CardBrandCategory {
+  /** Visa branded cards */
+  Visa = 'visa',
+  /** Mastercard branded cards */
+  Mastercard = 'mastercard',
+  /** American Express branded cards */
+  Amex = 'amex',
+  /**
+   * Discover branded cards
+   * Note: Encompasses all of Discover Global Network (Discover, Diners, JCB, UnionPay, Elo)
+   */
+  Discover = 'discover',
+}
+
+/** Filter types for card brand acceptance */
+export enum CardBrandAcceptanceFilter {
+  /** Accept all card brands supported by Stripe */
+  All = 'all',
+  /** Accept only the specified card brands */
+  Allowed = 'allowed',
+  /** Accept all card brands except the specified ones */
+  Disallowed = 'disallowed',
+}
+
+/** Options to block certain card brands on the client */
+export type CardBrandAcceptance =
+  | {
+      /** Accept all card brands supported by Stripe */
+      filter: CardBrandAcceptanceFilter.All;
+    }
+  | {
+      /** Accept only the specified card brands */
+      filter: CardBrandAcceptanceFilter.Allowed;
+      /** List of card brands to accept
+       * Note: Any card brands that do not map to a CardBrandCategory will be blocked when using an allow list
+       */
+      brands: CardBrandCategory[];
+    }
+  | {
+      /** Accept all card brands except the specified ones */
+      filter: CardBrandAcceptanceFilter.Disallowed;
+      /** List of card brands to block
+       * Note: Any card brands that do not map to a CardBrandCategory will be accepted when using a disallow list
+       */
+      brands: CardBrandCategory[];
+    };