API Reference

Deals

Deal portfolio endpoints

Access and manage your MCA deal portfolio.

List Deals

GET /api/public/v1/deals

Query Parameters:

Parameter	Type	Description
page	number	Page number (default: 1)
limit	number	Items per page (default: 20, max: 100)
status	string	Filter by status
sub_status	string	Filter by sub-status
merchant_id	string	Filter by merchant
funder_id	string	Filter by funder
search	string	Search merchant name or deal ID
funded_date_from	string	ISO date
funded_date_to	string	ISO date
sort_by	string	Sort field (default: fundedDate)
sort_order	string	asc or desc (default: desc)

Required Scope: deals:read

Get Deal

GET /api/public/v1/deals/:id

Required Scope: deals:read

Response:

{
  "data": {
    "id": "clx...",
    "dealId": "N-1001-DEM-A01",
    "merchantName": "Acme Coffee",
    "fundedAmount": 10000,
    "purchaseAmount": 13000,
    "totalCollected": 5200,
    "outstandingBalance": 7800,
    "rtrPercentage": 40.0,
    "status": "active",
    "subStatus": "onTime",
    "fundedDate": "2026-01-15",
    "paymentCount": 52,
    "nextPaymentDate": "2026-03-05",
    "lastPaymentDate": "2026-03-04"
  }
}

Update Deal

PATCH /api/public/v1/deals/:id

Required Scope: deals:write

Deal Statuses

Status	Description
active	Currently being collected
closed	Manually closed
refinanced	Replaced by new deal
paidOff	Fully paid
defaulted	In default
inCollections	Sent to collections
inLegal	In legal proceedings
settled	Settled for less