Quote
The Quote endpoint enables the RentalCover server to generate a policy quote based on the parameters provided.
Normally this endpoint is called during the checkout process when the user has chosen a vehicle and is offered an excess reduction policy. However, it can be called at any point in the search / book process as long as the required parameters are available.
This API call will generate a URL to the generated RentalCover quote. This URL can be integrated into the booking confirmation page and confirmation emails so that users can click the link and be redirected to their corresponding quote page on RentalCover.
Endpoint: /insurances/quote
/insurances/quote
Method: POST
POST
Request Parameters
| API Key, provided by RentalCover.com. |
| Date/time of vehicle pickup. |
| Date/time of vehicle drop-off. |
| ISO 3166 two character country code for country of travel. |
| Customer age. |
| Customer email. |
| Customer first name (if unknown use |
| Customer last name (if unknown use |
| ISO 3166 two character country code for customer country of residence or IP. |
| [ExcessReduction, CDW, Comprehensive, RoadsideAssistance, FullProtection] Requested policy type By Default we provide, ExcessReduction and Comprehensive policies To Request RoadsideAssistance policies (customers travelling to US), request with “Type”:“RoadsideAssistance” To Request CDW policies (US Residents travelling elsewhere), request with “Type”:“CDW”. |
| Full geographical location of vehicle pick-up. Format should be a unique free-text identifier, preferably comma-separated in order of increasing specificity. Airports should end with a colon followed by IATA code. Non-airport example: "Paris,Paris Montparnasse Railway Station", airport example: "Paris,Paris Le Bourget Airport:LBG". |
| Full geographical location of vehicle drop-off. Format should be a unique free-text identifier, preferably comma-separated in order of increasing specificity. Airports should end with a colon followed by IATA code. |
| Customer street address line 1 (50 character limit). |
| Customer street address line 2 (50 character limit). |
| Customer suburb. |
| Customer post code or zip code. |
| Customer phone. |
| Customer other email. |
| The customer's state, region or territory, this is a 2 or 3-letter code. See supported regions. |
| Age of second driver. |
| Age of third driver. |
| The amount of cover required. |
| Price of partner policy (if partner sets price). If < RC policy then partner price will be used. |
| If >1 standard excess available for vehicle, this is the higher amount. If only 1 standard excess, use this field. |
| If >1 standard excess available for the vehicle this is the lower amount. If only 1 standard liability available, use |
| Currency of vehicle’s standard liability. |
| Vehicle supplier ID. |
| Vehicle supplier ID of second supplier. |
| Vehicle supplier name. |
| Vehicle supplier country code. |
| Vehicle name. |
| Vehicle category (if SIPP not used). |
| Vehicle SIPP code. |
| Vehicle berths. |
| Vehicle off road. |
| Vehicle class. |
| The wholesale price of the vehicle paid by the OTA. |
| The retail price of the vehicle. |
| Whether to allow RC email contact with customer. Would be |
| Two character language code. See supported languages. |
| If LDW is included we remove theft from the Comparison Table in Content endpoint. |
| |
| |
| The end user’s IP address. |
| The local vehicle pickup time with UTC offset (Atom format).e.g. 2018-12-04T22:00:00-05:00. Used to determine cancellation grace period. Allows customers to cancel up to time of pickup +15 minutes. If null then cancellation is midnight +15mins. |
| Unstructured data. Pass whatever you use as your own city identifiers. |
| Two Letter Country Code. |
| The vehicle drop off time in UTC with offset (Atom format) e.g. 2018-12-04T22:00:00-05:00. |
| |
| |
| This indicates the state, region or territory code the customer is picking their vehicle up from, e.g. |
| If passed all the responses in the quote response will be in the specified currency. Also all subsequent actions to that quote will be in the specified currency (i.e. purchase, update, and cancel). See supported currencies. |
| Used if partner has multiple sites to determine partner’s referring domain. Use this format: yoursite.com string would be |
| Used to request for roadside assistance cover option. |
| Used to send BW Cookie ID to RentalCover. |
| Comma separated list of vehicle types. Codes here:
|
| Indicates whether the partner is collecting the payment. |
Response Attributes
Response properties with the text Formatted
appended are formatted with the relevant currency code and symbol.
| Internal ID of the booking (primary key) |
| This is the sole identifier for all claims and support requests. Unique booking reference ending with |
| See booking statuses. |
| Start date/time of booking. |
| End date/time of booking. |
| Total amount customer is to pay for the policy (already includes discounts & markups). |
| Amount of cover the policy includes. |
| Supplier’s (i.e. the insurer’s) policy number. Usually issued upon payment. This is not used for any claims or customer support (we use |
| Flag whether the policy has expired. |
| URL of RentalCover logo. |
| Number of days the customer is covered for. |
| Amount of discount that has been applied to the |
| Full name of destination country of travel. |
| ISO 3166 two character destination country code. |
| Full name of destination country of travel. |
| Destination country phone prefix. |
| This indicates the state, region or territory code the customer is picking their vehicle up from. |
| Three character currency of the booking. |
| Total amount customer must pay for the policy (already includes discounts & markups). Includes currency formatting. |
| Amount of cover the policy includes. |
| Amount of discount that has been applied to the |
|
|
| Total commission for the partner (already includes discounts and markups). |
| Formatted version of the TotalCommission. |
| Three character settlement currency of the booking. |
| Total amount customer must pay for the policy, in the settlement currency rate (already includes discounts and markups). |
| Formatted version of the Settlement Amount. |
| Total commission for the partner, in the settlement currency rate. |
| Formatted version of the SettlementCommission. |
| Policy disclaimer. |
| Amount of gap cover that the policy includes. |
| Name of the policy. |
| Type of the Policy. |
| Policy code. |
| Amount of excess. |
| Policy inclusions. |
| Policy description. |
| Policy selling points / benefits. |
| Any special messages related to the policy will be passed through this field. |
| Amount of gap cover that the policy includes. |
| Amount of excess. |
| URL to the policy PDS PDF. |
| Name of the policy supplier. |
| URL that allows the policy to be modified (if not using API endpoint). |
| URL that allows the policy to be cancelled (if not using API endpoint). |
| First name of customer. |
| Last name of customer. |
| Email address of customer. |
| Age of customer. |
| Customer country code. |
| 0:n coupons, not returned if no coupons available. |
| Coupon code. |
| Coupon title. |
| Value of coupon. |
| Fixed or percentage. |
| Amount remaining on coupon [null]. |
| Date that coupon is effective from. |
| Date that coupon is effective to. |
| Coupon terms and conditions. |
| Quote URL of the policy. Can be used if customer opts out. Renders the payment page on RentalCover.com, customer can then complete payment for the policy. |
Last updated