Payment Card Request:

See the Payment Card API reference for request message fields.

This API lets clients add and update patient payment cards information in the HealthDyne system. A client can also use the GET method of patient payment request to retrieve patient payment card information.

Use POST method to add a payment card to the patient profile and PUT method to update existing patient payment card details.

Get Patient Payment card

Once a patient payment card has been registered successfully, the GET Patient Payment Card API allows clients to retrieve Payment Card details (active details) from HD pharmacy system using PatientKey.

Server

Only HTTPS connections are accepted.

Header

Sample GET Patient Request

GET https://api.uat-healthdyne.com/v2/TestreadPatient171/paymentcard

Sample GET Patient Payment Card Response

{
  "patientKey": "TestreadPatient171",
  "cards": [
    {
      "cardType": 1,
      "cardNumber": "*********************1111",
      "cardHolderFirstName": "Test",
      "cardHolderLastName": "Partient",
      "cardExpireMonth": 3,
      "cardExpireYear": 2027,
      "defaultCard": true,
      "cardSequenceNumber": "415129",
      "cardStatus": "Active"
    }
  ]
}

Click here to see Get Patient Payment Card Response Data Object

The below table lists the potential response codes that can be received in response to a GET request.

Add Patient Payment card

The POST Patient Payment Card API allows clients to add Payment Card details to HD pharmacy system.

Server

Only HTTPS connections are accepted.

Header

Sample POST Patient Payment Card Request

{
    "patientKey": "TestreadPatient171",
    "returnUrl" : "www.callbackurl.com"
}

Click here to see Add Patient Payment Card Request Data Object

Sample POST Patient Payment Card Response

{
    "returnUrl": "https://cardcenter.qa-healthdyne.com/AddCard/c440977f-dba1-4d5f-aa5f-2862cd81"
}

Click here to see Add Patient Payment Card Response Data Object

The below table lists the potential response codes that can be received in response to a GET request.

Update Patient Payment card

Once a patient payment card has been registered successfully, the PUT Patient Payment Card API allows clients to update Payment Card details (active details) in HD pharmacy system.

Server

Only HTTPS connections are accepted.

Header

Sample PUT Patient Payment Card Request

{
  "patientKey": "TestreadPatient171",
  "cardSequenceNumber": "1234567891111",
  "expirationMonth": 3,
  "expirationYear": 2028,
  "cardFirstName": "test",
  "cardMiddleName": "u",
  "cardLastName": "patient"
}

Click here to see Update Patient Payment Card Request Data Object

Sample Put Patient Payment Card Response

{
  "patientKey": "TestreadPatient171",
  "cardSequenceNumber": "1234567891111",
  "message" : "Payment card updated successfully."
}

Click here to see Update Patient Payment Card Response Data Object

The below table lists the potential response codes that can be received in response to a POST request.

Deactivate Patient Payment card

The DELETE Patient Payment Card API allows clients to deactivate a Payment Card in HD pharmacy system.

Server

Only HTTPS connections are accepted.

Header

Sample DELETE Patient Payment Card Request

{
    "patientKey": "TestreadPatient171",
    "cardSequenceNumber": "1234567891111"
}

Click here to see Deactivate Patient Payment Card Request Data Object

Sample DELETE Patient Payment Card Response

{
    "patientKey": "DTCUserM101",
    "cardSequenceNumber": "415051",
    "message": "Deactivated"
}

Click here to see Deactivate Patient Payment Card Response Data Object

The below table lists the potential response codes that can be received in response to a DELETE request.