{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Instalment 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":"instalment-attributes","__idx":0},"children":["Instalment 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 create and instalment, 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":"attributes-table","__idx":2},"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":["platform"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid values only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["futures"]}," for instalment plans"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["futures"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["futureType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid values only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["instalment-plan"]}," for plans"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["instalment-plan"]}]},{"$$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":["O"]},{"$$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."]},{"$$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":["numberOfInstalments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid values only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If not sets defaults to weekly"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instalmentFrequency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Valid values only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If not sets defaults to 2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2"]}]},{"$$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":["O"]},{"$$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 is pre-populated, 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. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid values: \"new-payment-card\", \"phone\", payment-card or \"payment-link\""]},{"$$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"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"hold-submission-attributes","__idx":3},"children":["Hold submission attributes"]},{"$$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":["platform"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["futures"]}," for holds"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["futures"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["futureType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["hold"]}," for holds"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hold"]}]},{"$$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":["O"]},{"$$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."]},{"$$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":["O"]},{"$$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 is pre-populated, 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. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Valid values: \"new-payment-card\", \"phone\", payment-card or \"payment-link\""]},{"$$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":["O"]},{"$$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":"Instalment attributes","id":"instalment-attributes","depth":1},{"value":"Creating a transaction","id":"creating-a-transaction","depth":2},{"value":"Attributes table:","id":"attributes-table","depth":2},{"value":"Hold submission attributes","id":"hold-submission-attributes","depth":2}],"frontmatter":{"title":"Instalments and Holds attributes","seo":{"title":"Instalment attributes"}},"lastModified":"2025-11-03T02:02:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/instalments-and-holds/attributes","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}