@stripe/stripe-react-native 0.4.0 → 0.7.0

package/src/hooks/useStripe.tsx

@@ -1,12 +1,12 @@
 import type {
-  PaymentMethodCreateParams,
+  PaymentMethod,
   ApplePay,
   PaymentSheet,
   CreatePaymentMethodResult,
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   ConfirmPaymentResult,
-  HandleCardActionResult,
+  HandleNextActionResult,
   ConfirmSetupIntentResult,
   CreateTokenForCVCUpdateResult,
   ApplePayResult,
@@ -15,14 +15,19 @@ import type {
   InitPaymentSheetResult,
   PresentPaymentSheetResult,
   ConfirmPaymentSheetPaymentResult,
-  ConfirmSetupIntent,
+  SetupIntent,
   CreateTokenResult,
   PayWithGooglePayResult,
   GooglePayInitResult,
   GooglePay,
   CreateGooglePayPaymentMethodResult,
   OpenApplePaySetupResult,
-  CreateTokenParams,
+  Token,
+  VerifyMicrodepositsParams,
+  VerifyMicrodepositsForPaymentResult,
+  VerifyMicrodepositsForSetupResult,
+  CollectBankAccountForSetupResult,
+  CollectBankAccountForPaymentResult,
 } from '../types';
 import { useCallback, useEffect, useState } from 'react';
 import { isiOS } from '../helpers';
@@ -35,7 +40,7 @@ import {
   confirmApplePayPayment,
   confirmSetupIntent,
   createTokenForCVCUpdate,
-  handleCardAction,
+  handleNextAction,
   handleURLCallback,
   presentApplePay,
   updateApplePaySummaryItems,
@@ -48,6 +53,10 @@ import {
   createGooglePayPaymentMethod,
   presentGooglePay,
   openApplePaySetup,
+  collectBankAccountForPayment,
+  collectBankAccountForSetup,
+  verifyMicrodepositsForPayment,
+  verifyMicrodepositsForSetup,
 } from '../functions';
 
 /**
@@ -70,8 +79,8 @@ export function useStripe() {
 
   const _createPaymentMethod = useCallback(
     async (
-      data: PaymentMethodCreateParams.Params,
-      options: PaymentMethodCreateParams.Options = {}
+      data: PaymentMethod.CreateParams,
+      options: PaymentMethod.CreateOptions = {}
     ): Promise<CreatePaymentMethodResult> => {
       return createPaymentMethod(data, options);
     },
@@ -79,7 +88,7 @@ export function useStripe() {
   );
 
   const _createToken = useCallback(
-    async (params: CreateTokenParams): Promise<CreateTokenResult> => {
+    async (params: Token.CreateParams): Promise<CreateTokenResult> => {
       return createToken(params);
     },
     []
@@ -102,8 +111,8 @@ export function useStripe() {
   const _confirmPayment = useCallback(
     async (
       paymentIntentClientSecret: string,
-      data: PaymentMethodCreateParams.Params,
-      options: PaymentMethodCreateParams.Options = {}
+      data: PaymentMethod.ConfirmParams,
+      options: PaymentMethod.ConfirmOptions = {}
     ): Promise<ConfirmPaymentResult> => {
       return confirmPayment(paymentIntentClientSecret, data, options);
     },
@@ -139,11 +148,11 @@ export function useStripe() {
     []
   );
 
-  const _handleCardAction = useCallback(
+  const _handleNextAction = useCallback(
     async (
       paymentIntentClientSecret: string
-    ): Promise<HandleCardActionResult> => {
-      return handleCardAction(paymentIntentClientSecret);
+    ): Promise<HandleNextActionResult> => {
+      return handleNextAction(paymentIntentClientSecret);
     },
     []
   );
@@ -151,8 +160,8 @@ export function useStripe() {
   const _confirmSetupIntent = useCallback(
     async (
       paymentIntentClientSecret: string,
-      data: ConfirmSetupIntent.Params,
-      options: ConfirmSetupIntent.Options = {}
+      data: SetupIntent.ConfirmParams,
+      options: SetupIntent.ConfirmOptions = {}
     ): Promise<ConfirmSetupIntentResult> => {
       return confirmSetupIntent(paymentIntentClientSecret, data, options);
     },
@@ -193,7 +202,7 @@ export function useStripe() {
   );
 
   const _isGooglePaySupported = useCallback(
-    async (params?: GooglePay.IsGooglePaySupportedParams): Promise<boolean> => {
+    async (params?: GooglePay.IsSupportedParams): Promise<boolean> => {
       return isGooglePaySupported(params);
     },
     []
@@ -208,7 +217,7 @@ export function useStripe() {
 
   const _presentGooglePay = useCallback(
     async (
-      params: GooglePay.PresentGooglePayParams
+      params: GooglePay.PresentParams
     ): Promise<PayWithGooglePayResult> => {
       return presentGooglePay(params);
     },
@@ -229,12 +238,52 @@ export function useStripe() {
       return openApplePaySetup();
     }, []);
 
+  const _collectBankAccountForPayment = useCallback(
+    async (
+      clientSecret: string,
+      params: PaymentMethod.CollectBankAccountParams
+    ): Promise<CollectBankAccountForPaymentResult> => {
+      return collectBankAccountForPayment(clientSecret, params);
+    },
+    []
+  );
+
+  const _collectBankAccountForSetup = useCallback(
+    async (
+      clientSecret: string,
+      params: PaymentMethod.CollectBankAccountParams
+    ): Promise<CollectBankAccountForSetupResult> => {
+      return collectBankAccountForSetup(clientSecret, params);
+    },
+    []
+  );
+
+  const _verifyMicrodepositsForPayment = useCallback(
+    async (
+      clientSecret: string,
+      params: VerifyMicrodepositsParams
+    ): Promise<VerifyMicrodepositsForPaymentResult> => {
+      return verifyMicrodepositsForPayment(clientSecret, params);
+    },
+    []
+  );
+
+  const _verifyMicrodepositsForSetup = useCallback(
+    async (
+      clientSecret: string,
+      params: VerifyMicrodepositsParams
+    ): Promise<VerifyMicrodepositsForSetupResult> => {
+      return verifyMicrodepositsForSetup(clientSecret, params);
+    },
+    []
+  );
+
   return {
     retrievePaymentIntent: _retrievePaymentIntent,
     retrieveSetupIntent: _retrieveSetupIntent,
     confirmPayment: _confirmPayment,
     createPaymentMethod: _createPaymentMethod,
-    handleCardAction: _handleCardAction,
+    handleNextAction: _handleNextAction,
     isApplePaySupported: isApplePaySupported,
     presentApplePay: _presentApplePay,
     confirmApplePayPayment: _confirmApplePayPayment,
@@ -251,5 +300,9 @@ export function useStripe() {
     presentGooglePay: _presentGooglePay,
     createGooglePayPaymentMethod: _createGooglePayPaymentMethod,
     openApplePaySetup: _openApplePaySetup,
+    collectBankAccountForPayment: _collectBankAccountForPayment,
+    collectBankAccountForSetup: _collectBankAccountForSetup,
+    verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,
+    verifyMicrodepositsForSetup: _verifyMicrodepositsForSetup,
   };
 }

package/src/types/ApplePay.ts

@@ -1,70 +1,68 @@
-export namespace ApplePay {
-  export type CartSummaryItemType = 'final' | 'pending';
+export type CartSummaryItemType = 'final' | 'pending';
 
-  export type ContactFieldsType =
-    | 'emailAddress'
-    | 'name'
-    | 'phoneNumber'
-    | 'phoneticName'
-    | 'postalAddress';
+export type ContactFieldsType =
+  | 'emailAddress'
+  | 'name'
+  | 'phoneNumber'
+  | 'phoneticName'
+  | 'postalAddress';
 
-  export type AddressFields =
-    | 'street'
-    | 'city'
-    | 'subAdministrativeArea'
-    | 'state'
-    | 'postalCode'
-    | 'country'
-    | 'countryCode'
-    | 'subLocality';
+export type AddressFields =
+  | 'street'
+  | 'city'
+  | 'subAdministrativeArea'
+  | 'state'
+  | 'postalCode'
+  | 'country'
+  | 'countryCode'
+  | 'subLocality';
 
-  export interface ShippingMethod {
-    label: string;
-    amount: string;
-    type?: CartSummaryItemType;
-    identifier: string;
-    detail?: string;
-  }
+export interface ShippingMethod {
+  label: string;
+  amount: string;
+  type?: CartSummaryItemType;
+  identifier: string;
+  detail?: string;
+}
 
-  interface PostalAddress {
-    city?: string;
-    country?: string;
-    postalCode?: string;
-    state?: string;
-    street?: string;
-    isoCountryCode?: string;
-    subAdministrativeArea?: string;
-    subLocality?: string;
-  }
+interface PostalAddress {
+  city?: string;
+  country?: string;
+  postalCode?: string;
+  state?: string;
+  street?: string;
+  isoCountryCode?: string;
+  subAdministrativeArea?: string;
+  subLocality?: string;
+}
 
-  interface ContactName {
-    familyName?: string;
-    namePrefix?: string;
-    nameSuffix?: string;
-    givenName?: string;
-    middleName?: string;
-    nickname?: string;
-  }
+interface ContactName {
+  familyName?: string;
+  namePrefix?: string;
+  nameSuffix?: string;
+  givenName?: string;
+  middleName?: string;
+  nickname?: string;
+}
 
-  export interface ShippingContact {
-    emailAddress?: string;
-    name: ContactName;
-    phoneNumber?: number;
-    postalAddress: PostalAddress;
-  }
-  export interface CartSummaryItem {
-    label: string;
-    amount: string;
-    type?: CartSummaryItemType;
-  }
+export interface ShippingContact {
+  emailAddress?: string;
+  name: ContactName;
+  phoneNumber?: number;
+  postalAddress: PostalAddress;
+}
+export interface CartSummaryItem {
+  label: string;
+  amount: string;
+  type?: CartSummaryItemType;
+}
 
-  export interface PresentParams {
-    cartItems: CartSummaryItem[];
-    country: string;
-    currency: string;
-    requiredShippingAddressFields?: ContactFieldsType[];
-    requiredBillingContactFields?: ContactFieldsType[];
-    shippingMethods?: ShippingMethod[];
-    jcbEnabled?: boolean;
-  }
+export interface PresentParams {
+  cartItems: CartSummaryItem[];
+  country: string;
+  currency: string;
+  requiredShippingAddressFields?: ContactFieldsType[];
+  requiredBillingContactFields?: ContactFieldsType[];
+  shippingMethods?: ShippingMethod[];
+  jcbEnabled?: boolean;
 }

package/src/types/Common.ts

@@ -0,0 +1,15 @@
+export interface BillingDetails {
+  email?: string;
+  phone?: string;
+  name?: string;
+  address?: Address;
+}
+
+export interface Address {
+  city?: string;
+  country?: string;
+  line1?: string;
+  line2?: string;
+  postalCode?: string;
+  state?: string;
+}

package/src/types/Errors.ts

@@ -72,3 +72,15 @@ export const MissingRoutingNumber = {
   message:
     'You must provide a routing number for US bank accounts. This should be the ACH routing number.',
 };
+
+export enum VerifyMicrodepositsError {
+  Canceled = 'Canceled',
+  Failed = 'Failed',
+  Unknown = 'Unknown',
+}
+
+export enum CollectBankAccountError {
+  Canceled = 'Canceled',
+  Failed = 'Failed',
+  Unknown = 'Unknown',
+}

package/src/types/GooglePay.ts

@@ -1,79 +1,73 @@
-export namespace GooglePay {
-  export type PresentGooglePayParams = PresentGooglePayType & {
-    clientSecret: string;
-  };
+export type PresentParams = PresentType & {
+  clientSecret: string;
+};
 
-  export type PresentGooglePayType =
-    | {
-        /*
-         * Present Google Pay to collect customer payment details and use it to confirm the
-         * [SetupIntent] represented by [clientSecret].
-         */
-        forSetupIntent?: true;
-        /*
-         * The Google Pay API requires a [currencyCode](https://developers.google.com/pay/api/android/reference/request-objects#TransactionInfo).
-         * [currencyCode] is required even though the SetupIntent API does not require it.
-         */
-        currencyCode: string;
-      }
-    | {
-        /*
-         * Present Google Pay to collect customer payment details and use it to confirm the
-         * [PaymentIntent] represented by [clientSecret].
-         */
-        forSetupIntent?: false;
-      };
+export type PresentType =
+  | {
+      /*
+       * Present Google Pay to collect customer payment details and use it to confirm the
+       * [SetupIntent] represented by [clientSecret].
+       */
+      forSetupIntent?: true;
+      /*
+       * The Google Pay API requires a [currencyCode](https://developers.google.com/pay/api/android/reference/request-objects#TransactionInfo).
+       * [currencyCode] is required even though the SetupIntent API does not require it.
+       */
+      currencyCode: string;
+    }
+  | {
+      /*
+       * Present Google Pay to collect customer payment details and use it to confirm the
+       * [PaymentIntent] represented by [clientSecret].
+       */
+      forSetupIntent?: false;
+    };
 
-  export interface SetupIntentParams {
-    clientSecret: string;
-  }
+export type InitParams = {
+  merchantName: string;
+  countryCode: string;
+  /**
+   * Billing address collection configuration.
+   */
+  billingAddressConfig?: BillingAddressConfig;
+  /**
+   * Flag to indicate whether Google Pay collect the customer's email address.
+   *
+   * Default to `false`.
+   */
+  isEmailRequired?: boolean;
+} & IsSupportedParams;
 
-  export type InitParams = {
-    merchantName: string;
-    countryCode: string;
-    /**
-     * Billing address collection configuration.
-     */
-    billingAddressConfig?: BillingAddressConfig;
-    /**
-     * Flag to indicate whether Google Pay collect the customer's email address.
-     *
-     * Default to `false`.
-     */
-    isEmailRequired?: boolean;
-  } & IsGooglePaySupportedParams;
+export type IsSupportedParams = {
+  testEnv?: boolean;
+  /**
+   * If `true`, Google Pay is considered ready if the customer's Google Pay wallet
+   * has an existing payment method.
+   */
+  existingPaymentMethodRequired?: boolean;
+};
 
-  export type IsGooglePaySupportedParams = {
-    testEnv?: boolean;
-    /**
-     * If `true`, Google Pay is considered ready if the customer's Google Pay wallet
-     * has an existing payment method.
-     */
-    existingPaymentMethodRequired?: boolean;
-  };
-
-  export interface BillingAddressConfig {
-    isRequired?: boolean;
-    /**
-     * Billing address format required to complete the transaction.
-     */
-    format?: 'FULL' | 'MIN';
-    /**
-     * Set to true if a phone number is required to process the transaction.
-     */
-    isPhoneNumberRequired?: boolean;
-  }
+export interface BillingAddressConfig {
+  isRequired?: boolean;
+  /**
+   * Billing address format required to complete the transaction.
+   */
+  format?: 'FULL' | 'MIN';
+  /**
+   * Set to true if a phone number is required to process the transaction.
+   */
+  isPhoneNumberRequired?: boolean;
+}
 
-  export interface CreatePaymentMethodParams {
-    /*
-     * ISO 4217 alphabetic currency code. (e.g. "USD", "EUR")
-     */
-    currencyCode: string;
-    /*
-     * Amount intended to be collected. A positive integer representing how much to
-     * charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100,
-     * a zero-decimal currency).
-     */
-    amount: number;
-  }
+export interface CreatePaymentMethodParams {
+  /*
+   * ISO 4217 alphabetic currency code. (e.g. "USD", "EUR")
+   */
+  currencyCode: string;
+  /*
+   * Amount intended to be collected. A positive integer representing how much to
+   * charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100,
+   * a zero-decimal currency).
+   */
+  amount: number;
 }

package/src/types/NextAction.ts

@@ -0,0 +1,44 @@
+export type NextAction =
+  | VerifyWithMicrodepositsAction
+  | UrlRedirectAction
+  | WeChatRedirectAction
+  | AlipayRedirectAction
+  | BoletoVoucherAction
+  | OxxoVoucherAction;
+
+export type VerifyWithMicrodepositsAction = {
+  type: 'verifyWithMicrodeposits';
+  redirectUrl: string;
+  microdepositType: string;
+  arrivalDate: string;
+};
+
+export type UrlRedirectAction = {
+  type: 'urlRedirect';
+  redirectUrl: string;
+};
+
+export type WeChatRedirectAction = {
+  type: 'weChatRedirect';
+  redirectUrl: string;
+};
+
+export type AlipayRedirectAction = {
+  type: 'alipayRedirect';
+  redirectUrl: string;
+  nativeRedirectUrl: string;
+};
+
+export type BoletoVoucherAction = {
+  type: 'boletoVoucher';
+  expiration: number;
+  voucherURL: string;
+  voucherNumber: string;
+};
+
+export type OxxoVoucherAction = {
+  type: 'oxxoVoucher';
+  expiration: number;
+  voucherURL: string;
+  voucherNumber: string;
+};

package/src/types/PaymentIntent.ts

@@ -0,0 +1,53 @@
+import type { StripeError } from '.';
+import type { Address } from './Common';
+import type { Result as PaymentMethodResult } from './PaymentMethod';
+import type { NextAction } from './NextAction';
+import type * as PaymentMethod from './PaymentMethod';
+
+export interface Result {
+  id: string;
+  amount: number;
+  created: string;
+  currency: string;
+  status: Status;
+  description: string | null;
+  receiptEmail: string | null;
+  canceledAt: string | null;
+  clientSecret: string;
+  livemode: boolean;
+  paymentMethodId: string;
+  captureMethod: 'Automatic' | 'Manual';
+  confirmationMethod: 'Automatic' | 'Manual';
+  lastPaymentError: LastPaymentError | null;
+  shipping: ShippingDetails | null;
+  nextAction: NextAction | null;
+}
+
+export type ConfirmParams = PaymentMethod.CreateParams;
+
+export type ConfirmOptions = PaymentMethod.ConfirmOptions;
+
+export type LastPaymentError = StripeError<string> & {
+  paymentMethod: PaymentMethodResult;
+};
+
+export type FutureUsage = 'OffSession' | 'OnSession';
+
+export interface ShippingDetails {
+  address: Required<Address>;
+  name: string;
+  carrier: string;
+  phone: string;
+  trackingNumber: string;
+}
+
+export enum Status {
+  Succeeded = 'Succeeded',
+  RequiresPaymentMethod = 'RequiresPaymentMethod',
+  RequiresConfirmation = 'RequiresConfirmation',
+  Canceled = 'Canceled',
+  Processing = 'Processing',
+  RequiresAction = 'RequiresAction',
+  RequiresCapture = 'RequiresCapture',
+  Unknown = 'Unknown',
+}