Reporting

The Reporting API enables integrators and merchants to effortlessly retrieve detailed transaction histories and summary-level data. Seamlessly integrate comprehensive payment insights into your own dashboards, accounting systems, and reporting solutions.

Overview

Reporting API provides:

• Transaction History: Detailed line-item views of completed payments, filterable by merchant, terminal, and date ranges.

Authentication

Reporting API uses username/password-based OAuth2 authentication. See Authentication for details.

Endpoints

Transaction History

Retrieve a detailed list of transactions filtered by merchant, terminal, and date range.

Request Example:

GET https://api.test.devs.beadpay.io/reporting/transactions?merchantId=merchant-001&terminalId=terminal-123&startDate=2025-03-01&endDate=2025-03-04
Authorization: Bearer {access_token}

Response Example:

{
  "transactions": [
    {
      "trackingId": "abc123",
      "status": "completed",
      "amount": 100.00,
      "currency": "USD",
      "completedAt": "2025-03-01T15:20:30Z"
    },
    {
      "trackingId": "def456",
      "status": "completed",
      "amount": 75.50,
      "currency": "USD",
      "completedAt": "2025-03-02T12:45:15Z"
    }
  ],
  "total": 2
}

Pagination (Coming Soon)

Future updates will introduce pagination to efficiently handle large transaction data sets, ensuring fast and responsive reporting even for extensive transaction histories.

Performance

The Reporting API is optimized for efficient data retrieval. For high-volume queries or performance-sensitive integrations, contact our team for best practices.

Next Steps

• Implement your reporting integration using the examples above.

• Check for updates regarding pagination and enhanced filtering options.

For integration questions, or to discuss custom reporting needs, contact [e-mail].