@stripe/stripe-react-native 0.55.0 → 0.56.0

package/src/functions.ts

@@ -343,6 +343,7 @@ export const verifyMicrodepositsForSetup = async (
 };
 
 let confirmHandlerCallback: EventSubscription | null = null;
+let confirmationTokenHandlerCallback: EventSubscription | null = null;
 let orderTrackingCallbackListener: EventSubscription | null = null;
 let financialConnectionsEventListener: EventSubscription | null = null;
 let paymentSheetCustomPaymentMethodConfirmCallback: EventSubscription | null =
@@ -367,6 +368,21 @@ export const initPaymentSheet = async (
     );
   }
 
+  const confirmationTokenHandler =
+    params?.intentConfiguration?.confirmationTokenConfirmHandler;
+  if (confirmationTokenHandler) {
+    confirmationTokenHandlerCallback?.remove();
+    confirmationTokenHandlerCallback = addListener(
+      'onConfirmationTokenHandlerCallback',
+      ({ confirmationToken }) => {
+        confirmationTokenHandler(
+          confirmationToken,
+          NativeStripeSdk.confirmationTokenCreationCallback
+        );
+      }
+    );
+  }
+
   // Setup custom payment method confirmation handler for PaymentSheet
   if (params.customPaymentMethodConfiguration) {
     const customPaymentMethodHandler =

package/src/index.tsx

@@ -33,3 +33,4 @@ export type { Props as CustomerSheetProps } from './components/CustomerSheet';
 
 export * from './types/EmbeddedPaymentElement';
 export * from './types/PaymentSheet';
+export * from './types/ConfirmationToken';

package/src/specs/NativeApplePayButton.ts

@@ -26,7 +26,7 @@ export interface NativeProps extends ViewProps {
   disabled: boolean;
   type: Int32;
   buttonStyle: Int32;
-  borderRadius?: WithDefault<Int32, 4>;
+  buttonBorderRadius?: WithDefault<Int32, 4>;
   onShippingMethodSelectedAction?: DirectEventHandler<OnShippingMethodSelectedActionEvent>;
   onShippingContactSelectedAction?: DirectEventHandler<OnShippingContactSelectedActionEvent>;
   onCouponCodeEnteredAction?: DirectEventHandler<OnCouponCodeEnteredActionEvent>;

package/src/specs/NativeStripeSdkModule.ts

@@ -11,6 +11,7 @@ import type {
   CreateTokenForCVCUpdateResult,
   CreateTokenResult,
   CustomerAdapter,
+  CustomerSessionClientSecret,
   CustomerSheetError,
   CustomerSheetInitParams,
   CustomerSheetPresentParams,
@@ -79,6 +80,9 @@ export interface Spec extends TurboModule {
   intentCreationCallback(
     result: UnsafeObject<PaymentSheet.IntentCreationCallbackParams>
   ): Promise<void>;
+  confirmationTokenCreationCallback(
+    result: UnsafeObject<PaymentSheet.IntentCreationCallbackParams>
+  ): Promise<void>;
   customPaymentMethodResultCallback(
     result: UnsafeObject<PaymentSheet.CustomPaymentMethodResult>
   ): Promise<void>;
@@ -172,6 +176,12 @@ export interface Spec extends TurboModule {
   customerAdapterSetupIntentClientSecretForCustomerAttachCallback(
     clientSecret: string
   ): Promise<void>;
+  clientSecretProviderSetupIntentClientSecretCallback(
+    setupIntentClientSecret: string
+  ): Promise<void>;
+  clientSecretProviderCustomerSessionClientSecretCallback(
+    customerSessionClientSecret: UnsafeObject<CustomerSessionClientSecret>
+  ): Promise<void>;
   createEmbeddedPaymentElement(
     intentConfig: UnsafeObject<IntentConfiguration>,
     configuration: UnsafeObject<EmbeddedPaymentElementConfiguration>

package/src/types/ConfirmationToken.ts

@@ -0,0 +1,73 @@
+import type { BillingDetails } from './Common';
+import type { FutureUsage } from './PaymentIntent';
+import type { Type as PaymentMethodType } from './PaymentMethod';
+
+/**
+ * ConfirmationToken result type.
+ */
+export interface Result {
+  /** Unique identifier for the object (e.g. `ctoken_...`). */
+  id: string;
+
+  /** Time at which the object was created. Measured in seconds since the Unix epoch. */
+  created: number;
+
+  /** Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. */
+  expiresAt?: number;
+
+  /** `true` if the object exists in live mode or the value `false` if the object exists in test mode. */
+  liveMode: boolean;
+
+  /** ID of the PaymentIntent this token was used to confirm. */
+  paymentIntentId?: string;
+
+  /** ID of the SetupIntent this token was used to confirm. */
+  setupIntentId?: string;
+
+  /** Return URL used to confirm the intent for redirect-based methods. */
+  returnURL?: string;
+
+  /** Indicates intent to reuse the payment method. */
+  setupFutureUsage?: FutureUsage;
+
+  /** Non-PII preview of payment details captured by the Payment Element. */
+  paymentMethodPreview?: PaymentMethodPreview;
+
+  /** Shipping information collected on this token. */
+  shipping?: ShippingDetails;
+
+  /** All response fields from the API, including any additional or undocumented fields. */
+  allResponseFields: Record<string, any>;
+}
+
+/**
+ * Preview of payment method details captured by the ConfirmationToken.
+ * This represents the transactional checkout state, not a reusable PaymentMethod object.
+ */
+export interface PaymentMethodPreview {
+  /** Type of the payment method. */
+  type: PaymentMethodType;
+
+  /** Billing details for the payment method. */
+  billingDetails?: BillingDetails;
+
+  /** This field indicates whether this payment method can be shown again to its customer in a checkout flow */
+  allowRedisplay?: AllowRedisplay;
+
+  /** The ID of the Customer to which this PaymentMethod is saved. Null when the PaymentMethod has not been saved to a Customer. */
+  customerId?: string;
+
+  /** All response fields from the API, including any additional or undocumented fields. */
+  allResponseFields: Record<string, any>;
+}
+
+export type AllowRedisplay = 'always' | 'limited' | 'unspecified';
+
+export interface ShippingDetails {
+  /** The recipient's address. */
+  address: BillingDetails['address'];
+  /** The recipient's name. */
+  name?: string;
+  /** The recipient's phone (including extension). */
+  phone?: string;
+}

package/src/types/CustomerSheet.ts

@@ -7,17 +7,11 @@ import type {
   CardBrand,
 } from '../types';
 
-export type CustomerSheetInitParams = {
+type CustomerSheetOptionalInitParams = {
   /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. iOS only. */
   style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
   /** Configuration for the look and feel of the UI. */
   appearance?: PaymentSheet.AppearanceParams;
-  /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
-  setupIntentClientSecret?: string;
-  /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
-  customerId: string;
-  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
-  customerEphemeralKeySecret: string;
   /** Your customer-facing business name. The default value is the name of your app. */
   merchantDisplayName?: string;
   /** Optional configuration for setting the header text of the Payment Method selection screen */
@@ -37,11 +31,6 @@ export type CustomerSheetInitParams = {
   /** The list of preferred networks that should be used to process payments made with a co-branded card.
    * This value will only be used if your user hasn't selected a network themselves. */
   preferredNetworks?: Array<CardBrand>;
-  /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
-   * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
-   * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
-   */
-  customerAdapter?: CustomerAdapter;
   /** This is an experimental feature that may be removed at any time.
    *  Defaults to true. If true, the customer can delete all saved payment methods.
    *  If false, the customer can't delete if they only have one saved payment method remaining.
@@ -56,6 +45,45 @@ export type CustomerSheetInitParams = {
   cardBrandAcceptance?: PaymentSheet.CardBrandAcceptance;
 };
 
+/**
+ * Required params for initializing a CustomerSheet using a legacy CustomerAdapter
+ */
+type CustomerAdapterInitParams = {
+  /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
+  customerId: string;
+  /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
+  setupIntentClientSecret?: string;
+  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
+  customerEphemeralKeySecret: string;
+  /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
+   * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
+   * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
+   */
+  customerAdapter?: CustomerAdapter;
+  intentConfiguration?: never;
+  clientSecretProvider?: never;
+};
+
+/**
+ * Required params for initializing a CustomerSheet with a CustomerSession
+ */
+type CustomerSessionInitParams = {
+  /** An object that configures the intent used to display saved payment methods to a customer.*/
+  intentConfiguration: CustomerSheetIntentConfiguration;
+  /** An object that provides the client secret for the customer session. */
+  clientSecretProvider: ClientSecretProvider;
+  customerId?: never;
+  setupIntentClientSecret?: never;
+  customerEphemeralKeySecret?: never;
+  customerAdapter?: never;
+};
+
+export type CustomerSheetInitParams = (
+  | CustomerAdapterInitParams
+  | CustomerSessionInitParams
+) &
+  CustomerSheetOptionalInitParams;
+
 export type CustomerSheetPresentParams = {
   /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info. */
   presentationStyle?:
@@ -131,3 +159,43 @@ export type CustomerPaymentOption =
   | 'google_pay'
   | 'link'
   | string;
+
+export interface ClientSecretProvider {
+  /**
+   * Provides the `SetupIntent` client secret that is used when attaching a payment method
+   * to a customer.
+   */
+  provideSetupIntentClientSecret(): Promise<string>;
+
+  /**
+   * Provides the CustomerSessionClientSecret that will be claimed and used to access a
+   * customer's saved payment methods.
+   */
+  provideCustomerSessionClientSecret(): Promise<CustomerSessionClientSecret>;
+}
+
+export type CustomerSheetIntentConfiguration = {
+  /** A list of payment method types to display to the customer. If undefined or empty, we dynamically determine the payment methods using your Stripe Dashboard settings. */
+  paymentMethodTypes?: Array<string>;
+  /** The connected account whose payment method configurations will apply to the CustomerSheet session.
+   * Affects the allowed payment methods and whether card brand choice is enabled.
+   * When provided, the payment method will be saved to your platform account. See our
+   * [SetupIntent docs](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of)
+   * for more information.
+   */
+  onBehalfOf?: string;
+};
+
+export type CustomerSessionClientSecret = {
+  /**
+   * The Customer the Customer Session was created for.
+   */
+  customerId: string;
+  /**
+   * The client secret of this Customer Session.
+   * Used on the client to set up secure access to the given customer.
+   * See our [CustomerSession docs](https://docs.stripe.com/api/customer_sessions/object)
+   * for more information
+   */
+  clientSecret: string;
+};

package/src/types/EmbeddedPaymentElement.tsx

@@ -13,6 +13,7 @@ import type {
   CardBrand,
 } from './Common';
 import type { PaymentMethod } from '.';
+import type * as ConfirmationToken from './ConfirmationToken';
 import * as PaymentSheetTypes from './PaymentSheet';
 import NativeStripeSdkModule from '../specs/NativeStripeSdkModule';
 import {
@@ -134,11 +135,9 @@ export interface EmbeddedPaymentElementConfiguration {
   merchantDisplayName: string;
   /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
   customerId?: string;
-  /** A short-lived token that allows the SDK to access a Customer’s payment methods. */
+  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
   customerEphemeralKeySecret?: string;
-  /** (Experimental) This parameter can be changed or removed at any time (use at your own risk).
-   *  The client secret of this Customer Session. Used on the client to set up secure access to the given customer.
-   */
+  /** The client secret of this Customer Session. Used on the client to set up secure access to the given customer. */
   customerSessionClientSecret?: string;
   /** iOS only. Enable Apple Pay in the Payment Sheet by passing an ApplePayParams object.  */
   applePay?: PaymentSheetTypes.ApplePayParams;
@@ -253,6 +252,7 @@ class EmbeddedPaymentElement {
 // JS Factory: createEmbeddedPaymentElement
 // -----------------------------------------------------------------------------
 let confirmHandlerCallback: EventSubscription | null = null;
+let confirmationTokenHandlerCallback: EventSubscription | null = null;
 let formSheetActionConfirmCallback: EventSubscription | null = null;
 let customPaymentMethodConfirmCallback: EventSubscription | null = null;
 let rowSelectionCallback: EventSubscription | null = null;
@@ -295,6 +295,25 @@ function setupConfirmAndSelectionHandlers(
     );
   }
 
+  const confirmationTokenConfirmHandler =
+    intentConfig.confirmationTokenConfirmHandler;
+  if (confirmationTokenConfirmHandler) {
+    confirmationTokenHandlerCallback?.remove();
+    confirmationTokenHandlerCallback = addListener(
+      'onConfirmationTokenHandlerCallback',
+      ({
+        confirmationToken,
+      }: {
+        confirmationToken: ConfirmationToken.Result;
+      }) => {
+        confirmationTokenConfirmHandler(
+          confirmationToken,
+          NativeStripeSdkModule.confirmationTokenCreationCallback
+        );
+      }
+    );
+  }
+
   if (configuration.formSheetAction?.type === 'confirm') {
     const confirmFormSheetHandler =
       configuration.formSheetAction.onFormSheetConfirmComplete;

package/src/types/PaymentSheet.ts

@@ -14,6 +14,7 @@ import type {
 import type { FutureUsage } from './PaymentIntent';
 import type { Result } from './PaymentMethod';
 import type { StripeError } from './Errors';
+import type { Result as ConfirmationTokenResult } from './ConfirmationToken';
 
 export type SetupParamsBase = IntentParams & {
   /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
@@ -96,9 +97,7 @@ export type SetupParams =
     })
   | (SetupParamsBase & {
       customerEphemeralKeySecret?: never;
-      /** (Experimental) This parameter can be changed or removed at any time (use at your own risk).
-       *  The client secret of this Customer Session. Used on the client to set up secure access to the given customer.
-       */
+      /** The client secret of this Customer Session. Used on the client to set up secure access to the given customer. */
       customerSessionClientSecret: string;
     })
   | SetupParamsBase;
@@ -563,19 +562,39 @@ export type IntentCreationCallbackParams =
     };
 
 export type IntentConfiguration = {
-  /*
-    Called when the customer confirms payment. Your implementation should create a PaymentIntent or SetupIntent on your server and call the `intentCreationCallback` with its client secret or an error if one occurred.
-    - Note: You must create the PaymentIntent or SetupIntent with the same values used as the `IntentConfiguration` e.g. the same amount, currency, etc.
-    - Parameters:
-      - paymentMethod: The PaymentMethod representing the customer's payment details.
-      - shouldSavePaymentMethod: This is `true` if the customer selected the "Save this payment method for future use" checkbox. Set `setup_future_usage` on the PaymentIntent to `off_session` if this is `true`.
-      - intentCreationCallback: Call this with the `client_secret` of the PaymentIntent or SetupIntent created by your server or the error that occurred. If you're using customFlow: false (default), the error's localizedMessage will be displayed to the customer in the sheet. If you're using customFlow: true, the `confirm` method fails with the error.
-  */
-  confirmHandler: (
+  /**
+   * Called when the customer confirms payment. Your implementation should create a PaymentIntent or SetupIntent on your server and call the `intentCreationCallback` with its client secret or an error if one occurred.
+   * - Note: You must create the PaymentIntent or SetupIntent with the same values used as the `IntentConfiguration` e.g. the same amount, currency, etc.
+   * - Note: Either `confirmHandler` or `confirmationTokenConfirmHandler` must be provided, but not both.
+   * - Parameters:
+   *   - paymentMethod: The PaymentMethod representing the customer's payment details.
+   *   - shouldSavePaymentMethod: This is `true` if the customer selected the "Save this payment method for future use" checkbox. Set `setup_future_usage` on the PaymentIntent to `off_session` if this is `true`.
+   *   - intentCreationCallback: Call this with the `client_secret` of the PaymentIntent or SetupIntent created by your server or the error that occurred. If you're using customFlow: false (default), the error's localizedMessage will be displayed to the customer in the sheet. If you're using customFlow: true, the `confirm` method fails with the error.
+   */
+  confirmHandler?: (
     paymentMethod: Result,
     shouldSavePaymentMethod: boolean,
     intentCreationCallback: (result: IntentCreationCallbackParams) => void
   ) => void;
+
+  /**
+   * Called when the customer confirms payment using confirmation tokens.
+   * Your implementation should follow the guide to create (and optionally confirm) a PaymentIntent or SetupIntent on your server and call the `intentCreationCallback` with its client secret or an error if one occurred.
+   *
+   * - Note: You must create the PaymentIntent or SetupIntent with the same values used as the `IntentConfiguration` e.g. the same amount, currency, etc.
+   * - Note: When confirming the PaymentIntent or SetupIntent on your server, use the confirmation token ID (`confirmationToken.id`) as the `confirmation_token` parameter.
+   * - Note: Either `confirmHandler` or `confirmationTokenConfirmHandler` must be provided, but not both.
+   *
+   * @param confirmationToken - The ConfirmationToken representing the customer's payment details and any additional information collected during checkout (e.g., billing details, shipping address). This token contains a secure, non-PII preview of the payment method that can be safely passed to your server. Use `confirmationToken.id` when confirming the intent on your server.
+   * @param intentCreationCallback - Call this with the `client_secret` of the PaymentIntent or SetupIntent created by your server or the error that occurred. If you're using PaymentSheet, the error's localizedMessage will be displayed to the customer in the sheet. If you're using PaymentSheet.FlowController, the `confirm` method fails with the error.
+   *
+   * @see https://stripe.com/docs/api/confirmation_tokens
+   */
+  confirmationTokenConfirmHandler?: (
+    confirmationToken: ConfirmationTokenResult,
+    intentCreationCallback: (result: IntentCreationCallbackParams) => void
+  ) => void;
+
   /* Information about the payment (PaymentIntent) or setup (SetupIntent).*/
   mode: Mode;
   /* A list of payment method types to display to the customer. If undefined or empty, we dynamically determine the payment methods using your Stripe Dashboard settings. */

package/src/types/index.ts

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

package/stripe-react-native.podspec

@@ -2,7 +2,7 @@ require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 # Keep stripe_version in sync with https://github.com/stripe/stripe-identity-react-native/blob/main/stripe-identity-react-native.podspec
-stripe_version = '~> 24.24.0'
+stripe_version = '~> 24.25.0'
 
 fabric_enabled = ENV['RCT_NEW_ARCH_ENABLED'] == '1'
 

package/ios/StripeSdk.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>

package/ios/StripeSdk.xcodeproj/xcuserdata/wooj.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>SchemeUserState</key>
-	<dict>
-		<key>StripeSdk.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>1</integer>
-		</dict>
-		<key>Tests.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>0</integer>
-		</dict>
-	</dict>
-</dict>
-</plist>