Get available finance offers for patient

post

https://sandbox.hfdapi.com/v1/applications/{applicationId}/offers

Retrieves the finance offers that are available to be presented to the patient. Since these finance offers are dependent upon the patient’s credit grade (and other credit worthiness attributes), you cannot retrieve the available offers until the patient has been underwritten.

The offers that are returned back in the response represent the different offers from HFD that you can present to your patients in your UI platform. This allows you to present a better experience to your patients, as they can choose which payment plan works best for them. Giving the patients more control over their payment plan can also help maximize the likelihood that they will make their payments on time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

applicationId

uuid

required

The universally unique identifier associated with the patient’s application.

Body Params

serviceCost

number

The total cost of the treatment.

section

string

The sub-category for the treatment that is being administered which dictates what offers to present to the patient. For example, a dental office may offer “Aligners” and “General Dentistry”. Each of the treatment sub-categories may have different offer(s) associated with them. These sub-categories will be pre-determined by your team and HFD. If your organization wants to use sections for offers, you must pass this in the request. Please speak with your account representative for more information regarding sections and if they must be provided in your requests.

financeDate

date

The day that the financing for the patient should begin. Typically, this will be the date that the treatment was administered. The expected format is yyyy-mm-dd.

firstPaymentDueDate

date

The day that the patient has chosen to make their first payment. HFD does not allow a first payment date in the past, or more than 30 days after the finance date. The expected format is yyyy-mm-dd. If you do not pass us the first payment due date, it will be defaulted to X days after the finance date (according to your organization’s configurations).

downPaymentAmount

number

The amount that the patient has agreed to pay up front. If this down payment amount does not adhere to the requirements of the finance offer that the patient selects, the down payment will need to be adjusted to meet the requirement. For example, if you pass $200 into this request, but a patient selects an offer with a $250 minimum down payment, the down payment must be increased to at least $250.

Responses

200Finance Offers

400Bad request

401Unauthorized

403Forbidden

500Server error