@stripe/stripe-js 3.0.10 → 3.1.0

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/confirmation-tokens.d.mts

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