{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"THOP attributes","description":"Tyro Health Docs","keywords":"redocly developer portal, api portal starter, api reference docs","lang":"en-US","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":"thop-attributes","__idx":0},"children":["THOP attributes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-transaction","__idx":1},"children":["Creating a transaction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Use function"]},":",{"$$mdtype":"Tag","name":"highlight","attributes":{},"children":[" medipassTransactionSDK.renderCreateTransaction() "]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To process a THOP claim, the following fields apply. Any required field not passed to the SDK will be prompted within the Tyro Health submission page."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"thop-claim-submission-attributes","__idx":2},"children":["THOP claim submission attributes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"attributes-table","__idx":3},"children":["Attributes table:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required column values:"]}]},{"$$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":"Value"},"children":["Value"]},{"$$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":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mandatory"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["O"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["C"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]}]}]}]}]},{"$$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":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type/Format"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["providerNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"8 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Usually the Medicare Provider Number. Else the funder specific provider number. Should be 8 characters alpha-numeric. This will change the cardholder's payment narrative and settlement if different rules are set for given provider and practice."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1234565X"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invoiceReference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Up to 16 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["O"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["INV-20220315-001"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chargeAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The amount to charge for the virtual terminal transaction (THOP)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["10.00"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMethod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid values only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the payment should be processed by the provider as a one-off manual entry ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["new-payment-card"]},", the payment request should be sent ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["via SMS"]}," to the patient or to generate a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["payment-link"]}," for email or inclusion in an invoice or terminal payment. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid values: \"new-payment-card\", \"phone\", \"payment-link\" or \"terminal\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["new-payment-card"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.mobile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["+61411111111"]}]}]}]}]}]},"headings":[{"value":"THOP attributes","id":"thop-attributes","depth":1},{"value":"Creating a transaction","id":"creating-a-transaction","depth":2},{"value":"THOP claim submission attributes","id":"thop-claim-submission-attributes","depth":2},{"value":"Attributes table:","id":"attributes-table","depth":2}],"frontmatter":{"title":"THOP attributes","seo":{"title":"THOP attributes"}},"lastModified":"2025-11-03T02:02:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/mcp/mcp-attributes","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}