Skip to main content

​
Modulate Partner API

The Modulate Partner API gives ISO partners programmatic access to their merchant portfolio — including merchant details, transaction data, pricing breakdowns, residual reports, and AI-powered insights.

​
What you can do

Merchants

Search and retrieve merchant profiles, status, and statement history across your portfolio.

Pricing

View current IC+ pricing breakdowns and track pricing changes over time.

Transactions

Access card-level transaction detail and daily aggregates, plus NMI gateway data.

Residuals

Pull monthly residual reports with per-merchant breakdowns, adjustments, and trends.

Statements

Retrieve statement metadata and download PDFs.

AI Insights

Get AI-generated portfolio analysis and merchant-level explanations.

​
Base URL

https://modulate.aurorapayments.net/api/partner

​
Key features

  • Consistent envelope — Every response uses the same data / meta / errors shape
  • Pagination — All list endpoints support page and page_size params
  • Incremental sync — Use updated_since to fetch only changed records
  • Decimal money — All monetary values are strings ("1234.56") to avoid floating-point issues
  • Data freshness — Every response includes meta.as_of so you know how current the data is

​
Next steps

Quickstart

Make your first API call in under 2 minutes.

Authentication

Learn how API keys work and how to manage them.