@stripe/stripe-js 3.0.8 → 3.0.9

package/dist/api/bank-accounts.d.mts

@@ -0,0 +1,61 @@
+/**
+ * The BankAccount object.
+ */
+export interface BankAccount {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'bank_account';
+
+  /**
+   * The name of the person or business that owns the bank account.
+   */
+  account_holder_name: string | null;
+
+  /**
+   * The type of entity that holds the account. This can be either `individual` or `company`.
+   */
+  account_holder_type: string | null;
+
+  /**
+   * Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
+   */
+  bank_name: string | null;
+
+  /**
+   * Two-letter ISO code representing the country the bank account is located in.
+   */
+  country: string;
+
+  /**
+   * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+   */
+  currency: string;
+
+  /**
+   * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+   */
+  fingerprint: string | null;
+
+  /**
+   * The last four digits of the bank account number.
+   */
+  last4: string;
+
+  /**
+   * The routing transit number for the bank account.
+   */
+  routing_number: string | null;
+
+  /**
+   * For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn't enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
+   *
+   * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
+   */
+  status: string;
+}

package/dist/api/bank-accounts.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The BankAccount object.
+ */
+export interface BankAccount {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'bank_account';
+
+  /**
+   * The name of the person or business that owns the bank account.
+   */
+  account_holder_name: string | null;
+
+  /**
+   * The type of entity that holds the account. This can be either `individual` or `company`.
+   */
+  account_holder_type: string | null;
+
+  /**
+   * Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
+   */
+  bank_name: string | null;
+
+  /**
+   * Two-letter ISO code representing the country the bank account is located in.
+   */
+  country: string;
+
+  /**
+   * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+   */
+  currency: string;
+
+  /**
+   * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+   */
+  fingerprint: string | null;
+
+  /**
+   * The last four digits of the bank account number.
+   */
+  last4: string;
+
+  /**
+   * The routing transit number for the bank account.
+   */
+  routing_number: string | null;
+
+  /**
+   * For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn't enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
+   *
+   * For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
+   */
+  status: string;
+}

package/dist/api/cards.d.mts

@@ -0,0 +1,130 @@
+import {Metadata} from './shared';
+
+/**
+ * The Card object.
+ */
+export interface Card {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'card';
+
+  /**
+   * City/District/Suburb/Town/Village.
+   */
+  address_city: string | null;
+
+  /**
+   * Billing address country, if provided when creating card.
+   */
+  address_country: string | null;
+
+  /**
+   * Address line 1 (Street address/PO Box/Company name).
+   */
+  address_line1: string | null;
+
+  /**
+   * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  address_line1_check: string | null;
+
+  /**
+   * Address line 2 (Apartment/Suite/Unit/Building).
+   */
+  address_line2: string | null;
+
+  /**
+   * State/County/Province/Region.
+   */
+  address_state: string | null;
+
+  /**
+   * ZIP or postal code.
+   */
+  address_zip: string | null;
+
+  /**
+   * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  address_zip_check: string | null;
+
+  /**
+   * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+   */
+  brand: string;
+
+  /**
+   * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+   */
+  country: string | 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 | null;
+
+  /**
+   * The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+   */
+  customer?: string | null;
+
+  /**
+   * If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  cvc_check: string | null;
+
+  /**
+   * (For tokenized numbers only.) The last four digits of the device account number.
+   */
+  dynamic_last4: string | null;
+
+  /**
+   * Two-digit number representing the card's expiration month.
+   */
+  exp_month: number;
+
+  /**
+   * Four-digit number representing the card's expiration year.
+   */
+  exp_year: number;
+
+  /**
+   * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
+   */
+  fingerprint?: string | null;
+
+  /**
+   * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+   */
+  funding: string;
+
+  /**
+   * The last four digits of the card.
+   */
+  last4: string;
+
+  /**
+   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+   */
+  metadata: Metadata;
+
+  /**
+   * Cardholder name.
+   */
+  name: string | null;
+
+  /**
+   * If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
+   */
+  tokenization_method: string | null;
+}
+
+export namespace Card {
+  export type AvailablePayoutMethod = 'instant' | 'standard';
+}

package/dist/api/cards.d.ts

@@ -0,0 +1,130 @@
+import {Metadata} from './shared';
+
+/**
+ * The Card object.
+ */
+export interface Card {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'card';
+
+  /**
+   * City/District/Suburb/Town/Village.
+   */
+  address_city: string | null;
+
+  /**
+   * Billing address country, if provided when creating card.
+   */
+  address_country: string | null;
+
+  /**
+   * Address line 1 (Street address/PO Box/Company name).
+   */
+  address_line1: string | null;
+
+  /**
+   * If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  address_line1_check: string | null;
+
+  /**
+   * Address line 2 (Apartment/Suite/Unit/Building).
+   */
+  address_line2: string | null;
+
+  /**
+   * State/County/Province/Region.
+   */
+  address_state: string | null;
+
+  /**
+   * ZIP or postal code.
+   */
+  address_zip: string | null;
+
+  /**
+   * If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  address_zip_check: string | null;
+
+  /**
+   * Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
+   */
+  brand: string;
+
+  /**
+   * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
+   */
+  country: string | 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 | null;
+
+  /**
+   * The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.
+   */
+  customer?: string | null;
+
+  /**
+   * If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.
+   */
+  cvc_check: string | null;
+
+  /**
+   * (For tokenized numbers only.) The last four digits of the device account number.
+   */
+  dynamic_last4: string | null;
+
+  /**
+   * Two-digit number representing the card's expiration month.
+   */
+  exp_month: number;
+
+  /**
+   * Four-digit number representing the card's expiration year.
+   */
+  exp_year: number;
+
+  /**
+   * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example.
+   */
+  fingerprint?: string | null;
+
+  /**
+   * Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
+   */
+  funding: string;
+
+  /**
+   * The last four digits of the card.
+   */
+  last4: string;
+
+  /**
+   * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+   */
+  metadata: Metadata;
+
+  /**
+   * Cardholder name.
+   */
+  name: string | null;
+
+  /**
+   * If the card number is tokenized, this is the method that was used. Can be `apple_pay` or `google_pay`.
+   */
+  tokenization_method: string | null;
+}
+
+export namespace Card {
+  export type AvailablePayoutMethod = 'instant' | 'standard';
+}

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';
+}