Creating holds

To create a new hold , set:

The platform attribute to futures
futureType attribute to hold

Provider and location details

Provider and practice location details can be set with a single providerNumber attribute. Importantly, this provider number must be defined and active in Tyro Health and for the given business API Key. Provider numbers which are not registered in Tyro Health or for the given business API key will error. Only one provider can claim per invoice.

For the SDK, if a provider number is not sent in the transaction payload, the the user will be prompted to manually select:

The practice location
Individual provider

If only one of each category has been defined, that will be automatically selected.

Registration of provider numbers

Providers must first register with Tyro Health prior to submitting a hold. We do not currently offer an API for partners to self-register providers.

Registration for THOP is required to enable instalments and holds. This registration process is self-service and can be completed within a few minutes. If providers deliver services from multiple locations or businesses, each unique provider number must be registered. Details on provider registration and THOP is provided at: (https://help.medipass.com.au/en/articles/3821128-setting-up-medipass-card-payments)

Charge amount

The amount to charge for the hold. Example: $500.00

Payment Method

The following payment methods are supported:

new-payment-card : Manual entry of a new payment card.
Payment card : If a patient is passed this will pre-populate the saved payment card of the passed patient. If there is no saved payment card, the inputs for adding a new payment card are shown.
SMS : The payment request sent via SMS to the patient.
Payment link : The generation of a payment-link for email or inclusion in an invoice.

paymentMethod: "new-payment-card"| "phone" | "payment-link" | "payment-card"

Patient mobile

The mobile phone number of the patient. This can be either international notation: +61411111111 or national notation: 0411111111

patient.mobile: string