The Financing offer object Preview

Attributes

• id string A unique identifier for the financing object.
• object string, value is "capital.financing_offer" The object type: financing_offer.
• accepted _ terms nullable object Information about the current financing object. Describes currency, advance amount, fee amount, withhold rate, and fee discount of previous financing.
• account string The ID of the merchant associated with this financing object.
• charged _ off _ at nullable timestamp The time at which this financing offer was charged off, if applicable. Given in seconds since unix epoch.
• created integer Time at which the offer was created. Given in seconds since unix epoch.
• disclaimer _ variant nullable enum The type of disclaimer to use for a financing offer in user-facing surfaces. The corresponding disclaimer text to use for each disclaimer_variant value can be found in the marketing docs. Possible enum values celtic_us_loan Capital’s Loan offers, issued by Celtic Bank in the US. fundbox_au_financing Capital financing offer provided by FundBox in Australia. youlend_de_financing Capital financing offer provided by YouLend in Germany. youlend_fr_financing Capital financing offer provided by YouLend in France. youlend_uk_mca Capital offer provided by YouLend in the UK. The underlying financing may be a loan or a merchant cash advance. youlend_us_mca Capital offer provided by YouLend in the US.
• expires _ after number Time at which the offer expires. Given in seconds since unix epoch.
• financing _ application nullable object Preview feature Hash containing details about the financing application associated with the offer.
• financing _ type nullable enum The type of financing being offered. Possible enum values cash_advance Capital’s Merchant Cash Advance program. fixed_term_loan Capital’s fixed-term loan offering. See the integration guide for more information. flex_loan Capital’s flex loan offering. See the integration guide for more information.
• livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
• metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• offered _ terms nullable object Information about the financing offer. Describes currency, offered advance amount, offered fee amount, campaign type, withhold rate, and fee discount rate of previous financing.
• product _ type nullable enum Financing product identifier. Possible enum values refill A “refill” financing offer extended through Stripe Capital. Refills are a form of discounted refinancing. See the integration guide for more information. standard A standard financing offer extended through Stripe Capital.
• replacement nullable string The ID of the financing offer that replaced this offer.
• replacement _ for nullable string The ID of the financing offer that this offer is a replacement for.
• status enum The current status of the offer. Possible enum values accepted Set once an offer has been accepted by the Connected account. canceled Set when the Connected account has reached out to Capital’s servicing team within 48 hours of acceptance and requested cancellation of their offer. completed Set when the financing offer has fully repaid. This status is no longer in use. See fully_repaid instead. delivered Once an offer has been delivered, mark it so using the mark_delivered endpoint. expired Set when the financing offer has expired, usually 30 days after creation. fully_repaid Set when the financing offer has been fully repaid. paid_out Set once an offer has been paid out to the Connected account. rejected Set when Capital’s servicing team has rejected the application for financing. The Connected account receives an email with the reason for rejection. replaced Set when the financing offer has been replaced. undelivered All offers begin in this state. A financing offer must be delivered to its Connected account using approved marketing materials.
• status _ transitions object Preview feature Hash containing timestamps of when the offer transitioned to a particular status.
• type nullable enum Deprecated See financing_type. Possible enum values cash_advance fixed_term_loan flex_loan

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"}

Retrieve a given financing offer

GET / v1 / capital / financing_offers /:id

Get the details of the financing offer

Parameters

No parameters.

Returns

Returns the financing offer object

Response

{ "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"}

List financing offers

GET / v1 / capital / financing_offers

Retrieves the financing offers available for Connected accounts that belong to your platform.

Parameters

• connected _ account string limit list to offers belonging to given connected account
• created object Only return offers that were created during the given date interval.
• status string limit list to offers with given status

More parameters

• ending _ before string
• limit integer
• starting _ after string

Returns

Returns a list of financing offers for Connected accounts on your platform.

Response