stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/token.rb

@@ -19,7 +19,7 @@ module Stripe
   #
   # You can't store or use tokens more than once. To store card or bank account
   # information for later use, create [Customer](https://stripe.com/docs/api#customers)
-  # objects or [External accounts](https://stripe.com/api#external_accounts).
+  # objects or [External accounts](https://docs.stripe.com/api#external_accounts).
   # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
   # performs best with integrations that use client-side tokenization.
   class Token < APIResource
@@ -30,10 +30,47 @@ module Stripe
       "token"
     end
 
+    # These bank accounts are payment methods on `Customer` objects.
+    #
+    # On the other hand [External Accounts](/api#external_accounts) are transfer
+    # destinations on `Account` objects for connected accounts.
+    # They can be bank accounts or debit cards as well, and are documented in the links above.
+    #
+    # Related guide: [Bank debits and transfers](/payments/bank-debits-transfers)
+    attr_reader :bank_account
+    # You can store multiple cards on a customer in order to charge the customer
+    # later. You can also store multiple debit cards on a recipient in order to
+    # transfer to those cards later.
+    #
+    # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
+    attr_reader :card
+    # IP address of the client that generates the token.
+    attr_reader :client_ip
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    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.
+    attr_reader :object
+    # Type of the token: `account`, `bank_account`, `card`, or `pii`.
+    attr_reader :type
+    # Determines if you have already used this token (you can only use tokens once).
+    attr_reader :used
+
     # Creates a single-use token that represents a bank account's details.
-    # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
+    # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/tokens", params: params, opts: opts)
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/topup.rb

@@ -17,6 +17,39 @@ module Stripe
       "topup"
     end
 
+    # Amount transferred.
+    attr_reader :amount
+    # ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
+    attr_reader :balance_transaction
+    # 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
+    # Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
+    attr_reader :expected_availability_date
+    # Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).
+    attr_reader :failure_code
+    # Message to user further explaining reason for top-up failure if available.
+    attr_reader :failure_message
+    # Unique identifier for the object.
+    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](https://stripe.com/docs/api/metadata) 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.
+    attr_reader :object
+    # The source field is deprecated. It might not always be present in the API response.
+    attr_reader :source
+    # Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
+    attr_reader :statement_descriptor
+    # The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
+    attr_reader :status
+    # A string that identifies this top-up as part of a group.
+    attr_reader :transfer_group
+
     # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(
@@ -56,5 +89,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/transfer.rb

@@ -25,7 +25,42 @@ module Stripe
 
     nested_resource_class_methods :reversal, operations: %i[create retrieve update list]
 
-    # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
+    # Amount in cents (or local equivalent) to be transferred.
+    attr_reader :amount
+    # Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).
+    attr_reader :amount_reversed
+    # Balance transaction that describes the impact of this transfer on your account balance.
+    attr_reader :balance_transaction
+    # Time that this record of the transfer was first created.
+    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
+    # ID of the Stripe account the transfer was sent to.
+    attr_reader :destination
+    # If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.
+    attr_reader :destination_payment
+    # Unique identifier for the object.
+    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](https://stripe.com/docs/api/metadata) 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.
+    attr_reader :object
+    # A list of reversals that have been applied to the transfer.
+    attr_reader :reversals
+    # Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.
+    attr_reader :reversed
+    # ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.
+    attr_reader :source_transaction
+    # The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.
+    attr_reader :source_type
+    # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
+    attr_reader :transfer_group
+
+    # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/transfers", params: params, opts: opts)
     end
@@ -46,5 +81,13 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

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

@@ -13,6 +13,47 @@ module Stripe
         "treasury.credit_reversal"
       end
 
+      class StatusTransitions < Stripe::StripeObject
+        # Timestamp describing when the CreditReversal changed status to `posted`
+        attr_reader :posted_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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
+      # The FinancialAccount to reverse funds 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
+      # 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](https://stripe.com/docs/api/metadata) 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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedCredit being reversed.
+      attr_reader :received_credit
+      # Status of the CreditReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
       # Reverses a ReceivedCredit and creates a CreditReversal object.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -32,6 +73,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -13,6 +13,62 @@ module Stripe
         "treasury.debit_reversal"
       end
 
+      class LinkedFlows < Stripe::StripeObject
+        # Set if there is an Issuing dispute associated with the DebitReversal.
+        attr_reader :issuing_dispute
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusTransitions < Stripe::StripeObject
+        # Timestamp describing when the DebitReversal changed status to `completed`.
+        attr_reader :completed_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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
+      # The FinancialAccount to reverse funds 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
+      # Other flows linked to a DebitReversal.
+      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
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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
+      # The rails used to reverse the funds.
+      attr_reader :network
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The ReceivedDebit being reversed.
+      attr_reader :received_debit
+      # Status of the DebitReversal
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # The Transaction associated with this object.
+      attr_reader :transaction
+
       # Reverses a ReceivedDebit and creates a DebitReversal object.
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -32,6 +88,14 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = { linked_flows: LinkedFlows, status_transitions: StatusTransitions }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

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

@@ -15,6 +15,137 @@ module Stripe
         "treasury.financial_account"
       end
 
+      class Balance < Stripe::StripeObject
+        # Funds the user can spend right now.
+        attr_reader :cash
+        # Funds not spendable yet, but will become available at a later time.
+        attr_reader :inbound_pending
+        # Funds in the account, but not spendable because they are being held for pending outbound flows.
+        attr_reader :outbound_pending
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class FinancialAddress < Stripe::StripeObject
+        class Aba < Stripe::StripeObject
+          # The name of the person or business that owns the bank account.
+          attr_reader :account_holder_name
+          # The account number.
+          attr_reader :account_number
+          # The last four characters of the account number.
+          attr_reader :account_number_last4
+          # Name of the bank.
+          attr_reader :bank_name
+          # Routing number for the account.
+          attr_reader :routing_number
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # ABA Records contain U.S. bank account details per the ABA format.
+        attr_reader :aba
+        # The list of networks that the address supports
+        attr_reader :supported_networks
+        # The type of financial address
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { aba: Aba }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class PlatformRestrictions < Stripe::StripeObject
+        # Restricts all inbound money movement.
+        attr_reader :inbound_flows
+        # Restricts all outbound money movement.
+        attr_reader :outbound_flows
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class StatusDetails < Stripe::StripeObject
+        class Closed < Stripe::StripeObject
+          # The array that contains reasons for a FinancialAccount closure.
+          attr_reader :reasons
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details related to the closure of this FinancialAccount
+        attr_reader :closed
+
+        def self.inner_class_types
+          @inner_class_types = { closed: Closed }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The array of paths to active Features in the Features hash.
+      attr_reader :active_features
+      # Balance information for the FinancialAccount
+      attr_reader :balance
+      # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+      attr_reader :country
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
+      # Stripe or the platform can control Features via the requested field.
+      attr_reader :features
+      # The set of credentials that resolve to a FinancialAccount.
+      attr_reader :financial_addresses
+      # Unique identifier for the object.
+      attr_reader :id
+      # Attribute for field is_default
+      attr_reader :is_default
+      # 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](https://stripe.com/docs/api/metadata) 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
+      # The nickname for the FinancialAccount.
+      attr_reader :nickname
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The array of paths to pending Features in the Features hash.
+      attr_reader :pending_features
+      # The set of functionalities that the platform can restrict on the FinancialAccount.
+      attr_reader :platform_restrictions
+      # The array of paths to restricted Features in the Features hash.
+      attr_reader :restricted_features
+      # Status of this FinancialAccount.
+      attr_reader :status
+      # Attribute for field status_details
+      attr_reader :status_details
+      # The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+      attr_reader :supported_currencies
+
       # Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.
       def close(params = {}, opts = {})
         request_stripe_object(
@@ -35,7 +166,7 @@ module Stripe
         )
       end
 
-      # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
+      # Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.
       def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -104,6 +235,19 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          balance: Balance,
+          financial_addresses: FinancialAddress,
+          platform_restrictions: PlatformRestrictions,
+          status_details: StatusDetails,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end