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.
Required column values:
| Value | Description |
|---|---|
| M | Mandatory |
| O | Optional |
| C | Conditional |
| Field | Type/Format | Required | Description | Example |
|---|---|---|---|---|
platform | Valid values only | M | Set to futures for instalment plans | futures |
futureType | Valid values only | M | Set to instalment-plan for plans | instalment-plan |
providerNumber | String 8 characters | O | 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. | 1234565X |
invoiceReference | String Up to 16 characters | O | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. | INV-20220315-001 |
chargeAmount | String | M | The amount to charge for the virtual terminal transaction. | 10.00 |
numberOfInstalments | Valid values only | M | If not sets defaults to weekly | 4 |
instalmentFrequency | Valid values only | M | If not sets defaults to 2 | 2 |
paymentMethod | Valid values only | O | 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. Valid values: "new-payment-card", "phone", payment-card or "payment-link" | new-payment-card |
patient.mobile | String | M | The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111 | +61411111111 |
| Field | Type/Format | Required | Description | Example |
|---|---|---|---|---|
platform | String | M | Set to futures for holds | futures |
futureType | String | M | Set to hold for holds | hold |
providerNumber | String 8 characters | O | 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. | 1234565X |
invoiceReference | String Up to 16 characters | O | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. | INV-20220315-001 |
chargeAmount | String | M | The amount to charge for the virtual terminal transaction. | $10.00 |
paymentMethod | Valid values only | O | 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. Valid values: "new-payment-card", "phone", payment-card or "payment-link" | new-payment-card |
patient.mobile | String | O | The mobile phone number of the patient. Can be either international notation: +61411111111 or national notation: 0411111111 | +61411111111 |