Get a PPI premium quote before an application exists

​

Price PPI (Payment Protection Insurance) from a loan amount, term and repayment frequency, before an application is created. Returns the insurer's live Autosure quote: 'retailAmount' is the premium for the whole term and 'perRepayment' is that premium spread over each repayment. When PPI cannot be offered (e.g. a term over 60 months) the call still returns 200 with 'available'=false and a plain-language 'unavailableReason'. This call writes nothing, so it is safe to call repeatedly.

Query Parameters

  • amount
    Type: number
    required

    Loan amount

  • termLength
    Type: string
    required

    Loan term

  • repaymentFrequency
    Type: string
    required

    Repayment frequency: Weekly, Fortnightly or Monthly

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/applications/ppi-quote
curl 'https://api.pioneerhub.co.nz/api/v1/applications/ppi-quote?amount=25000&termLength=xv48_Months&repaymentFrequency=Weekly' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "status": "OK",
  "message": "Request processed successfully",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "retailAmount": 3304.1,
    "quoteRef": 20207487,
    "cover": "EMPLOYEE",
    "errors": [
      "string"
    ],
    "unavailableReason": "string",
    "available": true,
    "perRepayment": 15.89,
    "repaymentFrequency": "Weekly"
  }
}

PPI quote successfully generated

Previous
Get a personal-loan account quote
Next
Check if user has an in-progress application