Versions Compared

Version Old Version 2 New Version 3
Changes made by

Peter Nguyen: Insurance-VN

Peter Nguyen: Insurance-VN

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
HTTP/2 200 OK
{
  "data": {
    "type": "quotes",
    "id": "quote-4fbe88f2-1f3e-08dd-46e2-d1f2631efeca",
    "attributes": {
      "premium": {
        "isBeingCalculated": false,
        "hasBeenCalculated": true,
        "isConstrained": false,
        "canBeAccessed": true
      }
    }
  }
}

Specify a payment option

A payment option may need to be specified for the quote, depending on the agency configuration. To specify the payment option, send a request like below.

Code Block
languagejson
### Specify payment option
POST {{base-url-sales}}/api/v1/quotes/updateQuoteRequest
Authorization: {{access-token}}
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "updateQuoteRequests",
    "attributes": {
      "quoteId": "quote-4fbe88f2-1f3e-08dd-46e2-d1f2631efeca",
      "paymentOptionName": "Cash Monthly",
      "paymentOptionValue": "cash_monthly",
      "paymentMethod": "External",
      "paymentFrequency": "Monthly"
    }
  }
}

Sample response

Code Block
languagejson
HTTP/2 200 OK
{
  "data": {
    "type": "quotes",
    "id": "quote-4fbe88f2-1f3e-08dd-46e2-d1f2631efeca",
    "attributes": {
      "reference": "1106467",
      "description": "Sample Customer Name",
      "period": {
        "start": "2024-12-19T00:00:00+00:00",
        "end": "2025-12-18T23:59:59+00:00"
      },
      ...
    }
  }
}

Complete quote

Send a request with a quoteId specified in the request payload. Take note of the version and the policyHolderId in the response payload.

Code Block
languagejson
### Complete quote
POST {{base-url-sales}}/api/v1/quotes/completeQuoteRequest
Authorization: {{access-token}}
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{
  "data": {
    "type": "completeQuoteRequests",
    "attributes": {
      "quoteId": "quote-4fbe88f2-1f3e-08dd-46e2-d1f2631efeca"
    }
  }
}

Sample response

Code Block
languagejson
HTTP/2 200 OK
{
  "data": {
    "type": "quotes",
    "id": "quote-4fbe88f2-1f3e-08dd-46e2-d1f2631efeca",
    "attributes": {
      "reference": "1106467",
      "description": "Sample Customer Name",
      "period": {
        "start": "2024-12-19T00:00:00+00:00",
        "end": "2025-12-18T23:59:59+00:00"
      },
      "version": 28,
      "policyHolderId": "caa40751-80cd-4b18-9f0a-55b9af4be886",
      ...
    }
  }
}