The <<PaymentLink>> merge tag for email and SMS templates is designed for clinics that request prepayment for appointments in their confirmation and reminder messages.

This feature automatically creates an invoice using the appointment's default item code at the time appointment confirmations and reminders are sent. A payment link for this invoice is created using the Tyro Health Online integration and will be inserted into your message.

To enable this feature, go to Settings > Integrations > Tyro Health Online.

Tyro Health Online requires provider numbers to match with PracSuite for the payments feature to work correctly. To ensure this feature works for all practitioners regardless of provider numbers, we strongly encourage adding your Unique Location ID to PracSuite. This will be used as a fallback if provider numbers can't be matched and will allow your patient to continue with the payment process without error.

Your Unique Identification Number can be found in the Locations tab in Tyro Health Online. After selecting the relevant location for the practitioner without a provider number, select the Claiming tab and find the Unique Identification Number as shown below.

After copying this number, within PracSuite go to Settings > Integrations > Tyro Health Online and scroll down to the Tyro Health Online Payment Overrides grid.

After selecting Add, select the business and add the respective Unique Identification Number.

Click Save to finalise your changes.

This feature is supported when sending SMS and emails with the <<PaymentLink>> tag in the following scenarios:

In a valid scenario, PracSuite will automatically raise an invoice for an appointment using the default item code preferences relevant to the appointment type. Note that payment links expire 30 days after they're created.

Choose the text that you wish to display in front of the payment link in valid scenarios:

If payment links are not being generated with your SMS or Email, despite the <<PaymentLink>> tag appearing on your template, please confirm the following:

If a payment link cannot be created due to an invalid scenario (above), the following option determines whether the ​<<PaymentLink>> tag should return blank or alternate text.
​

We recommend setting this to Return Blank for invalid scenarios. This way, if an invalid scenario does occur, nothing regarding the payment will be inserted into the message and confuse the patient.

If you prefer to display more direct text in the event of an invalid payment scenario, then you can select Use Alternate Text.

Fee Category restrictions can be enabled to ensure that payment links aren't generated inappropriately. This will prevent payment links from being generated for e.g. third-party billing scenarios. If PracSuite attempts to generate a message with a payment link for any Fee Categories other than those listed, the invalid payment text will be inserted into the message.

After completing the above configuration, you're now ready to modify the SMS and/or email templates that need to include the <<PaymentLink>> merge tag.

In place of the <<PaymentLink>> tag will be the 'valid text' you entered earlier, followed by the payment link. In the event of an invalid scenario, the payment link tag will be left blank, or your chosen invalid text will be inserted. To minimise confusion, our recommendation is to Return Blank in the event of an invalid scenario.

After completing the above configuration, review the templates you have selected for the following, ensuring you select templates containing the <<PaymentLink>> merge tag where appropriate.

To test your template, book an appointment using your testing patient file.

After selecting your preferred appointment type, pay attention to the default item code and fee. An invoice will be raised with this item code, and this will be fee the patient will be asked to pay when they click the payment link.

After reviewing the item and fee, use the phone or email icons to generate a new message from the Appointment Details screen.

Note that payment links will be generated after clicking the send button.

When patients click the payment link, they will be presented with the following screen in their web browser. The patient must enter their card details and approve the payment.