Callbacks

Ideally, Partner APIs should synchronously process our request and return a response immediately. This is the preferred way, which also reduces errors and confusion.

If necessary, our please reach out to us.

How it works

Here's an example for a Prescription Transfer Request.

1. PHIL sends a Prescription Transfer request to the Partner Transfer API.
2. Partner returns responseType as RECEIVED.
3. After some time, partner calls the Prescription Transfer Callback API with responseType as CONFIRMED.
4. The callback API responds with either RX_CALLBACK_SUCCESS or RX_CALLBACK_ERROR.

Sending a Request

To call our Callback APIs, specify the response data in the request. Here's an example for CONFIRMED:

{
  "requestID": "partner_reference_id",
  "metadata": {
    "referenceID": "partner_reference_id",
    "responseType": "CONFIRMED",
    "responseID": "partner_response_id",
    "responseTimestamp": "2024-09-11T13:55:00Z"
  },
  "prescription": {
    ...
  }
}

Callback Responses

Once we received your Callback, there are two response types availbale:

If the callback processing encountered an error, the callback API will return error details.

{
  "requestID": "",
  "metadata": {
    "referenceID": "partner_reference_id",
    "responseType": "RX_CALLBACK_ERROR",
    "responseID": "partner_response_id",
    "responseTimestamp": "2024-09-11T12:26:00Z"
  },
  "error": {
    "type": "MISSING_INFO",
    "description": "could not map callback - requestID is missing."
  }
}