{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Reporting API","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"reporting-api","__idx":0},"children":["Reporting API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get programmatic, per-merchant access to transaction and settlement data so you can build dashboards, reconciliation tools, and analytics without switching between portals."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-is-it","__idx":1},"children":["What is it?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Reporting API is a suite of read-only REST endpoints that provides transaction-level (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transactions API"]},") and settlement-level (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mid"]},") and date."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":2},"children":["Requirements"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Requirement"},"children":["Requirement"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business operations (reporting / data access)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhooks"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — this API is pull-based, query it directly for the data you need"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Setup steps"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partners must provide evidence of authorisation to access reporting data on behalf of a merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Limitations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Data is only available for dates within the past 3 years"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#api-reference"},"children":["Jump to API reference"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"settlements-api","__idx":3},"children":["Settlements API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query settlement details for a merchant on a given settlement date, including the destination account and timing."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Understand the destination of funds"]},": See which bank account (BSB and account number) was settled to, and when."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reconcile efficiently"]},": Match incoming funds against transaction data to simplify financial operations."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transactions-api","__idx":4},"children":["Transactions API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query a merchant's transaction-level data for a given terminal business day, across one location or many."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Uncover actionable insights"]},": Analyse transactions by date and location to assess customer behaviour, such as peak transaction times, and compare performance across locations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Drive smarter decisions"]},": Centralise transaction data for dashboards, forecasting tools, or custom analytics pipelines. Results are paginated via the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," query parameters."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":5},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Terminal Business Day"]}," — the operational processing day assigned to EFTPOS transactions for batching and settlement reporting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"conditions-and-limitations","__idx":6},"children":["Conditions and limitations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Excluded Payment Types"]},": Non-card third-party payment methods (such as PayPal, Zip Pay, and Afterpay) are excluded from Reporting API responses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production-Only Credentials"]},": Development/Sandbox credentials cannot be used with the Reporting APIs; integrations must use Production Auth0 credentials."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-reference","__idx":7},"children":["API reference"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/reporting/1.0/other/get-reporting-settlements"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reporting/merchants/{mid}/settlements"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get settlements for a merchant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/reporting/1.0/other/get-reporting-transactions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reporting/merchants/{mid}/transactions"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get transactions for a merchant"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full request and response schemas, including error responses, are in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-explorer/reporting/1.0/other/get-reporting-settlements"},"children":["API Explorer"]},"."]}]},"headings":[{"value":"Reporting API","id":"reporting-api","depth":1},{"value":"What is it?","id":"what-is-it","depth":2},{"value":"Requirements","id":"requirements","depth":2},{"value":"Settlements API","id":"settlements-api","depth":2},{"value":"Transactions API","id":"transactions-api","depth":2},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"Conditions and limitations","id":"conditions-and-limitations","depth":2},{"value":"API reference","id":"api-reference","depth":2}],"frontmatter":{"seo":{"title":"Reporting API"}},"lastModified":"2026-09-09T05:39:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/business-operations/reporting/overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}