Skip to content

Funding APIs

Why This Exists

This document defines API responsibilities for the Funding Domain.

It does not define implementation code or final OpenAPI specifications.

Owner

The owner is the Chief Product Officer and Enterprise Architect.

Business Value

Funding APIs expose governed funding need, assessment, product, partner, application, risk, repayment, and recommendation workflows.

API Groups

API group Responsibilities Example endpoints
Funding Need API Capture and manage funding needs. POST /funding/needs, GET /funding/needs/{needId}
Working Capital Assessment API Create and retrieve assessments. POST /funding/assessments
Funding Product API Manage product catalogue. GET /funding/products, POST /funding/products
Funding Partner API Manage funding partners. GET /funding/partners, POST /funding/partners
Funding Recommendation API Create and retrieve recommendations. POST /funding/recommendations
Funding Application API Manage applications and status. POST /funding/applications, PATCH /funding/applications/{applicationId}
Cash-Flow Risk API Manage funding-related risks. POST /funding/risks, GET /funding/risks?organizationId=
Repayment API Manage repayment schedules and entries. POST /funding/applications/{id}/repayment-schedule

API Principles

  1. APIs must not mutate Organization, Contract, Marketplace, or Intelligence source facts.
  2. APIs must frame recommendations as decision support.
  3. APIs must publish funding events for meaningful workflow changes.
  4. APIs must preserve application and repayment audit history.