{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab","admonition"]},"type":"markdown"},"seo":{"title":"Reports","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":"reports","__idx":0},"children":["Reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Tyro terminal provides a reconciliation report feature: a shorter ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["summary"]}," report, or a"," ","more comprehensive ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["detail"]}," report, for either the current or previous settlement period."," ","Integrated reports let the POS request this report data on demand rather than relying on the"," ","terminal's own printer — useful for terminals without a printer attached (consider a PDF printer"," ","for saving reports), or POS systems that don't expose Windows printers directly (e.g. those using"," ","OPOS)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requesting reports through the POS also gives access to up to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["7 days"]}," of reconciliation data,"," ","rather than just the current and previous day available directly from the terminal."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reports can be requested at any time of day, and multiple times per day."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reports can only be requested for dates within the last 7 days."]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"JS library","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, check the certification criteria:"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/certification_criteria_iclient_retail_hospitality.7bf0b2b5462961db882fcba1f1e9ddbec0d942cc7ee96278907994599bebf62a.d564e73d.pdf"},"children":["Certification Criteria Document"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"making-the-request","__idx":1},"children":["Making the request"]},{"$$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":"Function definition"},"children":["Function definition"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameters"},"children":["Parameters"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliationReport(requestParams, responseReceivedCallback)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Initiates a reconciliation report request on the terminal."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requestParams"]}," (Object); ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseReceivedCallback"]}," — Function (a callback function to provide report data or the relevant error message)"]}]}]}]}]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["terminalBusinessDay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The reporting date in format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyyMMdd"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The report type. Valid values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["summary"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detail"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The report format. Valid values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txt"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["xml"]},". The text version is pre-formatted in a mono-spaced font."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Override the configured mid for multi-merchant terminals, or if your browser does not support local storage, or if you have developed headless pairing as a feature."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional — required for headless pairing, multi-merchant, or if your browser does not support local storage"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Override the configured tid for multi-merchant terminals or if your browser does not support local storage or if you have implemented headless pairing as a feature."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional — required for headless pairing, multi-merchant, or if your browser does not support local storage"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integrationKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supply the integration key if your browser does not support local storage or if you have developed headless pairing or multi-merchant as a feature."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional — required for headless pairing, multi-merchant, or if your browser does not support local storage"]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"function doReport(reportDate, reportType, reportFormat) {\n\n  iclient.reconciliationReport({\n    terminalBusinessDay: reportDate,\n    type: reportType,\n    format: reportFormat\n  }, reportCallback);\n}\n\nvar reportCallback = function(response) {\n  console.log(JSON.stringify(response));\n  $(\"#result\").html(response.result);\n  $(\"#data\").html(\"<pre>\" + escapeHtml(response.data) + \"</pre>\");\n  $(\"#error\").html(response.error);\n};\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://jsfiddle.net/IntegrationSupport/xaw5n78m/9/"},"children":["JS Fiddle demo"]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Don't click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]}," if you make changes in the JS Fiddle — click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Run"]}," instead. Clicking Save"," ","may break the fiddle's functionality."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"handling-the-response","__idx":2},"children":["Handling the response"]},{"$$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":"Function"},"children":["Function"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Usage required"},"children":["Usage required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseReceivedCallback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoked when the request has been completed on the terminal. Called with a single object containing the following fields, as shown in the below table."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]}]}]}]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Usage required"},"children":["Usage required"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The result of the report request, will be either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failure"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The format requested is passed back for convenience, will be either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["summary"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["detailed"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type requested is passed back for convenience, will be either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txt"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["xml"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The report. Pre-formatted text when format is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["txt"]},". Parsable XML when format is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["xml"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An error message to show the merchant. Only present when result is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failure"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"steps-to-follow","__idx":3},"children":["Steps to follow"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The report requested by the POS using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliationReport()"]}," is returned using"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseReceivedCallback"]}," — the POS must provide the function required to handle the callback"," ","response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," field contains the unparsed text or XML version of the report (as per the request);"," ","for reference, the format and type for the requested report are also passed back in the"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["format"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The POS must then parse the report data: for a text format report, remove the labels; for an"," ","XML format report, parse the XML to obtain the data for the transactions performed on a given"," ","day."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the request is unsuccessful, the POS will be provided the result and the error message in the"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," fields — display them on the screen for the user's reference."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"var reportCallback = function(response) {\n  console.log(JSON.stringify(response));\n  var report=response.data;\n  \n  //Parsing the Text version of the report to remove the labels//\n  if (($(\"input[name='format']:checked\").val())==\"txt\"){\n  report = report.replace(/NEW_LINE/g,\" \");\n  report = report.replace(/MEDIUM_CENTRED:/g,\" \");\n  report = report.replace(/MEDIUM:/g,\" \");\n  report = report.replace(/MEDIUM_RIGHT:/g,\" \");\n  report = report.replace(/MEDIUM_BOLD:/g,\" \");\n  report = report.replace(/LARGE_CENTRED:/g,\" \");\n  report = report.replace(/FORM_FEED/g,\" \");\n  report = report.replace(/SMALL:/g,\" \");\t\n  report = report.replace(/SMALL:/g,\" \");\n  }\n     \n\n    console.log(report);\n\n  $(\"#result\").html(response.result);\n  $(\"#data\").html(\"<pre>\" + escapeHtml(report) + \"</pre>\");\n  $(\"#error\").html(response.error);\n};\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"example-response","__idx":4},"children":["Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below is an XML response example for the report request."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\"result\":\"success\",\n\"format\":\"xml\",\n\"type\":\"summary\",\n\"data\":\"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n\n<reconciliation-summary mid=\\\"200\\\" tid=\\\"200\\\" terminal-business-day=\\\"2024-01-17\\\" total=\\\"1620.00\\\">\\n\n<card type=\\\"visa\\\" purchases=\\\"280.00\\\" refunds=\\\"-70.00\\\" total=\\\"210.00\\\"/>\\n\n<card type=\\\"mastercard\\\" purchases=\\\"200.00\\\" refunds=\\\"-80.00\\\" total=\\\"120.00\\\"/>\\n\n<card type=\\\"eftpos\\\" purchases=\\\"1100.00\\\" cash-out=\\\"50.00\\\" refunds=\\\"0.00\\\" total=\\\"1150.00\\\"/>\\n\n<card type=\\\"amex\\\" purchases=\\\"30.00\\\" refunds=\\\"0.00\\\" total=\\\"30.00\\\"/>\\n\n<card type=\\\"diners\\\" purchases=\\\"70.00\\\" refunds=\\\"0.00\\\" total=\\\"70.00\\\"/>\\n\n<card type=\\\"jcb\\\" purchases=\\\"40.00\\\" refunds=\\\"0.00\\\" total=\\\"40.00\\\"/>\\n\n</reconciliation-summary>\\n\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":".NET library","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Terminal reports are accessed through the TTA via the .NET interface"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Tyro.Integ.ITerminalAdapterReports"]},". At the conclusion of the execution of the methods, control is"," ","returned to the caller and an object containing the result of the operation is given."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Not all of Tyro's terminals have an integrated printer attached — for merchants whose terminals"," ","lack one, consider a PDF printer so reports can be saved in PDF format. Not all POS systems make"," ","their printers available as Windows printers either (many use OPOS for printing); the additional"," ","API calls below are available through the TTA for these systems."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"transaction-reports","__idx":5},"children":["Transaction reports"]},{"$$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":"Method"},"children":["Method"]},{"$$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":"code","attributes":{},"children":["IReport TransactionSummaryReport(string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTPS GET request for a transaction summary report for the date specified (format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyyMMdd"]},"), using the default MID and TID configured in the TTA configuration panel."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport TransactionDetailedReport(string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same, for a transaction detailed report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport TransactionSummaryReportMidTid(string mid, string tid, string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction summary report for the MID, TID and date specified."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport TransactionDetailedReportMidTid(string mid, string tid, string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transaction detailed report for the MID, TID and date specified."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"ireport-return-value","__idx":6},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport"]}," return value"]},{"$$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":"Method"},"children":["Method"]},{"$$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":"code","attributes":{},"children":["ErrorOccurred()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if a configuration or network error occurred — call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetError()"]}," to determine the cause. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," indicates the call executed successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetText()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The text associated with the report — plain text, in the format detailed below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetError()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}," object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HttpStatusCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorMessage"]},", and other useful information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetMid()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The mid associated with the report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetTid()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The tid associated with the report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetyyyyMMdd()"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date associated with the report."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-error-codes","__idx":7},"children":["Response error codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Accessed via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport.GetError().GetHttpStatusCode()"]},":"]},{"$$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":"HTTP Code"},"children":["HTTP Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Name"},"children":["HTTP Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["200"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OK"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request succeeds"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["202"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accepted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System not ready to receive requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request does not conform to requirements"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication Failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submitted key does not match Terminal's key"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Terminal is not connected to Tyro"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error in Tyro system - Please report these to Tyro"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["501"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Implemented"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The operation is not available"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["504"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gateway Timeout"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request timed out before response could be generated"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"report-format","__idx":8},"children":["Report format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The format of the report content is one where each line of the report is in the format"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["style: text"]},". The maximum length of any line is 27 characters, and the style of each line can"," ","include various combinations of text alignment, font size and font weight."]},{"$$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":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Alignment"},"children":["Alignment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Font size"},"children":["Font size"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Font weight"},"children":["Font weight"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LARGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Large"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LARGE_CENTRED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Centre"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Large"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LARGE_RIGHT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Right"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Large"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LARGE_BOLD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Large"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medium"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM_CENTRED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Centre"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medium"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM_RIGHT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Right"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medium"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEDIUM_BOLD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medium"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMALL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Small"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMALL_CENTRED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Centre"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Small"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMALL_RIGHT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Right"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Small"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMALL_BOLD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Small"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TINY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tiny"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TINY_CENTRED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Centre"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tiny"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TINY_RIGHT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Right"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tiny"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TINY_BOLD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Left"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tiny"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEW_LINE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write out a blank line"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FORM_FEED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Feed enough paper through to allow a clean tear off"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Many of the styles listed above are not currently in use but are reserved for future use. For"," ","centring, left pad the text with a number of spaces equal to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["(27 - length of text) / 2"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"summary-report-example-response","__idx":9},"children":["Summary report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"MEDIUM_CENTRED: Merchant Name Here\nMEDIUM_CENTRED: 125 York Street\nMEDIUM_CENTRED: Sydney NSW 2000\nNEW_LINE\nLARGE_CENTRED: SUMMARY REPORT\nNEW_LINE\nMEDIUM_CENTRED: Tyro EFTPOS\nNEW_LINE\nMEDIUM: Merchant ID: 123\nMEDIUM: Terminal ID: 3\nNEW_LINE\nMEDIUM: Printed: 23/07/12 10:26\nNEW_LINE\nMEDIUM: Card type: All cards\nNEW_LINE\nMEDIUM_BOLD: Date: 17/07/12\nNEW_LINE\nMEDIUM: Purchase 30 $1,139.88\nMEDIUM: Cash out (0) $0.00\nMEDIUM: Tip (0) $0.00\nMEDIUM: Refund 1 -$39.95\nMEDIUM: Void 0 $0.00\nMEDIUM_RIGHT: ------------\nMEDIUM: NET TOTAL 31 $1,099.93\nNEW_LINE\nMEDIUM: EFTPOS 16 $469.93\nMEDIUM: Visa 5 $194.70\nMEDIUM: MasterCard 4 $259.90\nMEDIUM_RIGHT: ------------\nMEDIUM: TYRO TOTAL 25 $924.53\nNEW_LINE\nMEDIUM: AMEX 6 $175.40\nMEDIUM: JCB 0 $0.00\nMEDIUM: Diners 0 $0.00\nMEDIUM_RIGHT: ------------\nMEDIUM: NET TOTAL 31 $1,099.93\nNEW_LINE\nFORM_FEED\n","lang":"console"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"detailed-report-example-response","__idx":10},"children":["Detailed report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"MEDIUM_CENTRED: Merchant Name Here\nMEDIUM_CENTRED: 127 York Street\nMEDIUM_CENTRED: Sydney NSW 2000\nNEW_LINE\nLARGE_CENTRED: DETAIL REPORT\nNEW_LINE\nMEDIUM_CENTRED: Tyro EFTPOS\nNEW_LINE\nMEDIUM: Merchant ID: 123\nMEDIUM: Terminal ID: 3\nNEW_LINE\nMEDIUM: Printed: 23/07/12 10:31\nNEW_LINE\nMEDIUM: Card type: All cards\nNEW_LINE\nMEDIUM_BOLD: Date: 17/07/12\nNEW_LINE\nMEDIUM: 08:39 Amex 6082 (s)\nMEDIUM: Purchase $19.90\nNEW_LINE\nMEDIUM: 08:58 EFTPOS 9815 (s)\nMEDIUM: Purchase $39.95\nNEW_LINE\nMEDIUM: 09:27 EFTPOS 0836 (c)\nMEDIUM: Purchase $106.80\nNEW_LINE\nMEDIUM: 09:32 MasterCard 2785 (c)\nMEDIUM: Purchase $24.95\nNEW_LINE\nMEDIUM: 09:48 EFTPOS 7926 (c)\nMEDIUM: Purchase $9.90\nNEW_LINE\nMEDIUM: 11:36 MasterCard 6818 (c)\nMEDIUM: Purchase $110.10\nNEW_LINE\nMEDIUM: 11:47 Amex 1003 (s)\nMEDIUM: Refund -$39.95\nNEW_LINE\nMEDIUM: 12:04 EFTPOS 1759 (c)\nMEDIUM: Purchase $44.00\nNEW_LINE\nMEDIUM: 12:18 EFTPOS 5161 (c)\nMEDIUM: Purchase $43.40\nNEW_LINE\nMEDIUM: 12:21 MasterCard 7826 (c)\nMEDIUM: Purchase $69.95\nNEW_LINE\nMEDIUM: 12:58 MasterCard 9977 (c)\nMEDIUM: Purchase $54.90\nNEW_LINE\nMEDIUM: 13:06 EFTPOS 1090 (c)\nMEDIUM: Purchase $6.95\nNEW_LINE\nMEDIUM: 13:12 Visa 3527 (c)\nMEDIUM: Purchase $27.00\nNEW_LINE\nMEDIUM: 13:14 EFTPOS 4795 (s)\nMEDIUM: Purchase $25.90\nNEW_LINE\nMEDIUM: 13:22 EFTPOS 4709 (s)\nMEDIUM: Purchase $10.08\nNEW_LINE\nMEDIUM: 13:33 Amex 4264 (s)\nMEDIUM: Purchase $69.95\nNEW_LINE\nMEDIUM: 13:45 Visa 0930 (s)\nMEDIUM: Purchase $29.95\nNEW_LINE\nMEDIUM: 14:04 Amex 8661 (s)\nMEDIUM: Purchase $11.95\nNEW_LINE\nMEDIUM: 14:15 Visa 2066 (c)\nMEDIUM: Purchase $32.30\nNEW_LINE\nMEDIUM: 14:16 Amex 3005 (s)\nMEDIUM: Purchase $53.60\nNEW_LINE\nMEDIUM: 14:49 EFTPOS 4739 (s)\nMEDIUM: Purchase $21.95\nNEW_LINE\nMEDIUM: 15:06 EFTPOS 4709 (c)\nMEDIUM: Purchase $8.95\nNEW_LINE\nMEDIUM: 15:08 Visa 2369 (c)\nMEDIUM: Purchase $46.85\nNEW_LINE\nMEDIUM: 15:30 EFTPOS 9475 (s)\nMEDIUM: Purchase $19.75\nNEW_LINE\nMEDIUM: 15:36 Amex 0043 (s)\nMEDIUM: Purchase $59.95\nNEW_LINE\nMEDIUM: 16:02 EFTPOS 2923 (s)\nMEDIUM: Purchase $24.95\nNEW_LINE\nMEDIUM: 16:40 EFTPOS 2410 (c)\nMEDIUM: Purchase $21.95\nNEW_LINE\nMEDIUM: 16:44 Visa 3895 (c)\nMEDIUM: Purchase $58.60\nNEW_LINE\nMEDIUM: 16:49 EFTPOS 3750 (s)\nMEDIUM: Purchase $12.95\nNEW_LINE\nMEDIUM: 16:50 EFTPOS 3750 (s)\nMEDIUM: Purchase $22.90\nNEW_LINE\nMEDIUM: 17:34 EFTPOS 8617 (c)\nMEDIUM: Purchase $49.55\nNEW_LINE\nSMALL: s: swiped, c: chip, m: manual\nSMALL: e: express payment\nNEW_LINE\nLARGE_CENTRED: SUMMARY REPORT\nMEDIUM: Purchase 30 $1,139.88\nMEDIUM: Cash out (0) $0.00\nMEDIUM: Tip (0) $0.00\nMEDIUM: Refund 1 -$39.95\nMEDIUM: Void 0 $0.00\nMEDIUM_RIGHT: ------------\nMEDIUM: NET TOTAL 31 $1,099.93\nNEW_LINE\nMEDIUM: EFTPOS 16 $469.93\nMEDIUM: Visa 5 $194.70\nMEDIUM: MasterCard 4 $259.90\nMEDIUM_RIGHT: ------------\nMEDIUM: TYRO TOTAL 25 $924.53\nNEW_LINE\nMEDIUM: AMEX 6 $175.40\nMEDIUM: JCB 0 $0.00\nMEDIUM: Diners 0 $0.00\nMEDIUM_RIGHT: ------------\nMEDIUM: NET TOTAL 31 $1,099.93\nNEW_LINE\nFORM_FEED\n","lang":"console"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reconciliation-reports","__idx":11},"children":["Reconciliation reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ITerminalAdapterReports"]}," interface also exposes a second set of methods, returning"," ","reports in XML rather than the styled plain text above. These reports are intended for POS-side"," ","reconciliation: download the summary report first and compare totals; if they don't match,"," ","download the detailed report to verify each transaction, then generate an \"overs and unders\""," ","report and notify the POS operator about the transactions that don't reconcile."]},{"$$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":"Method"},"children":["Method"]},{"$$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":"code","attributes":{},"children":["IReport ReconciliationReportSummary(string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTPS GET request for a summary reconciliation report for the date specified (format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyyMMdd"]},"), using the default MID and TID configured in the TTA configuration panel."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport ReconciliationReportDetailed(string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same, for a detailed reconciliation report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport ReconciliationReportSummaryMidTid(string mid, string tid, string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Summary reconciliation report for the MID, TID and date specified."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport ReconciliationReportDetailedMidTid(string mid, string tid, string date)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detailed reconciliation report for the MID, TID and date specified."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IReport"]}," interface as above — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GetText()"]}," here returns an XML document instead"," ","of plain text."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"summary-report-xml-schema","__idx":12},"children":["Summary report XML schema"]},{"$$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":"Response parameter"},"children":["Response parameter"]},{"$$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":"code","attributes":{},"children":["reconciliation-summary/@mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The mid (Merchant ID) for this report"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-summary/@tid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The tid (Terminal ID) for this report"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-summary/@terminal-business-day"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The terminal business day for this report (format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyy-MM-dd"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-summary/@total"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of all the transactions for the business day"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-summary/card"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of card schemes reported on (currently 6 — Visa, MasterCard, EFTPOS, Amex, Diners, JCB). Within each ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["card"]}," element: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@type"]}," (visa/mastercard/eftpos/amex/diners/jcb), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@purchases"]}," (total purchases), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@cash-out"]}," (total cash out), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@refunds"]}," (total refunds, shown as a negative amount), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@total"]}," (net total for the card scheme)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"detail-report-xml-schema","__idx":13},"children":["Detail report XML schema"]},{"$$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":"Response parameter"},"children":["Response parameter"]},{"$$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":"code","attributes":{},"children":["reconciliation-detail/@mid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The mid (Merchant ID) for this report"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-detail/@tid"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The tid (Terminal ID) for this report"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-detail/@terminal-business-day"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The terminal business day for this report (format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyy-MM-dd"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-detail/@total"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The total amount of all the transactions for the business day"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reconciliation-detail/transaction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The list of transactions processed by that terminal on that business day. Within each ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transaction"]}," element: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@type"]}," (purchase/refund/void), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@card-type"]}," (visa/mastercard/eftpos/amex/diners/jcb), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@amount"]}," (transaction amount, not including tip or cash out), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@cash-out"]}," (cash-out amount), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@tip"]}," (tip amount), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@transaction-local-date-time"]}," (format ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["yyyy-MM-dd HH:mm:ss"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@tyro-reference"]}," (a Tyro reference, unique when combined with MID, TID, and business day), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@merchant-reference"]}," (the integrated transaction ID, if passed in at initiation), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@settlement-date"]}," (not known for Amex, Diners, or JCB)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The XML used in the reports does not come with a DTD or XML Schema. We reserve the right to add"," ","elements or attributes in the future if we need to. We will not, however, remove elements or"," ","attributes. Our suggestion is that developers use XPath for retrieving data from the XML"," ","responses."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"summary-report-example-response-1","__idx":14},"children":["Summary report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reconciliation-summary mid=\"200\" tid=\"200\" terminal-business-day=\"2011-\n09-14\" total=\"1620.00\"> \n <card type=\"visa\" purchases=\"280.00\" refunds=\"-70.00\" total=\"210.00\"\n/> \n <card type=\"mastercard\" purchases=\"200.00\" refunds=\"-80.00\" total=\"\n120.00\"/> \n <card type=\"eftpos\" purchases=\"1100.00\" cash-out=\"50.00\" refunds=\"\n0.00\" total=\"1150.00\"/> \n <card type=\"amex\" purchases=\"30.00\" refunds=\"0.00\" total=\"30.00\"/> \n <card type=\"diners\" purchases=\"70.00\" refunds=\"0.00\" total=\"70.00\"/> \n <card type=\"jcb\" purchases=\"40.00\" refunds=\"0.00\" total=\"40.00\"/> \n</reconciliation-summary>\n","lang":"console"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"detail-report-example-response","__idx":15},"children":["Detail report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reconciliation-detail mid=\"200\" tid=\"200\" terminal-business-day=\"2011-\n09-14\" total=\"1620.00\"> \n<transaction type=\"purchase\" card-type=\"visa\" amount=\"100.00\" tip=\"\n10.00\" transaction-local-date-time=\"2011-09-14 12:30:30\" tyro-reference=\"870020\" merchant-reference=\"071061048231306351219677\" \nsettlement-date=\"2011-09-16\"/> \n <transaction type=\"purchase\" card-type=\"mastercard\" amount=\"200.00\" \ntransaction-local-date-time=\"2011-09-14 12:31:20\" tyro-reference=\"\n885214\" merchant-reference=\"071061048231306351219678\" settlement-date=\"\n2011-09-16\"/> \n <transaction type=\"purchase\" card-type=\"jcb\" amount=\"40.00\" \ntransaction-local-date-time=\"2011-09-14 12:33:23\" tyro-reference=\"\n896534\" merchant-reference=\"071061048231306351219679\"/> \n <transaction type=\"purchase\" card-type=\"amex\" amount=\"30.00\" \ntransaction-local-date-time=\"2011-09-14 12:36:35\" tyro-reference=\"\n905845\" merchant-reference=\"071061048231306351219680\"/> \n <transaction type=\"purchase\" card-type=\"eftpos\" amount=\"650.00\" cash-out=\"50.00\" transaction-local-date-time=\"2011-09-14 12:40:30\" tyro-reference=\"912556\" merchant-reference=\"071061048231306351219681\" \nsettlement-date=\"2011-09-16\"/> \n <transaction type=\"purchase\" card-type=\"eftpos\" amount=\"450.00\" \ntransaction-local-date-time=\"2011-09-14 12:50:30\" tyro-reference=\"\n920187\" merchant-reference=\"071061048231306351219682\" settlement-date=\"\n2011-09-16\"/> \n <transaction type=\"purchase\" card-type=\"diners\" amount=\"70.00\" \ntransaction-local-date-time=\"2011-09-14 13:30:30\" tyro-reference=\"\n935587\" merchant-reference=\"071061048231306351219683\"/> \n <transaction type=\"void\" card-type=\"mastercard\" amount=\"-80.00\" \ntransaction-local-date-time=\"2011-09-14 13:50:30\" tyro-reference=\"\n946585\" merchant-reference=\"071061048231306351219684\" settlement-date=\"\n2011-09-16\"/> \n <transaction type=\"purchase\" card-type=\"visa\" amount=\"170.00\" \ntransaction-local-date-time=\"2011-09-14 14:23:25\" tyro-reference=\"\n953594\" merchant-reference=\"071061048231306351219685\" settlement-date=\"\n2011-09-16\"/> \n <transaction type=\"refund\" card-type=\"visa\" amount=\"-70.00\" \ntransaction-local-date-time=\"2011-09-14 15:41:12\" tyro-reference=\"\n962548\" merchant-reference=\"071061048231306351219685\" settlement-date=\"\n2011-09-16\"/> \n</reconciliation-detail>\n","lang":"console"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"empty-summary-report-example-response","__idx":16},"children":["Empty summary report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reconciliation-summary mid=\"200\" tid=\"200\" terminal-business-day=\"2011-\n05-28\" total=\"0.00\">\n <card type=\"visa\" purchases=\"0.00\" refunds=\"0.00\" total=\"0.00\"/>\n <card type=\"mastercard\" purchases=\"0.00\" refunds=\"0.00\" total=\"0.00\"\n/>\n <card type=\"eftpos\" purchases=\"0.00\" cash-out=\"0.00\" refunds=\"0.00\"\n total=\"0.00\"/>\n <card type=\"amex\" purchases=\"0.00\" refunds=\"0.00\" total=\"0.00\"/>\n <card type=\"diners\" purchases=\"0.00\" refunds=\"0.00\" total=\"0.00\"/>\n <card type=\"jcb\" purchases=\"0.00\" refunds=\"0.00\" total=\"0.00\"/>\n</reconciliation-summary>\n","lang":"console"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"empty-detail-report-example-response","__idx":17},"children":["Empty detail report example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"console","header":{"controls":{"copy":{}}},"source":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<reconciliation-detail mid=\"200\" tid=\"200\" terminal-business-day=\"2011-\n05-28\" total=\"0.00\"></reconciliation-detail>\n","lang":"console"},"children":[]}]}]}]},"headings":[{"value":"Reports","id":"reports","depth":1},{"value":"Making the request","id":"making-the-request","depth":3},{"value":"Handling the response","id":"handling-the-response","depth":3},{"value":"Steps to follow","id":"steps-to-follow","depth":4},{"value":"Example response","id":"example-response","depth":5},{"value":"Transaction reports","id":"transaction-reports","depth":3},{"value":"IReport return value","id":"ireport-return-value","depth":4},{"value":"Response error codes","id":"response-error-codes","depth":4},{"value":"Report format","id":"report-format","depth":4},{"value":"Summary report example response","id":"summary-report-example-response","depth":5},{"value":"Detailed report example response","id":"detailed-report-example-response","depth":5},{"value":"Reconciliation reports","id":"reconciliation-reports","depth":3},{"value":"Summary report XML schema","id":"summary-report-xml-schema","depth":4},{"value":"Detail report XML schema","id":"detail-report-xml-schema","depth":4},{"value":"Summary report example response","id":"summary-report-example-response-1","depth":5},{"value":"Detail report example response","id":"detail-report-example-response","depth":5},{"value":"Empty summary report example response","id":"empty-summary-report-example-response","depth":5},{"value":"Empty detail report example response","id":"empty-detail-report-example-response","depth":5}],"frontmatter":{"title":"Reports","seo":{"title":"Reports"}},"lastModified":"2026-10-02T05:06:47.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/in-person-payments/pay-in-person/features/reports","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}