Get payout summary | Modulate Partner API

curl https://getmodulate.dev/api/partner/residuals/reports/2025/1/summary \
     -H "X-Partner-API-Key: <apiKey>"

{
  "data": {
    "year": 2025,
    "month": 1,
    "payout_before_adjustments": "45000.00",
    "total_adjustments": "500.00",
    "total_withholds": "-1200.00",
    "net_payout": "44300.00",
    "merchant_count": 142,
    "total_volume": "2500000.00",
    "total_transactions": 18500,
    "average_split_pct": 50,
    "payout_variance_vs_prior_month": "2100.00",
    "payout_variance_pct": 4.9
  },
  "meta": {
    "request_id": "req_res02",
    "api_version": "v1",
    "source": "bigquery",
    "as_of": "2025-01-15T10:30:00+00:00",
    "report_run_id": "rpt_2025_01_a1b2c3d4e5f6",
    "report_status": "final",
    "data_cutoff_at": "2025-02-05T00:00:00+00:00",
    "generated_at": "2025-01-15T10:30:00+00:00"
  },
  "errors": []
}

Returns aggregated payout summary including volume, profit, and agent payout for a month.

Authentication

X-Partner-API-Keystring

API Key authentication via header

Path parameters

yearintegerRequired2000-2100

Report year

monthintegerRequired1-12

Report month

Response

Successful Response

dataobject

Aggregated payout summary for a residual report period.

metaobject

errorslist of objects

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

503

Service Unavailable Error