CT Cardholder Integration

Personalized –Digital First + Physical

Step 1: Set Card Status – Activate

Description:

This step will activate the card for the Patient to be available for use.

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • cpId – Provided during client setup
  • proxyKey – Acquired during the orderCards step.

Endpoint Details:

  • API Endpoint – /fisendpoint/v1
  • Call Type – POST
  • Path – /changeCardStatus

Considerations:

Response will return a list of order details as well as confirming the card status.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId":"{{cpIdPersonalized}}",
"proxyKey": "9376873800385",
"cardStatus": "ACTIVATE"
}

Step 2: Get Cardholder Info

Description:

This step will pull back the Patient profile details currently registered to the card.

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • cpId – Provided during client setup
  • clientId – Provided during the client setup
  • personId – Acquired during the orderCards step

Endpoint Details:

  • API Endpoint – /fisendpoint/v1
  • Call Type – POST
  • Path – /getCardHolderInfo

Considerations:

Response will return the cardholder profile details currently set for the given card account.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId": "55555",
"clientID": "555555",
"personId": "5555555555"
}

Step 3: Update Cardholder Info

Description:

This step will update the cardholder profile details impacting communications methods and address verification elements.

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • cpId – Provided during client setup
  • personID – Acquired during the orderCards step or in the searchAccount step.

Endpoint Details:

  • API Endpoint – /fisendpoint/v1
  • Call Type – POST
  • Path – /updateCardHolderInfo

Considerations:

Checking the cardholder details after the update could be done for confirmation

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId": {{cpIdPersonalized}},
"personID": "1881009399",
"firstName": "string",
"lastName": "string",…

Step 4: Get Card Balance

Description:

This step will retrieve the card balance confirming available funds for use.

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • cpId – Provided during client setup as cpId
  • proxyKey – Acquired during the orderCards step.

Endpoint Details:

  • API Endpoint – /fisendpoint/v1
  • Call Type – GET
  • Path – /getCardBalance

Considerations:

Pending or on-hold transactions will not show as a part of the available balance.

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "5555555555555",
"cpId": ”555555"

Step 5: Get Card Status

Description:

This step will retrieve the card status confirming access and availability of the card to the cardholder.

Pre-requisites:

  • sessionId – Acquired during the authentication process.
  • clientId– Provided during client setup.
  • proxyKey – Acquired during the orderCards step

Endpoint Details:

  • API Endpoint – /fisendpoint/v1
  • Call Type – POST
  • Path – /getCardInfoStatus

Considerations:

N/A

Code Snippet:

Required Parameters


"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"clientId": {{clientId}},
"proxyKey": " 7531459784940"
}

CT Site Admin Integration

Instant Issue – Non-Personalized

Step 1: Get Unregistered Inventory Proxies

Description:

This step will pull a list of current unregistered proxies for a given customer for orders during a set period

Pre-requisites:

  • sessionId – Acquired during the authentication process
  • cpId – Provided during client setup
  • customerId – Provided during the client setup
  • startDate / endDate – Used to isolate orders for a specific time frame.

Endpoint Details:

  • API Endpoint – /customerendpoint/v1
  • Call Type – POST
  • Path – /getUnregisteredInventoryProxies

Considerations:

Checking the cardholder details after the update could be done for confirmation

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"customerId": {{customerId}},
"cpId": {{cpIdIIC}},
"startCreationDate": null,
"endCreationDate": null,…