Resources

Postman Collection

Pre-built Postman collection for testing the SmartMCA API

A ready-to-use Postman collection with all 77 API endpoints organized by resource, with example request bodies and environment variables.

Download

File	Description
Collection	Postman Collection v2.1
Environment	Environment variables

Quick Setup

1. Import the Collection

1. Open Postman
2. Click Import
3. Drag both files (collection + environment) or use the links above
4. Select the SmartMCA API environment from the top-right dropdown

2. Set Your API Key

1. Click the eye icon next to the environment dropdown
2. Set the api_key value to your API key (smca_live_... or smca_test_...)
3. Click Save

3. Start Making Requests

The collection is organized into folders matching the API reference:

Folder	Endpoints
Deals	List, create, get, update, update status, archive
Applications	List, create, get, update
Merchants	List, create, get, update
Contacts	List, create, get, update, delete (under merchants)
Payments	List, create, get (under deals)
Documents	List, upload, get
Collections	Get collection schedule
Analysis	Upload PDFs, submit JSON, list, get status, delete
Underwriting	List tools, select docs, trigger, get status, get results
Accounting	Chart of accounts, entries, 8 report types
Deal Accounting	Deal entries, revenue recognition
Workflows	List types, trigger, get executions, app actions
Webhooks	CRUD, deliveries, rotate secret, test, retry

Environment Variables

The collection uses these variables — set them in the environment or they’ll be prompted:

Variable	Default	Description
base_url	https://api.smartmca.com/api/public/v1	API base URL
api_key	—	Your API key
id	—	Generic entity ID
dealId	—	Deal ID for scoped endpoints
merchantId	—	Merchant ID
applicationId	—	Application ID
analysisId	—	Analysis ID
accountId	—	Accounting account ID
executionId	—	Workflow execution ID

Tip: Use Postman’s Tests tab to auto-set variables from responses:

// In the "Create deal" request Tests tab:
const data = pm.response.json().data;
pm.environment.set("dealId", data.id);

Using the Sandbox

Switch to sandbox mode by changing two variables:

Variable	Sandbox Value
base_url	https://api.smartmca.com/api/public/v1 (same URL)
api_key	smca_test_... (test key)

The sandbox uses the same API URL — the key prefix routes to the sandbox automatically.

Regenerating the Collection

The collection is generated from the OpenAPI spec:

cd docs-site
npx tsx scripts/generate-postman.ts

This reads public/openapi/smartmca-v1.json and outputs both files to public/postman/.