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 both on an adhoc basis and scheduled runs.

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

Regions, currencies, and languages supported by Reporting API
Supported currencies	Supported languages	Supported regions
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, ISK, JMD, JPY, KES, KHR, KMF, KRW, KYD, KZT, LAK, LBP, LKR, LRD, LSL, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLL, SOS, SRD, STN, SZL, THB, TJS, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW	English	United States Australia Canada Europe United Kingdom

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.
Identify report types — Determine the specific types of reports available and relevant to your needs. Learn more about report types.
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.
Set up how and when you want to receive your reports — Configure identified reports and setup preferences for how and when you want to receive them. Review available configurations and how to manage a report configuration.
Run a report and check its details — Execute your report configuration and monitor the status of requested reports. Learn more about how to run your report and check the report details.
Retrieve generated reports — Access and retrieve the generated reports based on your configured preferences. Learn more about how to retrieve reports.
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.