stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/resources/balance.rbi

@@ -0,0 +1,220 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # This is an object representing your Stripe balance. You can retrieve it to see
+  # the balance currently on your Stripe account.
+  #
+  # You can also retrieve the balance history, which contains a list of
+  # [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
+  # (charges, payouts, and so forth).
+  #
+  # The available and pending amounts for each currency are broken down further by
+  # payment source types.
+  #
+  # Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
+  class Balance < SingletonAPIResource
+    class Available < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount for bank account.
+        sig { returns(Integer) }
+        attr_reader :bank_account
+
+        # Amount for card.
+        sig { returns(Integer) }
+        attr_reader :card
+
+        # Amount for FPX.
+        sig { returns(Integer) }
+        attr_reader :fpx
+      end
+      # Balance amount.
+      sig { returns(Integer) }
+      attr_reader :amount
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # Attribute for field source_types
+      sig { returns(SourceTypes) }
+      attr_reader :source_types
+    end
+    class ConnectReserved < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount for bank account.
+        sig { returns(Integer) }
+        attr_reader :bank_account
+
+        # Amount for card.
+        sig { returns(Integer) }
+        attr_reader :card
+
+        # Amount for FPX.
+        sig { returns(Integer) }
+        attr_reader :fpx
+      end
+      # Balance amount.
+      sig { returns(Integer) }
+      attr_reader :amount
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # Attribute for field source_types
+      sig { returns(SourceTypes) }
+      attr_reader :source_types
+    end
+    class InstantAvailable < Stripe::StripeObject
+      class NetAvailable < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount for bank account.
+          sig { returns(Integer) }
+          attr_reader :bank_account
+
+          # Amount for card.
+          sig { returns(Integer) }
+          attr_reader :card
+
+          # Amount for FPX.
+          sig { returns(Integer) }
+          attr_reader :fpx
+        end
+        # Net balance amount, subtracting fees from platform-set pricing.
+        sig { returns(Integer) }
+        attr_reader :amount
+
+        # ID of the external account for this net balance (not expandable).
+        sig { returns(String) }
+        attr_reader :destination
+
+        # Attribute for field source_types
+        sig { returns(SourceTypes) }
+        attr_reader :source_types
+      end
+      class SourceTypes < Stripe::StripeObject
+        # Amount for bank account.
+        sig { returns(Integer) }
+        attr_reader :bank_account
+
+        # Amount for card.
+        sig { returns(Integer) }
+        attr_reader :card
+
+        # Amount for FPX.
+        sig { returns(Integer) }
+        attr_reader :fpx
+      end
+      # Balance amount.
+      sig { returns(Integer) }
+      attr_reader :amount
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # Breakdown of balance by destination.
+      sig { returns(T::Array[NetAvailable]) }
+      attr_reader :net_available
+
+      # Attribute for field source_types
+      sig { returns(SourceTypes) }
+      attr_reader :source_types
+    end
+    class Issuing < Stripe::StripeObject
+      class Available < Stripe::StripeObject
+        class SourceTypes < Stripe::StripeObject
+          # Amount for bank account.
+          sig { returns(Integer) }
+          attr_reader :bank_account
+
+          # Amount for card.
+          sig { returns(Integer) }
+          attr_reader :card
+
+          # Amount for FPX.
+          sig { returns(Integer) }
+          attr_reader :fpx
+        end
+        # Balance amount.
+        sig { returns(Integer) }
+        attr_reader :amount
+
+        # 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).
+        sig { returns(String) }
+        attr_reader :currency
+
+        # Attribute for field source_types
+        sig { returns(SourceTypes) }
+        attr_reader :source_types
+      end
+      # Funds that are available for use.
+      sig { returns(T::Array[Available]) }
+      attr_reader :available
+    end
+    class Pending < Stripe::StripeObject
+      class SourceTypes < Stripe::StripeObject
+        # Amount for bank account.
+        sig { returns(Integer) }
+        attr_reader :bank_account
+
+        # Amount for card.
+        sig { returns(Integer) }
+        attr_reader :card
+
+        # Amount for FPX.
+        sig { returns(Integer) }
+        attr_reader :fpx
+      end
+      # Balance amount.
+      sig { returns(Integer) }
+      attr_reader :amount
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # Attribute for field source_types
+      sig { returns(SourceTypes) }
+      attr_reader :source_types
+    end
+    # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
+    sig { returns(T::Array[Available]) }
+    attr_reader :available
+
+    # Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
+    sig { returns(T::Array[ConnectReserved]) }
+    attr_reader :connect_reserved
+
+    # Funds that you can pay out using Instant Payouts.
+    sig { returns(T::Array[InstantAvailable]) }
+    attr_reader :instant_available
+
+    # Attribute for field issuing
+    sig { returns(Issuing) }
+    attr_reader :issuing
+
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.
+    sig { returns(T::Array[Pending]) }
+    attr_reader :pending
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+  end
+end

data/rbi/stripe/resources/balance_transaction.rbi

@@ -0,0 +1,182 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
+  #
+  # Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
+  class BalanceTransaction < APIResource
+    class FeeDetail < Stripe::StripeObject
+      # Amount of the fee, in cents.
+      sig { returns(Integer) }
+      attr_reader :amount
+
+      # ID of the Connect application that earned the fee.
+      sig { returns(T.nilable(String)) }
+      attr_reader :application
+
+      # 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).
+      sig { returns(String) }
+      attr_reader :currency
+
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      # Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.
+      sig { returns(String) }
+      attr_reader :type
+    end
+    # Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.
+    sig { returns(Integer) }
+    attr_reader :amount
+
+    # The date that the transaction's net funds become available in the Stripe balance.
+    sig { returns(Integer) }
+    attr_reader :available_on
+
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+
+    # 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).
+    sig { returns(String) }
+    attr_reader :currency
+
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+
+    # If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.
+    sig { returns(T.nilable(Float)) }
+    attr_reader :exchange_rate
+
+    # Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.
+    sig { returns(Integer) }
+    attr_reader :fee
+
+    # Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.
+    sig { returns(T::Array[FeeDetail]) }
+    attr_reader :fee_details
+
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+
+    # Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`
+    sig { returns(Integer) }
+    attr_reader :net
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.
+    sig { returns(String) }
+    attr_reader :reporting_category
+
+    # This transaction relates to the Stripe object.
+    sig {
+      returns(T.nilable(T.any(String, T.any(Stripe::ApplicationFee, Stripe::Charge, Stripe::ConnectCollectionTransfer, Stripe::CustomerCashBalanceTransaction, Stripe::Dispute, Stripe::ApplicationFeeRefund, Stripe::Issuing::Authorization, Stripe::Issuing::Dispute, Stripe::Issuing::Transaction, Stripe::Payout, Stripe::Refund, Stripe::ReserveTransaction, Stripe::TaxDeductedAtSource, Stripe::Topup, Stripe::Transfer, Stripe::Reversal))))
+     }
+    attr_reader :source
+
+    # The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.
+    sig { returns(String) }
+    attr_reader :status
+
+    # Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
+    sig { returns(String) }
+    attr_reader :type
+
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :gt
+
+        # Minimum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :gte
+
+        # Maximum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :lt
+
+        # Maximum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :lte
+
+        sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return transactions that were created during the given date interval.
+      sig { returns(T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer)) }
+      attr_accessor :created
+
+      # Only return transactions in a certain currency. 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).
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      sig { returns(String) }
+      attr_accessor :ending_before
+
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      # For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
+      sig { returns(String) }
+      attr_accessor :payout
+
+      # Only returns the original transaction.
+      sig { returns(String) }
+      attr_accessor :source
+
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      sig { returns(String) }
+      attr_accessor :starting_after
+
+      # Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.
+      sig { returns(String) }
+      attr_accessor :type
+
+      sig {
+        params(created: T.any(::Stripe::BalanceTransaction::ListParams::Created, Integer), currency: String, ending_before: String, expand: T::Array[String], limit: Integer, payout: String, source: String, starting_after: String, type: String).void
+       }
+      def initialize(
+        created: nil,
+        currency: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        payout: nil,
+        source: nil,
+        starting_after: nil,
+        type: nil
+      ); end
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+    #
+    # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+    sig {
+      params(params: T.any(::Stripe::BalanceTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/bank_account.rbi

@@ -0,0 +1,156 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
+  # destinations on `Account` objects for connected accounts.
+  # They can be bank accounts or debit cards as well, and are documented in the links above.
+  #
+  # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
+  class BankAccount < APIResource
+    class FutureRequirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        sig { returns(String) }
+        attr_reader :code
+
+        # An informative message that indicates the error type and provides additional details about the error.
+        sig { returns(String) }
+        attr_reader :reason
+
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        sig { returns(String) }
+        attr_reader :requirement
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :currently_due
+
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      sig { returns(T.nilable(T::Array[Error])) }
+      attr_reader :errors
+
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :past_due
+
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :pending_verification
+    end
+    class Requirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        sig { returns(String) }
+        attr_reader :code
+
+        # An informative message that indicates the error type and provides additional details about the error.
+        sig { returns(String) }
+        attr_reader :reason
+
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        sig { returns(String) }
+        attr_reader :requirement
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :currently_due
+
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      sig { returns(T.nilable(T::Array[Error])) }
+      attr_reader :errors
+
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :past_due
+
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :pending_verification
+    end
+    # The ID of the account that the bank account is associated with.
+    sig { returns(T.nilable(T.any(String, Stripe::Account))) }
+    attr_reader :account
+
+    # The name of the person or business that owns the bank account.
+    sig { returns(T.nilable(String)) }
+    attr_reader :account_holder_name
+
+    # The type of entity that holds the account. This can be either `individual` or `company`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :account_holder_type
+
+    # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :account_type
+
+    # A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :available_payout_methods
+
+    # Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
+    sig { returns(T.nilable(String)) }
+    attr_reader :bank_name
+
+    # Two-letter ISO code representing the country the bank account is located in.
+    sig { returns(String) }
+    attr_reader :country
+
+    # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+    sig { returns(String) }
+    attr_reader :currency
+
+    # The ID of the customer that the bank account is associated with.
+    sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
+    attr_reader :customer
+
+    # Whether this bank account is the default external account for its currency.
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :default_for_currency
+
+    # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+    sig { returns(T.nilable(String)) }
+    attr_reader :fingerprint
+
+    # Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
+    sig { returns(T.nilable(FutureRequirements)) }
+    attr_reader :future_requirements
+
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+
+    # The last four digits of the bank account number.
+    sig { returns(String) }
+    attr_reader :last4
+
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Information about the requirements for the bank account, including what information needs to be collected.
+    sig { returns(T.nilable(Requirements)) }
+    attr_reader :requirements
+
+    # The routing transit number for the bank account.
+    sig { returns(T.nilable(String)) }
+    attr_reader :routing_number
+
+    # 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 payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
+    #
+    # For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.
+    sig { returns(String) }
+    attr_reader :status
+
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+  end
+end