Request

Request

Before a Plan gets created, it first must be approved to ensure it is a valid plan from AssureX.

To achieve this, the client will called the Request method, which will return an array of valid options (ie. how many installments the client chooses to pay back in, with varying interest rates).

Endpoints
POST /api/plan/request

Request Object

fieldtypedescription
emailstringemail of the user that is requesting for a plan
namestringname for the plan
principalnumbertotal amount requested for

Response Object <array>

fieldtypedescription
emailnumberemail of the user that created this plan
namestringname for the plan
datestringISO 8601 date of creation (YYYY-MM-DD)
principalstringtotal amount borrowed at creation
basestringamount to be paid per month
interestnumberinterest to be paid as a percentage (APR)
installmentsnumbernumber of months to repay the amount