@stripe/stripe-react-native 0.23.3 → 0.25.0

package/src/types/PaymentSheet.ts

@@ -1,5 +1,11 @@
 import type { BillingDetails, AddressDetails } from './Common';
 import type { CartSummaryItem } from './ApplePay';
+import type {
+  ButtonType,
+  RecurringPaymentRequest,
+  AutomaticReloadPaymentRequest,
+  MultiMerchantRequest,
+} from './PlatformPay';
 
 export type SetupParams = ClientSecretParams & {
   /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
@@ -57,9 +63,26 @@ export type ApplePayParams = {
   /**
    * An array of CartSummaryItem item objects that summarize the amount of the payment. If you're using a SetupIntent
    * for a recurring payment, you should set this to display the amount you intend to charge. */
-  paymentSummaryItems?: CartSummaryItem[];
-  // TODO: Uncomment when https://github.com/stripe/stripe-react-native/pull/1164 lands
-  // buttonType: ButtonType
+  cartItems?: CartSummaryItem[];
+  /** Sets the text displayed by the call to action button in the Apple Pay sheet. */
+  buttonType?: ButtonType;
+  /** A typical request is for a one-time payment. To support different types of payment requests, include a PaymentRequestType. Only supported on iOS 16 and up. */
+  request?:
+    | RecurringPaymentRequest
+    | AutomaticReloadPaymentRequest
+    | MultiMerchantRequest;
+  /** Callback function for setting the order details (retrieved from your server) to give users the
+   * ability to track and manage their purchases in Wallet. Stripe calls your implementation after the
+   * payment is complete, but before iOS dismisses the Apple Pay sheet. You must call the `completion`
+   * function, or else the Apple Pay sheet will hang. */
+  setOrderTracking?: (
+    completion: (
+      orderIdentifier: string,
+      orderTypeIdentifier: string,
+      authenticationToken: string,
+      webServiceUrl: string
+    ) => void
+  ) => void;
 };
 
 export type GooglePayParams = {
@@ -232,3 +255,10 @@ export interface PaymentOption {
   label: string;
   image: string;
 }
+
+export type PresentOptions = {
+  /** The number of milliseconds (after presenting) before the Payment Sheet closes automatically, at which point
+   *`presentPaymentSheet` will resolve with an `error.code` of `PaymentSheetError.Timeout`. The default is no timeout.
+   */
+  timeout?: number;
+};

package/src/types/PlatformPay.ts

@@ -69,6 +69,77 @@ export type ApplePayBaseParams = {
   supportedCountries?: Array<string>;
 };
 
+export type ApplePayConfirmParams = {
+  /** A typical request is for a one-time payment. To support different types of payment requests, include a PaymentRequestType. Only supported on iOS 16 and up. */
+  request?:
+    | RecurringPaymentRequest
+    | AutomaticReloadPaymentRequest
+    | MultiMerchantRequest;
+};
+
+export enum PaymentRequestType {
+  Recurring = 'Recurring',
+  AutomaticReload = 'AutomaticReload',
+  MultiMerchant = 'MultiMerchant',
+}
+
+/** Use this for a recurring payment, typically a subscription. */
+export type RecurringPaymentRequest = {
+  type: PaymentRequestType.Recurring;
+  /** A description that you provide of the recurring payment and that Apple Pay displays to the user in the sheet. */
+  description: string;
+  /** A URL to a web page where the user can update or delete the payment method for the recurring payment. */
+  managementUrl: string;
+  /** The regular billing cycle for the payment, including start and end dates, an interval, and an interval count. */
+  billing: RecurringCartSummaryItem;
+  /** Same as the billing property, but use this if the purchase has a trial period. */
+  trialBilling?: RecurringCartSummaryItem;
+  /** A localized billing agreement that the sheet displays to the user before the user authorizes the payment. */
+  billingAgreement?: string;
+  /** A URL you provide to receive life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.
+   * For more information about handling merchant token life-cycle notifications, see Receiving and handling merchant token notifications.
+   */
+  tokenNotificationURL?: string;
+};
+
+/** Use this for an automatic reload or refill payment, such as a store card top-up. */
+export type AutomaticReloadPaymentRequest = {
+  type: PaymentRequestType.AutomaticReload;
+  /** A description that you provide of the recurring payment and that Apple Pay displays to the user in the sheet. */
+  description: string;
+  /** A URL to a web page where the user can update or delete the payment method for the recurring payment. */
+  managementUrl: string;
+  /** A short, localized description of the item. */
+  label: string;
+  /** This is the amount that is automatically applied to the account when the account balance drops below the threshold amount. */
+  reloadAmount: string;
+  /** The balance an account reaches before you apply the automatic reload amount. */
+  thresholdAmount: string;
+  /** A localized billing agreement that the sheet displays to the user before the user authorizes the payment. */
+  billingAgreement?: string;
+  /** A URL you provide to receive life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.
+   * For more information about handling merchant token life-cycle notifications, see Receiving and handling merchant token notifications.
+   */
+  tokenNotificationURL?: string;
+};
+
+/** Use this to indicate payments for multiple merchants. */
+export type MultiMerchantRequest = {
+  type: PaymentRequestType.MultiMerchant;
+  merchants: Array<{
+    /** The Apple Pay merchant identifier. */
+    merchantIdentifier: string;
+    /** An external identifier for the merchant. */
+    externalIdentifier: string;
+    /** The merchant’s display name that the Apple Pay server associates with the payment token. */
+    merchantName: string;
+    /** The merchant’s top-level domain that the Apple Pay server associates with the payment token. */
+    merchantDomain?: string;
+    /** The amount to authorize for the payment token. */
+    amount: string;
+  }>;
+};
+
 export type ApplePayPaymentMethodParams = {
   /** Set this value to true to display the coupon code field, or pass the 'couponCode' field to autofill with a coupon code. Defaults to false. If true, you must implement the PlatformPayButton component's `onCouponCodeEntered` callback and call `updatePlatformPaySheet` from there. */
   supportsCouponCode?: boolean;
@@ -158,7 +229,7 @@ export type ConfirmParams = {
   /** Defines Google Pay behavior. Android only. */
   googlePay?: GooglePayBaseParams;
   /** Defines Apple Pay behavior. iOS only. */
-  applePay?: ApplePayBaseParams;
+  applePay?: ApplePayBaseParams & ApplePayConfirmParams;
 };
 
 export enum ButtonType {

package/src/types/PushProvisioning.ts

@@ -39,12 +39,14 @@ export type IsCardInWalletResult =
 export type CanAddCardToWalletParams = {
   /** The `primary_account_identifier` value from the issued card. Can be an empty string. */
   primaryAccountIdentifier: string | null;
-  /** Last 4 digits of the card number. */
+  /** Last 4 digits of the card number. Required for Android. */
   cardLastFour: string;
   /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If false, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
   testEnv?: boolean;
   /** iOS only. Set this to `true` if: your user has an Apple Watch device currently paired, and you want to check that device for the presence of the specified card. */
   hasPairedAppleWatch?: boolean;
+  /** Android only, defaults to `true`. Set this to `false` if you'd like to allow users without NFC-enabled devices to add cards to the wallet. NFC is required for paying in stores. */
+  supportsTapToPay?: boolean;
 };
 
 export type CanAddCardToWalletResult =

package/src/types/components/ApplePayButtonComponent.ts

@@ -22,6 +22,7 @@ export interface NativeProps {
       couponCode: string;
     }>
   ) => void;
+  onOrderTrackingAction?: () => void;
 }
 
 export type Type =

package/stripe-react-native.podspec

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