Links

Cancellation Workflow

Cancel a specific policy booking
Cancelling a policy booking is used where a user no longer requires coverage, and has contacted the partner directly to cancel this policy.
For example: Cancellation of a Product insurance policy where the product is on-sold or no longer needed. Where a refund is due, the partner (depending on method of payment collection, and policy cooling off period) may need to provide a refund to the user. This calculated pro-rata refund for the user (where applicable) is returned in the Cancellation response.
Cancellation Workflow

Booking Retrieval

The first step is to obtain information regarding the customers purchased insurance, this step can be skipped if you have stored all relevant information about a customers insurance booking such as INS number, Quote IDs, price paid, etc.
get
https://api.xcover.com/x/
partners/:partner_id/bookings/:quote_package_id
Retrieve a Booking

Booking Cancellation

Once a booking has been retrieved, check the can_be_cancelled flag is set to true in the response before issuing a cancellation request.
To ensure you refund the correct amount to the customer, it is recommended to first preview a cancellation and then confirm the cancellation once you have successfully issued the refund.
post
https://api.xcover.com/x/
partners/:partner_id/bookings/:quote_package_id/cancel
Cancel Booking
Request Payload
{
"quotes": [
{
"id": "62fd1f8b-f8fa-420a-82a0-6990976fb8cc",
"reason_for_cancellation": "No longer travelling"
}
]
}

Preview a Cancellation

An optional preview flag can be set to true in the booking cancellation request payload, the response will confirm a refund amount and timeframe required before cancellation can be completed.
It is important to note key details in the response, including thecancellation_id,total_refund amount and theconfirm_beforedatetime
post
https://api.xcover.com/x/
partners/:partner_id/bookings/:quote_package_id/cancel
Preview Cancellation
Request Payload
{
"preview": true,
"quotes": [
{
"id": "62fd1f8b-f8fa-420a-82a0-6990976fb8cc",
"reason_for_cancellation": "No longer travelling"
}
]
}

Confirm Cancellation

To confirm a cancellation that has been previewed a request to the following endpoint needs to be made.
post
https://api.xcover.com/x/
partners/:partner_id/bookings/:quote_package_id/confirm_cancellation
Confirm Cancellation