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

Endpoints

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
accountnumber string The account number of the credit card. (Required if trackdata is not supplied.)
allowduplicatepayments boolean Allows duplicate payments.
appointmentid integer The ID of the appointment where the copay should be applied.
billingaddress string The billing address for the credit card. (Max length: 20)
billingzip string The billing zipcode for the credit card.
cardsecuritycode integer The CVV2: the 3 (or 4 for Amex) digit value normally found on the back (or front for Amex) of the credit card. When creating contracts, this is required if using accountnumber instead of track data.
claimpayment array A JSON representation of claim ID and payment combinations. For example, '[ { "1":"1.00"}, { "2":"5.00"} ].' This indicates a payment of $1 for claim ID #1 and a payment of $5 for claim ID #2.
departmentid integer The ID of the department where the payment or contract is being collected.
ecommercemode boolean Use ECommerce credit card mode (e.g. for telemedicine). trackdata may NOT be used if this mode is true.
expirationmonthmm integer The month the credit card expires (MM). (Required if trackdata is not supplied.)
expirationyearyyyy integer The year the credit card expires (YYYY). (Required if trackdata is not supplied.)
nameoncard string The name on the credit card. (Required if trackdata is not supplied; track 2 does NOT supply name.) Please truncate at 30 characters. (Max length: 30)
todayservice boolean Apply the other amount value to today's service.
trackdata string The track data obtained from the credit card swipe. This can be track1 and/or track2 data. In either case, please including the start and end sentinels. ("%" and "?" for track1 and ";" and "?" for track2.)

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
accountnumber string The account number of the credit card. (Required if trackdata is not supplied.)
allowduplicatepayments boolean Allows duplicate payments.
amount string DEPRECATED: Please use "otheramount".
appointmentid integer The ID of the appointment where the copay should be applied.
billingaddress string The billing address for the credit card. (Required if track data is not supplied.) If more than 20 characters, please truncate. (Max length: 20)
billingzip string The billing zipcode for the credit card. (Required if track data is not supplied.)
cardsecuritycode integer The CVV2: the 3 (or 4 for Amex) digit value normally found on the back (or front for Amex) of the credit card. This is required for ecommerce mode payments.
claimpayment array A JSON representation of claim ID and payment combinations. For example, '[ { "1":"1.00"}, { "2":"5.00"} ].' This indicates a payment of $1 for claim ID #1 and a payment of $5 for claim ID #2.
copayamount string The amount associated with a particular appointment for a copay.
departmentid integer The ID of the department where the payment or contract is being collected.
ecommercemode boolean Use ECommerce credit card mode (e.g. for telemedicine). trackdata may NOT be used if this mode is true.
expirationmonthmm integer The month the credit card expires (MM). (Required if trackdata is not supplied.)
expirationyearyyyy integer The year the credit card expires (YYYY). (Required if trackdata is not supplied.)
nameoncard string The name on the credit card. (Required if trackdata is not supplied; track 2 does NOT supply name.) Please truncate at 30 characters. (Max length: 30)
otheramount string The amount being collected that is not associated with individual appointment. This money goes into the "unapplied" bucket. In the future, these payments will be able to be broken down by individual claim level. Co-pay amounts should be in "copayamount".
todayservice boolean Apply the other amount value to today's service.
trackdata string The track data obtained from the credit card swipe. This can be track1 and/or track2 data. In either case, please including the start and end sentinels. ("%" and "?" for track1 and ";" and "?" for track2.)

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

❙ Request Body

Expand all
departmentid integer The ID of the department where the payment or contract is being collected.
preferredcard boolean Flag to make a STOREDCARD contract the default one for the patient

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