Financing Summary Preview
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.
The Financing Summary object Preview
Attributes
- objectstring
The object type: financing_summary
- detailsnullable object
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.
- financing_
offernullable string The Financing Offer ID this Financing Summary corresponds to
- statusnullable enumDeprecated
Status of the Connected Account’s financing. /v1/capital/financing_summary will only return
details
forpaid_
financing.out Possible enum valuesaccepted
The Connected account has an accepted financing offer.
delivered
A financing offer has been marketed to the Connected account, but the account has not yet accepted.
none
The Connected account does not have any active financing.
{ "object": "capital.financing_summary", "details": { "advance_amount": 100000, "advance_paid_out_at": 1688424277.0578003, "currency": "usd", "current_repayment_interval": null, "fee_amount": 10000, "paid_amount": 100263, "remaining_amount": 9737, "repayments_begin_at": 1688424277.0577993, "withhold_rate": 0.05 }, "financing_offer": "financingoffer_1NPvU12eZvKYlo2CotjdGRzu", "status": "accepted"}
Retrieve the financing state for the account that was authenticated in the request.
Parameters
No parameters.
Returns
Returns a financing summary for the account
{ "object": "capital.financing_summary", "details": { "advance_amount": 100000, "advance_paid_out_at": 1688424277.0578003, "currency": "usd", "current_repayment_interval": null, "fee_amount": 10000, "paid_amount": 100263, "remaining_amount": 9737, "repayments_begin_at": 1688424277.0577993, "withhold_rate": 0.05 }, "financing_offer": "financingoffer_1NPvU12eZvKYlo2CotjdGRzu", "status": "accepted"}
This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
For accounts where controller.requirement_collection is application
, which includes Custom accounts, the properties below are always returned.
For accounts where controller.requirement_collection is stripe
, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.
Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. A Login Link differs from an Account Link in that it takes the user directly to their Express dashboard for the specified account