stripe 5.38.0 → 15.2.1

data/lib/stripe/resources/treasury/received_credit.rb

@@ -0,0 +1,284 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+    class ReceivedCredit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_credit"
+      def self.object_name
+        "treasury.received_credit"
+      end
+
+      class InitiatingPaymentMethodDetails < Stripe::StripeObject
+        class BillingDetails < Stripe::StripeObject
+          class Address < 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
+          end
+          # Attribute for field address
+          attr_reader :address
+          # Email address.
+          attr_reader :email
+          # Full name.
+          attr_reader :name
+        end
+
+        class FinancialAccount < Stripe::StripeObject
+          # The FinancialAccount ID.
+          attr_reader :id
+          # The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
+          attr_reader :network
+        end
+
+        class UsBankAccount < Stripe::StripeObject
+          # Bank name.
+          attr_reader :bank_name
+          # The last four digits of the bank account number.
+          attr_reader :last4
+          # The routing number for the bank account.
+          attr_reader :routing_number
+        end
+        # Set when `type` is `balance`.
+        attr_reader :balance
+        # Attribute for field billing_details
+        attr_reader :billing_details
+        # Attribute for field financial_account
+        attr_reader :financial_account
+        # Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
+        attr_reader :issuing_card
+        # Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+        attr_reader :type
+        # Attribute for field us_bank_account
+        attr_reader :us_bank_account
+      end
+
+      class LinkedFlows < Stripe::StripeObject
+        class SourceFlowDetails < Stripe::StripeObject
+          # You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.
+          attr_reader :credit_reversal
+          # Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).
+          #
+          # Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects.
+          #
+          # Related guide: [Moving money with Treasury using OutboundPayment objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments)
+          attr_reader :outbound_payment
+          # Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.
+          #
+          # Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.
+          #
+          # Related guide: [Moving money with Treasury using OutboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers)
+          attr_reader :outbound_transfer
+          # A `Payout` object is created when you receive funds from Stripe, or when you
+          # initiate a payout to either a bank account or debit card of a [connected
+          # Stripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+          # and list all payouts. Payouts are made on [varying
+          # schedules](/docs/connect/manage-payout-schedule), depending on your country and
+          # industry.
+          #
+          # Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
+          attr_reader :payout
+          # The type of the source flow that originated the ReceivedCredit.
+          attr_reader :type
+        end
+        # The CreditReversal created as a result of this ReceivedCredit being reversed.
+        attr_reader :credit_reversal
+        # Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
+        attr_reader :issuing_authorization
+        # Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.
+        attr_reader :issuing_transaction
+        # ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.
+        attr_reader :source_flow
+        # The expandable object of the source flow.
+        attr_reader :source_flow_details
+        # The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).
+        attr_reader :source_flow_type
+      end
+
+      class ReversalDetails < Stripe::StripeObject
+        # Time before which a ReceivedCredit can be reversed.
+        attr_reader :deadline
+        # Set if a ReceivedCredit cannot be reversed.
+        attr_reader :restricted_reason
+      end
+
+      class ListParams < Stripe::RequestParams
+        class LinkedFlows < Stripe::RequestParams
+          # The source flow type.
+          attr_accessor :source_flow_type
+
+          def initialize(source_flow_type: nil)
+            @source_flow_type = source_flow_type
+          end
+        end
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The FinancialAccount that received the funds.
+        attr_accessor :financial_account
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # Only return ReceivedCredits described by the flow.
+        attr_accessor :linked_flows
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # Only return ReceivedCredits that have the given status: `succeeded` or `failed`.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          linked_flows: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @linked_flows = linked_flows
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class InitiatingPaymentMethodDetails < Stripe::RequestParams
+          class UsBankAccount < Stripe::RequestParams
+            # The bank account holder's name.
+            attr_accessor :account_holder_name
+            # The bank account number.
+            attr_accessor :account_number
+            # The bank account's routing number.
+            attr_accessor :routing_number
+
+            def initialize(account_holder_name: nil, account_number: nil, routing_number: nil)
+              @account_holder_name = account_holder_name
+              @account_number = account_number
+              @routing_number = routing_number
+            end
+          end
+          # The source type.
+          attr_accessor :type
+          # Optional fields for `us_bank_account`.
+          attr_accessor :us_bank_account
+
+          def initialize(type: nil, us_bank_account: nil)
+            @type = type
+            @us_bank_account = us_bank_account
+          end
+        end
+        # Amount (in cents) to be transferred.
+        attr_accessor :amount
+        # 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_accessor :currency
+        # An arbitrary string attached to the object. Often useful for displaying to users.
+        attr_accessor :description
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The FinancialAccount to send funds to.
+        attr_accessor :financial_account
+        # Initiating payment method details for the object.
+        attr_accessor :initiating_payment_method_details
+        # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
+        attr_accessor :network
+
+        def initialize(
+          amount: nil,
+          currency: nil,
+          description: nil,
+          expand: nil,
+          financial_account: nil,
+          initiating_payment_method_details: nil,
+          network: nil
+        )
+          @amount = amount
+          @currency = currency
+          @description = description
+          @expand = expand
+          @financial_account = financial_account
+          @initiating_payment_method_details = initiating_payment_method_details
+          @network = network
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # 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
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_reader :description
+      # Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
+      attr_reader :failure_code
+      # The FinancialAccount that received the funds.
+      attr_reader :financial_account
+      # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+      attr_reader :hosted_regulatory_receipt_url
+      # Unique identifier for the object.
+      attr_reader :id
+      # Attribute for field initiating_payment_method_details
+      attr_reader :initiating_payment_method_details
+      # Attribute for field linked_flows
+      attr_reader :linked_flows
+      # 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 rails used to send the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Details describing when a ReceivedCredit may be reversed.
+      attr_reader :reversal_details
+      # Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
+      attr_reader :status
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
+      # Returns a list of ReceivedCredits.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/received_credits",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedCredit
+        def self.resource_class
+          "ReceivedCredit"
+        end
+
+        # Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_credits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/received_debit.rb

@@ -0,0 +1,243 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+    class ReceivedDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_debit"
+      def self.object_name
+        "treasury.received_debit"
+      end
+
+      class InitiatingPaymentMethodDetails < Stripe::StripeObject
+        class BillingDetails < Stripe::StripeObject
+          class Address < 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
+          end
+          # Attribute for field address
+          attr_reader :address
+          # Email address.
+          attr_reader :email
+          # Full name.
+          attr_reader :name
+        end
+
+        class FinancialAccount < Stripe::StripeObject
+          # The FinancialAccount ID.
+          attr_reader :id
+          # The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.
+          attr_reader :network
+        end
+
+        class UsBankAccount < Stripe::StripeObject
+          # Bank name.
+          attr_reader :bank_name
+          # The last four digits of the bank account number.
+          attr_reader :last4
+          # The routing number for the bank account.
+          attr_reader :routing_number
+        end
+        # Set when `type` is `balance`.
+        attr_reader :balance
+        # Attribute for field billing_details
+        attr_reader :billing_details
+        # Attribute for field financial_account
+        attr_reader :financial_account
+        # Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.
+        attr_reader :issuing_card
+        # Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.
+        attr_reader :type
+        # Attribute for field us_bank_account
+        attr_reader :us_bank_account
+      end
+
+      class LinkedFlows < Stripe::StripeObject
+        # The DebitReversal created as a result of this ReceivedDebit being reversed.
+        attr_reader :debit_reversal
+        # Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.
+        attr_reader :inbound_transfer
+        # Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.
+        attr_reader :issuing_authorization
+        # Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.
+        attr_reader :issuing_transaction
+        # Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
+        attr_reader :payout
+      end
+
+      class ReversalDetails < Stripe::StripeObject
+        # Time before which a ReceivedDebit can be reversed.
+        attr_reader :deadline
+        # Set if a ReceivedDebit can't be reversed.
+        attr_reader :restricted_reason
+      end
+
+      class ListParams < Stripe::RequestParams
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The FinancialAccount that funds were pulled from.
+        attr_accessor :financial_account
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # Only return ReceivedDebits that have the given status: `succeeded` or `failed`.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class InitiatingPaymentMethodDetails < Stripe::RequestParams
+          class UsBankAccount < Stripe::RequestParams
+            # The bank account holder's name.
+            attr_accessor :account_holder_name
+            # The bank account number.
+            attr_accessor :account_number
+            # The bank account's routing number.
+            attr_accessor :routing_number
+
+            def initialize(account_holder_name: nil, account_number: nil, routing_number: nil)
+              @account_holder_name = account_holder_name
+              @account_number = account_number
+              @routing_number = routing_number
+            end
+          end
+          # The source type.
+          attr_accessor :type
+          # Optional fields for `us_bank_account`.
+          attr_accessor :us_bank_account
+
+          def initialize(type: nil, us_bank_account: nil)
+            @type = type
+            @us_bank_account = us_bank_account
+          end
+        end
+        # Amount (in cents) to be transferred.
+        attr_accessor :amount
+        # 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_accessor :currency
+        # An arbitrary string attached to the object. Often useful for displaying to users.
+        attr_accessor :description
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The FinancialAccount to pull funds from.
+        attr_accessor :financial_account
+        # Initiating payment method details for the object.
+        attr_accessor :initiating_payment_method_details
+        # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
+        attr_accessor :network
+
+        def initialize(
+          amount: nil,
+          currency: nil,
+          description: nil,
+          expand: nil,
+          financial_account: nil,
+          initiating_payment_method_details: nil,
+          network: nil
+        )
+          @amount = amount
+          @currency = currency
+          @description = description
+          @expand = expand
+          @financial_account = financial_account
+          @initiating_payment_method_details = initiating_payment_method_details
+          @network = network
+        end
+      end
+      # Amount (in cents) transferred.
+      attr_reader :amount
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # 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
+      # An arbitrary string attached to the object. Often useful for displaying to users.
+      attr_reader :description
+      # Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.
+      attr_reader :failure_code
+      # The FinancialAccount that funds were pulled from.
+      attr_reader :financial_account
+      # A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+      attr_reader :hosted_regulatory_receipt_url
+      # Unique identifier for the object.
+      attr_reader :id
+      # Attribute for field initiating_payment_method_details
+      attr_reader :initiating_payment_method_details
+      # Attribute for field linked_flows
+      attr_reader :linked_flows
+      # 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 network used for the ReceivedDebit.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Details describing when a ReceivedDebit might be reversed.
+      attr_reader :reversal_details
+      # Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.
+      attr_reader :status
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
+      # Returns a list of ReceivedDebits.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/treasury/received_debits",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedDebit
+        def self.resource_class
+          "ReceivedDebit"
+        end
+
+        # Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_debits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end