@stripe/stripe-react-native 0.6.0 → 0.7.0

package/lib/typescript/src/hooks/useStripe.d.ts

@@ -1,20 +1,19 @@
-import type { PaymentMethodCreateParams, ApplePay, PaymentSheet, CreatePaymentMethodResult, RetrievePaymentIntentResult, RetrieveSetupIntentResult, ConfirmPaymentResult, HandleNextActionResult, ConfirmSetupIntentResult, CreateTokenForCVCUpdateResult, ApplePayResult, ApplePayError, StripeError, InitPaymentSheetResult, PresentPaymentSheetResult, ConfirmPaymentSheetPaymentResult, ConfirmSetupIntent, CreateTokenResult, PayWithGooglePayResult, GooglePayInitResult, GooglePay, CreateGooglePayPaymentMethodResult, OpenApplePaySetupResult, CreateTokenParams, VerifyMicrodepositsParams, CollectBankAccountParams } from '../types';
+import type { PaymentMethod, ApplePay, PaymentSheet, CreatePaymentMethodResult, RetrievePaymentIntentResult, RetrieveSetupIntentResult, ConfirmPaymentResult, HandleNextActionResult, ConfirmSetupIntentResult, CreateTokenForCVCUpdateResult, ApplePayResult, ApplePayError, StripeError, InitPaymentSheetResult, PresentPaymentSheetResult, ConfirmPaymentSheetPaymentResult, SetupIntent, CreateTokenResult, PayWithGooglePayResult, GooglePayInitResult, GooglePay, CreateGooglePayPaymentMethodResult, OpenApplePaySetupResult, Token, VerifyMicrodepositsParams, VerifyMicrodepositsForPaymentResult, VerifyMicrodepositsForSetupResult, CollectBankAccountForSetupResult, CollectBankAccountForPaymentResult } from '../types';
 /**
  * useStripe hook
  */
 export declare function useStripe(): {
     retrievePaymentIntent: (clientSecret: string) => Promise<RetrievePaymentIntentResult>;
     retrieveSetupIntent: (clientSecret: string) => Promise<RetrieveSetupIntentResult>;
-    confirmPayment: (paymentIntentClientSecret: string, data: PaymentMethodCreateParams.Params, options?: PaymentMethodCreateParams.Options) => Promise<ConfirmPaymentResult>;
-    createPaymentMethod: (data: PaymentMethodCreateParams.Params, options?: PaymentMethodCreateParams.Options) => Promise<CreatePaymentMethodResult>;
+    confirmPayment: (paymentIntentClientSecret: string, data: PaymentMethod.ConfirmParams, options?: PaymentMethod.ConfirmOptions) => Promise<ConfirmPaymentResult>;
+    createPaymentMethod: (data: PaymentMethod.CreateParams, options?: PaymentMethod.CreateOptions) => Promise<CreatePaymentMethodResult>;
     handleNextAction: (paymentIntentClientSecret: string) => Promise<HandleNextActionResult>;
-    handleCardAction: (paymentIntentClientSecret: string) => Promise<HandleNextActionResult>;
     isApplePaySupported: boolean | null;
     presentApplePay: (params: ApplePay.PresentParams) => Promise<ApplePayResult>;
     confirmApplePayPayment: (clientSecret: string) => Promise<{
         error?: StripeError<ApplePayError>;
     }>;
-    confirmSetupIntent: (paymentIntentClientSecret: string, data: ConfirmSetupIntent.Params, options?: ConfirmSetupIntent.Options) => Promise<ConfirmSetupIntentResult>;
+    confirmSetupIntent: (paymentIntentClientSecret: string, data: SetupIntent.ConfirmParams, options?: SetupIntent.ConfirmOptions) => Promise<ConfirmSetupIntentResult>;
     createTokenForCVCUpdate: (cvc: string) => Promise<CreateTokenForCVCUpdateResult>;
     updateApplePaySummaryItems: (summaryItems: ApplePay.CartSummaryItem[], errorAddressFields?: Array<{
         field: ApplePay.AddressFields;
@@ -26,14 +25,14 @@ export declare function useStripe(): {
     confirmPaymentSheetPayment: () => Promise<ConfirmPaymentSheetPaymentResult>;
     presentPaymentSheet: () => Promise<PresentPaymentSheetResult>;
     initPaymentSheet: (params: PaymentSheet.SetupParams) => Promise<InitPaymentSheetResult>;
-    createToken: (params: CreateTokenParams) => Promise<CreateTokenResult>;
-    isGooglePaySupported: (params?: GooglePay.IsGooglePaySupportedParams | undefined) => Promise<boolean>;
+    createToken: (params: Token.CreateParams) => Promise<CreateTokenResult>;
+    isGooglePaySupported: (params?: GooglePay.IsSupportedParams | undefined) => Promise<boolean>;
     initGooglePay: (params: GooglePay.InitParams) => Promise<GooglePayInitResult>;
-    presentGooglePay: (params: GooglePay.PresentGooglePayParams) => Promise<PayWithGooglePayResult>;
+    presentGooglePay: (params: GooglePay.PresentParams) => Promise<PayWithGooglePayResult>;
     createGooglePayPaymentMethod: (params: GooglePay.CreatePaymentMethodParams) => Promise<CreateGooglePayPaymentMethodResult>;
     openApplePaySetup: () => Promise<OpenApplePaySetupResult>;
-    collectBankAccountForPayment: (clientSecret: string, params: CollectBankAccountParams) => Promise<ConfirmPaymentResult>;
-    collectBankAccountForSetup: (clientSecret: string, params: CollectBankAccountParams) => Promise<ConfirmSetupIntentResult>;
-    verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<ConfirmPaymentResult>;
-    verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<ConfirmSetupIntentResult>;
+    collectBankAccountForPayment: (clientSecret: string, params: PaymentMethod.CollectBankAccountParams) => Promise<CollectBankAccountForPaymentResult>;
+    collectBankAccountForSetup: (clientSecret: string, params: PaymentMethod.CollectBankAccountParams) => Promise<CollectBankAccountForSetupResult>;
+    verifyMicrodepositsForPayment: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForPaymentResult>;
+    verifyMicrodepositsForSetup: (clientSecret: string, params: VerifyMicrodepositsParams) => Promise<VerifyMicrodepositsForSetupResult>;
 };

package/lib/typescript/src/types/ApplePay.d.ts

@@ -1,51 +1,49 @@
-export declare namespace ApplePay {
-    export type CartSummaryItemType = 'final' | 'pending';
-    export type ContactFieldsType = 'emailAddress' | 'name' | 'phoneNumber' | 'phoneticName' | 'postalAddress';
-    export type AddressFields = 'street' | 'city' | 'subAdministrativeArea' | 'state' | 'postalCode' | 'country' | 'countryCode' | 'subLocality';
-    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 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 PresentParams {
-        cartItems: CartSummaryItem[];
-        country: string;
-        currency: string;
-        requiredShippingAddressFields?: ContactFieldsType[];
-        requiredBillingContactFields?: ContactFieldsType[];
-        shippingMethods?: ShippingMethod[];
-        jcbEnabled?: boolean;
-    }
-    export {};
+export declare type CartSummaryItemType = 'final' | 'pending';
+export declare type ContactFieldsType = 'emailAddress' | 'name' | 'phoneNumber' | 'phoneticName' | 'postalAddress';
+export declare type AddressFields = 'street' | 'city' | 'subAdministrativeArea' | 'state' | 'postalCode' | 'country' | 'countryCode' | 'subLocality';
+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 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 PresentParams {
+    cartItems: CartSummaryItem[];
+    country: string;
+    currency: string;
+    requiredShippingAddressFields?: ContactFieldsType[];
+    requiredBillingContactFields?: ContactFieldsType[];
+    shippingMethods?: ShippingMethod[];
+    jcbEnabled?: boolean;
+}
+export {};

package/lib/typescript/src/types/Common.d.ts

@@ -0,0 +1,14 @@
+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/lib/typescript/src/types/Errors.d.ts

@@ -52,3 +52,13 @@ export declare const MissingRoutingNumber: {
     code: CreateTokenError;
     message: string;
 };
+export declare enum VerifyMicrodepositsError {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Unknown = "Unknown"
+}
+export declare enum CollectBankAccountError {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Unknown = "Unknown"
+}

package/lib/typescript/src/types/GooglePay.d.ts

@@ -1,51 +1,46 @@
-export declare namespace GooglePay {
-    type PresentGooglePayParams = PresentGooglePayType & {
-        clientSecret: string;
-    };
-    type PresentGooglePayType = {
-        forSetupIntent?: true;
-        currencyCode: string;
-    } | {
-        forSetupIntent?: false;
-    };
-    interface SetupIntentParams {
-        clientSecret: string;
-    }
-    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;
-    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;
-    };
-    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;
-    }
-    interface CreatePaymentMethodParams {
-        currencyCode: string;
-        amount: number;
-    }
+export declare type PresentParams = PresentType & {
+    clientSecret: string;
+};
+export declare type PresentType = {
+    forSetupIntent?: true;
+    currencyCode: string;
+} | {
+    forSetupIntent?: false;
+};
+export declare 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 declare 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 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 {
+    currencyCode: string;
+    amount: number;
 }

package/lib/typescript/src/types/PaymentIntent.d.ts

@@ -0,0 +1,46 @@
+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 declare type ConfirmParams = PaymentMethod.CreateParams;
+export declare type ConfirmOptions = PaymentMethod.ConfirmOptions;
+export declare type LastPaymentError = StripeError<string> & {
+    paymentMethod: PaymentMethodResult;
+};
+export declare type FutureUsage = 'OffSession' | 'OnSession';
+export interface ShippingDetails {
+    address: Required<Address>;
+    name: string;
+    carrier: string;
+    phone: string;
+    trackingNumber: string;
+}
+export declare enum Status {
+    Succeeded = "Succeeded",
+    RequiresPaymentMethod = "RequiresPaymentMethod",
+    RequiresConfirmation = "RequiresConfirmation",
+    Canceled = "Canceled",
+    Processing = "Processing",
+    RequiresAction = "RequiresAction",
+    RequiresCapture = "RequiresCapture",
+    Unknown = "Unknown"
+}

package/lib/typescript/src/types/PaymentMethod.d.ts

@@ -0,0 +1,167 @@
+import type { FormDetails } from './components/AuBECSDebitFormComponent';
+import type { CardBrand, BankAcccountHolderType, BankAcccountType } from './Token';
+import type { FutureUsage } from './PaymentIntent';
+import type { Address, BillingDetails } from './Common';
+export interface Result {
+    id: string;
+    liveMode: boolean;
+    customerId: string;
+    billingDetails: BillingDetails;
+    type: Type;
+    AuBecsDebit: AuBecsDebitResult;
+    BacsDebit: BacsDebitResult;
+    Card: CardResult;
+    Fpx: FpxResult;
+    Ideal: IdealResult;
+    SepaDebit: SepaDebitResult;
+    Sofort: SofortResult;
+    Upi: UpiResult;
+}
+export declare type CreateParams = CardParams | IdealParams | OxxoParams | P24Params | AlipayParams | GiropayParams | SepaParams | EpsParams | AuBecsDebitParams | SofortParams | GrabPayParams | FPXParams | AfterpayClearpayParams | KlarnaParams | BancontactParams | USBankAccountParams;
+export declare type ConfirmParams = CreateParams;
+export declare type CreateOptions = {};
+export declare type ConfirmOptions = CreateOptions;
+export declare type ShippingDetails = BillingDetails;
+interface BaseParams {
+    billingDetails?: BillingDetails;
+}
+export declare type CardParams = (BaseParams & {
+    type: 'Card';
+    token?: string;
+    setupFutureUsage?: FutureUsage;
+}) | (BaseParams & {
+    type: 'Card';
+    paymentMethodId: string;
+    cvc?: string;
+});
+export interface IdealParams extends BaseParams {
+    type: 'Ideal';
+    bankName?: string;
+    setupFutureUsage?: FutureUsage;
+}
+export interface FPXParams {
+    type: 'Fpx';
+    testOfflineBank?: boolean;
+}
+export interface AlipayParams {
+    type: 'Alipay';
+}
+export interface OxxoParams extends Required<BaseParams> {
+    type: 'Oxxo';
+}
+export interface SofortParams extends BaseParams {
+    type: 'Sofort';
+    country: string;
+    setupFutureUsage?: FutureUsage;
+}
+export interface GrabPayParams extends BaseParams {
+    type: 'GrabPay';
+}
+export interface BancontactParams extends Required<BaseParams> {
+    type: 'Bancontact';
+    setupFutureUsage?: FutureUsage;
+}
+export interface SepaParams extends Required<BaseParams> {
+    type: 'SepaDebit';
+    iban: string;
+    setupFutureUsage?: FutureUsage;
+}
+export interface GiropayParams extends Required<BaseParams> {
+    type: 'Giropay';
+}
+export interface AfterpayClearpayParams extends Required<BaseParams> {
+    type: 'AfterpayClearpay';
+    shippingDetails: ShippingDetails;
+}
+export declare type KlarnaParams = {
+    type: 'Klarna';
+    billingDetails: Pick<Required<BillingDetails>, 'email'> & {
+        address: Pick<Required<Address>, 'country'>;
+    } & BillingDetails;
+};
+export interface EpsParams extends Required<BaseParams> {
+    type: 'Eps';
+}
+export interface P24Params extends Required<BaseParams> {
+    type: 'P24';
+}
+export interface WeChatPayParams extends BaseParams {
+    type: 'WeChatPay';
+    appId: string;
+}
+export interface AuBecsDebitParams {
+    type: 'AuBecsDebit';
+    formDetails: FormDetails;
+}
+/** Before using this payment method type, ensure you have already collected the bank information
+ * for this intent with `collectBankAccountForPayment`. Otherwise, you will need to pass in the bank account
+ * details manually.*/
+export declare type USBankAccountParams = {
+    type: 'USBankAccount';
+    billingDetails?: Pick<Required<BillingDetails>, 'name'> & BillingDetails;
+    accountNumber?: string;
+    routingNumber?: string;
+    /** Defaults to Individual */
+    accountHolderType?: BankAcccountHolderType;
+    /** Defaults to Checking */
+    accountType?: BankAcccountType;
+    setupFutureUsage?: FutureUsage;
+};
+export interface AuBecsDebitResult {
+    fingerprint?: string;
+    last4?: string;
+    bsbNumber?: string;
+}
+export interface BacsDebitResult {
+    sortCode?: string;
+    last4?: string;
+    fingerprint?: string;
+}
+export interface CardResult {
+    brand?: CardBrand;
+    country?: string;
+    expYear?: number;
+    expMonth?: number;
+    fingerprint?: string;
+    funding?: string;
+    last4?: string;
+}
+export interface FpxResult {
+    bank?: string;
+}
+export interface IdealResult {
+    bankIdentifierCode?: string;
+    bank?: string;
+}
+export interface SepaDebitResult {
+    bankCode?: string;
+    country?: string;
+    fingerprint?: string;
+    last4?: string;
+}
+export interface SofortResult {
+    country?: string;
+}
+export interface UpiResult {
+    vpa?: string;
+}
+export declare type USBankAccountResult = {
+    routingNumber?: string;
+    accountHolderType?: BankAcccountHolderType;
+    accountType?: BankAcccountType;
+    last4?: string;
+    bankName?: string;
+    linkedAccount?: string;
+    fingerprint?: string;
+    preferredNetwork?: string;
+    supportedNetworks?: string[];
+};
+export declare type Type = 'AfterpayClearpay' | 'Card' | 'Alipay' | 'GrabPay' | 'Ideal' | 'Fpx' | 'CardPresent' | 'SepaDebit' | 'AuBecsDebit' | 'BacsDebit' | 'Giropay' | 'P24' | 'Eps' | 'Bancontact' | 'Oxxo' | 'Sofort' | 'Upi' | 'USBankAccount' | 'Unknown';
+export declare type CollectBankAccountParams = {
+    type: 'USBankAccount';
+    billingDetails: {
+        name: string;
+        email?: string;
+    };
+};
+export {};

package/lib/typescript/src/types/PaymentSheet.d.ts

@@ -1,56 +1,42 @@
-export declare namespace PaymentSheet {
-    type SetupParams = ClientSecretParams & GooglePayParams & ApplePayParams & {
-        customerId?: string;
-        customerEphemeralKeySecret?: string;
-        customFlow?: boolean;
-        merchantDisplayName?: string;
-        style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
-        returnURL?: string;
-        primaryButtonColor?: string;
-        defaultBillingDetails?: BillingDetails;
-        allowsDelayedPaymentMethods?: boolean;
-    };
-    type ClientSecretParams = {
-        paymentIntentClientSecret: string;
-        setupIntentClientSecret?: undefined;
-    } | {
-        setupIntentClientSecret: string;
-        paymentIntentClientSecret?: undefined;
-    };
-    type ApplePayParams = {
-        applePay?: true;
-        merchantCountryCode: string;
-    } | {
-        applePay?: false;
-        merchantCountryCode?: string;
-    };
-    type GooglePayParams = {
-        googlePay?: true;
-        merchantCountryCode: string;
-        currencyCode?: string;
-        testEnv?: boolean;
-    } | {
-        googlePay?: false;
-        merchantCountryCode?: string;
-        currencyCode?: string;
-        testEnv?: boolean;
-    };
-    interface Address {
-        city?: string;
-        country?: string;
-        line1?: string;
-        line2?: string;
-        postalCode?: string;
-        state?: string;
-    }
-    interface BillingDetails {
-        address: Address;
-        name?: string;
-        email?: string;
-        phone?: string;
-    }
-    interface PaymentOption {
-        label: string;
-        image: string;
-    }
+import type { BillingDetails } from './Common';
+export declare type SetupParams = ClientSecretParams & GooglePayParams & ApplePayParams & {
+    customerId?: string;
+    customerEphemeralKeySecret?: string;
+    customFlow?: boolean;
+    merchantDisplayName?: string;
+    style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+    returnURL?: string;
+    primaryButtonColor?: string;
+    defaultBillingDetails?: BillingDetails;
+    allowsDelayedPaymentMethods?: boolean;
+};
+declare type ClientSecretParams = {
+    paymentIntentClientSecret: string;
+    setupIntentClientSecret?: undefined;
+} | {
+    setupIntentClientSecret: string;
+    paymentIntentClientSecret?: undefined;
+};
+declare type ApplePayParams = {
+    applePay?: true;
+    merchantCountryCode: string;
+} | {
+    applePay?: false;
+    merchantCountryCode?: string;
+};
+declare type GooglePayParams = {
+    googlePay?: true;
+    merchantCountryCode: string;
+    currencyCode?: string;
+    testEnv?: boolean;
+} | {
+    googlePay?: false;
+    merchantCountryCode?: string;
+    currencyCode?: string;
+    testEnv?: boolean;
+};
+export interface PaymentOption {
+    label: string;
+    image: string;
 }
+export {};