experience-calculator-api
home
API Type
- Experience API
Overview:
Pepper Mule to expose Calculator API for digital consumption across Pepper and external partner websites. This lightweight API allows Pepper to provide the appropriate calculations.
Lender's Protection Fee Calculator:
Lender protection Fee is a one-off, non-refundable fee used to offset the risk associated with loans of a higher Loan to Value Ratio (LVR).
- LPF amount get calculated on basis of ProductType, docType, isConstruction, isInvestment and Final LVR.
- Lender's Protection Fee is charged on Prime loans - Full Doc Owner Occupier loans >85% LVR, Full Doc Investment loans >80% LVR and Alt Doc >70% LVR.
Note : "productName": "Prime", in all cases.
Max LVR limit is 95%.
Postcode Risk Rating:
Enter the postcode of the security property to determine the maximum loan amount we will lend.
- To Get detailed risk and limits matrix for a postcode and loan details.
Postcode Lookup:
This API endpoint allows users to retrieve the suburbs associated with a specific postcode in Australia (AU) and New Zealand (NZ). It returns a list of suburbs that correspond to the provided postcode, facilitating location-based searches and services.
Supported Protocols
- HTTPS
Accepts
- application/json
Responds With
- application/json
Authentication
- Basic Authenticaion
Endpoint Quick Reference
LPF Calculator:
/v1/CalculateLPFWithPayment
- POST
Postcode Risk Rating:
/v1/PostcodeRiskRating
- POST
Postcode Lookup:
/v1/postcodeLookup
- GET
Status Response Codes
- 200: OK
- 400: Bad Request - Check whether your request body or request headers if matched to the specification
- 401: Unauthorized - Check whether your credentials are correct
- 404: Resource Not Found - Check if you have correct resource URI
- 405: Method Not Allowed - Check if you have valid methods for the resource
- 408: Request Timeout - The API could be still processing your request, try to adjust connection timeout
- 500: Unexpected Server Error - If this issue persists, contact support for troubleshooting
- 503: Service Unavailable - Server is handling too many request at this moment. try again later or reach out to support if issue persists
- 504: Gateway Timeout - There might be a problem with the load-balancer, reach out to support if issue persists