PHI SDK integration changes

In early 2023, we transitioned our Private Health Insurance claiming system from HICAPS to HealthPoint. As part of the move, we made some changes to data models that would have exposed breaking changes for our integration partners. To provide flexibility, we temporarily masked these changes, allowing partners to schedule the necessary updates according to their development timelines. Partners were requested to complete these changes, test them, and deploy to production by June 30th, 2023.

What’s changed

  1. New value for funder - we’re removing the ‘hicaps’ funder and replacing it with ‘phi’.
  2. We’ve removed the funderData object and restructured the payload to fit with a simplified model.

Steps to upgrade

  1. Complete the following code changes. There’s a sample Before and After payload below to clarify the changes.
    a) change funder , from hicaps to phi
    b) if using funderData.hicaps.transactionMethod , set it at paymentMethod instead
    c) if using funderData.hicaps.patient.healthFundCode , set it at patient.healthFundCode instead
    d) remove funderData
  2. Reach out to the partnerships team when you’re ready to test the changes. We’ll validate the transactions in our test environment and confirm you’ve switched to the new model.
  3. Once testing is completed and you’re ready for production. We’d appreciate your letting us know once you’ve completed your release.

Example payloads

Before:

Copy
Copied
{
  funder: "hicaps",
  platform: "funder",
  providerNumber: "2470314T",
  patient: {
    firstName: "Paul",
    lastName: "Wong",
    reference: "01",
    dob: "2000-01-01"
  },
  funderData: {
    hicaps: {
      transactionMethod: "phone",
      patient: {
         healthFundCode: "BUP"
      }
    }
  }
  claimableItems: [
    {
      itemCode: "011",
      price: "$201"
    }
  ]
}

After:

Copy
Copied
{
  funder: "phi",
  platform: "funder",
  providerNumber: "2470314T",
  paymentMethod: "phone",
  patient: {
    firstName: "Paul",
    lastName: "Wong",
    reference: "01",
    dob: "2000-01-01",
    healthFundCode: "BUP"
  },
  claimableItems: [
    {
      itemCode: "011",
      price: "$201"
    }
  ]
}
2025 Copyright © Tyro Health and Tyro Payments 2025. All right reserved.