Patient Pay Vendors

Summary 

The patient pay vendor endpoints (or “PPV” for brevity’s sake), are a suite of APIs that enable a third-party vendor to manage billing workflows and actions in athenaNet, including but not limited to: 

  1. Management of dunning levels. 
  2. Movement of claims to collections. 
  3. Issuing refunds.  
  4. Disabling athena-generated patient statements and active payment plans. 
  5. Adjusting charges. 

These APIs differ from our traditional “record payment” and “collect payment” functionalities. See “Testing” section for more details.  

Complete List  

  1. POST /patientpayvendors/{vendorcode}/patientenrollment   
  2. POST /patientpayvendors/{vendorcode}/payments
  3. POST /patientpayvendors/{vendorcode}/payments/{patientpaymentid}/refund
  4. POST /patientpayvendors/{vendorcode}/statements
  5. POST /patientpayvendors/{vendorcode}/changeageingownership
  6. POST /patientpayvendors/{vendorcode}/claimcollections
  7. POST /patientpayvendors/{vendorcode}/adjustingcharges

Workflows 

Enrollment
A vendor calls this API when a given patient (or set of patients) is ready to be managed by the vendor. This means the vendor is responsible for starting to send patient statements and accepting payments from the patient at that point forward.  

Enrolling a patient with a vendor:  
a. Disables active payment plans managed by athena. 
b. athena stops sending paper statements for the patient. 
c. athena-owned card-on-file agreements, however, do stay active. 

Payments
Vendors use this endpoint to record a patient payment in athenaNet. This is the only payment endpoint we have that supports refunds, and vendors must record payments using this API if they would like to issue refunds. 

Refunds
Note that only full refunds are supported currently (no charge-level refunds). 

Change Aging Ownership
Aging ownership could be either owned by athenahealth or the vendor. Default ownership of a claim for an enrolled patient lies with athenahealth.  

A vendor calls this API to register the “aging” ownership of a claim and move that claim from a non-finance plan to a finance plan (and vice versa). For example, when a patient sets up a payment plan on a vendor portal, this endpoint allows the vendor to update the dunning level to ensure appropriate dunning messages in athenahealth statements. 

Switching ownership of a patient between athenahealth and the vendor resets the dunning level. For example, if the dunning level of a charge is ‘2’, it will reset to ‘1’ once ownership of the claim is transferred to the vendor. 

Statements
Vendors use this endpoint to update statement details in athenaNet once statements have been sent out to the patient. This will also age the claims in athenaNet. 

Claim Collections
Takes array of claim ids to be moved into collections status.  

Adjusting Charges
Takes an array of charge ids and associated amounts to be adjusted for a specific patient. 

Testing in Sandbox

Please Note: Testing is currently supported only in the Preview sandbox with practice ID 195900 for the following vendor code and payment methods only: 

For testing payments and refunds, you will need to supply one of the accepted payment method values.  

Partial-Pay Vendor

You may use this vendor code to test the enrollment API in addition to payments and refunds.

Field Name 

Type 

ParamType 

Test Value 

Required 

VENDORCODE 

string 

PathParam 

PPV 

 

Field Name 

Type 

ParamType 

Test Value 

Required 

PAYMENTMETHOD 

string 

Body 

PPVAMEX   

PPVMC/VISA   

PPVDSCVR   

PPVCASH   

PPVCHECK   

 

Full-Pay Vendor

Field Name 

Type 

ParamType 

Test Value 

Required 

VENDORCODE 

string 

PathParam 

FPV 

 

Field Name 

Type 

ParamType 

Test Value 

Required 

PAYMENTMETHOD 

string 

Body 

FPVAMEX   

FPVMC/VISA   

FPVDSCVR   

FPVCASH   

FPVCHECK   

To have testing enabled for a partner or client sandbox, please refer to API – Support to submit a request.  
 

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