Response

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.

Key response attributes include:

Field	Format	Description	Example value
`id`	128 characters	Tyro Health Online unique transaction reference	5ce4d63cb0a38c005582b838
patient {}	Object	Patient names as validated with Medicare - note that updated name details may be returned.
`patient.firstName`	Up to 40 characters	Patient first / given name as registered with Medicare.	Willis
`patient.lastName`	Up to 40 characters	Patient last / family name as registered with Medicare.	Mia
`patient.dobString`	string	Date of birth in YYYY-MM-DD format.	1991-13-06
practice	Object
`practice.id`	string	Internal practice ID	61f7297f272329006343997e
`practice.fullName`	string	Name of practice
claims	Object
`claims.status`	256 characters	Description of overall claim	Approved
`claims.statusDescription`		Description of the status	Payment Approved
`claims.gatewayCode`		Claim item gateway response code	00
`claims.amountExpectedBenefitString`	integer	Total claim benefit amount in cents or (string) in currency notation Medicare is expected to pay.	8000 / $80.00
`claimItems.amountActualBenefitString`	string	The amount Medicare has approved to pay in currency format. E.g. $119.95.	$50.00
`claims.amountGap/ claims.amountGapString`		Total claim gap (employee payable) amount in cents or (string) in currency notation.	6000 / $60.00
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	Approved
`claims.claimItems.gatewayCode`	String	Claim gateway response code	00
`claims.claimItems.amountActualBenefit / claims.claimItems.amountActualBenefitString`		Claim item benefit amount in cents or (string) in currency notation.	4000 / $40.00
`claims.claimItems.amountGap/ claims.claimItems.amountGapString`		Claim item gap (member payable) amount in cents or (string) in currency notation.	2500 / $25.00
`externalReferences{}`		Key-pair objectServices Australia transaction IDs - for provider support requests to Medicare/DVA.

Transaction object response on success(root level attributes):

Copy

Copied

{
_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
}

On Error response will either be a string or an object.

Transaction object response onError object (root level attributes):

Copy

Copied

{
  "statusCode": number,
  "error": string,
  "message": string,
  "errorCode": number,
  "errors": [
    {
      "message": string,
      "attribute": string
    }
  ]
}