@stripe/stripe-js 3.0.8 → 3.0.9

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,11 @@
+export * from './shared';
+export * from './payment-methods';
+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,11 @@
+export * from './shared';
+export * from './payment-methods';
+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/orders.d.mts

@@ -0,0 +1,122 @@
+import {Address} from './shared';
+import {PaymentIntent} from './payment-intents';
+
+/**
+ * The Order object.
+ */
+export interface Order {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'order';
+
+  /**
+   * Total order cost after discounts and taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
+   */
+  amount_total: number;
+
+  /**
+   * Order cost before any discounts or taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
+   */
+  amount_subtotal: number;
+
+  /**
+   * Customer billing details associated with the order.
+   */
+  billing_details: Order.Billing | null;
+
+  /**
+   * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+   */
+  currency: string;
+
+  /**
+   * Time at which the object was created. Measured in seconds since the Unix epoch.
+   */
+  created: 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;
+
+  /**
+   * Customer shipping information associated with the order.
+   */
+  shipping_details: Order.Shipping | null;
+
+  /**
+   * Payment information associated with the order.
+   */
+  payment: Order.Payment;
+
+  /**
+   * The overall status of the order.
+   */
+  status: Order.Status;
+}
+
+export namespace Order {
+  export interface Billing {
+    /**
+     * Billing address for the order.
+     */
+    address?: Address;
+
+    /**
+     * Email address for the order.
+     */
+    email?: string | null;
+
+    /**
+     * Full name for the order.
+     */
+    name?: string | null;
+
+    /**
+     * Billing phone number for the order (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface Shipping {
+    /**
+     * Recipient shipping address. Required if the order includes products that are shippable.
+     */
+    address?: Address;
+
+    /**
+     * Recipient name.
+     */
+    name?: string | null;
+
+    /**
+     * Recipient phone (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface Payment {
+    /**
+     * Payment intent associated with this order. Null when the order is `open`.
+     */
+    payment_intent?: PaymentIntent | null;
+
+    /**
+     * The status of the underlying payment associated with this order, if any. Null when the order is `open`.
+     */
+    status?: PaymentIntent.Status | null;
+  }
+
+  export type Status =
+    | 'open'
+    | 'submitted'
+    | 'processing'
+    | 'complete'
+    | 'canceled';
+}

package/dist/api/orders.d.ts

@@ -0,0 +1,122 @@
+import {Address} from './shared';
+import {PaymentIntent} from './payment-intents';
+
+/**
+ * The Order object.
+ */
+export interface Order {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'order';
+
+  /**
+   * Total order cost after discounts and taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). To submit an order, the total must be either 0 or at least $0.50 USD or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts).
+   */
+  amount_total: number;
+
+  /**
+   * Order cost before any discounts or taxes are applied. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency).
+   */
+  amount_subtotal: number;
+
+  /**
+   * Customer billing details associated with the order.
+   */
+  billing_details: Order.Billing | null;
+
+  /**
+   * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+   */
+  currency: string;
+
+  /**
+   * Time at which the object was created. Measured in seconds since the Unix epoch.
+   */
+  created: 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;
+
+  /**
+   * Customer shipping information associated with the order.
+   */
+  shipping_details: Order.Shipping | null;
+
+  /**
+   * Payment information associated with the order.
+   */
+  payment: Order.Payment;
+
+  /**
+   * The overall status of the order.
+   */
+  status: Order.Status;
+}
+
+export namespace Order {
+  export interface Billing {
+    /**
+     * Billing address for the order.
+     */
+    address?: Address;
+
+    /**
+     * Email address for the order.
+     */
+    email?: string | null;
+
+    /**
+     * Full name for the order.
+     */
+    name?: string | null;
+
+    /**
+     * Billing phone number for the order (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface Shipping {
+    /**
+     * Recipient shipping address. Required if the order includes products that are shippable.
+     */
+    address?: Address;
+
+    /**
+     * Recipient name.
+     */
+    name?: string | null;
+
+    /**
+     * Recipient phone (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface Payment {
+    /**
+     * Payment intent associated with this order. Null when the order is `open`.
+     */
+    payment_intent?: PaymentIntent | null;
+
+    /**
+     * The status of the underlying payment associated with this order, if any. Null when the order is `open`.
+     */
+    status?: PaymentIntent.Status | null;
+  }
+
+  export type Status =
+    | 'open'
+    | 'submitted'
+    | 'processing'
+    | 'complete'
+    | 'canceled';
+}