Reporting

The Reporting API is a modular interface used to configure, customize, and retrieve reports.

Configure reports

Use pre-built reports or specify the configuration, criteria, and attributes to tailor the data output to your specific needs.

Schedule reports

Schedule reports both on an adhoc basis and scheduled runs.

Check the status and download

Check the real-time status of the report generation and dowload reports in multiple formats.

How reporting works

The following steps help you to get started with Reporting:

Request access — Follow the steps in getting started to set up access to the Reporting API.
Select the type of integration — Select the type of integration option you want to use.
- Quick integration — Use pre-configured preset reports to quickly integrate and schedule reports without having to configure every aspect of the report.
  1. Choose preset report — Determine the preset report you want to use. Learn more about preset reports.
  2. Schedule preset report — Choose when you want the report to be generated by choosing the frequency and entities for which the reporting data needs to be generated. Learn more about scheduling reports and how to manage report configurations.
- Custom integration — Use pre-funded and post-fund report types to customize the structure, configure the schedule, and provide the date range of the data you require in your report in the format of your choice.
  1. Choose report type — Determine the pre-funded or post-funded report type you want to use. Learn more about report types.
  2. Customize report — Choose the required attributes, customize the attributes using aliases, aggregates and custom calculation, and set the custom report file name, header and trailer. Learn more about advanced customization.
  3. Schedule report — Choose when you want the report to be generated by choosing the frequency, entities for which the reporting data needs to be generated, and a custom report file name. Learn more about scheduling reports and how to manage report configurations.
Check the status of the report — Check the details of the report configuration and monitor its status. Learn more about how to retrieve report details.
Retrieve generated reports — Access and retrieve the generated reports based on your configured preferences. Learn more about how to retrieve reports.

You can also:

Create and manage reporting groups — Group entities or reporting groups together as one to generate a single report for all entities. Learn more about reporting groups and how to manage reporting groups.
Run an ad hoc report and check its details — Execute any report configuration at any time as adhoc and monitor the status of requested reports. Learn more about how to run your report and check the report details.
Reconcile standard reports — Reconcile payments life-cycle data using standard reports. Learn more about how to reconcile standard reports.
Get webhook notifications for reports — Subscribe to report status notifications to get notified via webhooks when a report completes or errors. Learn more about notifications.

Availability