Receipt
If you are a patient looking to make a payment, please click here to Make a Payment or contact your provider.
The Receipts feature allows the user to create, view, and email e-payment receipts.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Get list of payment-receipts
GET
/v1/{practiceid}/patients/{patientid}/receipts
Retrieves a list of epayment receipts for a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
departmentid
string
The department ID for the receipts you are looking for.
Output Parameters
Expand all
amount
string
The amount of the payment.
cardnumberlast4digits
string
The last 4 digits of the card number.
cardtypeabbreviation
string
The short version of the type of card.
cardtypename
string
The long version of the type of card.
contractid
string
If this e-payment was associated with a payment contract, this is the ID of that contract.
epaymentcontractbalance
string
If this e-payment was associated with a payment contract, this is the balance for the contract.
epaymentcontractmaxamount
string
If this e-payment was associated with a payment contract, this is the max amount allowed for the contract.
epaymentid
string
An ID that can be used to get a receipt.
requestdate
string
The timestamp (Eastern) when the payment was initiated.
type
string
Type of transaction associated with the payment.
Example Code
Get payment-receipts for an e-payment
GET
/v1/{practiceid}/patients/{patientid}/receipts/{epaymentid}
Retrieves a copy of a patient receipt for a specific epayment
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
epaymentid
integer
epaymentid
customerversion
boolean
If true, returns the customer (patient) version of the receipt.
merchantversion
boolean
If true, returns the merchant version of the receipt.
Output Parameters
Expand all
receipthtml
string
The HTML of the receipt.
Example Code
Get payment-receipts for an e-payment
GET
/v1/{practiceid}/patients/{patientid}/receipts/{epaymentid}/details
Retrieves the details of the patient payment receipt
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
epaymentid
integer
epaymentid
termsasjson
boolean
To include contract terms as JSON object.
Output Parameters
Expand all
accountnumber
string
The credit card number with *'s replacing all but the last 4 digits.
approvalcode
string
The credit card approval code
authorizer
string
Code that identifies the authorizing agency.
cardholdername
string
The name on the card
cardtype
string
Card type: Visa, Mastercard, etc.
isapproved
string
Was this transaction approved (true/false)
merchantaddress
string
The address of the merchant.
merchantaddress2
string
The address of the merchant, second line
merchantcity
string
The city of the merchant.
merchantstate
string
The state of the merchant.
merchantzip
string
The zip of the merchant.
recordnumber
string
Unique number from athenaNet. Recommended to be printed on the receipt.
salestax
string
The amount ($) of sales tax for this transaction.
subtotal
string
The amount ($) without tax for this transaction.
total
string
The total amount ($) for this transaction
tracenumber
string
An identifier used by the processor used to trace this transaction. Strongly recommended to be printed on the receipt (and required in some circumstances)
transactiondate
string
The date, with time zone, to print (e.g. mm/dd/yyyy hh:mm AM/PM PDT
transactionreferencenumber
string
A reference number for this transaction. Require to be printed if returned.
transactiontype
string
The type of transaction (PURCHASE, AUTHORIZATION, CREDIT, VOIDCREDIT, INQUIRY, VOIDPURCHASE, MANUALCONVERSION are all possible.
Example Code
Send email of payment-receipt
POST
/v1/{practiceid}/patients/{patientid}/receipts/{epaymentid}/email
Emails a copy of the credit card receipt to an email recipient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
epaymentid
integer
epaymentid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Indicates if the email attempt was successful. Note that email delivery is never guaranteed due to the nature of email!
Example Code
Get list of signed e-payment receipts
GET
/v1/{practiceid}/patients/{patientid}/receipts/{epaymentid}/signed
Retrieves a PDF of the signed receipt image
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
epaymentid
integer
epaymentid
Example Code
Submit authorizations for payment receipts
POST
/v1/{practiceid}/patients/{patientid}/receipts/{epaymentid}/signed
Upload a signed receipt/contract (via multipart/form-data).
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
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