stripe 15.0.0 → 15.1.0.pre.beta.2

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

@@ -0,0 +1,92 @@
+# 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
+          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
+        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
+        end
+
+        class TransferHistory < Stripe::StripeObject
+          class BankDebitFailed < Stripe::StripeObject
+            # Open Enum. The return reason for the failed InboundTransfer.
+            attr_reader :failure_reason
+          end
+
+          class BankDebitProcessing < Stripe::StripeObject; end
+          class BankDebitQueued < Stripe::StripeObject; end
+
+          class BankDebitReturned < Stripe::StripeObject
+            # Open Enum. The return reason for the returned InboundTransfer.
+            attr_reader :return_reason
+          end
+
+          class BankDebitSucceeded < Stripe::StripeObject; end
+          # 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
+          # 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
+        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
+        # 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.
+        attr_reader :transfer_history
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# 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
+          # Open Enum. Method for bank account.
+          attr_reader :bank_account
+        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
+        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
+        end
+
+        class StatusDetails < Stripe::StripeObject
+          class Failed < Stripe::StripeObject
+            # Open Enum. The `failed` status reason.
+            attr_reader :reason
+          end
+
+          class Returned < Stripe::StripeObject
+            # Open Enum. The `returned` status reason.
+            attr_reader :reason
+          end
+          # The `failed` status reason.
+          attr_reader :failed
+          # The `returned` status reason.
+          attr_reader :returned
+        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
+        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
+        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
+        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
+        # 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
+        # A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+        attr_reader :receipt_url
+        # Details about the OutboundPayment notification settings for recipient.
+        attr_reader :recipient_notification
+        # The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
+        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 `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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # OutboundPaymentQuote represents a quote
+      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
+        end
+
+        class EstimatedFee < Stripe::StripeObject
+          # The fee amount for corresponding fee type.
+          attr_reader :amount
+          # The fee type.
+          attr_reader :type
+        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
+        end
+
+        class FxQuote < Stripe::StripeObject
+          class Rates < Stripe::StripeObject
+            # The exchange rate going from_currency -> to_currency.
+            attr_reader :exchange_rate
+          end
+          # 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
+        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
+        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
+        # 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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # Use the OutboundSetupIntent API to create and setup usable payout methods.
+      class OutboundSetupIntent < APIResource
+        OBJECT_NAME = "v2.money_management.outbound_setup_intent"
+        def self.object_name
+          "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
+          end
+          # The type of next action.
+          attr_reader :type
+          # Confirmation of Payee details.
+          attr_reader :confirmation_of_payee
+        end
+        # Created timestamp.
+        attr_reader :created
+        # ID of the outbound setup intent.
+        attr_reader :id
+        # 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
+        # Information about the payout method that’s created and linked to this outbound setup intent.
+        attr_reader :payout_method
+        # Closed Enum. Status of the outbound setup intent.
+        attr_reader :status
+        # The intended money movement flow this payout method should be set up for, specified in params.
+        attr_reader :usage_intent
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# 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
+        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
+        end
+
+        class StatusDetails < Stripe::StripeObject
+          class Failed < Stripe::StripeObject
+            # Open Enum. The `failed` status reason.
+            attr_reader :reason
+          end
+
+          class Returned < Stripe::StripeObject
+            # Open Enum. The `returned` status reason.
+            attr_reader :reason
+          end
+          # The `failed` status reason.
+          attr_reader :failed
+          # The `returned` status reason.
+          attr_reader :returned
+        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
+        end
+
+        class To < Stripe::StripeObject
+          # 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
+        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
+        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 hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+        attr_reader :receipt_url
+        # The description that appears on the receiving end for an OutboundTransfer (for example, bank statement for external bank transfer).
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# 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.
+          attr_reader :payments
+          # Transfers status.
+          attr_reader :transfers
+        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 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 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
+        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
+        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
+        # The PayoutMethodBankAccount object details.
+        attr_reader :bank_account
+        # The PayoutMethodCard object details.
+        attr_reader :card
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module MoneyManagement
+      # The PayoutMethodsBankAccountSpec object.
+      class PayoutMethodsBankAccountSpec < APIResource
+        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
+              # Attribute for field content
+              attr_reader :content
+              # Attribute for field localization_key
+              attr_reader :localization_key
+            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
+          end
+          # The list of fields for a country, along with associated information.
+          attr_reader :fields
+        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
+      end
+    end
+  end
+end