Skip to content
Last updated

Reporting API

Get programmatic, per-merchant access to transaction and settlement data so you can build dashboards, reconciliation tools, and analytics without switching between portals.

What is it?

The Reporting API is a suite of read-only REST endpoints that provides transaction-level (Transactions API) and settlement-level (Settlements API) data for Tyro merchants. It enables merchants and partners to query historical card-present and card-not-present transactions, track fund lodgements to merchant bank accounts, and link settlement records directly to individual payments using clearing identifiers. Both APIs are queried by merchant ID (mid) and date.

Requirements

RequirementDescription
Integration typeBusiness operations (reporting / data access)
WebhooksNone — this API is pull-based, query it directly for the data you need
Setup stepsPartners must provide evidence of authorisation to access reporting data on behalf of a merchant
LimitationsData is only available for dates within the past 3 years
API referenceJump to API reference

Settlements API

Query settlement details for a merchant on a given settlement date, including the destination account and timing.

  • Understand the destination of funds: See which bank account (BSB and account number) was settled to, and when.
  • Reconcile efficiently: Match incoming funds against transaction data to simplify financial operations.

Transactions API

Query a merchant's transaction-level data for a given terminal business day, across one location or many.

  • Uncover actionable insights: Analyse transactions by date and location to assess customer behaviour, such as peak transaction times, and compare performance across locations.
  • Drive smarter decisions: Centralise transaction data for dashboards, forecasting tools, or custom analytics pipelines. Results are paginated via the limit and page query parameters.

Key concepts

Terminal Business Day — the operational processing day assigned to EFTPOS transactions for batching and settlement reporting.

Conditions and limitations

  • Historical Data Scope: Transactions and settlements are available from the previous business day onwards (up to 3 years retention); same-day or live pending transactions are not supported.
  • Excluded Payment Types: Non-card third-party payment methods (such as PayPal, Zip Pay, and Afterpay) are excluded from Reporting API responses.
  • Production-Only Credentials: Development/Sandbox credentials cannot be used with the Reporting APIs; integrations must use Production Auth0 credentials.

API reference

EndpointDescription
GET /reporting/merchants/{mid}/settlementsGet settlements for a merchant
GET /reporting/merchants/{mid}/transactionsGet transactions for a merchant

Full request and response schemas, including error responses, are in the API Explorer.