Cancel

What it does: Cancels a quote or purchased protection.

When to call it: Before the booking's FromDate. Cancellation is blocked if a claim is in progress or the customer has raised a card dispute.

Use DELETE to cancel without a reason. Use POST to include a CancelReason (recommended - useful for reporting and customer service).

DELETE /insurances/cancel/<reference>
POST   /insurances/cancel/<reference>

Example request

DELETE (no reason)

curl -i -X DELETE \
  -H "X_API_KEY: your_api_key" \
  https://api-staging.rentalcover.com/insurances/cancel/AB12-345C-INS

POST (with reason)

curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"CancelReason": "Customer trip has been cancelled"}' \
  https://api-staging.rentalcover.com/insurances/cancel/AB12-345C-INS

Request parameters

Parameter	Required?	Description
reference (URL)	Required	The RentalCover booking reference.
CancelReason	Required for POST	Reason for cancellation. Max 500 characters.

Response

Field	Type	Description
BookingId	string	Internal booking ID.
Reference	string	Booking reference.
Status	string	Cancelled on success.
CancelMessage	string	Human-readable cancellation confirmation, including any refund amount.

{
   "BookingId":"12345",
   "Reference":"AB12-345C-INS",
   "Status":"Cancelled",
   "CancelMessage":"Booking: AB12-345C-INS has been cancelled. A refund for AU$99.00 has been processed."
}