Employee Cardholder Integration

Personalized –Digital First + Physical

Step 1: Set Card Status – Activate

Description:

This step will activate the card for the Employee 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: Set Card PIN

Description:

This step will set the 4-digit PIN for card transactions.

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 – /changePinByProxy

Considerations:

Response will return a list of order and card details
This endpoint can be used for setting the initial Pin for the card or for updating an existing Pin

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId":"{{cpIdPersonalized}}",
"proxyKey": "9376873800385",
"newPin": "2255",
"oldPin": "1234" /* NOT NEEDED*/
}

Step 3: Get Cardholder Info

Description:

This step will pull back the Employee 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 4: 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 5: Get Card Balance

Description:

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

Pre-requisites:

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

Endpoint Details:

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

Considerations:

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

Code Snippet:

Required Parameters

"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "1234567890123",
"custProgId": ”987654"

Step 6: 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"
}