Submit Business performance data

In order to generate Offers, finmid requires that Platforms share non-PI data on key Business performance indicators (e.g., goods sold, number of transactions, ratings, refund count, etc.). This data is used to confirm the Business's eligibility for an Offer and to determine the terms of the Offer.

Guidelines:

  • Multiple data points across multiple months may be submitted in a single API call.
  • All data points within a single API call must be associated with the same Business ID.
  • An API request must include at least one performance indicator per reported date; a request with an empty indicator object will be considered invalid.
  • Only completed reporting periods can be submitted. finmid aggregates the data at the resolution agreed during your integration setup, so a data point is accepted once the period it belongs to has ended: with monthly aggregation, any report_date inside the current month is rejected until the month is over, including a YYYY-MM-DD date; with daily aggregation, the current day is rejected until it is over.
  • If a single data point covers a period that has not ended yet, the whole request is rejected with validation_error.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 100
^[a-zA-Z0-9_\.\-]{1,100}$

Identifier of the Business.

Body Params
Responses
204

Performance data accepted.

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