This endpoint returns the currently active Offer Group for a Business that can be accepted.

An Offer Group contains multiple offers of the same type from which the Business can choose exactly one to accept. The type of offers (flexible or fixed) is determined by the financing setup and agreements between finmid and the Platform. If no active Offer Group exists, the offer_group field will be null, indicating the Business is currently not eligible for funding.

Flexible Offers define payment as a percentage of the Business's sales revenue.

Fixed Offers define payment as a fixed amount paid at a regular frequency (WEEKLY or MONTHLY).

Determining available ranges

Each offer in the group represents one selectable combination of payout amount and payment period. The offers are sorted in ascending order, so you can derive the available ranges from the array:

• Payout amount range — the payout_amount of the first offer is the minimum; the last offer is the maximum.
• Payment period range — the payment_estimated_months of the first offer is the minimum; the last offer is the maximum.

These ranges can be used, for example, to populate sliders or input constraints in a UI before the Business selects a specific offer to accept.

Calling this endpoint counts as the Business opening the offers

🚧

This endpoint is primarily intended for Platforms that build their own Capital UI. Call it (with default parameters) only at the moment the Business is actually shown the offers.

The first such call marks the Offer Group as opened by the Business: it triggers the capital_offer.opened webhook and feeds finmid's offer analytics (e.g. open rate). If you call this endpoint for any other purpose, i.e. fetching extra offer data for internal processing, background jobs or monitoring - set suppress_offer_opened_event=true to prevent the Offer Group from being incorrectly reported as seen by the Business and to ensure the accuracy of open-rate analytics.

Related webhooks:

• capital_offer.created to communicate when a new Offer Group is available for the Business
• capital_offer.opened is triggered when Offer Group is first seen by the Business. This occurs either when our iframe is displayed to the business or when a specific Offer Group is retrieved for the very first time via the public-api endpoint. In case of the public-api endpoint, the suppress_offer_opened_event parameter must be omitted or explicitly set to false.
• capital_offer.expired to communicate when an Offer Group has expired
• capital_offer.withdrawn to communicate when an Offer Group was withdrawn because of an outcome the platform reported