stripe 20.1.0 → 20.2.0.pre.beta.1

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

@@ -0,0 +1,255 @@
+# 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class EstimatedFee < ::Stripe::StripeObject
+          class NetworkFeeDetails < ::Stripe::StripeObject
+            class NetworkOptions < ::Stripe::StripeObject
+              class Ach < ::Stripe::StripeObject
+                # Open Enum. ACH submission timing.
+                attr_reader :submission
+
+                def self.inner_class_types
+                  @inner_class_types = {}
+                end
+
+                def self.field_remappings
+                  @field_remappings = {}
+                end
+              end
+              # ACH-specific network fee options.
+              attr_reader :ach
+
+              def self.inner_class_types
+                @inner_class_types = { ach: Ach }
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The network associated with the fee.
+            attr_reader :network
+            # Per-network options that affect the fee.
+            attr_reader :network_options
+
+            def self.inner_class_types
+              @inner_class_types = { network_options: NetworkOptions }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class TaxAmount < ::Stripe::StripeObject
+            # Currency code.
+            attr_reader :currency
+            # Tax amount value represented as a decimal string in major units.
+            attr_reader :value_decimal
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The fee amount for corresponding fee type.
+          attr_reader :amount
+          # Details about the network and options associated with this fee. Present when type is network_fee.
+          attr_reader :network_fee_details
+          # Tax charged for this fee, if applicable. Value expressed as a decimal string in major units.
+          attr_reader :tax_amount
+          # The fee type.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { network_fee_details: NetworkFeeDetails, tax_amount: TaxAmount }
+          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
+          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 OutboundPaymentQuote.
+          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
+        # 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

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

@@ -11,12 +11,42 @@ module Stripe
           "v2.money_management.outbound_setup_intent"
         end
 
+        class NextAction < ::Stripe::StripeObject
+          class ConfirmationOfPayee < ::Stripe::StripeObject
+            # The type of the credential.
+            attr_reader :object
+            # The Confirmation of Payee status.
+            attr_reader :status
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Confirmation of Payee details.
+          attr_reader :confirmation_of_payee
+          # The type of next action.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { confirmation_of_payee: ConfirmationOfPayee }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         # Created timestamp.
         attr_reader :created
         # ID of the outbound setup intent.
         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
+        # Specifies which actions needs to be taken next to continue setup of the credential.
+        attr_reader :next_action
         # String representing the object's type. Objects of the same type share the same value of the object field.
         attr_reader :object
         # Use the PayoutMethods API to list and interact with PayoutMethod objects.
@@ -27,7 +57,7 @@ module Stripe
         attr_reader :usage_intent
 
         def self.inner_class_types
-          @inner_class_types = {}
+          @inner_class_types = { next_action: NextAction }
         end
 
         def self.field_remappings

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

@@ -0,0 +1,260 @@
+# 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 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
+          # 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 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 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 PayoutMethodOptions < ::Stripe::StripeObject
+            class BankAccount < ::Stripe::StripeObject
+              class PreferredNetworkOptions < ::Stripe::StripeObject
+                class Ach < ::Stripe::StripeObject
+                  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 OutboundTransfer.
+              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 OutboundTransfer uses to send payout.
+          attr_reader :payout_method
+          # Payout method options for the OutboundTransfer.
+          attr_reader :payout_method_options
+
+          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.
+          # 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
+        # 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
+        # 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 `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 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
+
+        def self.inner_class_types
+          @inner_class_types = {
+            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

@@ -11,6 +11,21 @@ module Stripe
           "v2.money_management.payout_method"
         end
 
+        class AlternativeReference < ::Stripe::StripeObject
+          # The ID of the alternative resource being referenced.
+          attr_reader :id
+          # The type of the alternative reference (e.g., external_account for V1 external accounts).
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class BankAccount < ::Stripe::StripeObject
           # The type of bank account (checking or savings).
           attr_reader :bank_account_type
@@ -20,8 +35,13 @@ module Stripe
           attr_reader :branch_number
           # 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_schemes
           # The ID of the Financial Connections Account used to create the bank account.
           attr_reader :financial_connections_account
+          # Uniquely identifies this particular bank account. You can use this attribute to check whether two
+          # recipients who've signed up with you are using the same bank account, for example.
+          attr_reader :fingerprint
           # The last 4 digits of the account number.
           attr_reader :last4
           # The routing number of the bank account, if present.
@@ -62,6 +82,23 @@ module Stripe
           end
         end
 
+        class CryptoWallet < ::Stripe::StripeObject
+          # Destination wallet address.
+          attr_reader :address
+          # Optional field, required if network supports memos (only "stellar" currently).
+          attr_reader :memo
+          # Which rail is being used to make an outbound money movement to this wallet.
+          attr_reader :network
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class UsageStatus < ::Stripe::StripeObject
           # Payments status - used when sending OutboundPayments (sending funds to recipients).
           # If disabled, enable the payout method by creating an OutboundSetupIntent using [`POST /v2/money_management/outbound_setup_intents`](https://docs.stripe.com/api/v2/money-management/outbound-setup-intents/create).
@@ -78,16 +115,22 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # The alternative reference for this payout method, if it's a projected payout method.
+        attr_reader :alternative_reference
         # Whether the payout method was archived. Payout methods can be archived through the /archive API,
         # and they will not be automatically archived by Stripe. Archived payout methods cannot be used
         # for outbound money movement.
         attr_reader :archived
+        # A set of available payout speeds for this payout method.
+        attr_reader :available_payout_speeds
         # The PayoutMethodBankAccount object details.
         attr_reader :bank_account
         # The PayoutMethodCard object details.
         attr_reader :card
         # Created timestamp.
         attr_reader :created
+        # The PayoutMethodCryptoWallet object details.
+        attr_reader :crypto_wallet
         # ID of the PayoutMethod object.
         attr_reader :id
         # ID of the underlying active OutboundSetupIntent object, if any.
@@ -105,7 +148,13 @@ module Stripe
         attr_reader :usage_status
 
         def self.inner_class_types
-          @inner_class_types = { bank_account: BankAccount, card: Card, usage_status: UsageStatus }
+          @inner_class_types = {
+            alternative_reference: AlternativeReference,
+            bank_account: BankAccount,
+            card: Card,
+            crypto_wallet: CryptoWallet,
+            usage_status: UsageStatus,
+          }
         end
 
         def self.field_remappings

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

@@ -209,6 +209,8 @@ module Stripe
         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
         # 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`.