Get the details of the financing offer
Parameters
No parameters.
Returns
Returns the financing offer object
{ "id": "financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh", "object": "capital.financing_offer", "account": "acct_1NPvKgBY65lDjjDk", "created": 1688423699, "expires_after": 1690934400, "financing_type": "flex_loan", "livemode": true, "offered_terms": { "advance_amount": 10000, "campaign_type": "newly_eligible_user", "currency": "usd", "fee_amount": 1000, "previous_financing_fee_discount_rate": null, "withhold_rate": 0.05 }, "product_type": "standard", "status": "undelivered"}
Retrieves the financing offers available for Connected accounts that belong to your platform.
Parameters
- connected_
accountstring limit list to offers belonging to given connected account
- createdobject
Only return offers that were created during the given date interval.
- statusstring
limit list to offers with given status
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
Returns a list of financing offers for Connected accounts on your platform.
{ "object": "list", "url": "/v1/capital/financing_offers", "has_more": false, "data": [ { "id": "financingoffer_1Nn7FV2eZvKYlo2CcGGcdZ6L", "object": "capital.financing_offer", "account": "acct_1Nn7FVGy17qyuPVN", "created": 1693951049, "expires_after": 1696464000, "financing_type": "flex_loan", "livemode": true, "offered_terms": { "advance_amount": 10000, "campaign_type": "newly_eligible_user", "currency": "usd", "fee_amount": 1000, "previous_financing_fee_discount_rate": null, "withhold_rate": 0.05 }, "product_type": "standard", "status": "undelivered" } ]}
Acknowledges that platform has received and delivered the financing_offer to the intended merchant recipient.
Parameters
No parameters.
Returns
Returns the financing offer object
{ "id": "financingoffer_1NPvKg2eZvKYlo2CnEEmlCVh", "object": "capital.financing_offer", "account": "acct_1NPvKgBY65lDjjDk", "created": 1688423699, "expires_after": 1690934400, "financing_type": "flex_loan", "livemode": true, "offered_terms": { "advance_amount": 10000, "campaign_type": "newly_eligible_user", "currency": "usd", "fee_amount": 1000, "previous_financing_fee_discount_rate": null, "withhold_rate": 0.05 }, "product_type": "standard", "status": "delivered"}
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.
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.