InstantBooking

Instant policy purchase

The instant booking endpoint enables the purchase of a policy by creating a quote and confirming the booking instantly with a single API request.

This endpoint can be used when the partner wants to purchase a policy without the need for a Quote.

Endpoint: /insurances/instantBooking

Method: POST

Request

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{
  "FromDate": "2024-04-18 00:00:00",
  "ToDate": "2024-04-21 00:00:00",
  "CustomerAge": 29,
  "Email": "[email protected]",
  "FirstName": "Test",
  "LastName": "Test",
  "Country": "NZ",
  "DestinationCountry": "NZ",
  "PolicyCode": "FP NZ ROW inc.Baggage - Asservo Mutual",
  "LanguageCode": "en",
  "Currency": "AUD",
  "Region": "san fran",
  "City": "brisbane",
  "Address1": "abc street",
  "PhoneNumber": "0400-000-000",
  "PostalCode": "55555",
  "PartnerCollectingPayment": true
}' \
https://api-staging.rentalcover.com/insurances/instantBooking

Response

Request Parameters

FromDate date [yyyy-mm-dd hh:mm:ss] required	Date/time of vehicle pickup.
ToDate date [yyyy-mm-dd hh:mm:ss] required	Date/time of vehicle drop-off.
CustomerAge integer required	Customer age.
Email string required	Customer email.
FirstName string required	Customer first name.
LastName string required	Customer last name.
Country string [varchar(2)] required	ISO 3166 two character country code for customer country of residence or IP.
DestinationCountry string [varchar(2)] required	ISO 3166 two character country code for country of travel.
PolicyCode string required	Policy code of available policy in RentalCover Platform.
LanguageCode string [varchar(2)] required	Two character language code. See supported languages.
Currency string [varchar(3)] required	If passed all the responses will be in the specified currency. Also, all subsequent actions to that booking will be in the specified currency (i.e. update, and cancel). See supported currencies.
AgentReference string	partner can provide their INS for a booking. A unique booking reference ending with -INS that is created for each policy booked. If nothing is provided, booking reference will be generated
PartnerReference string	Important for good customer experience. Your booking reference will appear in our systems to help with customer service inquiries wherever insurance reference number is not known
Address1 string	Customer street address line 1 (50 character limit).
City string	Customer suburb/city.
PostalCode string|integer	Customer post code or zip code.
Phone string	Customer phone.
Region string	The customer's state, region or territory, this is a 2 or 3-letter code. See supported regions.
PolicyPrice float	Price of partner policy (if partner sets price).
VehicleRentalGross float	The retail price of the vehicle.
PhoneNumber string	Customer phone number
VehicleTypes string [100]	Comma-separated list of vehicle types. Codes here: car,motorhome,campervan,4x4, minibus,lighttruck,bus
PartnerCollectingPayment boolean	Indicates whether the partner is collecting the payment. Only true OR NULL is accepted
MetaData json	Additional user-defined data, provided as a valid JSON object. This field allows clients to send supplementary information relevant to their specific use case. The structure and content of this object are entirely determined by the client. e.g. { "securitytoken": "39456fdhUIHIUH", "esim": { "esim_eligible": true } }

Response Attributes

Response properties with the text Formatted appended are formatted with the relevant currency code and symbol.

Attributes	Description
BookingId integer	Internal ID of the booking (primary key)
Reference string	This is the sole identifier for all claims and support requests. A unique booking reference ending with -INS that is created for each policy booked. Customers will receive this reference in confirmation emails. Also used in update and cancel requests.
Status string	See booking statuses.
FromDate datetime	Start date/time of booking.
ToDate datetime	End date/time of booking.
ConfirmedOn datetime	Datetime of when the booking was confirmed
PartnerReference string	PartnerReference passed in the InstantBooking request.
TotalAmount float	Total amount the customer is to pay for the policy (already includes discounts & markups).
TotalAmountFormatted string	Total amount customer must pay for the policy (already includes discounts & markups). Includes currency formatting. e.g US$39.82
InsuranceCoverAmount float	Amount of cover the policy includes.
InsuranceCoverAmountFormatted string	Amount of cover the policy includes.
Disclaimer string	Policy disclaimer.
VehicleTypes.freecancellationcover boolean	Whether the policy covers free cancellation cover
VehicleTypes.freetravelinsurance boolean	Whether the policy covers free travel insurance
VehicleTypes.car boolean	Whether the policy covers car
VehicleTypes.motorhome boolean	Whether the policy covers motorhome
VehicleTypes.campervan boolean	Whether the policy covers campervan
VehicleTypes.4X4 boolean	Whether the policy covers 4X4
VehicleTypes.minibus boolean	Whether the policy covers minibus
VehicleTypes.lighttruck boolean	Whether the policy covers lighttruck
VehicleTypes.bus boolean	Whether the policy covers bus
VehicleTypes.caravan boolean	Whether the policy covers caravan
Logos.DarkFontPng.Type string	Type of logo
Logos.DarkFontPng.Url string	Link to the logo
Logos.DarkFontSvg.Type string	Type of logo
Logos.DarkFontSvg.Url string	Link to the logo
Logos.LightFontPng.Type string	Type of logo
Logos.LightFontPng.Url string	Link to the logo
Logos.LightFontSvg.Type string	Type of logo
Logos.LightFontSvg.Url string	Link to the logo
Policy.Code string	Policy code.
Policy.Name string	Name of the policy.
Policy.Type string	Type of the Policy.
Policy.PdsUrl string	URL to the policy PDS PDF.
Customer.CustomerId Integer	Id of the customer.
Customer.FirstName string	First name of customer.
Customer.LastName string	Last name of customer.
Customer.Email string	Email address of customer.
Customer.BackupEmail string	Backup email address of customer.
DateOfBirth string	Customer 'sDate of birth.
Customer.Age integer	Age of customer.
Customer.Phone string	Customer's phone number.
Customer.Address1 string	Customer's street address line 1.
Customer.Address2 string	Customer's street address line 2.
Customer.City string	Customer's city.
Customer.Region string	Customer's region.
Customer.PostalCode string	Customer's PostalCode.
Customer.Country string	Customer's country name.