Mid-office travel agent integration

This section documents use-cases about integrating the policy details in partners’ mid-office systems to streamline agent booking and improve frontline productivity.

Policy details

The following parameters are all available from the policy API summary endpoint

Financial breakdown

The following provides a mapping for key elements for integrating into partner mid-office systems with mapping to API attributes. The following parameters are all available from the policy API summary endpoint

Tax breakdown

The policy details endpoint contains a breakdown of the taxes payable on the policy. The total tax breakdown is calculated on the policy premium after discounts have been applied. An example is given below for Australian taxes. Round the resulted API return results to 2 decimal places to ensure accurate representation of the taxes payable on the transaction amount:

1
    "taxes": [
2
        {
3
            "name": "Stamp Duty",
4
            "amount": 6.11009174
5
        },
6
        {
7
            "name": "GST",
8
            "amount": 6.17180983
9
        }
10
]

Options

The policy details endpoint contains a detailed breakdown of options information that can be used to populate downstream into mid-office systems.

Cancellation option

The cancellation limit option provides the cancellation coverage selected (E.g $20,000) as well as the additional premium incurred:

1
    "policyCancellationLimitOption": {
2
        "id": 5536508,
3
        "coverLimit": 20000.00000000,
4
        "premium": 46.33000000
5
    },

Specified item option

The specified items contains the list of items, including item value been requested and total additional premium:

1
    "policySpecifiedItemOption": {
2
        "specifiedItems": [
3
            {
4
                "name": "Item1",
5
                "currency": {
6
                    "id": 1,
7
                    "symbol": "$",
8
                    "code": "AUD",
9
                    "description": "Australian Dollar",
10
                    "hasMinorUnits": true
11
                },
12
                "itemValue": 1234.00000000,
13
                "displayItemValue": "$ 1,234.00"
14
            },
15
            {
16
                "name": "Item2",
17
                "currency": {
18
                    "id": 1,
19
                    "symbol": "$",
20
                    "code": "AUD",
21
                    "description": "Australian Dollar",
22
                    "hasMinorUnits": true
23
                },
24
                "itemValue": 432.00000000,
25
                "displayItemValue": "$ 432.00"
26
            }
27
        ],
28
        "premium": 74.59000000
29
    },

Specified medical condition option

The specified medical condition provides a breakdown of which travellers have opted in for medical screening cover, additional excess payable if the specified condition occurs during the claimable event as well as the additional premium payable:

1
    "policySpecifiedMedicalConditionsOption": {
2
        "medicalScreenings": [
3
            {
4
                "id": "5536510",
5
                "referenceNumber": "0798659",
6
                "travellerGuid": "ec739c40-74ea-45db-bd39-8bd34fb6efd1",
7
                "screeningDate": "2023-09-17T23:42:00Z",
8
                "outcome": "OptInForCover",
9
                "excess": 100.00000000
10
            }
11
        ],
12
        "premium": 75.22000000
13
    }

Policy Detail flow

The sequence flow for retreiving policy details for a partner and brand is typically the following.

• client needs to have username and password to access list of policies associated with a partner account
• call is made from client to the user API endpointto get an access token using user credentials (username and password). Sample requests and parameter details available at Authorization
• use this as a bearer token to make a call to the policy detail endpoint available at the Policies API
• policy detail endpoint responds with the details for the given policy number. The schema of the response details available at the policy detail endpoint