Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/own-pay/OwnPay-Documentation/llms.txt

Use this file to discover all available pages before exploring further.

The Reports portal gives administrators a real-time window into their brand’s financial performance. Rather than manually querying the database, you can apply date range and gateway filters to instantly compute key metrics — total revenue, transaction count, average ticket size, and gateway fee totals — and export the underlying data as a CSV spreadsheet for bookkeeping, reconciliation, or stakeholder reporting. All figures are scoped to your currently active brand and denominated in that brand’s base currency. In the OwnPay admin dashboard, expand the REPORTS & FINANCE section in the left sidebar and click Reports. The analytics portal opens with the filter bar at the top and KPI summary cards below it.

Report Types and Views

OwnPay’s Reports portal provides the following analytical views, all driven by the same filter controls:

Transaction Summary

Aggregate totals across all completed transactions in the selected period — total revenue, count, average value, and fee totals.

Revenue by Gateway

Filter the summary to a single gateway to see how much revenue each payment method contributes. Compare gateways by switching the gateway selector.

Revenue by Period

Adjust the From and To date pickers to analyse performance across any custom time window — a single day, a month, a quarter, or a full year.

Export to CSV

Download the filtered transaction dataset as a CSV spreadsheet for bookkeeping, reconciliation, or stakeholder reporting.

Key Metrics

The four KPI summary cards at the top of the report provide an instant financial snapshot for the selected filter window:
MetricDescription
Total RevenueThe sum of all completed payment amounts in the brand’s base currency. Refunds are factored into the net calculation.
TransactionsThe total count of completed (successful) payment records in the selected period.
Avg TransactionThe average payment value, calculated as Total Revenue ÷ Transaction Count. Useful for understanding typical customer spend.
Total FeesThe cumulative gateway processing fees applied across all transactions in the period. Compare this against your processor statements to verify fee configurations.

Filtering Reports

Filtering by Date Range

1

Set the From date

Click the From date picker and select the start date of the reporting period. The default is the first day of the current calendar month.
2

Set the To date

Click the To date picker and select the end date. The default is today’s date.
3

Generate the report

Click Generate Report. The KPI cards and analytics table update instantly to reflect the selected window.

Filtering by Gateway

To isolate the performance of a specific payment method:
  1. Open the Gateway dropdown in the filter bar.
  2. Select a specific gateway (e.g. Nagad Personal) or leave it set to All Gateways for a combined view.
  3. Click Generate Report to refresh the calculations.
Use gateway filtering to identify your highest-revenue payment method and ensure it is always active and correctly configured. If one gateway suddenly drops in transaction volume, it may indicate a configuration issue or an outage.

Exporting Reports to CSV

1

Apply your desired filters

Set the date range and gateway filter as described above, then click Generate Report to confirm the scope.
2

Click Export CSV

Click the Export CSV link next to the report header. OwnPay will compile the filtered transaction dataset and trigger a file download.
3

Review the exported file

The downloaded file is named report_{from}_{to}.csv and contains one row per transaction with the following columns: ID, Gateway, Currency, Amount, Status, and Date.
Refunded gateway fees are deducted from net totals in the CSV export, matching the figures shown in the on-screen KPI cards. The export reflects only completed transactions — pending and failed payments are excluded from revenue totals.

Report Query Fields Reference

FieldTypeDefaultDescription
From DateDate picker1st of current monthStart of the reporting period (inclusive).
To DateDate pickerCurrent dateEnd of the reporting period (inclusive).
GatewaySelectAll GatewaysFilter to a specific payment processor or manual gateway.
Export CSVLinkDownload a spreadsheet of the filtered raw transaction data.

Reading the Analytics Chart

Below the KPI cards, OwnPay renders a detailed analytics chart and breakdown table for the selected period and gateway. If no completed transactions exist in the selected window, the panel displays “No transaction data for this period.” This is expected for new brands or very narrow date ranges with no activity.

Best Practices

Archive CSV exports regularly

Export and securely archive monthly CSV reports. These serve as your primary bookkeeping backup in the event of database issues.

Reconcile gateway fees

Compare the Total Fees figure in OwnPay against your payment processor’s billing statements each month to catch any fee configuration drift.

Verify base currency matches expectations

All amounts in the Reports portal are shown in the brand’s base currency. If figures look off, confirm the correct currency is set under Gateways → Currencies & Rates.

Limit export date ranges for large volumes

For brands processing thousands of transactions daily, avoid generating reports spanning more than one year at a time to prevent slow server responses and large file downloads.
CSV exports contain transaction IDs, payment amounts, gateway slugs, and timestamps. Treat these files as sensitive financial records. Do not share them with unauthorised staff or store them in unsecured cloud folders accessible to external parties.

Build docs developers (and LLMs) love