Skip to main content

​
1. Get your API key

API keys are created in the Modulate admin UI under Organization detail > API Keys. Your key will look like: 
pk_live_6475dfd7...
Store your API key securely. It grants read access to your entire merchant portfolio.

​
2. Make your first request

curl -X GET "https://modulate.aurorapayments.net/api/v2/partner/merchants?page=1&page_size=5" \
  -H "X-Partner-API-Key: pk_live_YOUR_KEY_HERE"

​
3. Understand the response

Every response follows the same envelope: 
{
  "data": [
    {
      "merchant_id": "1234567890",
      "dba_name": "Coffee Shop Downtown",
      "status": "active",
      "volume_last_month": "45230.50"
    }
  ],
  "meta": {
    "request_id": "req_abc123",
    "api_version": "v2",
    "source": "risecrm",
    "as_of": "2026-02-09T04:00:00Z",
    "pagination": {
      "page": 1,
      "page_size": 5,
      "total_count": 6153,
      "total_pages": 1231
    }
  },
  "errors": []
}
Key fields:
  • data — The payload (object or array depending on endpoint)
  • meta.as_of — When the underlying data was last refreshed
  • meta.pagination — Present on all list endpoints
  • errors — Empty on success; contains error details on failure

​
Next steps