Payment Complete

When a payment has completed successfully the user will have access to the policy.

Payment Complete

API

Policy

The details of a policy can be retrieved by performing a GET request to the policy url.

Request

curl -X 'GET' \
  'https://st.igate-test.co.uk/api/v1/policies/24072253-ae9e-483a-9e2e-4f22ddb2b221/' \
  -H 'Authorization: Bearer abc123xyz...' \
  -H 'accept: application/json'

Response

Type: 200 OK

{
  "uuid": "24072253-ae9e-483a-9e2e-4f22ddb2b221",
  "url": "https://st.igate-test.co.uk/api/v1/policies/24072253-ae9e-483a-9e2e-4f22ddb2b221/",
  "created_at": "2025-01-29T19:43:03.477787Z",
  "updated_at": "2025-01-29T19:43:03.477939Z",
  "vehicle": {
    "url": "https://st.igate-test.co.uk/api/v1/user/vehicles/edfe9daa-346c-4894-8417-87b081b2e97a/",
    "uuid": "edfe9daa-346c-4894-8417-87b081b2e97a",
    "created_at": "2025-01-24T11:27:34.419898Z",
    "updated_at": "2025-01-24T11:27:34.419946Z",
    "vehicle_type": 1,
    "reg_no": "kr10ygd",
    "abi_code": 16545701,
    "year_of_manufacture": 2010,
    "cc": 1242,
    "number_of_doors": 3,
    "number_of_seats": 4,
    "make": "Fiat",
    "model": "500",
    "gearbox_type_id": "002",
    "gearbox_type_name": "Manual",
    "body_type_id": "02",
    "body_type_name": "Hatchback",
    "fuel_type_id": "002",
    "fuel_type_name": "Petrol"
  },
  "payment": {
    "uuid": "ba7df418-d8c4-457d-8fbd-8e96517dce5a",
    "url": "https://st.igate-test.co.uk/api/v1/payments/ba7df418-d8c4-457d-8fbd-8e96517dce5a/",
    "amount": "50.00",
    "card_holder": "J SMITH",
    "card_number": "************5262",
    "expiry_date": "0128",
    "card_type": "J SMITH",
    "billing_use_policy_address": false,
    "billing_address": {
      "url": "https://st.igate-test.co.uk/api/v1/user/address/718bdd0c-1e35-4214-a03e-a21197eae06f/",
      "uuid": "718bdd0c-1e35-4214-a03e-a21197eae06f",
      "created_at": "2025-01-29T19:42:36.681468Z",
      "updated_at": "2025-01-29T19:42:36.681514Z",
      "house": "23",
      "street": "North Lake str.",
      "city": null,
      "county": "Norfolk",
      "postcode": "PE301KM"
    },
    "policy_address": {
      "url": "https://st.igate-test.co.uk/api/v1/user/address/cf18edab-4d2f-4dbd-951e-b18a6fdd9d67/",
      "uuid": "cf18edab-4d2f-4dbd-951e-b18a6fdd9d67",
      "created_at": "2025-01-29T19:42:36.683633Z",
      "updated_at": "2025-01-29T19:42:36.683657Z",
      "house": null,
      "street": null,
      "city": null,
      "county": null,
      "postcode": null
    }
  },
  "policy_documents": [
    {
      "uuid": "1370eff8-703c-4490-868e-01c6931ac8ce",
      "scheme_code": "trin",
      "title": "Insurance Product",
      "subtitle": "Information document",
      "document": "https://st.igate-test.co.uk/documents/1370eff8-703c-4490-868e-01c6931ac8ce/product.pdf",
      "cta_text": "View IPID"
    },
    {
      "uuid": "938b9b40-e42c-4c00-8a97-b072370177d6",
      "scheme_code": "trin",
      "title": "Policy Booklet",
      "subtitle": "Trinity Lane",
      "document": "https://st.igate-test.co.uk/documents/938b9b40-e42c-4c00-8a97-b072370177d6/booklet.pdf",
      "cta_text": "View booklet"
    }
  ],
  "policy_number": "199/3949167/Z442/WEB",
  "insurer_name": "Trinity Lane",
  "scheme_code": "trin",
  "scheme_name": "Trin",
  "policy_start_date": "2025-01-01T19:16:39.967925Z",
  "policy_end_date": "2025-01-09T23:59:59.999999Z",
  "policy_progress": 100
}

Notes

• When there is a matching scheme_code for documents they will appear in the policy_documents list. However, this can be an empty list:

"policy_documents": []

These are the details of the documents to display in the ‘Your Documents’ list.