LendWorksLendWorksDocs

Commissions

Track commission transactions, splits, payouts, and view organization-level commission metrics.

The commissions API provides access to commission transaction records and aggregate metrics for your organization.

List Commission Transactions

GET /v1/commissions

Returns a paginated list of commission transactions including splits, payouts, and clawbacks.

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
limitinteger20Items per page (max 100)

Example Request

curl -H "Authorization: Bearer lw_live_xxxx" \
     "https://api.lend.works/v1/commissions?limit=20"

Example Response

{
  "data": [
    {
      "id": "tx_a1b2c3d4-1234-5678-9abc-def012345678",
      "type": "commission_transaction",
      "attributes": {
        "dealId": "f1a2b3c4-...",
        "advisorId": "e5f6g7h8-...",
        "advisorName": "Mike Johnson",
        "amount": "5000.00",
        "type": "earned",
        "status": "paid",
        "dealBusinessName": "Acme Corp",
        "lenderName": "First Capital Finance",
        "paidAt": "2025-01-15T10:00:00Z",
        "createdAt": "2025-01-10T16:00:00Z"
      }
    }
  ],
  "meta": {
    "total": 234,
    "page": 1,
    "limit": 20,
    "hasMore": true,
    "requestId": "d09e19f2-a3b4-4c56-7890-123456789345"
  }
}

Commission Summary

GET /v1/commissions/summary

Returns aggregate commission metrics for your organization for the current month.

Example Request

curl -H "Authorization: Bearer lw_live_xxxx" \
     https://api.lend.works/v1/commissions/summary

Example Response

{
  "data": {
    "type": "commission_summary",
    "attributes": {
      "totalCommissions": "142500.00",
      "avgPerDeal": "4750.00",
      "dealCount": 30,
      "topEarners": [
        {
          "userId": "e5f6g7h8-...",
          "name": "Mike Johnson",
          "totalEarned": "42000.00",
          "dealCount": 8
        },
        {
          "userId": "a9b8c7d6-...",
          "name": "Sarah Williams",
          "totalEarned": "38500.00",
          "dealCount": 7
        }
      ]
    }
  },
  "meta": {
    "requestId": "e10f20a3-b4c5-4d67-8901-234567890456"
  }
}

Errors

StatusCodeDescription
403FORBIDDENAPI key lacks read permission