{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Request attributes - payment at online booking","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":"request-attributes---payment-at-online-booking","__idx":0},"children":["Request attributes - payment at online booking"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"attributes-table","__idx":1},"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":["patient.firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of patient"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Emily"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Test"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.refId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An optional unique patient reference as set by you. This can be used to save patient details for future payments instead of setting firstName lastName and other patient details. ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Additionally the refId can be used within the PMS to pre-populate details entered during the online checkout experience including tokenised card information"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["12DB612A-2CBB-4FFA-B195-1F930F0A2E8B"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fahad.rahman@medipass.io"]}]},{"$$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":["Mobile number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["0491 570 006"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.dobString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date of birth in YYYY-MM-DD format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1990-01-01"]}]},{"$$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":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Medicare registered provider number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2429581T"]}]},{"$$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":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoice unique reference - should align to invoice/transaction number set in the PMS and as shown to the provider."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["MavisTest123"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackOrigin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["C"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL of the booking website. Required if using checkout SDK"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["https://medipass.com.au"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sendReceipt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["O"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set to true, will automatically email a payment receipt."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"textAlign":"center","fontWeight":"bold"}},"children":["For each item - Itemised charges can be displayed to patients. To set, each item as object in nonClaimableItems array"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nonClaimableItems.serviceDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"YYYY-MM-DD"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service date for invoice. If blank, auto populates to current date"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2020-06-16"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nonClaimableItems.reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference for the non claimable item"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["01"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nonClaimableItems.chargeAmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Currency notation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["M"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Price for service"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["$55.00"]}]}]}]}]}]},"headings":[{"value":"Request attributes - payment at online booking","id":"request-attributes---payment-at-online-booking","depth":1},{"value":"Attributes table:","id":"attributes-table","depth":2}],"frontmatter":{"title":"Request attributes - payment at online booking","seo":{"title":"Request attributes - payment at online booking"}},"lastModified":"2025-11-03T02:02:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/checkout/request-attributes-payment-at-online-booking","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}