Booking Statuses & Errors

Booking Statuses

Status	Meaning
Received	Quote created; payment has not yet been taken.
PendingConfirm	Payment has been taken; final confirmation from the insurer is pending.
Confirmed	Protection is active and confirmed by the insurer.
Cancelled	Protection has been cancelled.

Errors

The RentalCover API uses standard HTTP status codes. When a request fails, the response body contains a JSON object describing the error.

HTTP status codes

Code	Meaning	What to do
200	Success	The request completed successfully.
400	Bad request	A required parameter is missing, invalid, or the request conflicts with the current booking state. Read the error message in the response body.
401	Unauthorised	Your API key is missing or invalid. Check the X_API_KEY header.
404	Not found	The endpoint or resource does not exist. Check the URL and booking reference.
500	Internal server error	An unexpected error occurred on the RentalCover server. Contact your CSE if this persists.

Error response body

// Single-field validation error
{
  "errors": {
    "email": ["Email cannot be blank."]
  }
}

// General request error
{
  "errors": ["Policy cannot be purchased or modified after the date of travel"]
}

Common error scenarios

General errors typically return HTTP 400.

Quote errors

Scenario	Example error
Required field missing	"Email cannot be blank." / "FromDate: must be in the future"
Invalid country code	"Country is too long (maximum is 2 characters)."
Invalid language code	"Language Code is too long (maximum is 5 characters)."
SIPP code not covered by underwriters	"No policies available for SIPP code."
Region without trading licence	"No policies are available for the requested state, province or territory."

Purchase errors

Scenario	Example error
Booking details differ from quote	"Policy not found"
Purchase attempted after travel date	"Policy cannot be purchased or modified after the date of travel"
Booking not found	"Booking details not found"
Payment failure	"Payment validation failed, please make sure your credit card details are correct or try another card"
Invalid or expired coupon	"Invalid or expired coupon, please try again or remove coupon"

Cancel errors

Scenario	Example error
Invalid booking reference	"Booking not found"
Already cancelled	"Booking AB12-345C-INS can not be cancelled, already been cancelled on 2024-01-23"
Claim in progress	"Booking 98PD-SEQN-INS can not be cancelled, claim in progress"
Charge dispute raised	"Booking F8TU-62C6-INS can not be cancelled as it has been disputed"

For further troubleshooting, please contact your CSE.