Introduction

Build on top of your merchant portfolio with the Modulate Partner API

The Modulate Partner API gives ISO partners programmatic access to every dimension of their merchant portfolio — pricing, processor profiles, transactions, statements, residuals, compliance, and AI-powered insights — through a single, consistent REST API.

What you can build

Portfolio dashboards

Display live merchant health, volume trends, and residual summaries directly inside your own platform.

Automated pricing tools

Pull current and historical TSYS pricing for any merchant to power competitive analysis or repricing workflows.

Statement delivery

List and download merchant statements programmatically — great for automated distribution or archiving.

Residual reporting

Access payout summaries, adjustments, withholds, and per-merchant residual breakdowns for any reporting period.

Processor profiles

Retrieve complete TSYS processor profile data — card network acceptance, banking details, interchange qualification, hierarchy, and more — for any merchant in your portfolio.

API basics

PropertyValue
Base URLhttps://getmodulate.dev
ProtocolHTTPS only
FormatJSON request and response bodies
AuthenticationX-Partner-API-Key header
VersioningURL-based (/api/partner/...)

Rate limits

Requests are rate-limited per API key. Exceeding the limit returns a 429 Too Many Requests response with a Retry-After header indicating when you can resume.

Need higher rate limits? Contact help@getmodulate.dev to discuss your use case.

Support