latestOpenAPI 3.0.02026-08-15122834.2 KB

fea4b2a0d73d

Offers

Get offers for a business

get/api/platform/v1/businesses/{businessId}/offers

Path parameters

{"stackTrail":"paths:/api/platform/v1/businesses/{businessId}/offers:get:parameters:0:schema","oasType":"schema","type":"unknown"}

UUID representation for the target business

Response

Array containing the locked offer objects

idstring required

A unique id representing the offer object

expiredAtobject

UTC timestamp when the offer expires

selectedAtobject

If the offer has been selected, the UTC timestamp of that selection

createdAtstring required

Creation UTC timestamp of the offer

updatedAtstring required

Last updated UTC timestamp of the offer

businessIdstring required

Id of the business that received the offer

Example response

[
  {
    "terms": {
      "advanceAmountCents": 1000000,
      "repaymentPercentage": 20,
      "feeFactor": 1.3,
      "repaymentFrequency": "WEEKLY",
      "totalRepaymentInCents": 1300000
    },
    "createdAt": "2022-06-01T03:57:26.115Z",
    "updatedAt": "2022-06-01T03:57:26.115Z"
  }
]