Package com.stripe.model.capital
Class FinancingSummary
java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.capital.FinancingSummary
- All Implemented Interfaces:
StripeActiveObject
,StripeObjectInterface
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
For more details about Details, please refer to the API Reference.Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSON
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Additional information about the financing summary.The Financing Offer ID this Financing Summary corresponds to.The object type: financing_summaryStatus of the Connected Account's financing.int
hashCode()
static FinancingSummary
retrieve()
Retrieve the financing state for the account that was authenticated in the request.static FinancingSummary
retrieve
(RequestOptions options) Retrieve the financing state for the account that was authenticated in the request.static FinancingSummary
retrieve
(FinancingSummaryRetrieveParams params, RequestOptions options) Retrieve the financing state for the account that was authenticated in the request.static FinancingSummary
retrieve
(Map<String, Object> params, RequestOptions options) Retrieve the financing state for the account that was authenticated in the request.void
setDetails
(FinancingSummary.Details details) Additional information about the financing summary.void
setFinancingOffer
(String financingOffer) The Financing Offer ID this Financing Summary corresponds to.void
The object type: financing_summaryvoid
setResponseGetter
(StripeResponseGetter responseGetter) The amount that is yet to be paid in the current repayment interval, in minor units.void
Status of the Connected Account's financing.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId
Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
FinancingSummary
public FinancingSummary()
-
-
Method Details
-
retrieve
Retrieve the financing state for the account that was authenticated in the request.- Throws:
StripeException
-
retrieve
Retrieve the financing state for the account that was authenticated in the request.- Throws:
StripeException
-
retrieve
public static FinancingSummary retrieve(Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieve the financing state for the account that was authenticated in the request.- Throws:
StripeException
-
retrieve
public static FinancingSummary retrieve(FinancingSummaryRetrieveParams params, RequestOptions options) throws StripeException Retrieve the financing state for the account that was authenticated in the request.- Throws:
StripeException
-
setResponseGetter
The amount that is yet to be paid in the current repayment interval, in minor units. For example, $100 USD will be represented as 10000.- Specified by:
setResponseGetter
in interfaceStripeActiveObject
- Overrides:
setResponseGetter
in classApiResource
- Parameters:
responseGetter
- theStripeResponseGetter
instance to use for making further requests.
-
getDetails
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. -
getFinancingOffer
The Financing Offer ID this Financing Summary corresponds to. -
getObject
The object type: financing_summaryEqual to
capital.financing_summary
. -
getStatus
Status of the Connected Account's financing. /v1/capital/financing_summary will only returndetails
forpaid_out
financing.One of
accepted
,delivered
, ornone
. -
setDetails
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. -
setFinancingOffer
The Financing Offer ID this Financing Summary corresponds to. -
setObject
The object type: financing_summaryEqual to
capital.financing_summary
. -
setStatus
Status of the Connected Account's financing. /v1/capital/financing_summary will only returndetails
forpaid_out
financing.One of
accepted
,delivered
, ornone
. -
equals
-
canEqual
-
hashCode
public int hashCode()
-