Transaction History

The Transaction History endpoint allows integrators and merchants to easily retrieve detailed, line-item payment transaction records. Integrate these records directly into your own dashboards, reporting tools, or accounting systems.

Authentication

The Reporting API, including the Transaction History endpoint, uses username/password-based OAuth2 authentication. See Authentication for details.

Retrieve Transaction History

Query transaction history with optional filtering 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}

Query Parameter	Description	Required?
merchantId	Filter by specific merchant	Optional
terminalId	Filter by specific terminal	Optional
startDate	Start date for transaction filter (YYYY-MM-DD)	Required
endDate	End date for transaction filter (YYYY-MM-DD)	Required

Response Example

{
  "transactions": [
    {
      "trackingId": "abc123",
      "status": "completed",
      "amount": 100.00,
      "currency": "USD",
      "terminalId": "terminal-123",
      "merchantId": "merchant-001",
      "reference": "ORDER1001",
      "completedAt": "2025-03-01T15:20:30Z"
    },
    {
      "trackingId": "def456",
      "status": "completed",
      "amount": 75.50,
      "currency": "USD",
      "terminalId": "terminal-123",
      "merchantId": "merchant-001",
      "reference": "ORDER1002",
      "completedAt": "2025-03-02T12:45:15Z"
    }
  ],
  "totalTransactions": 2
}

Transaction Fields

Field	Description
trackingId	Unique transaction identifier
status	Payment status (completed, expired, etc.)
amount	Amount of the transaction
currency	Currency code (e.g., USD)
terminalId	Terminal associated with transaction
merchantId	Merchant associated with transaction
reference	Your provided order or reference identifier
completedAt	Timestamp when transaction was completed

Handling Large Data Sets

Support for pagination will be provided soon to handle large data sets efficiently.

Next Steps

• Integrate the Transaction History endpoint into your platform's reporting workflow.

For questions or integration assistance, contact [e-mail].