v1.0

Getting Started

Quick Start

Get up and running with the SmartMCA API in 5 minutes

1. Get an API Key

Navigate to Settings > API Access in your SmartMCA dashboard. If you don’t have access yet, click Request Access.

Once approved, create a new API key with the scopes you need.

2. Test Your Key

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.smartmca.com/api/public/v1/health

Response:

{
  "data": {
    "status": "ok",
    "version": "1.0.0"
  }
}

3. List Your Deals

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.smartmca.com/api/public/v1/deals?limit=5"

Response:

{
  "data": [
    {
      "id": "clx...",
      "dealId": "N-1001-DEM-A01",
      "merchantName": "Acme Coffee",
      "fundedAmount": 10000,
      "purchaseAmount": 13000,
      "totalCollected": 5200,
      "outstandingBalance": 7800,
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 5,
      "total": 42,
      "totalPages": 9
    }
  }
}

4. Create a Merchant

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"legalName": "Test Merchant LLC", "businessState": "NY"}' \
  https://api.smartmca.com/api/public/v1/merchants

5. Set Up Webhooks

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhooks/smartmca",
    "events": ["deal.funded", "payment.completed"]
  }' \
  https://api.smartmca.com/api/public/v1/webhooks

Next Steps