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
field | type | description |
---|---|---|
string | email of the user that is requesting for a plan | |
name | string | name for the plan |
principal | number | total amount requested for |
Response Object <array>
field | type | description |
---|---|---|
number | email of the user that created this plan | |
name | string | name for the plan |
date | string | ISO 8601 date of creation (YYYY-MM-DD) |
principal | string | total amount borrowed at creation |
base | string | amount to be paid per month |
interest | number | interest to be paid as a percentage (APR) |
installments | number | number of months to repay the amount |