@stripe/stripe-react-native 0.66.0 → 0.67.0

package/src/hooks/useOnramp.tsx

@@ -1,10 +1,12 @@
 import { EventSubscription, Platform } from 'react-native';
 import NativeOnrampSdk from '../specs/NativeOnrampSdkModule';
-import { Onramp, OnrampError, StripeError } from '../types';
+import { Onramp } from '../types';
 import type { Address } from '../types';
 import { useCallback } from 'react';
 import { addOnrampListener } from '../events';
 import { CryptoPaymentToken } from '../types/Onramp';
+import { getCurrentPublishableKey } from '../internal/stripeConfig';
+import pjson from '../../package.json';
 
 export function requireOnrampModule() {
   if (NativeOnrampSdk == null) {
@@ -24,6 +26,83 @@ export function requireOnrampModule() {
 let onCheckoutClientSecretRequestedSubscription: EventSubscription | null =
   null;
 
+const legacyAppAttestationUnavailableMessages = [
+  'App attestation is missing or device cannot use native Link.',
+  'Native Link is not available',
+];
+const cryptoOnrampAppAttestationUnavailableCode = 'app_attestation_unavailable';
+
+function isLegacyAppAttestationUnavailableMessage(message?: string): boolean {
+  return (
+    message != null && legacyAppAttestationUnavailableMessages.includes(message)
+  );
+}
+
+function publishableKeyMode(): 'live' | 'test' | undefined {
+  const publishableKey = getCurrentPublishableKey();
+  if (publishableKey?.startsWith('pk_live_')) {
+    return 'live';
+  }
+  if (publishableKey?.startsWith('pk_test_')) {
+    return 'test';
+  }
+  return undefined;
+}
+
+// Temporary React Native shim: iOS/Android currently surface this configure/create
+// failure as a legacy SDK-level message instead of a typed rich error. This can be
+// removed once the native SDKs map it themselves, though keeping it is harmless as
+// a compatibility fallback for older native SDK versions.
+function mapLegacyConfigureAppAttestationError(result: {
+  error?: Onramp.CryptoOnrampError;
+}): { error?: Onramp.CryptoOnrampError } {
+  const error = result.error;
+  if (
+    error == null ||
+    error.onrampErrorType != null ||
+    (!isLegacyAppAttestationUnavailableMessage(error.message) &&
+      !isLegacyAppAttestationUnavailableMessage(error.localizedMessage))
+  ) {
+    return result;
+  }
+
+  const userMessage =
+    "This app couldn't be verified. Contact the app developer for help.";
+  const mode = publishableKeyMode();
+
+  const context = [
+    'Context:',
+    '  operation: configure',
+    mode != null ? `  mode: ${mode}` : undefined,
+  ].filter((line): line is string => line != null);
+  const appAttestationError = {
+    ...error,
+    message: userMessage,
+    localizedMessage: userMessage,
+    stripeErrorCode: cryptoOnrampAppAttestationUnavailableCode,
+    developerMessage: [
+      "App attestation unavailable: this app isn't configured to use Stripe Crypto Onramp.",
+      '',
+      "This usually means app attestation isn't enabled for this Stripe account, or this app isn't registered as a trusted application. Use your iOS bundle ID or Android package name and contact Stripe to enable app attestation or register the app for this account.",
+      '',
+      ...context,
+      '',
+      `Code: ${cryptoOnrampAppAttestationUnavailableCode}`,
+      '',
+      'Next step: confirm app attestation is enabled for this Stripe account and that the app identifier is registered as trusted, then call configure again.',
+      `SDK: stripe-react-native@${pjson.version}`,
+    ].join('\n'),
+    userMessage,
+    operation: 'configure',
+    mode,
+  } as unknown as Onramp.CryptoOnrampError;
+
+  return {
+    ...result,
+    error: appAttestationError,
+  };
+}
+
 /**
  * useOnramp hook
  */
@@ -31,8 +110,10 @@ export function useOnramp() {
   const _configure = useCallback(
     async (
       config: Onramp.Configuration
-    ): Promise<{ error?: StripeError<OnrampError> }> => {
-      return requireOnrampModule().configureOnramp(config);
+    ): Promise<{ error?: Onramp.CryptoOnrampError }> => {
+      return mapLegacyConfigureAppAttestationError(
+        await requireOnrampModule().configureOnramp(config)
+      );
     },
     []
   );
@@ -57,7 +138,7 @@ export function useOnramp() {
     async (
       walletAddress: string,
       network: Onramp.CryptoNetwork
-    ): Promise<{ error?: StripeError<OnrampError> }> => {
+    ): Promise<{ error?: Onramp.CryptoOnrampError }> => {
       return requireOnrampModule().registerWalletAddress(
         walletAddress,
         network
@@ -69,7 +150,7 @@ export function useOnramp() {
   const _attachKycInfo = useCallback(
     async (
       kycInfo: Onramp.KycInfo
-    ): Promise<{ error?: StripeError<OnrampError> }> => {
+    ): Promise<{ error?: Onramp.CryptoOnrampError }> => {
       return requireOnrampModule().attachKycInfo(kycInfo);
     },
     []
@@ -89,9 +170,9 @@ export function useOnramp() {
     []
   );
 
-  const _presentCRSCARFDeclaration =
-    useCallback(async (): Promise<Onramp.CRSCARFDeclarationResult> => {
-      return requireOnrampModule().presentCRSCARFDeclaration();
+  const _presentUserAttestation =
+    useCallback(async (): Promise<Onramp.UserAttestationResult> => {
+      return requireOnrampModule().presentUserAttestation();
     }, []);
 
   const _presentKycInfoVerification = useCallback(
@@ -104,7 +185,7 @@ export function useOnramp() {
   const _authenticateUserWithToken = useCallback(
     async (
       linkAuthTokenClientSecret: string
-    ): Promise<{ error?: StripeError<OnrampError> }> => {
+    ): Promise<{ error?: Onramp.CryptoOnrampError }> => {
       return requireOnrampModule().authenticateUserWithToken(
         linkAuthTokenClientSecret
       );
@@ -113,14 +194,14 @@ export function useOnramp() {
   );
 
   const _updatePhoneNumber = useCallback(
-    async (phone: string): Promise<{ error?: StripeError<OnrampError> }> => {
+    async (phone: string): Promise<{ error?: Onramp.CryptoOnrampError }> => {
       return requireOnrampModule().updatePhoneNumber(phone);
     },
     []
   );
 
   const _verifyIdentity = useCallback(async (): Promise<{
-    error?: StripeError<OnrampError>;
+    error?: Onramp.CryptoOnrampError;
   }> => {
     return requireOnrampModule().verifyIdentity();
   }, []);
@@ -168,7 +249,7 @@ export function useOnramp() {
     async (
       onrampSessionId: string,
       provideCheckoutClientSecret: () => Promise<string | null>
-    ): Promise<{ error?: StripeError<OnrampError> }> => {
+    ): Promise<{ error?: Onramp.CryptoOnrampError }> => {
       onCheckoutClientSecretRequestedSubscription?.remove();
       onCheckoutClientSecretRequestedSubscription = addOnrampListener(
         'onCheckoutClientSecretRequested',
@@ -203,13 +284,15 @@ export function useOnramp() {
   );
 
   const _logOut = useCallback(async (): Promise<{
-    error?: StripeError<OnrampError>;
+    error?: Onramp.CryptoOnrampError;
   }> => {
     return requireOnrampModule().logout();
   }, []);
 
-  const _isAuthError = (error?: StripeError<OnrampError>): boolean => {
-    const stripeErrorCode = error?.stripeErrorCode;
+  const _isAuthError = (error?: Onramp.CryptoOnrampError): boolean => {
+    const stripeErrorCode =
+      error?.stripeErrorCode ??
+      (error?.onrampErrorType ? error.apiErrorCode : undefined);
     if (stripeErrorCode == null) {
       return false;
     }
@@ -276,17 +359,17 @@ export function useOnramp() {
      * Requires an authenticated Link user.
      *
      * @param identifiers The compliance identifiers to submit
-     * @returns Promise that resolves to whether the submission was valid, any remaining requirements, invalid identifiers, or error
+     * @returns Promise that resolves to whether collection is complete, any remaining requirements, CARF TIN state, invalid identifiers, or error
      */
     submitIdentifiers: _submitIdentifiers,
 
     /**
-     * Presents UI for the current Link user to accept the CRS/CARF declaration.
+     * Presents UI for the current Link user to accept user attestation.
      * Requires an authenticated Link user.
      *
      * @returns Promise that resolves to `Confirmed` when accepted, or error
      */
-    presentCRSCARFDeclaration: _presentCRSCARFDeclaration,
+    presentUserAttestation: _presentUserAttestation,
 
     /**
      * Presents UI to verify KYC information for the current Link user.

package/src/internal/stripeConfig.ts

@@ -0,0 +1,9 @@
+let currentPublishableKey: string | undefined;
+
+export function setCurrentPublishableKey(publishableKey: string): void {
+  currentPublishableKey = publishableKey;
+}
+
+export function getCurrentPublishableKey(): string | undefined {
+  return currentPublishableKey;
+}

package/src/specs/NativeOnrampSdkModule.ts

@@ -23,7 +23,7 @@ export interface Spec extends TurboModule {
   submitIdentifiers(
     identifiers: ReadonlyArray<UnsafeObject<Onramp.ComplianceIdentifier>>
   ): Promise<Onramp.SubmitIdentifiersResult>;
-  presentCRSCARFDeclaration(): Promise<Onramp.CRSCARFDeclarationResult>;
+  presentUserAttestation(): Promise<Onramp.UserAttestationResult>;
   presentKycInfoVerification: (
     updatedAddress: UnsafeObject<Address> | null
   ) => Promise<Onramp.VerifyKycResult>;

package/src/specs/NativeStripeSdkModule.ts

@@ -256,12 +256,6 @@ export interface Spec extends TurboModule {
     id: string
   ): Promise<UnsafeObject<Checkout.State>>;
 
-  checkoutUpdateTaxId(
-    sessionKey: string,
-    type: string,
-    value: string
-  ): Promise<UnsafeObject<Checkout.State>>;
-
   checkoutRunServerUpdateStart(
     sessionKey: string
   ): Promise<UnsafeObject<Checkout.State>>;

package/src/types/Checkout.ts

@@ -557,15 +557,6 @@ export interface Checkout {
    */
   selectShippingOption(id: string): Promise<void>;
 
-  /**
-   * Sets the customer's tax ID on the session.
-   * @param type - The tax ID type (e.g. `"eu_vat"`).
-   * @param value - The tax ID value (e.g. `"DE123456789"`).
-   * - Throws: `CheckoutError` if updating the tax ID fails.
-   * @internal
-   */
-  updateTaxId(type: string, value: string): Promise<void>;
-
   /**
    * Runs an async operation that updates the Checkout Session on your server,
    * then automatically refreshes the local session state.

package/src/types/Errors.ts

@@ -44,12 +44,6 @@ export enum PaymentSheetError {
   Timeout = 'Timeout',
 }
 
-export enum OnrampError {
-  Failed = 'Failed',
-  Canceled = 'Canceled',
-  Unknown = 'Unknown',
-}
-
 export type ErrorType =
   | 'api_connection_error'
   | 'api_error'

package/src/types/Onramp.ts

@@ -1,10 +1,19 @@
 import type { Address } from './Common';
-import type { OnrampError, StripeError } from './Errors';
+import type { StripeError } from './Errors';
 import type {
   ApplePayBaseParams,
   ApplePayPaymentMethodParams,
 } from './PlatformPay';
 
+/**
+ * Generic error codes returned by Crypto Onramp APIs.
+ */
+export enum OnrampError {
+  Failed = 'Failed',
+  Canceled = 'Canceled',
+  Unknown = 'Unknown',
+}
+
 /**
  * Configuration used to initialize and customize the crypto onramp experience.
  *
@@ -255,7 +264,68 @@ export type ComplianceIdentifierRequirements = {
   identifiers: ComplianceIdentifierRequirement[];
   /** Alternative identifier groups that may satisfy one or more requirements. */
   alternatives: ComplianceIdentifierAlternativeGroup[];
+  /** Whether at least one CRS/CARF tax identification number still needs to be collected. */
+  carfTinRequired: boolean;
+};
+
+/**
+ * Typed Crypto Onramp error discriminants returned by newer native SDKs.
+ */
+export type OnrampErrorType = 'AppAttestationError' | 'UncategorizedApiError';
+
+/**
+ * A native SDK component and version included in Crypto Onramp diagnostics.
+ */
+export type SDKVersion = {
+  /** The SDK component name. */
+  name: string;
+  /** The SDK component version. */
+  version: string;
+};
+
+export type OnrampApiError = StripeError<OnrampError> & {
+  onrampErrorType: string;
+  developerMessage: string;
+  userMessage: string;
+  reason?: string;
+  operation: string;
+  appPackageName: string;
+  mode?: 'live' | 'test';
+  sdkVersions?: SDKVersion[];
+  requestId?: string;
+  apiErrorCode?: string;
+  apiErrorType?: string;
+  apiErrorMessage?: string;
+  apiUserMessage?: string;
+  docUrl?: string;
 };
+/**
+ * A typed Crypto Onramp app attestation failure.
+ */
+export type AppAttestationError = OnrampApiError & {
+  onrampErrorType: 'AppAttestationError';
+};
+
+/**
+ * A typed Crypto Onramp API error that did not map to a narrower category.
+ */
+export type UncategorizedApiError = OnrampApiError & {
+  onrampErrorType: 'UncategorizedApiError';
+};
+
+/**
+ * Error returned by Crypto Onramp APIs.
+ *
+ * Most failures use the generic Stripe error envelope. Newer native SDK
+ * versions may instead return typed SDK-owned errors via
+ * `onrampErrorType`.
+ */
+export type CryptoOnrampError =
+  | (StripeError<OnrampError> & {
+      onrampErrorType?: undefined;
+    })
+  | AppAttestationError
+  | UncategorizedApiError;
 
 /**
  * Result of retrieving missing compliance identifiers.
@@ -267,8 +337,9 @@ export type RetrieveMissingIdentifiersResult =
   | {
       identifiers?: undefined;
       alternatives?: undefined;
+      carfTinRequired?: undefined;
       /** Present if retrieval failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -276,38 +347,41 @@ export type RetrieveMissingIdentifiersResult =
  */
 export type SubmitIdentifiersResult =
   | {
-      /** Whether all required identifiers were accepted. */
-      valid: boolean;
+      /** Whether all required MiCA identifiers and CRS/CARF tax identification numbers have been submitted. */
+      completed: boolean;
       /** Any identifiers that still need to be collected. */
       identifiers: ComplianceIdentifierRequirement[];
       /** Alternative identifier groups that may satisfy one or more requirements. */
       alternatives: ComplianceIdentifierAlternativeGroup[];
+      /** Whether at least one CRS/CARF tax identification number still needs to be collected. */
+      carfTinRequired: boolean;
       /** Submitted identifier types whose values were invalid. */
       invalidIdentifiers: ComplianceIdentifierType[];
       error?: undefined;
     }
   | {
-      valid?: undefined;
+      completed?: undefined;
       identifiers?: undefined;
       alternatives?: undefined;
+      carfTinRequired?: undefined;
       invalidIdentifiers?: undefined;
       /** Present if submission failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
- * Result of presenting the CRS/CARF declaration.
+ * Result of presenting user attestation.
  */
-export type CRSCARFDeclarationResult =
+export type UserAttestationResult =
   | {
-      /** The customer accepted the declaration. */
+      /** The customer accepted the attestation. */
       status: 'Confirmed';
       error?: undefined;
     }
   | {
       status?: undefined;
-      /** Present if the declaration failed or was cancelled. */
-      error: StripeError<OnrampError>;
+      /** Present if attestation failed or was cancelled. */
+      error: CryptoOnrampError;
     };
 
 /**
@@ -327,7 +401,7 @@ export type VerifyKycResult =
   | {
       status?: undefined;
       /** Present if the verification failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -335,7 +409,7 @@ export type VerifyKycResult =
  */
 export type VoidResult = {
   /** Present if the operation failed. */
-  error?: StripeError<OnrampError>;
+  error?: CryptoOnrampError;
 };
 
 /**
@@ -363,7 +437,7 @@ export type AuthorizeResult =
       status?: undefined;
       customerId?: undefined;
       /** Present if the authorization failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -378,7 +452,7 @@ export type HasLinkAccountResult =
   | {
       hasLinkAccount?: undefined;
       /** Present if the lookup failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -393,7 +467,7 @@ export type RegisterLinkUserResult =
   | {
       customerId?: undefined;
       /** Present if registration failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -428,7 +502,7 @@ export type CollectPaymentMethodResult =
       displayData?: undefined;
       kycInfo?: undefined;
       /** Present if collection/selection failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -443,7 +517,7 @@ export type CreateCryptoPaymentTokenResult =
   | {
       cryptoPaymentToken?: undefined;
       /** Present if token creation failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };
 
 /**
@@ -484,5 +558,5 @@ export type PaymentDisplayDataResult =
   | {
       displayData?: undefined;
       /** Present if collection/selection failed with an error. */
-      error: StripeError<OnrampError>;
+      error: CryptoOnrampError;
     };

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 = '~> 25.15.0'
+stripe_version = '~> 25.17.0'
 
 fabric_enabled = ENV['RCT_NEW_ARCH_ENABLED'] == '1'
 
@@ -38,7 +38,7 @@ Pod::Spec.new do |s|
 
   s.subspec 'Core' do |core|
     core.source_files = 'ios/**/*.{h,m,mm,swift}'
-    core.exclude_files = [ 'ios/Tests/', 'ios/NewArch/', 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm' ]
+    core.exclude_files = [ 'ios/Tests/', 'ios/NewArch/', 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm', 'ios/OnrampErrors.swift' ]
     # These headers contain c++ code so make sure they are private to avoid
     # being exported to the umbrella header, which is used by swift interop.
     # StripeSwiftInterop.h will cause circular dependency issues.
@@ -53,7 +53,7 @@ Pod::Spec.new do |s|
   end
 
   s.subspec 'Onramp' do |onramp|
-    onramp.source_files = [ 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm' ]
+    onramp.source_files = [ 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm', 'ios/OnrampErrors.swift' ]
     onramp.dependency 'stripe-react-native/Core'
     onramp.dependency 'StripeCryptoOnramp', stripe_version
   end