Instalment attributes
Creating a transaction
Use function:
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.
Instalment submission attributes
| Field | Type | Max length | Required? | Notes |
|---|---|---|---|---|
platform |
valid values only | Yes | Set to futures for instalment plans | |
futureType |
valid values only | Yes | Set to instalment-plan for plans | |
providerNumber |
String | 8 | 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. Example: 1234565X | |
invoiceReference |
String | 16 | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. | |
chargeAmount |
String | Yes | The amount to charge for the virtual terminal transaction. Example: 10.00 | |
numberOfInstalments |
valid values only | Yes | If not sets defaults to weekly | |
instalmentFrequency |
valid values only | Yes | If not sets defaults to 2 | |
paymentMethod |
"new-payment-card", "phone", payment-card or "payment-link" | Whether the payment should be processed by the provider as a one-off manual entry new-payment-card,the payment is pre-populated , the payment request should be sent via SMS to the patient or to generate a payment-link for email or inclusion in an invoice | ||
patient.mobile |
String | Yes | The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111 |
Hold submission attributes
| Field | Type | Max length | Required? | Notes |
|---|---|---|---|---|
platform |
string | Yes | Set to futures for holds | |
futureType |
string | Yes | Set to hold for holds | |
providerNumber |
String | 8 | 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. Example: 1234565X | |
invoiceReference |
String | 16 | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. å | |
chargeAmount |
String | Yes | ||
paymentMethod |
"new-payment-card", "phone", payment-card or "payment-link" | Whether the payment should be processed by the provider as a one-off manual entry new-payment-card,the payment is pre-populated , the payment request should be sent via SMS to the patient or to generate a payment-link for email or inclusion in an invoice | ||
patient.mobile |
String | The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111 |