Payment Plan

The Payment Plan feature allows a patient with a large outstanding balance to pay it off over time. Multiple payment plans can be created for the same patient. This feature allows the user to create and view payment plan details. 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). The Payment Reference allows the user to view the configured list of payment methods for the practice. For more information, please refer Payment Plans.

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

Endpoints

Create patient's payment plan
POST
/v1/{practiceid}/patients/{patientid}/collectpayment/paymentplan

Creates a payment plan for the patient. If payment is to be made via a credit card than provide the appropriate credit card fields.

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. (Required if track data is not supplied.) If more than 20 characters, please truncate. (Max length: 20)
billingmethod string Valid values are SENDSTATEMENTS or CREDITCARD.
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. When creating contracts, this is required if using accountnumber instead of track data.
claimids array One or more claim IDs.
cycleamount string The amount the patient is to be billed per cycle.
departmentid integer The ID of the department where the payment or contract is being collected.
downpaymentamount string Down payment to be billed.
ecommercemode boolean Use ECommerce credit card mode (e.g. for telemedicine). trackdata may NOT be used if this mode is true.
email string The email address of the patient
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.)
frequency string How often should the patient be billed (ONETIMEON - One-time charge, WEEKLY - Weekly, BIWEEKLY - Every two weeks, TWICEAMONTH - First and fifteenth of month, MONTHLY - Monthly, MONTHLYFIRSTBUSDAY - Monthly, first business day, MONTHLYLASTBUSDAY - Monthly, last business day).
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)
paymentplanname string The name of the payment plan.
percentage string The percentage of the current outstanding balance that the patient should be billed each period.
startdate string The date the plan should start. Defaulted to tomorrow. If you set something to start today, it will NOT get billed today; it will be billed on the same day one month from today. Future payments of credit card plans will be billed on the same day of the month as the start date. For example, if the start date is 01/15, then the credit card will be billed for the second time on 02/15.
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.
paymentplanid string The ID of the payment plan.
success string true for success. false for an error.
Example Code
View patient's payment-plan
GET
/v1/{practiceid}/patients/{patientid}/collectpayment/paymentplan

Retrieves payment plans for 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
patientid integer patientid
departmentid integer The department ID.
paymentplanids array One or more payment plan IDs.

Output Parameters

Expand all
amountdue integer Remaining amount due for the patient.
billingmethod string Billing method of the payment plan.
cycleamount integer The amount the patient is billed per cycle.
downpayment integer Down payment billed to the patient.
frequency string How often should the patient be billed (ONETIMEON - One-time charge, WEEKLY - Weekly, BIWEEKLY - Every two weeks, TWICEAMONTH - First and fifteenth of month, MONTHLY - Monthly, MONTHLYFIRSTBUSDAY - Monthly, first business day, MONTHLYLASTBUSDAY - Monthly, last business day).
name string Name of payment plan.
numfuturepayments integer Number of future payments the patient has to make.
outstanding integer Total outstanding amount.
paymentplanid integer Unique id of the payment plan.
paymentplantype string Type of payment plan.
plannotes string Comments for payment plan.
Example Code
Get list of non-credit-card payment methods
GET
/v1/{practiceid}/configuration/validnonccpcreditcardmethods

Retrieves a list of valid credit card methods for practices not using CCP for use with /patients/{patientid}/recordpayment

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
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
name string The name of this payment method (used in athenahealth's UI).
paymentmethod string The payment method identifier for use in /patients/{patientid}/recordpayment
Example Code