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. The key attributes are listed below.
| Field | Format | Description | Example value |
|---|---|---|---|
id | 128 characters | Tyro Health Online unique transaction reference | |
| patient {} | Object | Patient names as validated with DVA - note that updated name details may be returned. | |
patient.firstName | Up to 40 characters | Patient first / given name as registered with DVA. | |
patient.lastName | Up to 40 characters | Patient last / family name as registered with DVA. | |
patient.dobString | string | Date of birth in YYYY-MM-DD format. | |
| practice | Object | ||
practice.id | string | Internal practice ID | |
practice.fullName | string | Name of practice | |
| claims | Object | ||
claims.status | 256 characters | Description of overall claim | |
claims.statusDescription | Description of the status | ||
claims.gatewayCode | Claim item gateway response code | ||
claims.amountExpectedBenefitString | integer | Total claim benefit amount in cents or (string) in currency notation DVA is expected to pay. | |
claimItems.amountActualBenefitString | string | The amount DVA has approved to pay in currency format. E.g. $119.95. | |
claims.amountGap/ claims.amountGapString | Total claim gap (employee payable) amount in cents or (string) in currency notation. | ||
| claims.claimItems | Array | For each claimed item, a separate line level response as below. | |
claims.claimItems.status | 256 characters | Description of the claim/quote item level status | |
claims.claimItems.gatewayCode | String | Claim gateway response code | |
claims.claimItems.amountActualBenefit / claims.claimItems.amountActualBenefitString | Claim item benefit amount in cents or (string) in currency notation. | ||
claims.claimItems.amountGap/ claims.claimItems.amountGapString | Claim item gap (member payable) amount in cents or (string) in currency notation. | ||
externalReferences{} | Key-pair objectServices Australia transaction IDs - for provider support requests to DVA. |
{
_id: string
abn: string
amountBalance: number
amountBalanceString: string
amountCharged: number
amountChargedString: string
amountClaimsActualBenefit: number
amountClaimsActualBenefitString: string
amountClaimsExpectedBenefit: number
amountClaimsExpectedBenefitString: string
amountClaimsGap: number
amountClaimsGapString: string
amountFee: number
amountFeeNet: number
amountFeeNetString: string
amountFeeString: string
amountItemsCharged: number
amountItemsChargedString: string
amountItemsFee: number
amountItemsFeeString: string
amountOutOfPocket: number
amountOutOfPocketString: string
amountOutstanding: number
amountOutstandingString: string
amountRefund: number
amountRefundString: string
amountTax: number
amountTaxString: string
application: Object
businessId: string
businessStatus: string
claims: [
amountActualBenefit: number
amountActualBenefitString: string
amountExpectedBenefit: number
amountExpectedBenefitString: string
amountGap: number
amountGapString: string
beneficiary: string
claimDateString: string
claimId: string
claimItems: Object
claimType: string
createdByAccountId: string
createdByAccountUsername: string
funder: Object
gatewayCode: string
healthFund: Object
healthFundAccount: Object
professionalCategory: Object
providerNumber: string
requested: string
responded: string
specialties: Object
specialty: Object
status: string
statusDescription: string
statusHistory: Array
_id: string
]
created: string
createdByAccountUsername: string
items: Array
modified: string
originatingFlow: string
patient: Object
payments: Array
practice: Object
staff: Object
transactionId: string
transactionType: string
webhooks: Array
}
Transaction object response onError object (root level attributes):
{
"statusCode": number,
"error": string,
"message": string,
"errorCode": number,
"errors": [
{
"message": string,
"attribute": string
}
]
}