Reporting

Purpose

The Reporting section provides read-only access to historical payments already recorded in the Bead platform. It is designed for reconciliation, analytics, dashboards, and operational audits rather than real-time transaction handling.

When to use Reporting

• Daily or monthly reconciliation against internal ledgers

• Generating statements for partners, merchants, or terminals

• Building dashboards that show recent sales or payment trends

• Investigating payment discrepancies such as underpaid or overpaid transactions

For real-time updates use webhooks. Reporting should complement, not replace, webhook notifications.

How it works

1. Your application sends a POST request to one of the payment-history endpoints.

2. The service queries Bead’s reporting database (a replicated read-only store).

3. Results are returned in pages. You decide the page size, sort order, date range, and status filters via query-string parameters.

Available endpoints

Scope	Path	Description
Terminal	/Terminals/{id}/payments	History for a single payment terminal
Merchant	/Merchants/{id}/payments	Aggregated history for all terminals at one merchant
Partner	/Partners/{id}/payments	Portfolio-wide history across every merchant and terminal owned by the partner

Shared query parameters

Pagination, sorting, date range, and status filters are common to all three endpoints. They are documented once on the Pagination and Sorting page and should be included as query-string parameters on every request.

Next steps

• Review Pagination and Sorting to learn the query parameters.

• Pick the endpoint that matches your scope:

  • Terminal Payments

  • Merchant Payments

  • Partner Payments

• Check Changelog for recent updates before going live.