Partners can submit Tyro EFTPOS card requests via the Transaction SDK and obtain transaction status changes via both callbacks and webhooks.
Creating a transaction
Use function:
To process a Tyro EFTPOS purchase request 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 | String Valid values only | M | The SDK supports two modes - one for payment transactions and another for claims. Set to: - virtual-terminal for card payments | virtual-terminal |
paymentMethod | String Valid values only | O | Valid values only. For EFTPOS payments only, specify a method: - Set to terminal for Tyro EFTPOS - Set to new-payment-card for provider entry - Set to mobile for SMS payment requests | terminal |
chargeAmount | String Currency notation Up to 6 numeric and 2 decimal digits | M | For EFTPOS payments only, specify a total tender amount. Gross (including GST) amount in $XX.XX format. | $15.15 |
providerNumber | String Up to 16 alphanumeric characters | O | Servicing provider number or other registration identifier which must be valid and active in Tyro Health Online and HealthPoint for a given funder. For PHI quotes and claims, a Medicare issued provider number should be used where available. Where a Medicare provider number is not applicable, use the appropriate identifier - a Medibank, Fund specific or HealthPoint issued provider number. The provider number can also be used to set the default terminal identifier (TID) and merchant identifier (MID) if multiple TIDs and MIDs exist for a business. Optional for EFTPOS payments. Up to 16 alphanumeric characters | 0034503W |
invoiceReference | String | O | Provider nominated unique transaction reference number, such as an invoice number from the practice management or accounting system. Used for reconciliation purposes. | INV-20220315-001 |
| patient {} object | ||||
patient.firstName | String Up to 40 characters | O | Patient first name as on their health fund card | John |
patient.lastName | String Up to 40 characters | O | Patient last name as on their health fund card | Curtain |
patient.dob | String YYYY-MM-DD | O | Patient Date of Birth in 'YYYY-MM-DD' format. | 1967-11-02 |
patient.mobile | String | O | Optional mobile phone number of the member. This can be used for patient searches in the Tyro Health Online portal. International or national notation supported. | +61411111111 or 0411111111 |
patient.refId | String Up to 128 alphanumeric characters | O | An optional but recommended patient unique reference as set by you, such as a UUID. This value is used to uniquely identify a patient in Tyro Health Online. Omitting refId will cause duplicate patient records to be created and could make patient searches more difficult for providers who also use the Tyro Health Online portal to check on status of a claim and remittance. If supplied and valid, this value will pre-populate patient details from the patient record in the business as set in any prior claim. Any patient details sent for an existing patient record will update those values. | 5AD5E2AF-69D2-43D3-9321-428495205E5E |
When a transaction is processed, the SDK will pass through the transaction details to the first parameter of the onSuccess callback.
The response payload contains a number of attributes with a complete description of the transaction model in our online API documentation.
Key response attributes include:
| Field | Type/Format | Description | Example |
|---|---|---|---|
id | String 64-128 bit ID | a unique transaction level identifier | 12BA46C3-BA6B-4192-9368-BD78AFAAB489 |
status | String | Overall transaction status | Approved |
payments[].status | String | Status of the payment (if run in conjunction with a claim) | Approved |
payments[].amount | String Currency notation | Amount paid | $40.00 |
payments[].gatewayDescription | String | For declined transaction, additional descriptions from the payment network | 2001 - Insufficient funds |