# Modulate ## Docs - [Explain Portfolio](https://modulate.aurorapayments.net/api-reference/ai-insights/explain.md): Generate AI-powered portfolio insights for a residual period. Rate limited to 5 req/min. - [Create Export](https://modulate.aurorapayments.net/api-reference/exports/create.md): Starts an async CSV export of merchant residuals. Returns 202 with an export ID to poll. - [Download Export](https://modulate.aurorapayments.net/api-reference/exports/download.md): Returns a signed GCS URL for downloading a completed export CSV. - [Get Export Status](https://modulate.aurorapayments.net/api-reference/exports/status.md): Check the status of an async export job (pending, running, succeeded, failed). - [Get Merchant](https://modulate.aurorapayments.net/api-reference/merchants/get.md): Returns full detail for a single merchant in the partner's portfolio. - [List Merchants](https://modulate.aurorapayments.net/api-reference/merchants/list.md): Paginated list of merchants in the partner's portfolio with filtering and sorting. - [Get Merchant Status](https://modulate.aurorapayments.net/api-reference/merchants/status.md): Returns a concise status summary for a merchant. - [Get Current Pricing](https://modulate.aurorapayments.net/api-reference/pricing/current.md): Returns the current TSYS PPM pricing configuration for a merchant. - [Get Pricing History](https://modulate.aurorapayments.net/api-reference/pricing/history.md): Returns pricing change history for a merchant over a configurable lookback period. - [List Portfolio Pricing](https://modulate.aurorapayments.net/api-reference/pricing/portfolio.md): Paginated current TSYS pricing for all merchants in the partner's portfolio. effective_rate_bps includes Other Volume Fee (OVF) where applicable. - [Get Adjustments](https://modulate.aurorapayments.net/api-reference/residuals/adjustments.md): Returns adjustment line items for a residual report period. - [Get Merchant Residuals](https://modulate.aurorapayments.net/api-reference/residuals/merchants.md): Paginated merchant-level residual details with search, sort, and incremental sync support. - [List Available Reports](https://modulate.aurorapayments.net/api-reference/residuals/reports.md): Returns the list of available residual report months for the partner's organization. - [Get Monthly Summary](https://modulate.aurorapayments.net/api-reference/residuals/summary.md): Returns aggregated payout summary including volume, profit, and agent payout for a month. - [Get Top Merchants](https://modulate.aurorapayments.net/api-reference/residuals/top-merchants.md): Returns the top merchants ranked by profit for a residual report period. - [Get Payout Trend](https://modulate.aurorapayments.net/api-reference/residuals/trend.md): Returns month-over-month payout trend data for the last N months. - [Get Withholds](https://modulate.aurorapayments.net/api-reference/residuals/withholds.md): Returns withhold line items for a residual report period. - [Get Statement](https://modulate.aurorapayments.net/api-reference/statements/get.md): Returns metadata for a single statement including period, type, and availability. - [List Portfolio Statements](https://modulate.aurorapayments.net/api-reference/statements/list.md): Paginated metadata-only statement list across all merchants in the partner portfolio. - [List Merchant Statements](https://modulate.aurorapayments.net/api-reference/statements/list-by-merchant.md): Paginated list of processor and custom statements for a merchant. - [Download Statement PDF](https://modulate.aurorapayments.net/api-reference/statements/pdf.md): Download a statement as raw PDF stream or base64-encoded JSON. Use ?format=base64 for JSON delivery. - [Health Check](https://modulate.aurorapayments.net/api-reference/system/health.md): Returns service status and database connectivity. No authentication required. - [Get Daily Transactions](https://modulate.aurorapayments.net/api-reference/transactions/daily.md): Returns daily aggregated transaction totals for a merchant over a date range. - [Get Gateway Transaction](https://modulate.aurorapayments.net/api-reference/transactions/gateway-get.md): Returns detail for a single NMI gateway transaction. - [List Gateway Transactions](https://modulate.aurorapayments.net/api-reference/transactions/gateway-list.md): Paginated NMI gateway transactions for a merchant with action type and status filters. - [List Transactions](https://modulate.aurorapayments.net/api-reference/transactions/list.md): Paginated transaction detail list for a merchant with card brand and batch filters. - [Authentication](https://modulate.aurorapayments.net/authentication.md): API key authentication for the Modulate Partner API - [Changelog](https://modulate.aurorapayments.net/changelog.md): Version history for the Modulate Partner API - [Data Freshness](https://modulate.aurorapayments.net/data-freshness.md): How current is the data returned by each endpoint family - [Error Handling](https://modulate.aurorapayments.net/error-handling.md): Error codes, response format, and retry strategies - [AI Insights](https://modulate.aurorapayments.net/guides/ai-insights.md): Get AI-generated portfolio analysis and merchant explanations - [Export Data](https://modulate.aurorapayments.net/guides/export-data.md): Create, poll, and download async CSV exports - [Reconcile Residuals](https://modulate.aurorapayments.net/guides/reconcile-residuals.md): Monthly residual reconciliation workflow using the Partner API - [Sync Merchants](https://modulate.aurorapayments.net/guides/sync-merchants.md): Build an incremental sync pipeline for your merchant portfolio - [Introduction](https://modulate.aurorapayments.net/introduction.md): Access merchant data, pricing, residuals, and AI insights through the Modulate Partner API - [Quickstart](https://modulate.aurorapayments.net/quickstart.md): Make your first API call in under 2 minutes - [Rate Limits](https://modulate.aurorapayments.net/rate-limits.md): Request limits, rate limit headers, and 429 handling - [Response Format](https://modulate.aurorapayments.net/response-format.md): Envelope structure, pagination, money formatting, and timestamps ## OpenAPI Specs - [openapi](https://modulate.aurorapayments.net/openapi.json)