Get Active Offer Group

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.

Related webhooks:

  • capital_offer.created to communicate when a new Offer Group is available for the Business
  • capital_offer.opened is triggered when an Offer Group is first seen by the Business, either by rendering our iframe, or by the very first call to the endpoint, that gives an access to a given Offer Group
  • capital_offer.expired to communicate when an Offer Group has expired
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 100

Identifier of the Business.

Responses

401

Missing or invalid API key. Could not authenticate API request.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json