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

Endpoints

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
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
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
accountnumber string The account number of the credit card. (Required if trackdata is not supplied.)
allowduplicatepayments boolean Allows duplicate payments.
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.
email string The email address of the patient. This is the email that the notification that the charge is about to happen and the receipt afterwards will be emailed to.
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.)
maxamount integer The maximum amount that will be charged when remittance information is received.
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.
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
appointmentid integer The ID of the appointment where the copay should be applied.
cardnumberlast4 string The last 4 digits of the credit card number. This is required if the payment method is a credit card.
checknumber string The check number. This is required if the payment is made by check.
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.
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".
paymentmethod string Valid values include CASH or CHECK or anything as a result of /configuration/validnonccpcreditcardmethods. Note that practices using Credit Card Plus (CCP) should typically NOT be using this call and should instead use the collectpayment endpoints to charge the card. In addition, all payments recorded via this method are subject to the same policies as any other money collected by athenahealth.
postdate string The date the payment was made. Defaulted to today.
todayservice string Apply the other amount value to today's service.

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
appointmentid integer The ID of the appointment where the copay should be applied.
bankdepositdate string The date when payment gets deposited to US Bank.
cardnumberlast4 string The last 4 digits of the credit card number. This is required if the payment method is a credit card.
checknumber string The check number. This is required if the payment is made by check.
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.
externalrefid string The Vendor side reference for this payment. This is expected to be unique for a vendor as it is the one used for checking if a particular payment is duplicate of another. Also, in case of any issues, this field will help us with debugging. Maxlength = 32
movetounappliedifoverpay boolean In case of overpay in a particular claim, automatically move the balance amount for that particular claim to unapplied
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.
patientid integer The ID of the patient for whom the payment is being made
paymentmethod string The payment method obtained from the api /patientpayvendors/{VENDORCODE}/validvendorpaymentmethods
postdate string The date the payment was made. Defaulted to today.
todayservice string Apply the other amount value to today's service.
vendorterminalid string The TID is used to make the CC payment with payment gateway. This is required if the payment method is a credit card.

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

❙ Request Body

Expand all
bankdepositdate string The date when the payment gets deposited to US Bank.
departmentid number The ID of the department where the refund is issued.
externalrefid string The Vendor side reference for this refund. This is expected to be unique for a vendor as it is the one used for checking if a particular refund is duplicate of another. Also, in case of any issues, this field will help us with debugging. Maxlength = 32
fullrefund boolean Currently the only supported value is true. Passing this as false would return an error
ispaymentsettled boolean This input will be used to decide whether the refund needs to be voided or refunded. So based on the Vendor credit card processor settlement time, vendor will decide to use ISPAYMENTSETTLED = true if the actual refund happened after the settlement time
patientid number The ID of the patient for whom the payment is made
paymentmethod string The payment method obtained from the api /patientpayvendors/{VENDORCODE}/validvendorpaymentmethods
postdate string The date the payment was made. Defaulted to today.
vendorterminalid string The TID is used to make the CC payment with payment gateway. This is required if the payment method is a credit card.

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

❙ Request Body

Expand all
charges array
patientid number 'Patient ID'

Output Parameters

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