Function usePlatformPay

Returns {
    loading: boolean;
    isPlatformPaySupported: (
        params?: { googlePay?: IsGooglePaySupportedParams },
    ) => Promise<boolean>;
    confirmPlatformPaySetupIntent: (
        clientSecret: string,
        params: PlatformPay.ConfirmParams,
    ) => Promise<PlatformPay.ConfirmSetupIntentResult>;
    confirmPlatformPayPayment: (
        clientSecret: string,
        params: PlatformPay.ConfirmParams,
    ) => Promise<PlatformPay.ConfirmPaymentResult>;
    createPlatformPayPaymentMethod: (
        params: PaymentMethodParams,
    ) => Promise<PaymentMethodResult>;
    createPlatformPayToken: (
        params: PaymentMethodParams,
    ) => Promise<PlatformPay.TokenResult>;
    dismissPlatformPay: () => Promise<boolean>;
    updatePlatformPaySheet: (
        params: {
            applePay: {
                cartItems: PlatformPay.CartSummaryItem[];
                shippingMethods: ShippingMethod[];
                errors: ApplePaySheetError[];
            };
        },
    ) => Promise<{ error?: StripeError<PlatformPayError> }>;
    canAddCardToWallet: (
        params: CanAddCardToWalletParams,
    ) => Promise<CanAddCardToWalletResult>;
    openPlatformPaySetup: () => Promise<void>;
}

• loading: boolean

  Use this boolean to present a spinner or other similar loading screen. true if the SDK is currently processing, false if it is not.

• isPlatformPaySupported: (params?: { googlePay?: IsGooglePaySupportedParams }) => Promise<boolean>

  Check if the relevant native wallet (Apple Pay on iOS, Google Pay on Android) is supported.

• confirmPlatformPaySetupIntent: (
      clientSecret: string,
      params: PlatformPay.ConfirmParams,
  ) => Promise<PlatformPay.ConfirmSetupIntentResult>

  Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe SetupIntent.

• confirmPlatformPayPayment: (
      clientSecret: string,
      params: PlatformPay.ConfirmParams,
  ) => Promise<PlatformPay.ConfirmPaymentResult>

  Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to confirm a Stripe PaymentIntent.

• createPlatformPayPaymentMethod: (params: PaymentMethodParams) => Promise<PaymentMethodResult>

  Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe PaymentMethod and token.

• createPlatformPayToken: (params: PaymentMethodParams) => Promise<PlatformPay.TokenResult>

  Deprecated

  The Tokens API is deprecated, you should use Payment Methods and createPlatformPayPaymentMethod instead. Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe token.

• dismissPlatformPay: () => Promise<boolean>

  Dismiss the Apple Pay sheet if it is open. iOS only, this is a no-op on Android.

• updatePlatformPaySheet: (
      params: {
          applePay: {
              cartItems: PlatformPay.CartSummaryItem[];
              shippingMethods: ShippingMethod[];
              errors: ApplePaySheetError[];
          };
      },
  ) => Promise<{ error?: StripeError<PlatformPayError> }>

  Update different items on the Apple Pay sheet, including the summary items, the shipping methods, and any errors shown. iOS only, this is a no-op on Android.

• canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>

  Check if the app & device support adding this card to the native wallet.

• openPlatformPaySetup: () => Promise<void>

  iOS only, this is a no-op on Android. Use this method to move users to the interface for adding credit cards. This method transfers control to the Wallet app on iPhone or to the Settings app on iPad. For devices that don’t support Apple Pay, this method does nothing.