Class: Stripe::Capital::FinancingSummary

Inherits:
SingletonAPIResource show all
Defined in:
lib/stripe/resources/capital/financing_summary.rb

Overview

A financing object describes an account’s current financing state. Used by Connect platforms to read the state of Capital offered to their connected accounts.

Defined Under Namespace

Classes: Details, RetrieveParams

Constant Summary collapse

OBJECT_NAME = 
"capital.financing_summary"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from SingletonAPIResource

resource_url, #resource_url, retrieve

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#details ⇒ Object (readonly)

Additional information about the financing summary. Describes currency, advance amount, fee amount, withhold rate, remaining amount, paid amount, current repayment interval, repayment start date, and advance payout date.



55
56
57
 
# File 'lib/stripe/resources/capital/financing_summary.rb', line 55

def details
  @details
end

#financing_offer ⇒ Object (readonly)

The Financing Offer ID this Financing Summary corresponds to



57
58
59
 
# File 'lib/stripe/resources/capital/financing_summary.rb', line 57

def financing_offer
  @financing_offer
end

#object ⇒ Object (readonly)

The object type: financing_summary



59
60
61
 
# File 'lib/stripe/resources/capital/financing_summary.rb', line 59

def object
  @object
end

#status ⇒ Object (readonly)

Status of the Connected Account’s financing. [/v1/capital/financing_summary](stripe.com/docs/api/capital/financing_summary) will only return ‘details` for `paid_out` financing.



61
62
63
 
# File 'lib/stripe/resources/capital/financing_summary.rb', line 61

def status
  @status
end

Class Method Details

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/capital/financing_summary.rb', line 10

def self.object_name
  "capital.financing_summary"
end