Cancel

The Cancel endpoint enables the RentalCover server to cancel a quoted or purchased policy assuming the FromDate has not yet passed.

Endpoint: /insurances/cancel

Method: DELETE or POST

(Using POST allows a CancelReason to be Posted to the endpoint)

DELETE /insurnaces/cancel

curl -i -X DELETE \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
https://api-staging.rentalcover.com/insurances/cancel/AB12-345C-INS

POST /insurances/cancel

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"CancelReason":"I am no longer travelling"}' \
https://api-staging.rentalcover.com/insurances/cancel/AB12-345C-INS
curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"CancelReason":"I am no longer travelling"}' \
https://api-staging.rentalcover.com/insurances/cancel/AB12-345C-INS

Response

{
   "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."
}

Request Parameters

reference string required	The RentalCover.com booking reference (passed in endpoint URL)
CancelReason string [500] required for POST method	Reason for cancelling the policy