Set finance offer selected by patient

post

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

Once you have retrieved and presented the finance offers available to a patient, the next step is to let HFD know which offer the patient felt was best for them. When you set the offer, you must ensure that the patient is comfortable with all of the requirements (ex: the minimum down payment required, the length of the payment plan, etc.) and that the payment plan details you pass to HFD adhere to said requirements.

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.

offerId

uuid

required

The universally unique identifier associated with the offer.

Body Params

financeAmount

number

The amount that the patient needs financing for. This amount can be calculated by the cost of the treatment minus the down payment being collected (along with any discounts being provided in the office). This finance amount must adhere to the minimum and maximum requirements of the finance offer that the patient selects.

downPaymentAmount

number

The amount that the patient has agreed to pay up front. This down payment amount must adhere to the requirements of the finance offer that the patient selects.

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. 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). The expected format is yyyy-mm-dd.

termMonths

integer

The length of the finance plan associated with the offer, in months.

interestRate

number

The interest rate associated with the offer. This interest rate will be returned in its percentage form (NOT its decimal form). For example, a 15.99% interest rate will be returned as 15.99. HFD recommends presenting the interest rate, not the annual percentage rate, to the patient, as this is what drives their monthly payment.

Responses

200Finance Offers

400Bad request

401Unauthorized

403Forbidden

500Server error