@stripe/stripe-js 3.0.10 → 3.1.0

package/dist/api/confirmation-tokens.d.ts

@@ -0,0 +1,183 @@
+import {StripeElements} from '../stripe-js';
+import {Address} from './shared';
+import {PaymentMethod, PaymentMethodCreateParams} from './payment-methods';
+import {PaymentIntent} from './payment-intents';
+
+/**
+ * The ConfirmationToken object.
+ */
+export interface ConfirmationToken {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'confirmation_token';
+
+  /**
+   * Time at which the object was created. Measured in seconds since the Unix epoch.
+   */
+  created: number;
+
+  /**
+   * Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used. Measured in seconds since the Unix epoch.
+   */
+  expires_at: number;
+
+  /**
+   * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+   */
+  livemode: boolean;
+
+  /**
+   * ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
+   */
+  payment_intent: null | string;
+
+  /**
+   * Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
+   */
+  payment_method_preview: ConfirmationToken.PaymentMethodPreview;
+
+  /**
+   * The URL your customer is redirected to after they complete the payment.
+   */
+  return_url: string | null;
+
+  /**
+   * Indicates that you intend to make future payments with this ConfirmationToken’s payment method.
+   *
+   * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
+   *
+   * Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
+   */
+  setup_future_usage: PaymentIntent.SetupFutureUsage | null;
+
+  /**
+   * ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
+   */
+  setup_intent: null | string;
+
+  /**
+   * Shipping information for this ConfirmationToken.
+   */
+  shipping: PaymentIntent.Shipping | null;
+
+  /**
+   * Set to true when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions.
+   */
+  use_stripe_sdk: boolean;
+}
+
+export interface ConfirmationTokenCreateParams {
+  /**
+   * Data used to create a new payment method.
+   *
+   */
+  payment_method_data?: {
+    /**
+     * The customer's billing details.
+     */
+    billing_details?: PaymentMethodCreateParams.BillingDetails;
+  };
+
+  /**
+   * Shipping information.
+   */
+  shipping?: ConfirmationToken.Shipping;
+
+  /**
+   * The url your customer will be directed to after they complete authentication.
+   */
+  return_url?: string | null;
+}
+
+export interface CreateConfirmationToken {
+  /**
+   * The Elements instance.
+   *
+   * @docs https://stripe.com/docs/js/elements_object
+   */
+  elements: StripeElements;
+
+  /**
+   * Parameters for creating the ConfirmationToken.
+   * Details collected by Elements will be overriden by values passed here.
+   */
+  params?: ConfirmationTokenCreateParams;
+}
+
+export namespace ConfirmationToken {
+  export interface Shipping {
+    /**
+     * Recipient address.
+     */
+    address: Address;
+
+    /**
+     * Recipient name.
+     */
+    name: string | null;
+
+    /**
+     * Recipient phone (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface PaymentMethodPreview {
+    /**
+     * The type of the PaymentMethod. An additional hash is included on payment_method_preview with a name matching this value. It contains additional information specific to the PaymentMethod type.
+     */
+    type: string;
+
+    billing_details: PaymentMethod.BillingDetails;
+
+    acss_debit?: PaymentMethod.AcssDebit;
+
+    affirm?: PaymentMethod.Affirm;
+
+    afterpay_clearpay?: PaymentMethod.AfterpayClearpay;
+
+    au_becs_debit?: PaymentMethod.AuBecsDebit;
+
+    card?: PaymentMethod.Card;
+
+    card_present?: PaymentMethod.CardPresent;
+
+    eps?: PaymentMethod.Eps;
+
+    fpx?: PaymentMethod.Fpx;
+
+    grabpay?: PaymentMethod.GrabPay;
+
+    ideal?: PaymentMethod.Ideal;
+
+    p24?: PaymentMethod.P24;
+
+    sepa_debit?: PaymentMethod.SepaDebit;
+
+    us_bank_account?: PaymentMethod.UsBankAccount;
+  }
+
+  export interface MandateData {
+    customer_acceptance: {
+      type: 'online';
+
+      online?: {
+        /**
+         * The IP address from which the Mandate was accepted by the customer.
+         */
+        ip_address: string;
+
+        /**
+         * The user agent of the browser from which the Mandate was accepted by the customer.
+         */
+        user_agent: string;
+      };
+    };
+  }
+}

package/dist/api/financial-connections.d.mts

@@ -0,0 +1,232 @@
+type SupportedPaymentMethodType = 'us_bank_account' | 'link';
+
+interface CommonBalance {
+  /**
+   * The time that the external institution calculated this balance. Measured
+   * in seconds since the Unix epoch.
+   */
+  as_of: number;
+
+  /**
+   * The balances owed to (or by) the account holder.
+   *
+   * Each key is a three-letter ISO currency code, in lowercase.
+   *
+   * Each value is a integer amount. A positive amount indicates money owed to
+   * the account holder. A negative amount indicates money owed by the account
+   * holder.
+   */
+  current: {
+    [key: string]: number | undefined;
+  };
+}
+
+interface CashBalance {
+  /**
+   * Information on a `cash` balance. Only set if `balance.type` is `cash`.
+   */
+  cash: {
+    /**
+     * The funds available to the account holder. Typically this is the
+     * current balance less any holds.
+     *
+     * Each key is a three-letter ISO currency code, in lowercase.
+     *
+     * Each value is a integer amount. A positive amount indicates money owed
+     * to the account holder. A negative amount indicates money owed by the
+     * account holder.
+     */
+    available: {[key: string]: number | undefined};
+  };
+
+  type: 'cash';
+}
+
+interface CreditBalance {
+  /**
+   * Information on a `credit` balance. Only set if `balance.type` is `credit`.
+   */
+  credit: {
+    /**
+     * The credit that has been used by the account holder.
+     *
+     * Each key is a three-letter ISO currency code, in lowercase
+     *
+     * Each value is a integer amount. A positive amount indicates money owed
+     * to the account holder. A negative amount indicates money owed by the
+     * account holder.
+     */
+    used: {[key: string]: number | undefined};
+  };
+
+  type: 'credit';
+}
+
+type Balance = (CommonBalance & CashBalance) | (CommonBalance & CreditBalance);
+
+interface BalanceRefresh {
+  /**
+   * The status of the Balance Refresh
+   */
+  status: 'pending' | 'succeeded' | 'failed';
+
+  /**
+   * Time at which the Balance Refresh was attempted. Measured in seconds since the Unix epoch.
+   */
+  last_attempted_at: number;
+}
+
+interface OwnershipRefresh {
+  /**
+   * The status of the Ownership Refresh
+   */
+  status: 'pending' | 'succeeded' | 'failed';
+
+  /**
+   * Time at which the Ownersip Refresh was attempted. Measured in seconds since the Unix epoch.
+   */
+  last_attempted_at: number;
+}
+
+/**
+ * The Financial Connections Session object
+ */
+export interface FinancialConnectionsSession {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * List of accounts collected by the Session
+   */
+  accounts: FinancialConnectionsSession.Account[];
+
+  /**
+   * Filters applied to the Session
+   */
+  filters?: FinancialConnectionsSession.Filters;
+
+  /**
+   * List of data permissions requested in the Session
+   */
+  permissions?: FinancialConnectionsSession.Permission[];
+
+  /**
+   * For webview integrations only. The user will be redirected to this URL to return to your app.
+   */
+  return_url?: string;
+}
+
+export namespace FinancialConnectionsSession {
+  /**
+   * The Financial Connections Account object
+   */
+  export interface Account {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+
+    /**
+     * String representing the object's type. `'linked_account'` is present for backwards-compatibility.
+     */
+    object: 'linked_account' | 'financial_connections.account';
+
+    /**
+     * The balance for this Account
+     */
+    balance: null | Balance;
+
+    /**
+     * The most recent Balance Refresh for this Account
+     */
+    balance_refresh: null | BalanceRefresh;
+
+    /**
+     * The type of the account.
+     */
+    category: 'cash' | 'credit' | 'investment' | 'other';
+
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+
+    /**
+     * A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+     */
+    display_name: string;
+
+    /**
+     * The name of the institution that holds this account.
+     */
+    institution_name: string;
+
+    /**
+     * The last 4 digits of the account number. If present, this will be 4 numeric characters.
+     */
+    last4: string | null;
+
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+
+    /**
+     * The ID of this account's Ownership resource.
+     */
+    ownership: string | null;
+
+    /**
+     * The most recent Ownership Refresh for this Account
+     */
+    ownership_refresh: null | OwnershipRefresh;
+
+    /**
+     * Permissions granted on this Account
+     */
+    permissions: Permission[];
+
+    /**
+     * The status of the Account
+     */
+    status: 'active' | 'inactive' | 'disconnected';
+
+    /**
+     * The sub-category of the Account
+     */
+    subcategory:
+      | 'checking'
+      | 'savings'
+      | 'mortgage'
+      | 'line_of_credit'
+      | 'credit_card'
+      | 'other';
+
+    /**
+     * The types of Payment Methods which can be set up by this Account
+     */
+    supported_payment_method_types: SupportedPaymentMethodType[];
+  }
+
+  /**
+   * Filters to restrict the kinds of accounts to collect.
+   */
+  export interface Filters {
+    /**
+     * List of countries from which to collect accounts.
+     */
+    countries?: string[];
+  }
+
+  /**
+   * Data features to which access can be requested
+   */
+  export type Permission =
+    | 'payment_method'
+    | 'balances'
+    | 'transactions'
+    | 'ownership'
+    | 'account_numbers';
+}

package/dist/api/financial-connections.d.ts

@@ -0,0 +1,232 @@
+type SupportedPaymentMethodType = 'us_bank_account' | 'link';
+
+interface CommonBalance {
+  /**
+   * The time that the external institution calculated this balance. Measured
+   * in seconds since the Unix epoch.
+   */
+  as_of: number;
+
+  /**
+   * The balances owed to (or by) the account holder.
+   *
+   * Each key is a three-letter ISO currency code, in lowercase.
+   *
+   * Each value is a integer amount. A positive amount indicates money owed to
+   * the account holder. A negative amount indicates money owed by the account
+   * holder.
+   */
+  current: {
+    [key: string]: number | undefined;
+  };
+}
+
+interface CashBalance {
+  /**
+   * Information on a `cash` balance. Only set if `balance.type` is `cash`.
+   */
+  cash: {
+    /**
+     * The funds available to the account holder. Typically this is the
+     * current balance less any holds.
+     *
+     * Each key is a three-letter ISO currency code, in lowercase.
+     *
+     * Each value is a integer amount. A positive amount indicates money owed
+     * to the account holder. A negative amount indicates money owed by the
+     * account holder.
+     */
+    available: {[key: string]: number | undefined};
+  };
+
+  type: 'cash';
+}
+
+interface CreditBalance {
+  /**
+   * Information on a `credit` balance. Only set if `balance.type` is `credit`.
+   */
+  credit: {
+    /**
+     * The credit that has been used by the account holder.
+     *
+     * Each key is a three-letter ISO currency code, in lowercase
+     *
+     * Each value is a integer amount. A positive amount indicates money owed
+     * to the account holder. A negative amount indicates money owed by the
+     * account holder.
+     */
+    used: {[key: string]: number | undefined};
+  };
+
+  type: 'credit';
+}
+
+type Balance = (CommonBalance & CashBalance) | (CommonBalance & CreditBalance);
+
+interface BalanceRefresh {
+  /**
+   * The status of the Balance Refresh
+   */
+  status: 'pending' | 'succeeded' | 'failed';
+
+  /**
+   * Time at which the Balance Refresh was attempted. Measured in seconds since the Unix epoch.
+   */
+  last_attempted_at: number;
+}
+
+interface OwnershipRefresh {
+  /**
+   * The status of the Ownership Refresh
+   */
+  status: 'pending' | 'succeeded' | 'failed';
+
+  /**
+   * Time at which the Ownersip Refresh was attempted. Measured in seconds since the Unix epoch.
+   */
+  last_attempted_at: number;
+}
+
+/**
+ * The Financial Connections Session object
+ */
+export interface FinancialConnectionsSession {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * List of accounts collected by the Session
+   */
+  accounts: FinancialConnectionsSession.Account[];
+
+  /**
+   * Filters applied to the Session
+   */
+  filters?: FinancialConnectionsSession.Filters;
+
+  /**
+   * List of data permissions requested in the Session
+   */
+  permissions?: FinancialConnectionsSession.Permission[];
+
+  /**
+   * For webview integrations only. The user will be redirected to this URL to return to your app.
+   */
+  return_url?: string;
+}
+
+export namespace FinancialConnectionsSession {
+  /**
+   * The Financial Connections Account object
+   */
+  export interface Account {
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+
+    /**
+     * String representing the object's type. `'linked_account'` is present for backwards-compatibility.
+     */
+    object: 'linked_account' | 'financial_connections.account';
+
+    /**
+     * The balance for this Account
+     */
+    balance: null | Balance;
+
+    /**
+     * The most recent Balance Refresh for this Account
+     */
+    balance_refresh: null | BalanceRefresh;
+
+    /**
+     * The type of the account.
+     */
+    category: 'cash' | 'credit' | 'investment' | 'other';
+
+    /**
+     * Time at which the object was created. Measured in seconds since the Unix epoch.
+     */
+    created: number;
+
+    /**
+     * A human-readable name that has been assigned to this account, either by the account holder or by the institution.
+     */
+    display_name: string;
+
+    /**
+     * The name of the institution that holds this account.
+     */
+    institution_name: string;
+
+    /**
+     * The last 4 digits of the account number. If present, this will be 4 numeric characters.
+     */
+    last4: string | null;
+
+    /**
+     * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+     */
+    livemode: boolean;
+
+    /**
+     * The ID of this account's Ownership resource.
+     */
+    ownership: string | null;
+
+    /**
+     * The most recent Ownership Refresh for this Account
+     */
+    ownership_refresh: null | OwnershipRefresh;
+
+    /**
+     * Permissions granted on this Account
+     */
+    permissions: Permission[];
+
+    /**
+     * The status of the Account
+     */
+    status: 'active' | 'inactive' | 'disconnected';
+
+    /**
+     * The sub-category of the Account
+     */
+    subcategory:
+      | 'checking'
+      | 'savings'
+      | 'mortgage'
+      | 'line_of_credit'
+      | 'credit_card'
+      | 'other';
+
+    /**
+     * The types of Payment Methods which can be set up by this Account
+     */
+    supported_payment_method_types: SupportedPaymentMethodType[];
+  }
+
+  /**
+   * Filters to restrict the kinds of accounts to collect.
+   */
+  export interface Filters {
+    /**
+     * List of countries from which to collect accounts.
+     */
+    countries?: string[];
+  }
+
+  /**
+   * Data features to which access can be requested
+   */
+  export type Permission =
+    | 'payment_method'
+    | 'balances'
+    | 'transactions'
+    | 'ownership'
+    | 'account_numbers';
+}

package/dist/api/index.d.mts

@@ -0,0 +1,12 @@
+export * from './shared';
+export * from './payment-methods';
+export * from './confirmation-tokens';
+export * from './payment-intents';
+export * from './orders';
+export * from './setup-intents';
+export * from './sources';
+export * from './tokens';
+export * from './bank-accounts';
+export * from './cards';
+export * from './verification-sessions';
+export * from './financial-connections';

package/dist/api/index.d.ts

@@ -0,0 +1,12 @@
+export * from './shared';
+export * from './payment-methods';
+export * from './confirmation-tokens';
+export * from './payment-intents';
+export * from './orders';
+export * from './setup-intents';
+export * from './sources';
+export * from './tokens';
+export * from './bank-accounts';
+export * from './cards';
+export * from './verification-sessions';
+export * from './financial-connections';