stripe 5.55.0 → 18.2.0.pre.beta.1

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

@@ -0,0 +1,240 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # OutboundTransfer represents a single money movement from one FinancialAccount you own to a payout method you also own.
+      class OutboundTransfer < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_transfer"
+        def self.object_name
+          "v2.money_management.outbound_transfer"
+        end
+
+        class Amount < ::Stripe::StripeObject
+          # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+          attr_reader :value
+          # 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).
+          attr_reader :currency
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class DeliveryOptions < ::Stripe::StripeObject
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class From < ::Stripe::StripeObject
+          class Debited < ::Stripe::StripeObject
+            # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+            attr_reader :value
+            # 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).
+            attr_reader :currency
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount debited from the sender, only set on responses.
+          attr_reader :debited
+          # The FinancialAccount that funds were pulled from.
+          attr_reader :financial_account
+
+          def self.inner_class_types
+            @inner_class_types = { debited: Debited }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Failed < ::Stripe::StripeObject
+            # Open Enum. The `failed` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Returned < ::Stripe::StripeObject
+            # Open Enum. The `returned` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The `failed` status reason.
+          attr_reader :failed
+          # The `returned` status reason.
+          attr_reader :returned
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed, returned: Returned }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when an OutboundTransfer changed status to `canceled`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :canceled_at
+          # Timestamp describing when an OutboundTransfer changed status to `failed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :failed_at
+          # Timestamp describing when an OutboundTransfer changed status to `posted`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :posted_at
+          # Timestamp describing when an OutboundTransfer changed status to `returned`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :returned_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class To < ::Stripe::StripeObject
+          class Credited < ::Stripe::StripeObject
+            # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+            attr_reader :value
+            # 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).
+            attr_reader :currency
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The monetary amount being credited to the destination.
+          attr_reader :credited
+          # The payout method which the OutboundTransfer uses to send payout.
+          attr_reader :payout_method
+
+          def self.inner_class_types
+            @inner_class_types = { credited: Credited }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TraceId < ::Stripe::StripeObject
+          # Possible values are `pending`, `supported`, and `unsupported`. Initially set to `pending`, it changes to
+          # `supported` when the recipient bank provides a trace ID, or `unsupported` if the recipient bank doesn't support it.
+          # Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain `pending`
+          # even after the payment or transfer is posted.
+          attr_reader :status
+          # The trace ID value if `trace_id.status` is `supported`, otherwise empty.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The "presentment amount" for the OutboundTransfer.
+        attr_reader :amount
+        # Returns true if the OutboundTransfer can be canceled, and false otherwise.
+        attr_reader :cancelable
+        # Time at which the OutboundTransfer was created.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # Delivery options to be used to send the OutboundTransfer.
+        attr_reader :delivery_options
+        # An arbitrary string attached to the OutboundTransfer. Often useful for displaying to users.
+        attr_reader :description
+        # The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a `failed`, `canceled`, or `returned` state.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :expected_arrival_date
+        # The FinancialAccount that funds were pulled from.
+        attr_reader :from
+        # Unique identifier for the OutboundTransfer.
+        attr_reader :id
+        # 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.
+        attr_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A link to the Stripe-hosted receipt for this OutboundTransfer. The receipt link remains active for 60 days from the OutboundTransfer creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings.
+        attr_reader :statement_descriptor
+        # Closed Enum. Current status of the OutboundTransfer: `processing`, `failed`, `posted`, `returned`, `canceled`.
+        # An OutboundTransfer is `processing` if it has been created and is processing.
+        # The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
+        # If an OutboundTransfer fails to arrive at its payout method, its status will change to `returned`.
+        attr_reader :status
+        # Status details for an OutboundTransfer in a `failed` or `returned` state.
+        attr_reader :status_details
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # To which payout method the OutboundTransfer was sent.
+        attr_reader :to
+        # A unique identifier that can be used to track this OutboundTransfer with recipient bank. Banks might call this a “reference number” or something similar.
+        attr_reader :trace_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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amount: Amount,
+            delivery_options: DeliveryOptions,
+            from: From,
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            to: To,
+            trace_id: TraceId,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use the PayoutMethods API to list and interact with PayoutMethod objects.
+      class PayoutMethod < APIResource
+        OBJECT_NAME = "v2.money_management.payout_method"
+        def self.object_name
+          "v2.money_management.payout_method"
+        end
+
+        class UsageStatus < ::Stripe::StripeObject
+          # Payments status - used when sending OutboundPayments (sending funds to recipients).
+          attr_reader :payments
+          # Transfers status - used when making an OutboundTransfer (sending funds to yourself).
+          attr_reader :transfers
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BankAccount < ::Stripe::StripeObject
+          # Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through
+          # the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects
+          # cannot be used as payout methods and will not appear in the payout method list.
+          attr_reader :archived
+          # The type of bank account (checking or savings).
+          attr_reader :bank_account_type
+          # The name of the bank this bank account is in. This field is populated automatically by Stripe.
+          attr_reader :bank_name
+          # The country code of the bank account.
+          attr_reader :country
+          # List of enabled flows for this bank account (wire or local).
+          attr_reader :enabled_delivery_options
+          # The ID of the Financial Connections Account used to create the bank account.
+          attr_reader :financial_connections_account
+          # The last 4 digits of the account number.
+          attr_reader :last4
+          # The routing number of the bank account, if present.
+          attr_reader :routing_number
+          # The list of currencies supported by this bank account.
+          attr_reader :supported_currencies
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Card < ::Stripe::StripeObject
+          # Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through
+          # the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects
+          # cannot be used as payout methods and will not appear in the payout method list.
+          attr_reader :archived
+          # The month the card expires.
+          attr_reader :exp_month
+          # The year the card expires.
+          attr_reader :exp_year
+          # The last 4 digits of the card number.
+          attr_reader :last4
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # A set of available payout speeds for this payout method.
+        attr_reader :available_payout_speeds
+        # Created timestamp.
+        attr_reader :created
+        # ID of the PayoutMethod object.
+        attr_reader :id
+        # ID of the underlying active OutboundSetupIntent object, if any.
+        attr_reader :latest_outbound_setup_intent
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Closed Enum. The type of payout method.
+        attr_reader :type
+        # Indicates whether the payout method has met the necessary requirements for outbound money movement.
+        attr_reader :usage_status
+        # 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
+        # The PayoutMethodBankAccount object details.
+        attr_reader :bank_account
+        # The PayoutMethodCard object details.
+        attr_reader :card
+
+        def self.inner_class_types
+          @inner_class_types = { usage_status: UsageStatus, bank_account: BankAccount, card: Card }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # The PayoutMethodsBankAccountSpec object.
+      class PayoutMethodsBankAccountSpec < SingletonAPIResource
+        OBJECT_NAME = "v2.money_management.payout_methods_bank_account_spec"
+        def self.object_name
+          "v2.money_management.payout_methods_bank_account_spec"
+        end
+
+        class Countries < ::Stripe::StripeObject
+          class Field < ::Stripe::StripeObject
+            class LocalNameHuman < ::Stripe::StripeObject
+              # The default content of the localizable string.
+              attr_reader :content
+              # A unique key representing the instance of this localizable string.
+              attr_reader :localization_key
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The local name of the field.
+            attr_reader :local_name
+            # The human readable local name of the field.
+            attr_reader :local_name_human
+            # The maximum length of the field.
+            attr_reader :max_length
+            # THe minimum length of the field.
+            attr_reader :min_length
+            # The placeholder value of the field.
+            attr_reader :placeholder
+            # The stripe name of the field.
+            attr_reader :stripe_name
+            # The validation regex of the field.
+            attr_reader :validation_regex
+
+            def self.inner_class_types
+              @inner_class_types = { local_name_human: LocalNameHuman }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The list of fields for a country, along with associated information.
+          attr_reader :fields
+
+          def self.inner_class_types
+            @inner_class_types = { fields: Field }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The list of specs by country.
+        attr_reader :countries
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = { countries: Countries }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,246 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use ReceivedCredits API to retrieve information on when, where, and how funds are sent into your FinancialAccount.
+      class ReceivedCredit < APIResource
+        OBJECT_NAME = "v2.money_management.received_credit"
+        def self.object_name
+          "v2.money_management.received_credit"
+        end
+
+        class Amount < ::Stripe::StripeObject
+          # A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
+          attr_reader :value
+          # 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).
+          attr_reader :currency
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusDetails < ::Stripe::StripeObject
+          class Failed < ::Stripe::StripeObject
+            # Open Enum. The `failed` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class Returned < ::Stripe::StripeObject
+            # Open Enum. The `returned` status reason.
+            attr_reader :reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Hash that provides additional information regarding the reason behind a `failed` ReceivedCredit status. It is only present when the ReceivedCredit status is `failed`.
+          attr_reader :failed
+          # Hash that provides additional information regarding the reason behind a `returned` ReceivedCredit status. It is only present when the ReceivedCredit status is `returned`.
+          attr_reader :returned
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed, returned: Returned }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when the ReceivedCredit was marked as `failed`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :failed_at
+          # Timestamp describing when the ReceivedCredit changed status to `returned`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :returned_at
+          # Timestamp describing when the ReceivedCredit was marked as `succeeded`.
+          # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+          attr_reader :succeeded_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BalanceTransfer < ::Stripe::StripeObject
+          # The ID of the account that owns the source object originated the ReceivedCredit.
+          attr_reader :from_account
+          # Open Enum. The type of Stripe Money Movement that originated the ReceivedCredit.
+          attr_reader :type
+          # The ID of the outbound payment object that originated the ReceivedCredit.
+          attr_reader :outbound_payment
+          # The ID of the outbound transfer object that originated the ReceivedCredit.
+          attr_reader :outbound_transfer
+          # The ID of the payout object that originated the ReceivedCredit.
+          attr_reader :payout_v1
+          # The ID of the v1 transfer object that originated the ReceivedCredit.
+          attr_reader :transfer
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BankTransfer < ::Stripe::StripeObject
+          class GbBankAccount < ::Stripe::StripeObject
+            # The bank name the transfer was received from.
+            attr_reader :account_holder_name
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The last 4 digits of the account number that originated the transfer.
+            attr_reader :last4
+            # Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+            # The sort code of the account that originated the transfer.
+            attr_reader :sort_code
+
+            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 of the bank account the transfer was received from.
+            attr_reader :account_holder_name
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The BIC of the SEPA account.
+            attr_reader :bic
+            # The origination country of the bank transfer.
+            attr_reader :country
+            # The IBAN that originated the transfer.
+            attr_reader :iban
+            # The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class UsBankAccount < ::Stripe::StripeObject
+            # The bank name the transfer was received from.
+            attr_reader :bank_name
+            # The last 4 digits of the account number that originated the transfer.
+            attr_reader :last4
+            # Open Enum. The money transmission network used to send funds for this ReceivedCredit.
+            attr_reader :network
+            # The routing number of the account that originated the transfer.
+            attr_reader :routing_number
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Financial Address on which funds for ReceivedCredit were received.
+          attr_reader :financial_address
+          # Open Enum. Indicates the origin of source from which external funds originated from.
+          attr_reader :origin_type
+          # Freeform string set by originator of the external ReceivedCredit.
+          attr_reader :statement_descriptor
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `gb_bank_account`.
+          attr_reader :gb_bank_account
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `sepa_bank_account`.
+          attr_reader :sepa_bank_account
+          # Hash containing the transaction bank details. Present if `origin_type` field value is `us_bank_account`.
+          attr_reader :us_bank_account
+
+          def self.inner_class_types
+            @inner_class_types = {
+              gb_bank_account: GbBankAccount,
+              sepa_bank_account: SepaBankAccount,
+              us_bank_account: UsBankAccount,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount and currency of the ReceivedCredit.
+        attr_reader :amount
+        # Time at which the ReceivedCredit was created.
+        # Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # Freeform string set by originator of the ReceivedCredit.
+        attr_reader :description
+        # Financial Account ID on which funds for ReceivedCredit were received.
+        attr_reader :financial_account
+        # Unique identifier for the ReceivedCredit.
+        attr_reader :id
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe’s money transmission licenses.
+        attr_reader :receipt_url
+        # Open Enum. The status of the ReceivedCredit.
+        attr_reader :status
+        # This hash contains detailed information that elaborates on the specific status of the ReceivedCredit. e.g the reason behind a failure if the status is marked as `failed`.
+        attr_reader :status_details
+        # Hash containing timestamps of when the object transitioned to a particular status.
+        attr_reader :status_transitions
+        # Open Enum. The type of flow that caused the ReceivedCredit.
+        attr_reader :type
+        # 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
+        # This object stores details about the originating Stripe transaction that resulted in the ReceivedCredit. Present if `type` field value is `balance_transfer`.
+        attr_reader :balance_transfer
+        # This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `bank_transfer`.
+        attr_reader :bank_transfer
+
+        def self.inner_class_types
+          @inner_class_types = {
+            amount: Amount,
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            balance_transfer: BalanceTransfer,
+            bank_transfer: BankTransfer,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end