Submitting transactions
To process THOP transactions, set:
- The platform attribute to virtual-terminal
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 THOP claim. We do not currently offer an API for partners to self-register providers.
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 virtual terminal (THOP) transaction. Example: 100.00
Payment Method
The following three THOP payment methods are supported:
- new-payment-card : Once-off manual entry new-payment-card.
- 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.
Patient mobile
The mobile phone number of the patient. This can be either international notation: +61411111111 or national notation: 0411111111