{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Response","description":"Tyro Health Docs","keywords":"redocly developer portal, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"response","__idx":0},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a transaction is processed, the SDK will pass through the transaction details to the first parameter of the onSuccess callback."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response payload contains a number of attributes with a complete description of the transaction model in our online API documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-response-attributes-include","__idx":1},"children":["Key response attributes include:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"claim-response-attributes","__idx":2},"children":["Claim response attributes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a transaction is processed, the SDK will pass through the transaction details to the first parameter of the onSuccess callback."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response payload contains a number of attributes with a complete description of the transaction model in our online API documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key response attributes include"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Format"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example value"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["128 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["5ce4d63cb0a38c005582b838"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tyro Health Online  unique transaction reference"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["patient {}"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Object"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patient names as validated with icare"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Up to 40 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["Willis"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patient first / given name as registered with icare."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Up to 40 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["Curtin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patient last / family name as registered with icare."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patient.dobString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["1991-13-06 "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date of birth in YYYY-MM-DD format."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["practice"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Object"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["practice.id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["61f7297f272329006343997e"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal practice ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["practice.fullName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of practice"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["claims"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Object"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["256 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["Approved"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of overall claim/quote"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.statusDescription"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["Payment Approved "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.gatewayCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["00"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim item gateway response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.amountExpectedBenefitString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["8000 / $80.00"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total claim benefit amount in cents or (string) in currency notation icare is expected to pay."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claimItems.amountActualBenefitString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["$50.00 "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The amount icare has approved to pay in currency format. E.g. $119.95."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.amountGap/claims.amountGapString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":[" 6000 / $60.00"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total claim gap (employee payable) amount in cents or (string) in currency notation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["claims.claimItems"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Array"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["For each claimed item, a separate line level response as below."]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.claimItems.status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["256 characters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["Approved"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the claim/quote item level status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.claimItems.gatewayCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["00"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim gateway response code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.claimItems.amountActualBenefit / claims.claimItems.amountActualBenefitString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["4000 / $40.00 "]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim item benefit amount in cents or (string) in currency notation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims.claimItems.amountGap/ claims.claimItems.amountGapString"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"highlight","attributes":{"backgroundcolour":"grey","textcolour":"dark"},"children":["2500 / $25.00"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Claim item gap (member payable) amount in cents or (string) in currency notation."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transaction-object-response-on-successroot-level-attributes","__idx":3},"children":["Transaction object response on success(root level attributes):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"{\n_id: string\nabn: string\namountBalance: number\namountBalanceString: string\namountCharged: number\namountChargedString: string\namountClaimsActualBenefit: number\namountClaimsActualBenefitString: string\namountClaimsExpectedBenefit: number\namountClaimsExpectedBenefitString: string\namountClaimsGap: number\namountClaimsGapString: string\namountFee: number\namountFeeNet: number\namountFeeNetString: string\namountFeeString: string\namountItemsCharged: number\namountItemsChargedString: string\namountItemsFee: number\namountItemsFeeString: string\namountOutOfPocket: number\namountOutOfPocketString: string\namountOutstanding: number\namountOutstandingString: string\namountRefund: number\namountRefundString: string\namountTax: number\namountTaxString: string\napplication: Object\nbusinessId: string\nbusinessStatus: string\nclaims: [\n   amountActualBenefit: number\n   amountActualBenefitString: string\n   amountExpectedBenefit: number\n   amountExpectedBenefitString: string\n   amountGap: number\n   amountGapString: string\n   beneficiary: string\n   claimDateString: string\n   claimId: string\n   claimItems: Object\n   claimType: string\n   createdByAccountId: string\n   createdByAccountUsername: string\n   funder: Object\n   gatewayCode: string\n   healthFund: Object\n   healthFundAccount: Object\n   professionalCategory: Object\n   providerNumber: string\n   requested: string\n   responded: string\n   specialties: Object\n   specialty: Object\n   status: string\n   statusDescription: string\n   statusHistory: Array\n   _id: string\n]\ncreated: string\ncreatedByAccountUsername: string\nitems: Array\nmodified: string\noriginatingFlow: string\npatient: Object\npayments: Array\npractice: Object\nstaff: Object\ntransactionId: string\ntransactionType: string\nwebhooks: Array\n}\n\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"on-error-response-will-either-be-a-string-or-an-object","__idx":4},"children":["On Error response will either be a string or an object."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transaction object response onError object (root level attributes):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"{\n  \"statusCode\": number,\n  \"error\": string,\n  \"message\": string,\n  \"errorCode\": number,\n  \"errors\": [\n    {\n      \"message\": string,\n      \"attribute\": string\n    }\n  ]\n}\n","lang":"js"},"children":[]}]},"headings":[{"value":"Response","id":"response","depth":1},{"value":"Key response attributes include:","id":"key-response-attributes-include","depth":2},{"value":"Claim response attributes","id":"claim-response-attributes","depth":2},{"value":"Transaction object response on success(root level attributes):","id":"transaction-object-response-on-successroot-level-attributes","depth":2},{"value":"On Error response will either be a string or an object.","id":"on-error-response-will-either-be-a-string-or-an-object","depth":2}],"frontmatter":{"seo":{"title":"Response"}},"lastModified":"2025-04-10T04:24:24.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/icare/response","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}