Dashboard types
Agent dashboard
Metrics scoped to a specific agent’s portfolio:| Endpoint | Description |
|---|---|
| Applications summary | Lead counts broken down by pipeline stage |
| KPI metrics | Key performance indicators for the agent |
| Merchant status | Active, inactive, and closed merchant breakdown |
| Monthly active merchants | Month-over-month active merchant count |
| Monthly processing volume | Rolling monthly processing volume trend |
| Net merchants | Net merchant adds and attrition by month |
| Ticket counts | Open ticket summary for the agent |
| Top performers (processing) | Highest-volume merchants in the agent’s book |
Agent residuals
ISO residual data scoped to an agent’s portfolio. These endpoints are served from the Financial Reporting section:| Endpoint | Description |
|---|---|
| List residuals | ISO residual historical summaries and aggregated metrics |
| Get residual | Single residual period summary |
| Get residual metrics | Aggregated residual metrics |
| List all merchant summaries | All-time merchant-level residual summaries |
| List merchant summaries | Merchant summaries for a specific residual period |
| Get merchant summary | Single merchant residual summary |
| List gross details | Gross residual detail records |
| List merchant details | Line-item residual details for a merchant |
| Get merchant detail | Single merchant residual detail record |
| List all overrides | All-time residual overrides |
| List overrides | Overrides for a specific residual period |
| Get override | Single residual override record |
Merchant dashboard
Metrics scoped to a single merchant’s activity:| Endpoint | Description |
|---|---|
| KPI metrics | Key performance indicators for the merchant |
| Latest batch date | Most recent settlement batch date |
| Recent transactions | Latest transaction activity |
| Ticket counts | Open support tickets for the merchant |
| Transaction trend | Volume trend over time |
Partner dashboard
Metrics scoped to a partner’s full downstream portfolio:| Endpoint | Description |
|---|---|
| Applications summary | Lead pipeline breakdown across all agents |
| KPI metrics | Key performance indicators for the partner |
| Merchant status | Portfolio-level active/inactive/closed breakdown |
| Monthly active merchants | Month-over-month active merchant count |
| Monthly processing volume | Rolling monthly volume trend |
| Net merchants | Net merchant adds and attrition by month |
| Top agents MTD | Best-performing agents month-to-date |
| Top performers (processing) | Highest-volume merchants in the portfolio |
| Top performers (residual) | Highest-residual merchants in the portfolio |
Partner residuals
ISO residual data scoped to a partner’s portfolio. These endpoints are served from the Financial Reporting section:| Endpoint | Description |
|---|---|
| List residuals | ISO residual historical summaries and aggregated metrics |
| Get residual | Single residual period summary |
| Get residual metrics | Aggregated residual metrics |
| List all merchant summaries | All-time merchant-level residual summaries |
| List merchant summaries | Merchant summaries for a specific residual period |
| Get merchant summary | Single merchant residual summary |
| List gross details | Gross residual detail records |
| List merchant details | Line-item residual details for a merchant |
| Get merchant detail | Single merchant residual detail record |
| List all overrides | All-time residual overrides |
| List overrides | Overrides for a specific residual period |
| Get override | Single residual override record |