stripe 19.3.0 → 19.4.0.pre.alpha.2

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

@@ -0,0 +1,181 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # An InboundTransfer object, representing a money movement from a
+      # user owned PaymentMethod to a FinancialAccount belonging to the same user.
+      class InboundTransfer < APIResource
+        OBJECT_NAME = "v2.money_management.inbound_transfer"
+        def self.object_name
+          "v2.money_management.inbound_transfer"
+        end
+
+        class From < ::Stripe::StripeObject
+          class PaymentMethod < ::Stripe::StripeObject
+            # The type of object this destination represents. For a us bank account, we expect us_bank_account.
+            attr_reader :type
+            # The destination US bank account identifier. eg "usba_***".
+            attr_reader :us_bank_account
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The amount in specified currency that was debited from the Payment Method.
+          attr_reader :debited
+          # The Payment Method object used to create the InboundTransfer.
+          attr_reader :payment_method
+
+          def self.inner_class_types
+            @inner_class_types = { payment_method: PaymentMethod }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class To < ::Stripe::StripeObject
+          # The amount by which the FinancialAccount balance is credited.
+          attr_reader :credited
+          # The FinancialAccount that funds will land in.
+          attr_reader :financial_account
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TransferHistory < ::Stripe::StripeObject
+          class BankDebitFailed < ::Stripe::StripeObject
+            # Open Enum. The return reason for the failed InboundTransfer.
+            attr_reader :failure_reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class BankDebitProcessing < ::Stripe::StripeObject
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class BankDebitQueued < ::Stripe::StripeObject
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class BankDebitReturned < ::Stripe::StripeObject
+            # Open Enum. The return reason for the returned InboundTransfer.
+            attr_reader :return_reason
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class BankDebitSucceeded < ::Stripe::StripeObject
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The history entry for a failed InboundTransfer.
+          attr_reader :bank_debit_failed
+          # The history entry for a processing InboundTransfer.
+          attr_reader :bank_debit_processing
+          # The history entry for a queued InboundTransfer.
+          attr_reader :bank_debit_queued
+          # The history entry for a returned InboundTransfer.
+          attr_reader :bank_debit_returned
+          # The history entry for a succeeded InboundTransfer.
+          attr_reader :bank_debit_succeeded
+          # Creation time of the HistoryEntry in RFC 3339 format and UTC.
+          attr_reader :created
+          # Effective at time of the HistoryEntry in RFC 3339 format and UTC.
+          attr_reader :effective_at
+          # A unique ID for the HistoryEntry.
+          attr_reader :id
+          # Open Enum. The Level of the HistoryEntry.
+          attr_reader :level
+          # Open Enum. The type of the HistoryEntry.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {
+              bank_debit_failed: BankDebitFailed,
+              bank_debit_processing: BankDebitProcessing,
+              bank_debit_queued: BankDebitQueued,
+              bank_debit_returned: BankDebitReturned,
+              bank_debit_succeeded: BankDebitSucceeded,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The amount in specified currency that will land in the FinancialAccount balance.
+        attr_reader :amount
+        # Creation time of the InboundTransfer. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
+        attr_reader :created
+        # A freeform text field provided by user, containing metadata.
+        attr_reader :description
+        # A nested object containing information about the origin of the InboundTransfer.
+        attr_reader :from
+        # Unique identifier for the InboundTransfer.
+        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
+        # A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+        attr_reader :receipt_url
+        # A nested object containing information about the destination of the InboundTransfer.
+        attr_reader :to
+        # A list of history objects, representing changes in the state of the InboundTransfer. The most recent entry's type indicates the current status of the InboundTransfer.
+        attr_reader :transfer_history
+
+        def self.inner_class_types
+          @inner_class_types = { from: From, to: To, transfer_history: TransferHistory }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,374 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # OutboundPayment represents a single money movement from one FinancialAccount you own to a payout method someone else owns.
+      class OutboundPayment < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_payment"
+        def self.object_name
+          "v2.money_management.outbound_payment"
+        end
+
+        class DeliveryOptions < ::Stripe::StripeObject
+          class PaperCheck < ::Stripe::StripeObject
+            # The ID of a file to include as an attachment with the paper check.
+            attr_reader :attachment
+            # Memo printed on the memo field of the check.
+            attr_reader :memo
+            # Open Enum. Shipping speed of the paper check.
+            attr_reader :shipping_speed
+            # Signature for the paper check.
+            attr_reader :signature
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+          # Delivery options for paper check.
+          attr_reader :paper_check
+          # Open Enum. Speed of the payout.
+          attr_reader :speed
+
+          def self.inner_class_types
+            @inner_class_types = { paper_check: PaperCheck }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class From < ::Stripe::StripeObject
+          # 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 = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class RecipientNotification < ::Stripe::StripeObject
+          # Closed Enum. Configuration option to enable or disable notifications to recipients.
+          # Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
+          attr_reader :setting
+
+          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 Processing < ::Stripe::StripeObject
+            # Open Enum. The `processing` 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 `processing` status details.
+          attr_reader :processing
+          # The `returned` status reason.
+          attr_reader :returned
+
+          def self.inner_class_types
+            @inner_class_types = { failed: Failed, processing: Processing, returned: Returned }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class StatusTransitions < ::Stripe::StripeObject
+          # Timestamp describing when an OutboundPayment 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 OutboundPayment 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 OutboundPayment 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 OutboundPayment 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 PayoutMethodOptions < ::Stripe::StripeObject
+            class BankAccount < ::Stripe::StripeObject
+              class PreferredNetworkOptions < ::Stripe::StripeObject
+                class Ach < ::Stripe::StripeObject
+                  # Open Enum. ACH submission timing.
+                  attr_reader :submission
+                  # The transaction purpose for this ACH payment.
+                  attr_reader :transaction_purpose
+
+                  def self.inner_class_types
+                    @inner_class_types = {}
+                  end
+
+                  def self.field_remappings
+                    @field_remappings = {}
+                  end
+                end
+                # ACH-specific network options.
+                attr_reader :ach
+
+                def self.inner_class_types
+                  @inner_class_types = { ach: Ach }
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # Per-network configuration options.
+              attr_reader :preferred_network_options
+              # The preferred networks to use for this OutboundPayment.
+              attr_reader :preferred_networks
+
+              def self.inner_class_types
+                @inner_class_types = { preferred_network_options: PreferredNetworkOptions }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Options for bank account payout methods.
+            attr_reader :bank_account
+
+            def self.inner_class_types
+              @inner_class_types = { bank_account: BankAccount }
+            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 OutboundPayment uses to send payout.
+          attr_reader :payout_method
+          # Payout method options for the OutboundPayment.
+          attr_reader :payout_method_options
+          # To which account the OutboundPayment is sent.
+          attr_reader :recipient
+
+          def self.inner_class_types
+            @inner_class_types = { payout_method_options: PayoutMethodOptions }
+          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
+
+        class TrackingDetails < ::Stripe::StripeObject
+          class PaperCheck < ::Stripe::StripeObject
+            class MailingAddress < ::Stripe::StripeObject
+              # City, district, suburb, town, or village.
+              attr_reader :city
+              # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+              attr_reader :country
+              # Address line 1 (e.g., street, PO Box, or company name).
+              attr_reader :line1
+              # Address line 2 (e.g., apartment, suite, unit, or building).
+              attr_reader :line2
+              # ZIP or postal code.
+              attr_reader :postal_code
+              # State, county, province, or region.
+              attr_reader :state
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Open Enum. Carrier of the paper check.
+            attr_reader :carrier
+            # Check number.
+            attr_reader :check_number
+            # Postal code of the latest tracking update.
+            attr_reader :current_postal_code
+            # Mailing address of the paper check.
+            attr_reader :mailing_address
+            # Tracking number for the check.
+            attr_reader :tracking_number
+            # Open Enum. Tracking status of the paper check.
+            attr_reader :tracking_status
+            # When the tracking details were last updated.
+            attr_reader :updated_at
+
+            def self.inner_class_types
+              @inner_class_types = { mailing_address: MailingAddress }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Paper check tracking details.
+          attr_reader :paper_check
+
+          def self.inner_class_types
+            @inner_class_types = { paper_check: PaperCheck }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The "presentment amount" for the OutboundPayment.
+        attr_reader :amount
+        # Returns true if the OutboundPayment can be canceled, and false otherwise.
+        attr_reader :cancelable
+        # Time at which the OutboundPayment 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 OutboundPayment.
+        attr_reader :delivery_options
+        # An arbitrary string attached to the OutboundPayment. 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 OutboundPayment.
+        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
+        # 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
+        # The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.
+        attr_reader :outbound_payment_quote
+        # The purpose of the OutboundPayment.
+        attr_reader :purpose
+        # A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null.
+        attr_reader :receipt_url
+        # Details about the OutboundPayment notification settings for recipient.
+        attr_reader :recipient_notification
+        # The recipient verification id for this OutboundPayment. Only required for countries with regulatory mandates to verify recipient names before OutboundPayment creation.
+        attr_reader :recipient_verification
+        # The description that appears on the receiving end for an OutboundPayment (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 OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`.
+        # An OutboundPayment is `processing` if it has been created and is processing.
+        # The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`.
+        # If an OutboundPayment fails to arrive at its payout method, its status will change to `returned`.
+        attr_reader :status
+        # Status details for an OutboundPayment in a `processing`, `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 OutboundPayment was sent.
+        attr_reader :to
+        # A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a "reference number" or something similar.
+        attr_reader :trace_id
+        # Information to track this OutboundPayment with the recipient bank.
+        attr_reader :tracking_details
+
+        def self.inner_class_types
+          @inner_class_types = {
+            delivery_options: DeliveryOptions,
+            from: From,
+            recipient_notification: RecipientNotification,
+            status_details: StatusDetails,
+            status_transitions: StatusTransitions,
+            to: To,
+            trace_id: TraceId,
+            tracking_details: TrackingDetails,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # OutboundPaymentQuote represents a quote that provides fee and amount estimates for OutboundPayment.
+      class OutboundPaymentQuote < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_payment_quote"
+        def self.object_name
+          "v2.money_management.outbound_payment_quote"
+        end
+
+        class DeliveryOptions < ::Stripe::StripeObject
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+          # Open Enum. Speed of the payout.
+          attr_reader :speed
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class EstimatedFee < ::Stripe::StripeObject
+          # The fee amount for corresponding fee type.
+          attr_reader :amount
+          # The fee type.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class From < ::Stripe::StripeObject
+          # 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 = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class FxQuote < ::Stripe::StripeObject
+          class Rates < ::Stripe::StripeObject
+            # The exchange rate going from_currency -> to_currency.
+            attr_reader :exchange_rate
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The duration the exchange rate lock remains valid from creation time. Allowed value is five_minutes or none.
+          attr_reader :lock_duration
+          # Time at which the rate lock will expire, measured in seconds since the Unix epoch. Null when rate locking is not supported.
+          attr_reader :lock_expires_at
+          # Lock status of the quote. Transitions from active to expired once past the lock_expires_at timestamp. Value can be active, expired or none.
+          attr_reader :lock_status
+          # Key pair: from currency Value: exchange rate going from_currency -> to_currency.
+          attr_reader :rates
+          # The currency that the transaction is exchanging to.
+          attr_reader :to_currency
+
+          def self.inner_class_types
+            @inner_class_types = { rates: Rates }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class To < ::Stripe::StripeObject
+          # The monetary amount being credited to the destination.
+          attr_reader :credited
+          # The payout method which the OutboundPayment uses to send payout.
+          attr_reader :payout_method
+          # To which account the OutboundPayment is sent.
+          attr_reader :recipient
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The "presentment amount" for the OutboundPaymentQuote.
+        attr_reader :amount
+        # Time at which the OutboundPaymentQuote 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 OutboundPayment.
+        attr_reader :delivery_options
+        # The estimated fees for the OutboundPaymentQuote.
+        attr_reader :estimated_fees
+        # Details about the sender of an OutboundPaymentQuote.
+        attr_reader :from
+        # The underlying FXQuote details for the OutboundPaymentQuote.
+        attr_reader :fx_quote
+        # Unique identifier for the OutboundPaymentQuote.
+        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
+        # Details about the recipient of an OutboundPaymentQuote.
+        attr_reader :to
+
+        def self.inner_class_types
+          @inner_class_types = {
+            delivery_options: DeliveryOptions,
+            estimated_fees: EstimatedFee,
+            from: From,
+            fx_quote: FxQuote,
+            to: To,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end