This step will activate the card for the Patient to be available for use.
Response will return a list of order details as well as confirming the card status.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId":"{{cpIdPersonalized}}",
"proxyKey": "9376873800385",
"cardStatus": "ACTIVATE"
}
This step will pull back the Patient profile details currently registered to the card.
Response will return the cardholder profile details currently set for the given card account.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId": "55555",
"clientID": "555555",
"personId": "5555555555"
}
This step will update the cardholder profile details impacting communications methods and address verification elements.
Checking the cardholder details after the update could be done for confirmation
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId": {{cpIdPersonalized}},
"personID": "1881009399",
"firstName": "string",
"lastName": "string",…
This step will retrieve the card balance confirming available funds for use.
Pending or on-hold transactions will not show as a part of the available balance.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "5555555555555",
"cpId": ”555555"
This step will retrieve the card status confirming access and availability of the card to the cardholder.
N/A
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"clientId": {{clientId}},
"proxyKey": " 7531459784940"
}
This step will pull a list of current unregistered proxies for a given customer for orders during a set period
Checking the cardholder details after the update could be done for confirmation
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"customerId": {{customerId}},
"cpId": {{cpIdIIC}},
"startCreationDate": null,
"endCreationDate": null,…
This step will provide the available carrier and delivery speed methods available.
sessionId – Acquired during the authentication process
Response will return a list of current carrier and delivery speed identifiers to be used Step 2
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
This step will execute the creation of the bulk inventory for physical cards to be delivered to a specified location.
Response will return the orderId as the unique identifier for the order for reporting purposes
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"custProgId": "{{cpIdIIC}}",
"customerId": "{{customerId}}",
"qty": 1,
"shippingMethod": "USPS First Class",…
This step will provide a list of orders, status or orders, and tracking information (if applicable) based on defined criteria.
Response will return a list of orders based on the criteria provide in the payload
Order status and tracking information can be accessed here to follow inventory delivery
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"customerId": 98709,
"startDate": "2025-01-23",
"endDate": "2025-02-08",
"orderStatus": [Ordered, Shipped, Failed],…
This step will assign a card in the onsite inventory to a specific Patient.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"custProgId": "{{cpIdIIC}}",
"customerId": "{{customerId}}",
"orderDetails": [
{
"proxyKey": "string",
"email": "[email protected]",
"phone": "string",
"firstName": "string",
"lastName": "string",…
This step will be used if an Patient already has a registered card that is lost or damaged, and will issue them a new physical card from the inventory while keeping all of the underlying account data / balances the same.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
{
"cpId": "{{cpIdIIC}}",
"proxyKey": "string",
"newProxyKey": "string"
}
xxxxx
This step will execute the creation of the card account and issue the card to the Patient when onboarded into the trial.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"custProgId": 987654,
"customerId": 12345,
"orderProdType": "Personalized Payroll Order",
"cardType": "Digital",
"orderDetails": [
{
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string", …
This step will execute load of funds to the card account for the Patient based on client level eligibility and approval requirements.
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"customerId": 98709,
"custProgId": 115718,
"fundingId": 54850,
"orderDetails": [
{
"amount": "0.50",
"proxyKey": "0252516355546",…
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906"
{
"cpId": 987654,
"proxyKey": 9376873800385,
"resendMethod": "[email] or [sms]",
"alertType": "Initial"
}…
This step will recall the complete order information
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "1234567890123",
"customerProgramId": ”987654"
This step will recall the shipping information for the physical card delivery and provide tracking if available
Required Parameters
"sessionId": "uywbzibgbfgaienonrgyxahwuwegrtpssvvljdpypfkotqdjqsbydd10906",
"proxyKey": "1234567890123",
"customerProgramId": ”987654"