stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/resources/v2/money_management/financial_account.rb

@@ -0,0 +1,328 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # A FinancialAccount represents a balance and can be used as the source or destination for the money management (`/v2/money_management`) APIs.
+      class FinancialAccount < APIResource
+        OBJECT_NAME = "v2.money_management.financial_account"
+        def self.object_name
+          "v2.money_management.financial_account"
+        end
+
+        class AccruedFees < ::Stripe::StripeObject
+          # The currencies enabled for fee accrual on this FinancialAccount.
+          attr_reader :currencies
+          # Direction of fee accrual for this FinancialAccount.
+          attr_reader :direction
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Balance < ::Stripe::StripeObject
+          # Balance that can be used for money movement.
+          attr_reader :available
+          # Balance of inbound funds that will later transition to the `available` balance.
+          attr_reader :inbound_pending
+          # Balance of funds that are being used for a pending outbound money movement.
+          attr_reader :outbound_pending
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Credit < ::Stripe::StripeObject
+          class FundedBy < ::Stripe::StripeObject
+            class Platform < ::Stripe::StripeObject
+              # The platform FinancialAccount used to fund this credit FinancialAccount.
+              attr_reader :financial_account
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Details for platform-funded credit FinancialAccounts.
+            attr_reader :platform
+            # The type of funding source for this credit FinancialAccount.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = { platform: Platform }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Details about how this credit FinancialAccount is funded.
+          attr_reader :funded_by
+          # The currencies supported by this credit FinancialAccount.
+          attr_reader :supported_currencies
+
+          def self.inner_class_types
+            @inner_class_types = { funded_by: FundedBy }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ManagedBy < ::Stripe::StripeObject
+          # Enum describing the Stripe product that is managing this FinancialAccount.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class MultiprocessorSettlement < ::Stripe::StripeObject
+          # Settlement currencies enabled for this FinancialAccount.
+          attr_reader :settlement_currencies
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Other < ::Stripe::StripeObject
+          # The type of the FinancialAccount, represented as a string. Upgrade your API version to see the type reflected in `financial_account.type`.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Payments < ::Stripe::StripeObject
+          class BalanceByFundsType < ::Stripe::StripeObject
+            class PaymentProcessing < ::Stripe::StripeObject
+              # Balance that can be used for money movement.
+              attr_reader :available
+              # Balance of inbound funds that will later transition to the `available` balance.
+              attr_reader :inbound_pending
+              # Balance of funds that are being used for a pending outbound money movement.
+              attr_reader :outbound_pending
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+
+            class StoredValue < ::Stripe::StripeObject
+              # Balance that can be used for money movement.
+              attr_reader :available
+              # Balance of inbound funds that will later transition to the `available` balance.
+              attr_reader :inbound_pending
+              # Balance of funds that are being used for a pending outbound money movement.
+              attr_reader :outbound_pending
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Payment processing funds are those that are received for goods or services and may only be used for payouts to self. These funds may be converted to stored value funds.
+            attr_reader :payment_processing
+            # Stored value funds may be used for either payouts to self or payments to others.
+            attr_reader :stored_value
+
+            def self.inner_class_types
+              @inner_class_types = {
+                payment_processing: PaymentProcessing,
+                stored_value: StoredValue,
+              }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class StartingBalance < ::Stripe::StripeObject
+            # When the balance was projected.
+            attr_reader :at
+            # The available balance at the time when the balance was projected.
+            attr_reader :available
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The balance of the `payments` FinancialAccount is a mix of payment processing and stored value funds, and this field
+          # describes the breakdown between the two. The sum will match the balance of the FinancialAccount.
+          attr_reader :balance_by_funds_type
+          # The currency that non-settlement currency payments will be converted to.
+          attr_reader :default_currency
+          # Settlement currencies enabled for this FinancialAccount. Payments in other currencies will be automatically converted to `default_currency`.
+          attr_reader :settlement_currencies
+          # Describes the available balance when it was projected.
+          attr_reader :starting_balance
+
+          def self.inner_class_types
+            @inner_class_types = {
+              balance_by_funds_type: BalanceByFundsType,
+              starting_balance: StartingBalance,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Closed < ::Stripe::StripeObject
+            class ForwardingSettings < ::Stripe::StripeObject
+              # The address to send forwarded payments to.
+              attr_reader :payment_method
+              # The address to send forwarded payouts to.
+              attr_reader :payout_method
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The forwarding settings for the closed FinancialAccount.
+            attr_reader :forwarding_settings
+            # The reason the FinancialAccount was closed.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = { forwarding_settings: ForwardingSettings }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Details related to the closed state of the FinancialAccount.
+          attr_reader :closed
+
+          def self.inner_class_types
+            @inner_class_types = { closed: Closed }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Storage < ::Stripe::StripeObject
+          # The usage type for funds in this FinancialAccount. Can be used to specify that the funds are for Consumer activity.
+          attr_reader :funds_usage_type
+          # The currencies that this FinancialAccount can hold.
+          attr_reader :holds_currencies
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # If this is a `accrued_fees` FinancialAccount, this hash include details specific to `accrued_fees` FinancialAccount.
+        attr_reader :accrued_fees
+        # Multi-currency balance of this FinancialAccount, split by availability state. Each balance is represented as a hash where the key is the three-letter ISO currency code, in lowercase, and the value is the amount for that currency.
+        attr_reader :balance
+        # Open Enum. Two-letter country code that represents the country where the LegalEntity associated with the FinancialAccount is based in.
+        attr_reader :country
+        # Time at which the object was created.
+        attr_reader :created
+        # If this is a `credit` FinancialAccount, this hash includes details specific to `credit` FinancialAccounts.
+        attr_reader :credit
+        # A descriptive name for the FinancialAccount, up to 50 characters long. This name will be used in the Stripe Dashboard and embedded components.
+        attr_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # If this is a managed FinancialAccount, `managed_by` indicates the product that created and manages this FinancialAccount. For managed FinancialAccounts,
+        # creation of money management resources can only be orchestrated by the managing product.
+        attr_reader :managed_by
+        # Metadata associated with the FinancialAccount.
+        attr_reader :metadata
+        # If this is a `multiprocessor_settlement` FinancialAccount, this hash includes details specific to `multiprocessor_settlement` FinancialAccounts.
+        attr_reader :multiprocessor_settlement
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # If this is a `other` FinancialAccount, this hash indicates what the actual type is. Upgrade your API version to see it reflected in `type`.
+        attr_reader :other
+        # If this is a `payments` FinancialAccount, this hash include details specific to `payments` FinancialAccount.
+        attr_reader :payments
+        # Closed Enum. An enum representing the status of the FinancialAccount. This indicates whether or not the FinancialAccount can be used for any money movement flows.
+        attr_reader :status
+        # Additional details related to the status of the FinancialAccount.
+        attr_reader :status_details
+        # If this is a `storage` FinancialAccount, this hash includes details specific to `storage` FinancialAccounts.
+        attr_reader :storage
+        # Type of the FinancialAccount. An additional hash is included on the FinancialAccount with a name matching this value.
+        # It contains additional information specific to the FinancialAccount type.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            accrued_fees: AccruedFees,
+            balance: Balance,
+            credit: Credit,
+            managed_by: ManagedBy,
+            multiprocessor_settlement: MultiprocessorSettlement,
+            other: Other,
+            payments: Payments,
+            status_details: StatusDetails,
+            storage: Storage,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/financial_account_statement.rb

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # A Financial Account Statement represents a monthly statement for a Financial Account.
+      class FinancialAccountStatement < APIResource
+        OBJECT_NAME = "v2.money_management.financial_account_statement"
+        def self.object_name
+          "v2.money_management.financial_account_statement"
+        end
+
+        class FilesByCurrency < ::Stripe::StripeObject
+          class DownloadUrl < ::Stripe::StripeObject
+            # The time at which the URL expires, in ISO 8601 format (UTC).
+            attr_reader :expires_at
+            # The URL to download the file.
+            attr_reader :url
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The MIME type of the file.
+          attr_reader :content_type
+          # The download URL and expiration.
+          attr_reader :download_url
+          # The size of the file in bytes.
+          attr_reader :size
+
+          def self.inner_class_types
+            @inner_class_types = { download_url: DownloadUrl }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { size: :int64_string }
+          end
+        end
+
+        class Period < ::Stripe::StripeObject
+          # The end of the statement period (inclusive), as a UTC-aligned ISO 8601 date
+          # (e.g., "2026-05-31"). For example, a May 2026 statement has end_date "2026-05-31",
+          # meaning all transactions up to and including May 31st UTC are included.
+          attr_reader :end_date
+          # The start of the statement period (inclusive), as a UTC-aligned ISO 8601 date (e.g., "2026-05-01").
+          attr_reader :start_date
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the statement was created, in ISO 8601 format (UTC).
+        attr_reader :created
+        # Available balance at the end of the statement period.
+        attr_reader :ending_balance
+        # Currency-specific files and file metadata. Null by default, populated by specifying include=files_by_currency in the Retrieve endpoint.
+        attr_reader :files_by_currency
+        # The Financial Account this statement belongs to.
+        attr_reader :financial_account
+        # Unique identifier for the statement.
+        attr_reader :id
+        # True if the object exists in live mode, false if in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The time period covered by this statement.
+        attr_reader :period
+        # The ID of the statement that replaced this one. Only present on statements that have been restated.
+        attr_reader :restated_by
+        # The ID of the statement this one replaces. Only present on restatements.
+        attr_reader :restated_statement
+        # Available balance at the start of the statement period.
+        attr_reader :starting_balance
+        # The status of the statement. A statement is "active" by default.
+        # When a statement is replaced by a restatement, its status becomes "restated".
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { files_by_currency: FilesByCurrency, period: Period }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/financial_address.rb

@@ -0,0 +1,225 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # A Financial Address contains information needed to transfer money to a Financial Account. A Financial Account can have more than one Financial Address.
+      class FinancialAddress < APIResource
+        OBJECT_NAME = "v2.money_management.financial_address"
+        def self.object_name
+          "v2.money_management.financial_address"
+        end
+
+        class Credentials < ::Stripe::StripeObject
+          class CaBankAccount < ::Stripe::StripeObject
+            # The account holder name to be used during bank transfers.
+            attr_reader :account_holder_name
+            # The account number of the Canadian Bank Account.
+            attr_reader :account_number
+            # The name of the Bank.
+            attr_reader :bank_name
+            # The institution number of the Canadian Bank Account.
+            attr_reader :institution_number
+            # The last four digits of the Canadian Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+            # The transit number of the Canadian Bank Account.
+            attr_reader :transit_number
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class CryptoWallet < ::Stripe::StripeObject
+            # The blockchain address of the crypto wallet.
+            attr_reader :address
+            # Required if the network supports memos (e.g. Stellar).
+            attr_reader :memo
+            # The blockchain network of the crypto wallet.
+            attr_reader :network
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class GbBankAccount < ::Stripe::StripeObject
+            # The account holder name to be used during bank transference.
+            attr_reader :account_holder_name
+            # The account number of the UK Bank Account.
+            attr_reader :account_number
+            # The last four digits of the UK Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+            # The sort code of the UK Bank Account.
+            attr_reader :sort_code
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class MxBankAccount < ::Stripe::StripeObject
+            # The account holder name to be used during bank transfers.
+            attr_reader :account_holder_name
+            # The CLABE (Clave Bancaria Estandarizada) of the Mexican Bank Account.
+            attr_reader :clabe
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class SepaBankAccount < ::Stripe::StripeObject
+            # The account holder name to be used during bank transfers.
+            attr_reader :account_holder_name
+            # The name of the Bank.
+            attr_reader :bank_name
+            # The BIC of the SEPA Bank Account.
+            attr_reader :bic
+            # The originating country of the SEPA Bank account.
+            attr_reader :country
+            # The IBAN of the SEPA Bank Account.
+            attr_reader :iban
+            # The last four digits of the SEPA Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class UsBankAccount < ::Stripe::StripeObject
+            class AccountHolderAddress < ::Stripe::StripeObject
+              # The city of the address.
+              attr_reader :city
+              # The country of the address.
+              attr_reader :country
+              # The first line of the address.
+              attr_reader :line1
+              # The second line of the address.
+              attr_reader :line2
+              # The postal / zip code of the address.
+              attr_reader :postal_code
+              # The state of the address.
+              attr_reader :state
+              # The town of the address.
+              attr_reader :town
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The address of the account holder.
+            attr_reader :account_holder_address
+            # The name of the account holder.
+            attr_reader :account_holder_name
+            # The account number of the US Bank Account.
+            attr_reader :account_number
+            # The name of the Bank.
+            attr_reader :bank_name
+            # The BIC of the bank or financial institution.
+            attr_reader :bic
+            # The last four digits of the US Bank Account number. This will always be returned.
+            # To view the full account number when retrieving or listing FinancialAddresses, use the `include` request parameter.
+            attr_reader :last4
+            # The routing number of the US Bank Account.
+            attr_reader :routing_number
+
+            def self.inner_class_types
+              @inner_class_types = { account_holder_address: AccountHolderAddress }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The credentials of the Canadian Bank Account for the FinancialAddress. This contains unique banking details such as the account number, institution number, etc. of a Canadian bank account.
+          attr_reader :ca_bank_account
+          # The credentials of the crypto wallet for the Financial Address. This contains unique details such as the blockchain network, wallet address, and memo of a crypto wallet.
+          attr_reader :crypto_wallet
+          # The credentials of the UK Bank Account for the FinancialAddress. This contains unique banking details such as the sort code, account number, etc. of a UK bank account.
+          attr_reader :gb_bank_account
+          # The credentials of the Mexican Bank Account for the FinancialAddress. This contains unique banking details such as the CLABE and account holder name of a Mexican bank account.
+          attr_reader :mx_bank_account
+          # The credentials of the SEPA Bank Account for the FinancialAddress. This contains unique banking details such as the IBAN, BIC, etc. of a SEPA bank account.
+          attr_reader :sepa_bank_account
+          # Open Enum. The type of Credentials that are provisioned for the FinancialAddress.
+          attr_reader :type
+          # The credentials of the US Bank Account for the FinancialAddress. This contains unique banking details such as the routing number, account number, etc. of a US bank account.
+          attr_reader :us_bank_account
+
+          def self.inner_class_types
+            @inner_class_types = {
+              ca_bank_account: CaBankAccount,
+              crypto_wallet: CryptoWallet,
+              gb_bank_account: GbBankAccount,
+              mx_bank_account: MxBankAccount,
+              sepa_bank_account: SepaBankAccount,
+              us_bank_account: UsBankAccount,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The creation timestamp of the FinancialAddress.
+        attr_reader :created
+        # Object indicates the type of credentials that have been allocated and attached to the FinancialAddress.
+        # It contains all necessary banking details with which to perform money movements with the FinancialAddress.
+        # This field is only available for FinancialAddresses with an active status.
+        attr_reader :credentials
+        # Open Enum. The currency the FinancialAddress supports.
+        attr_reader :currency
+        # A ID of the FinancialAccount this FinancialAddress corresponds to.
+        attr_reader :financial_account
+        # The ID of a FinancialAddress.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Open Enum. The currency the FinancialAddress settles into the FinancialAccount.
+        attr_reader :settlement_currency
+        # Closed Enum. An enum representing the status of the FinancialAddress. This indicates whether or not the FinancialAddress can be used for any money movement flows.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { credentials: Credentials }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/money_management/financial_address_debit_simulation.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Debit Simulations represent a simulated debit transaction applied to financial addresses for testing purposes.
+      class FinancialAddressDebitSimulation < APIResource
+        OBJECT_NAME = "v2.money_management.financial_address_debit_simulation"
+        def self.object_name
+          "v2.money_management.financial_address_debit_simulation"
+        end
+
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The status of the request, signifying whether a simulated debit was initiated.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end