Payment

The Payment feature allows the user to make credit card payments including initiating a payment plan. Credit card payments can also be voided and non-credit card (cash/check) payments can be recorded in athenaNet. In addition, credit card payments not made via athenahealth's Credit Card Plus (CCP) can be recorded as having been made, however, we highly recommend using CCP (and /collectpayment).

Record Payment
The POST /patients/{patientid}/recordpayment call allows partners to record payments made via cash, check, or credit card payment outside of athenahealth's Credit Card Plus (CCP) processing.

Do not use this feature if the check is being scanned at the front desk using athenaNet, if a credit card payment is being made within athenaNet via CCP, or a payment is made via API using POST /patients/{patientid}/collectpayment. This will result in payments being double counted.

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

Accepts patients credit card payment information

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.
success string true for success. false for an error.
Example Code
Enter appointment's payment information
POST
/v1/{practiceid}/patients/{patientid}/collectpayment/singleappointment/{appointmentid}

Stores the card information in order to charge this card in the future

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
appointmentid integer appointmentid
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
Record patient's payment information details
POST
/v1/{practiceid}/patients/{patientid}/recordpayment

Records the data related to a cash, check, or non-CCP credit card patient payment

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
paymentbatchid integer The ID of the payment batch where the payment was posted.
success string true for success. false for an error.
Example Code
Void an individual payment from an epayment ID.
POST
/v1/{practiceid}/patients/{patientid}/voidpayment/{epaymentid}

This only works from the time of the payment to the time it is settled, generally around 8 p.m. Eastern time nightly.

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
epaymentid integer epaymentid
Content-Type string Content type of the payload

Output Parameters

Expand all
success string Returns if the upload of the signed receipt was successful or not.
Example Code
Record payment made at a third party vendor by a patient
POST
/v1/{practiceid}/patientpayvendors/{vendorcode}/payments

No description

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
vendorcode string vendorcode
Content-Type string Content type of the payload

Request Body

Expand all

Output Parameters

Expand all
patientpaymentid integer The athena reference for the payment that was recorded. Caller should pass this same reference later on for refunding
previouslyrecordedyn string If the payment was considered a duplicate, then athena will not record the payment, but will set this field to true and return the previously recorded id in PATIENTPAYMENTID field. A payment will be considered duplicate if a will be considered duplicate if a record payment call hapenned for the same patient id and same total payment amount within a period of 6 hours. To avoid getting duplicate payments, use different reference id in EXTERNALREFID
Example Code
Record refund made at a third party vendor by a patient
POST
/v1/{practiceid}/patientpayvendors/{vendorcode}/payments/{patientpaymentid}/refund

No description

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
vendorcode string vendorcode
patientpaymentid string patientpaymentid
Content-Type string Content type of the payload

Output Parameters

Expand all
patientpaymentid integer The athena reference for the refund that was recorded. Caller should pass this same reference later on for refunding
recordedtime date_time The time the patient refund was recorded
Example Code
List of Charge objects to post vendor Adjustments
POST
/v1/{practiceid}/patientpayvendors/{vendorcode}/adjustingcharges

Status of Charge IDs adjusted for

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
vendorcode string vendorcode
Content-Type string Content type of the payload

Output Parameters

Expand all
charges array
error string 'Error in Patient'
patientid number 'Patient ID'
Example Code