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

Use Reporting when you need to:

• Run daily or monthly reconciliation against internal ledgers

• Generate statements for partners, merchants, or terminals

• Build dashboards that show recent sales or payment trends

• Investigate 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 GET 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 control page size, sort order, date range, and status filters with query 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.

Relationship to Settlement

Reporting focuses on payments. Settlement focuses on how those payments were grouped and funded.

Use Reporting when you need:

• Lists of payments and their payment level fields

• Filters on payment status, tender type, currency, and date range

Use Settlement when you need:

• Merchant settlement batches that show how payments were grouped and funded

• Payment settlement records that show settlement amounts, currencies, and available times

A common pattern is:

1. Use Reporting to identify the payments you care about for a report or investigation

2. Use Settlement to retrieve merchant settlements and payment settlement lines for those payments

For more detail, see Payment History Concepts and the Settlement pages.

Next steps

• Review Pagination and Sorting to learn the query parameters

• Pick the endpoint that matches your scope:

  • Terminal Payments

  • Merchant Payments

  • Partner Payments

• When you also need batch and settlement line information, use:

  • Merchant settlements

  • Payment settlements

• Check the Changelog for recent updates before going live