Stored Card

The Store Cards feature allow the user to retrieve, create and remove credit card details (referred to as stored cards) of a patient. It also allows the user to make payments against claims using a stored card of a patient.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Upload new patient's credit-card details
POST
/v1/{practiceid}/patients/{patientid}/collectpayment/storedcard

Add a new credit card details of a patient in the system

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Request Body

Expand all

Output Parameters

Expand all
epaymentid integer After a successful payment, this ID can be used to retrieve the receipt.
errortext string The error text returned by the credit card processor.
storedcardid integer
success string true for success. false for an error.
Example Code
Get list of patient's credit-card information
GET
/v1/{practiceid}/patients/{patientid}/collectpayment/storedcard

Retrieve the list of patients stored credit card information in the system

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
departmentid integer The ID of the department where the payment or contract is being collected. This parameter is currently not formally required. However, it will be in a future patch so it is highly recommended that this parameter is used.

Output Parameters

Expand all
billingaddress string The billing address associated with the card.
billingcity string The billing city associated with the card. This may be absent for some cards.
billingstate string The billing state associated with the card (two letter abbreviation). This may be absent for some cards.
billingzip string The billing zip associated with the card (two letter abbreviation).
cardexpirationmmyyyy string The expiration month and year of the card (MM/YYYY).
cardnumberlast4digits string The last four digits of the card number.
cardtype string The type of the card. Example - VISA, Mastercard, etc..
nameoncard string The name on the card.
preferredcard string A flag to denote the preferred card of a patient. This is true for at most one of the cards returned.
status string The status of the card.
storedcardid number The ID of the stored credit card.
Example Code
Create new patient's specific credit-card
POST
/v1/{practiceid}/patients/{patientid}/collectpayment/storedcard/{storedcardid}

Add a new credit card information to the patient file

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
storedcardid integer storedcardid
patientid integer patientid
Content-Type string Content type of the payload

Request Body

Expand all

Output Parameters

Expand all
epaymentid integer After a successful payment, this ID can be used to retrieve the receipt.
errortext string The error text returned by the credit card processor.
success string true for success. false for an error.
Example Code
Update patient's specific credit-card information
PUT
/v1/{practiceid}/patients/{patientid}/collectpayment/storedcard/{storedcardid}

Modifies existing credit card information for a patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
storedcardid integer storedcardid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
epaymentid integer After a successful payment, this ID can be used to retrieve the receipt.
errortext string The error text returned by the credit card processor.
success string true for success. false for an error.
Example Code
Delete patient's specific credit-card information
DELETE
/v1/{practiceid}/patients/{patientid}/collectpayment/storedcard/{storedcardid}

Delete the record of a specific credit card of the patient

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
storedcardid integer storedcardid
patientid integer patientid
departmentid integer The ID of the department where the payment or contract is being collected.

Output Parameters

Expand all
epaymentid integer After a successful payment, this ID can be used to retrieve the receipt.
errortext string The error text returned by the credit card processor.
success string true for success. false for an error.
Example Code