API Docs

Introduction

Description

This document describes the resources available to promote RentalCover.com insurance products on a partner’s website. The endpoint documentation is supplemented with information regarding Snowplow tags and Non-API functions, which outline customisations required for implementation, particularly on the front end.

The RentalCover.com API adheres to the principles of REST. It has predictable, resource-oriented URLs, and uses HTTP response codes to indicate errors.

We provide the following endpoints:

  • Content: Returns content modules based on a given booking reference.
  • Quote: Returns a policy quote based on the parameters provided.
  • Status: Returns the booking details of a specified booking reference.
  • Update: Modifies a quoted or purchased policy.
  • Purchase: Book a quoted policy based on the parameters provided.
  • CoverOptOut: Specify that a customer has opted in or out of RentalCover.com.
  • Cancel: Cancel a quoted or purchased policy.

Please direct any troubleshooting questions to your customer solutions engineer.

Production API URL: https://api.rentalcover.com

Back To Top

Authentication

Authenticate

Authenticate your account when using the API by including your secret API key in the request. Your API Key is sent in the X_API_KEY header of your request. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as public source control repositories or client-side code.

In production, all API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail.

Back To Top

Testing

Testing

Before taking your integration live, use the following information to test it thoroughly. If you need help after reading this, please get in touch with your customer solutions engineer.

What should I test as I integrate RentalCover.com?

The card number, expiration, CVV, and amount are set correctly in Purchase.

Staging / Test API URL: https://api-staging.rentalcover.com/

Back To Top

Testing Payment

You can use the following credit card details for testing the Purchase endpoint.

Successful Card (Staging only)

Cardholder Name: Any name
Card Number: 4242 4242 4242 4242
Expiration Date: Any future date
CVV: Any CVV

Successful Card (Staging)

Cardholder Name: Any name
Card Number: 4012 8888 8888 1881
Expiration Date: Any expiry
CVV: Any CVV

Other Cards

Please check stripe documentation

Back To Top

Endpoints

Content

The Content endpoint enables the RentalCover.com server to return formatted and unformatted content modules based on a given booking reference.

Request Parameters
AgentReference string required
The booking Reference returned in the Quote endpoint.
LanguageCode string [2] default is en
Preferred language code. See supported languages.
Important Note Re: Logo Use
For compliance all logos must be called dynamically (PoweredByLogo, RCLogo, RCLogo2, InsurerLogo etc). The same applies for all other text.For design purposes logos can be pulled from this box link.

Response Attributes

The PartnerContent property can contain many field names and descriptions that are specific to each partner, please contact your account manager to obtain the list of possible fields. Here`s the full PartnerContent list.

PartnerContent.BookButton1With string  
Go to Book button
PartnerContent.BookButton1Without string
Go to Book button
PartnerContent.BookButton2With string
Book with Extra Cover button
PartnerContent.BookButton2Without string
Book without Extra Cover button
PartnerContent.BookNowDescription string
Book now with Extra Cover from RentalCover.com.
PartnerContent.NoRentalProtection string
No Rental Protection
PartnerContent.NoRentalProtectionDescription string
Book without additional protection for your rental.
PartnerContent.YourRentalProtected string
Your rental protected  Only AU$9.34 per day
PartnerContent.SectionHeader string
Extra Cover for your USA rental – Excellent Value, Best Cover, Peace of Mind
RCLogo2string
RentalCover.com logo
SectionHeader string
Same as one present under PartnerContent.SectionHeader (Note: this will be removed soon. Please use the sectionHeader from PartnerContent)
InsurerLogo string
Insurer logo
Include string
Include text in comparison table
DefaultCheck  boolean  
false: if policy is non-US, non-EU true: anything other than US, EU
Supplier.Disclaimer string
Disclaimer 1
Supplier.Disclaimer2 string
Disclaimer 2
Policy.InsuranceCoverAmountFormatted string
Formatted total cover amount
Policy.InsuranceCoverAmount string
Unformatted total cover amount
Policy.DailyAmountFormatted string  
Formatted daily amount
Policy.DailyAmount string  
Non formatted daily amount
Policy.TotalAmountFormatted string  
Formatted total amount
Policy.TotalAmount string  
Non formatted total amount
Policy.PerDayText string  
Pay per day text
Policy.Name string  
Name of the policy
Policy.Type string  
Type of policy
Policy.CoverAmountText string  
Cover amount text
Policy.BubbleText2 string  
Bubble text to be used in comparison table
Policy.LDWIncluded string  
Possible values: Supplier Specific text OR dont_show
Policy.CDWIncluded string  
Possible values: Supplier specific text OR dont_show
Policy.SLIIncluded string  
Possible values: true, false, dont_show
Policy.WHTIncluded string  
Possible values: true, false, dont_show
Policy.TheftIncluded string  
Possible values: true, false, dont_show
Policy.RoadsideIncluded string  
Possible values: true, false, dont_show
Policy.LossofuseIncluded string  
Possible values: true, false, dont_show
Policy.CreditcardfeesIncluded string  
Possible values: true, false, dont_show
Policy.KeylosslockoutIncluded string  
Possible values: true, false, dont_show
Policy.TowingimpoundIncluded string  
Possible values: true, false, dont_show
Policy.MisfuelingIncluded string  
N/A
Policy.ShortDescription string  
Short description from policy
Policy.MobileShortDescription string  
Mobile version of short description
Policy.Inclusions array  
Different inclusions as an array
Policy.SpecialMessage string  
Any special messages related to the policy will be passed through this field.
Policy.CheckboxImage string  
Checkbox images to be used in comparison table
Policy.UnderwrittenBy string  
Underwritten by text
Policy.UnderwritterLogo string  
Underwriter logo
Policy.PDSWordingText string  
View policy wording text
ComparisonPolicy.SupplierName string  
Comparison policy supplier name
ComparisonPolicy.LDWIncludedHeader string  
LDW included header
ComparisonPolicy.LDWIncludedSubheader string  
LDW included sub header
ComparisonPolicy.LDWIncludedText string  
LDW included text
ComparisonPolicy.CDWIncludedHeader string  
CDW included header
ComparisonPolicy.CDWIncludedSubheader string  
CDW included subheader
ComparisonPolicy.CDWIncludedText string  
CDW included text
ComparisonPolicy.SLIIncludedHeader string  
SLI included header
ComparisonPolicy.SLIIncludedSubheader string  
SLI included subheader
ComparisonPolicy.SLIIncludedText string  
SLI included text
ComparisonPolicy.WHTIncludedHeader string  
WHT included header
ComparisonPolicy.WHTIncludedText string  
WHT included text
ComparisonPolicy.TheftHeader string  
Theft header
ComparisonPolicy.RoadsideHeader string  
Roadside header
ComparisonPolicy.RoadsideIncludedText  string  
Roadside included text
ComparisonPolicy.LossofuseHeader string  
Loss of use header
ComparisonPolicy.LossofuseIncludedText string  
Loss of use included text
ComparisonPolicy.CreditcardfeesHeader string  
Credit card fees header text
ComparisonPolicy.CreditcardfeesIncludedText string  
Credit card fees included text
ComparisonPolicy.KeylosslockoutHeader string  
Key loss lock out header text
ComparisonPolicy.KeylosslockoutIncludedText string  
Key loss lock out included text
ComparisonPolicy.TowingimpoundHeader string  
Towing impound header text
ComparisonPolicy.TowingimpoundIncludedText string  
Towing impound included text
ComparisonPolicy.MisfuelingHeader string  
Misfueling header
ComparisonPolicy.AllIncludedHeader string  
All included header text
ComparisonPolicy.Shortname string  
Short name
ComparisonPolicy.LDWIncluded string  
Possible values: true , false , dont_show
ComparisonPolicy.CDWIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.SLIIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.WHTIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.TheftIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.RoadsideIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.LossofuseIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.CreditcardfeesIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.KeylosslockoutIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.TowingimpoundIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.MisfuelingIncluded string  
Possible values: true, false, dont_show
ComparisonPolicy.SupplierLogo string  
Supplier logo
ComparisonPolicy.Exclusions string  
Exclusions
ComparisonPolicy.ExcessPayablePriceText string  
Excess payable price text
ComparisonPolicy.FromPrice string  
From price
ComparisonPolicy.FromPriceFormatted string  
Formatted from price
ComparisonPolicy.ToPrice string  
To price
ComparisonPolicy.ToPriceFormatted string  
Formatted to price
Endpoint: /insurances/content

Method: POST

Example Request:

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"LanguageCode":"en","AgentReference":"AB12-345C-INS"}' \
https://api-staging.rentalcover.com/insurances/content

Example Response:

{
  "-PartnerContent": {
    "AcceptCover": "Yes, I'd like to purchase TEST - Collision Damage Coverage for US$12.00 per day.<br>",
    "BookButton1With": "Reserve My Rental Car",
    "BookButton1Without": "Reserve My Rental Car",
    "RefuseCover": "No, thanks.",
    "SectionHeader": "Add Collision Damage Waiver (CDW) & Theft Coverage",
    "CancellationHeader": "Important: You have insurance that is valid for any rental",
    "CancellationBody": "Your insurance can be used with any rental from any rental company from 2016-09-19 to 2016-09-19. Click 'cancel' if you are no longer hiring a car",
    "ToQualify": "To qualify, I am a resident of:"
  },
  "PoweredByText": "Powered by",
  "RCLogo2": "https://www.rentalcover.com/RCLogo.png",
  "SectionHeader": "Add Collision Damage Waiver (CDW) & Theft Coverage",
  "ClaimsText": "Claims",
  "InsurerLogo": "https://s3-ap-southeast-2.amazonaws.com/welovetravel-data/suppliers/aonLogo.png",
  "Include": "Include",
  "DefaultCheck": false,
  "-Supplier": {
    "Disclaimer": "I agree to purchase Collision Damage Insurance. I have read, accept and agree to the <a href='http://staging.rentalcover.com/pds/AB12-345C-INS' target='_blank'>Terms & Conditions of Cover</a>.",
    "Disclaimer2": ""
  },
  "-Policy": {
    "InsuranceCoverAmountFormatted": "US$35,000.00",
    "InsuranceCoverAmount": "35000.00",
    "DailyAmountFormatted": "US$12.00",
    "DailyAmount": 12,
    "TotalAmountFormatted": "US$12.00",
    "TotalAmount": "12.00",
    "PerDayText": "per day",
    "Name": "TEST - Collision Damage Coverage",
    "Type": "RoadsideAssistance",
    "Code": "destinationusa75",
    "CoverAmountText": "US$35,000.00 cover for all types of damage",
    "BubbleText2": "95% of users add this <br>",
    "LDWIncluded": "dont_show",
    "CDWIncluded": true,
    "SLIIncluded": "dont_show",
    "WHTIncluded": "dont_show",
    "TheftIncluded": "dont_show",
    "RoadsideIncluded": "dont_show",
    "LossofuseIncluded": "dont_show",
    "CreditcardfeesIncluded": "dont_show",
    "KeylosslockouIncluded": "dont_show",
    "TowingimpoundIncluded": "dont_show",
    "MisfuelingIncluded": "dont_show",
    "ShortDescription": "Here's where we put the product Short Description",
    "MobileShortDescription": "Here's where we put the product Mobile Short Description",
    "Description": "Here's where we put the product Full Description",
    "Inclusions": [
      "Inclusion1",
      "Inclusion2",
      "Inclusion3"
    ],
    "CheckboxImage": "https://s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/checkbox.png",
    "UnderwrittenBy": "Underwritten By",
    "UnderwritterLogo": "https://www.rentalcover.com/RCLogo.png",
    "PDSWordingText": "View Policy Wording",
    "PdsUrl": "http://files.rentalcover.com/pds/axa_PDS_usinbound.pdf"
  },
  "-ComparisonPolicy": {
    "SupplierName": "Hertz",
    "LDWIncludedHeader": "Loss Damage Waiver (LDW)",
    "LDWIncludedSubheader": "This rental comes with LDW so there is no deductible excess for damages, theft etc.",
    "LDWIncludedText": "LDW (Loss Damage Waiver) removes the deductible excess for damages & theft however there are 'out of pocket' costs that renters still face including towing, roadside repairs, key loss & other items below.",
    "CDWIncludedHeader": "Collision Damage Waiver (CDW)",
    "CDWIncludedSubheader": "Nil deductible excess payable for damages",
    "CDWIncludedText": "CDW (Collision Damage Waiver) removes any deductible excess so $0 is payable for damages/repairs. CDW does not cover theft or vandalism.",
    "SLIIncludedHeader": "Supplementary Liability Insurance",
    "SLIIncludedSubheader": "Insures against 3rd party claims",
    "SLIIncludedText": "SLI (Supplementary Liability Insurance) covers third party property (i.e. other cars or property damaged by your car) and injuries to other drivers, their passengers & pedestrians.",
    "WHTIncludedHeader": "Windscreen, headlight & tyre repairs/replacement",
    "WHTIncludedText": "Windscreen and tyre replacement or repair is the largest additional cost faced by renters once they leave the depot.",
    "TheftHeader": "Theft",
    "RoadsideHeader": "Roadside Repairs & Costs",
    "RoadsideIncludedText": "Roadside repairs include common costs such as battery replacement & labour costs for tyre replacement.",
    "LossofuseHeader": "Loss Of Use Fees",
    "LossofuseIncludedText": "“Loss of use” costs are commonly applied while the vehicle is off the road being repaired because the rental company is unable to rent the vehicle.",
    "CreditcardfeesHeader": "Credit Card & Admin Fees",
    "CreditcardfeesIncludedText": "Card fees are typically applied to incidentals such as towing, impound storage, loss of use, key loss etc.",
    "KeylosslockoutHeader": "Key loss & lockout costs",
    "KeylosslockoutIncludedText": "Costs from key loss can be significant as key programming is often required, plus roadside assistance, temporary keys, replacement keys etc.",
    "TowingimpoundHeader": "Towing & Impound Fees",
    "TowingimpoundIncludedText": "Towing & impound storage costs are often expensive. Average cost is $380 for towing & $120/day for impounding.",
    "MisfuelingHeader": "Misfueling",
    "AllIncludedHeader": "Car booking includes checked items only",
    "Shortname": "Damage Waiver",
    "LDWIncluded": "dont_show",
    "CDWIncluded": "dont_show",
    "SLIIncluded": "dont_show",
    "WHTIncluded": "dont_show",
    "TheftIncluded": "dont_show",
    "RoadsideIncluded": "dont_show",
    "LossofuseIncluded": "dont_show",
    "CreditcardfeesIncluded": "dont_show",
    "KeylosslockouIncluded": "dont_show",
    "TowingimpoundIncluded": "dont_show",
    "MisfuelingIncluded": "dont_show",
    "SupplierLogo": "https://s3-ap-southeast-2.amazonaws.com/welovetravel-data/suppliers/hertz.png",
    "Exclusions": "The supplier's policies do not cover loss/damages to: <ul> <li>Broken/lost keys</li> <li>Neverlost navigation</li> <li>Roadside Assistance- related costs</li> </ul> The above are covered by RentalCover.com.",
    "ExcessPayablePriceText": "Payable if cause of damage is 'excluded'",
    "FromPriceFormatted": "US$42.00",
    "FromPrice": "42.00",
    "ToPriceFormatted": "US$0.00",
    "ToPrice": "0.00"
  }
}

 

Back To Top

Quote

The Quote endpoint enables the RentalCover.com 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.com 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.com.

Request Parameters
X_API_KEY string [varchar(32)] required
API Key, provided by RentalCover.com
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 dropoff
DestinationCountry string     [varchar(2)] required 
ISO 3166 two character country code for country of travel
CustomerAge integer required 
Customer age
Email string required 
Customer email
FirstName string required 
Customer first name (if unknown use NULL)
LastName string required 
Customer last name (if unknown use NULL)
Country string [varchar(2)] required 
ISO 3166 two character country code for customer country of residence or IP
Type string
[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”
FromLocationName string
City name of vehicle pickup
ToLocationName string
City name of vehicle drop off
Address1 string
Customer street address line 1
Address2 string
Customer street address line 2
City string
Customer suburb
PostalCode string
Customer postcode or zip code
Phone string
Customer phone
OtherEmail string
Customer other email
Region string
Customer region / state
OtherDriveAge1 integer
Age of second driver
OtherDriveAge2 integer
Age of third driver
CoverAmount float
The amount of cover required
PolicyPrice float 
Price of partner policy (if partner sets price). If < RC policy then partner price will be used.
VehicleStdLiabilityHigh float
If >1 standard excess available for vehicle, this is the higher amount. If only 1 standard excess, use this field.
VehicleStdLiabilityLow float
If >1 standard excess available for the vehicle this is the lower amount. If only 1 standard liability available, use VehicleStdLiabilityHigh. Policy quotes will use this amount to determine the amount of cover required. if this value isn’t passed in the request then CoverAmount will be used.
VehicleStdLiabilityCurrency string [varchar(3)]
Currency of vehicle’s standard liability
VehicleSupplierId string
Vehicle supplier ID
VehicleSupplierIdTwo string
Vehicle supplier ID of second supplier
VehicleSupplierName string
Vehicle supplier name
VehicleSupplierCountryId string [varchar(2)]
Vehicle supplier country code
VehicleName string
Vehicle name
VehicleCategory string
Vehicle category (if SIPP not used)
VehicleCode string
Vehicle SIPP code
VehicleBerths string
Vehicle berths
VehicleOffroad4x4 boolean default is false
Vehicle off road
VehicleClass string
Vehicle class
VehicleNettPrice float
The wholesale price of the vehicle paid by the OTA
VehicleRentalGross float
The retail price of the vehicle.
ContactCustomer boolean [0|1] default is 1
Whether to allow RC email contact with customer. Would be 1 if RC allowed to send “opt out” emails.
LanguageCode string [varchar(2)] default is en
Two character language code. See supported languages
LDWIncluded boolean [0|1]
If LDW is included we remove theft from the Comparison Table in Content endpoint
SLIIncluded boolean [0|1]
CDWIncluded boolean [0|1]
UserIpAddress string [20]
The end user’s IP address
VehiclePickupTime datetime in UTC
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.
VehiclePickupCity string [varchar(50)]
Unstructured data. Pass whatever you use as your own city indentifiers.
VehiclePickupCountry string [varchar(2)]
Two Letter Country Code
VehicleDropoffTime datetime in UTC
The vehicle drop off time in UTC with offset (Atom format) e.g. 2018-12-04T22:00:00-05:00
VehicleDropoffCity string [varchar(50)]
VehicleDropoffCountry string [varchar(2)]
Currency string [varchar(3)]
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
PartnerSite string [50]
Used if partner has multiple sites to determine partner’s referring domain. Use this format: yoursite.com string would be yoursitecom
RoadSideAssistanceCoverOption boolean [0|1]
Used to request for roadside assistance cover option.
VehicleTypes string [100]
Comma separated list of vehicle types. Codes here:
car,motorhome,campervan,4x4,
minibus,lighttruck,bus

Example: car,motorhome,bus
Response Attributes

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

BookingId integer
Internal ID of the booking (primary key)
Reference string
This is the sole identifier for all claims and support requests. Unique booking reference ending with -
INS
that is created for for each policy booked. Customers will receive this reference in confirmation emails. Also used in purchase & cancel requests.
Status string
Status of booking:

Received: policy has been quoted but not yet paid for

PendingConfirm: policy has been paid for.

Confirmed: policy has been paid for and confirmed

Cancelled: policy has been cancelled

PartiallyPaid: policy has been partially paid for however there are amounts outstanding. Usually as the result of a modification which increased the price.
ToDate datetime 
End date/time of booking
TotalAmount float
Total amount customer is to pay for the policy (already includes discounts & markups)
InsuranceCoverAmount float
Amount of cover the policy includes
SupplierReference string
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 Reference).
Expired boolean
Flag whether the policy has expired
CoveredDays integer
Number of days the customer is covered for
Discount float
Amount of discount that has been applied to the TotalAmount
DestinationCountry string
Full name of destination country of travel
DestinationCountryObject.Code string
ISO 3166 two character destination country code
DestinationCountryObject.Name string
Full name of destination country of travel
DestinationCountryObject.PhoneCode string
Destination country phone prefix
Currency string
Three character currency of the booking
TotalAmountFormatted string
Total amount customer must pay for the policy (already includes discounts & markups). Includes currency formatting.
InsuranceCoverAmountFormatted string
Amount of cover the policy includes
DiscountFormatted string
Amount of discount that has been applied to the TotalAmount
DailyAmountFormatted string 
TotalAmount / No Days
Disclaimer string
Policy disclaimer
Policy.GapCoverAmount float
Amount of gap cover that the policy includes
Policy.Name string
Name of the policy
Policy.Type string
Type of the Policy
Policy.Code string
Policy code
Policy.Excess float
Amount of excess
Policy.Inclusions string
Policy inclusions
Policy.Description string
Policy description
Policy.SellingPoints string
Policy selling points / benefits
Policy.SpecialMessage string
Any special messages related to the policy will be passed through this field.
Policy.GapCoverAmountFormatted string
Amount of gap cover that the policy includes
Policy.ExcessFormatted string
Amount of excess
Policy.PdsUrl string
URL to the policy PDS PDF
Policy.SupplierName string
Name of the policy supplier
Policy.ModifyUrl string
URL that allows the policy to be modified (if not using API endpoint)
Policy.CancelUrl string
URL that allows the policy to be cancelled (if not using API endpoint)
Customer.FirstName string
First name of customer
Customer.LastName string
Last name of customer
Customer.Email string
Email address of customer
Customer.Age integer
Age of customer
Customer.Country string
Customer country code
Customer.Coupons object
0:n coupons, not returned if no coupons available.
Customer.Coupons.[coupon_code] string
Coupon code
Customer.Coupons.[coupon_code].Title string
Coupon title
Customer.Coupons.[coupon_code].Value integer
Value of coupon
Customer.Coupons.[coupon_code].ValueType string
Fixed or percentage
Customer.Coupons.[coupon_code].AmountRemaining float
Amount remaining on coupon [null]
Customer.Coupons.[coupon_code].EffectiveFrom date
Date that coupon is effective from
Customer.Coupons.[coupon_code].EffectiveTo date
Date that coupon is effective to
Customer.Coupons.[coupon_code].Ters string
Coupon terms and conditions
QuoteUrl string
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.
PoweredByLogo string
URL of RC logo
Quote General Errors

General errors will return a HTTP 400 response with a description of the error. See below for the list of Quote general errors.

  • No policies available

Endpoint: /insurances/quote

Method: POST

Example Request:

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"FromDate":"2014-09-20 00:00:00","ToDate":"2014-09-21 00:00:00", "CustomerAge":21, "DestinationCountry":"AU", "FirstName":"Jack", "LastName":"Smith", "Address1":"21 This Street", "City":"Sydney","Email":"jacksmith@myemail.com.au","Country":"AU"}' \
https://api-staging.rentalcover.com/insurances/quote

Example Response:

{
  "BookingId": "12345",
  "Reference": "AB12-345C-INS",
  "Status": "Received",
  "FromDate": "2015-06-24 00:00:00",
  "ToDate": "2015-06-25 00:00:00",
  "TotalAmount": 10,
  "InsuranceCoverAmount": 2000,
  "SupplierReference": null,
  "Expired": false,
  "PoweredByLogo": "https://www.rentalcover.com/poweredByRCLogo.png",
  "CoveredDays": 2,
  "Discount": 0,
  "DestinationCountry": "Australia",
  "DestinationCountryObject": {
    "Code": "AU",
    "Name": "Australia",
    "PhoneCode": "+61"
  },
  "Currency": "AUD",
  "TotalAmountFormatted": "GB\u00a310.00",
  "InsuranceCoverAmountFormatted": "GB\u00a32,000.00",
  "DiscountFormatted": "GB\u00a30.00",
  "DailyAmountFormatted": "GB\u00a35.00",
  "Disclaimer": "You agree that you have read, understood & accepted the terms of the <a href=\"http://files.rentalcover.com/pds/axa_PDS_usinbound.pdf\">Policy</a>.",
  "Policy": {
    "GapCoverAmount": "250.00",
    "Code": "destinationusa75",
    "Excess": "0.00",
    "Name": "Extra Cover for USA",
    "Type": "RoadsideAssistance",
    "Inclusions": "&lt;b&gt;Summary of Inclusions&lt;/b&gt;\r\nGB\u00a32,000.00 is sufficient to cover any repair costs and fees that drivers are required to pay on top of LDW (Loss Damage Waiver) policies. We also includeGB\u00a3250.00 Free Gap Cover just in case there is any shortfall or unanticipated &quot;out of pocket&quot; costs. This policy includes:\r\n&lt;li&gt;All drivers that are nominated on the rental agreement are covered automatically for free.\r\n&lt;li&gt;Includes free roadside assistance from the #1 rated roadside provider in United States (usually GB\u00a35.00-GB\u00a310.00/day).\r\n&lt;li&gt;Covers roadside repair costs, call out fees &amp; labour costs.\r\n\r\n&lt;li&gt;Covers towing costs and impound storage fees.\r\n&lt;li&gt;Covers key loss, lock out &amp; key replacement (regardless of the cause).\r\n&lt;li&gt;Covers windscreen, headlights, tyre, mirror &amp; glass repairs.\r\n&lt;li&gt;Covers car rentals, car shares, loan cars from mechanics &amp; accident replacement vehicles. \r\n&lt;li&gt;Covers dropoff/relocation fees that are charged by rental companies for returning damaged vehicles to their preferred destination.\r\n&lt;li&gt;Covers credit card and processing fees that are applied by rental companies.&lt;/li&gt;\r\n\r\n&lt;b&gt;Cancellations&lt;/b&gt;\r\nYour policy can be cancelled up to and including the day of commencement for a full, immediate refund.",
    "Description": "&lt;b&gt;Policy Description&lt;/b&gt;\r\nThis policy includes GB\u00a32,000.00 cover and can be applied to rental cars from any rental company. It includes free roadside assistance and covers damages, costs &amp; other fees that are not covered in the LDW policy  from  LDW has zero &quot;deductible excess&quot; (i.e. you don&#039;t have to pay an excess if there&#039;s an accident), drivers still face substantial costs for items that fall outside of the scope of the  LDW. This policy covers those items for up to GB\u00a32,000.00, namely: \r\n\r\n&lt;li&gt;Any damages that are not covered by rental companies to recoup lost sales while their vehicle is being repaired.\r\n&lt;li&gt;&quot;Dropoff&quot; fees that are charged by the rental companies to relocate vehicles to their intended destination.\r\n&lt;li&gt;Administration costs that are charged by {{IF SUPPLIER}}{{/IF}}rental companies for processing repairs, insurance etc.\r\n&lt;li&gt;Credit card fees that are applied to all of the above.&lt;/li&gt;\r\n&lt;b&gt;Additional Drivers&lt;/b&gt;\r\nWe separately include GB\u00a3250.00 Free Gap Cover for peace of mind, just in case there is a shortfall.\r\n \r\n&lt;b&gt;Additional Drivers&lt;/b&gt;\r\nAll drivers nominated on the rental agreement are covered automatically, free of charge. Those other drivers are also extended the benefit of the reimbursement of unused rental days resulting from a family medical emergency.\r\n\r\n&lt;b&gt;Claim Fee&lt;/b&gt;\r\nThe claim fee on this policy is GB\u00a30.00. \r\n\r\n&lt;b&gt;Exclusions&lt;/b&gt;\r\nThe following are not covered by this policy. Please read the &lt;a href=&quot;http://files.rentalcover.com/pds/axa_PDS_usinbound.pdf&quot;&gt;policy wording&lt;/a&gt; for further information:\r\n&lt;li&gt;4x4s, campervans, motorhomes, mini buses with 10 seats or more.\r\n&lt;li&gt;Driving on unsealed roads.\r\n&lt;li&gt;Damages that resulted from a breach of the rental agreement or that contravened local laws.&lt;/li&gt;",
    "SellingPoints": "&lt;li&gt;Covers car rentals, loan cars from mechanics &amp; accident replacement vehicles for up to GB\u00a32,000.00 of damages.\r\n&lt;li&gt;Cancel anytime including the day of pickup for a full, immediate refund.\r\n\r\n&lt;li&gt;Free roadside assistance.\r\n&lt;li&gt;Covers roadside repair costs.\r\n&lt;li&gt;Cover for towing costs and impound storage fees.\r\n&lt;li&gt;Key loss &amp; replacement.\r\n&lt;li&gt;Full cover for windscreen repairs, headlights and tyres.",
    "GapCoverAmountFormatted": "GB\u00a3250.00",
    "ExcessFormatted": "GB\u00a30.00",
    "PdsUrl": "http://files.rentalcover.com/pds/axa_PDS_usinbound.pdf",
    "SupplierName": "Axa Assistance",
    "ModifyUrl": "http://www.rentalcover.com/modify/AB12-345C-INS",
    "CancelUrl": ""
  },
  "Customer": {
    "CustomerId": "12345",
    "FirstName": "Jack",
    "LastName": "Smith",
    "Email": "jacksmith@myemail.com.au",
    "Age": "21",
    "Phone": null,
    "Address1": "21 This Street",
    "Address2": null,
    "City": "Sydney",
    "Region": null,
    "PostalCode": null,
    "CountryId": "14",
    "DateOfBirth": "1995-01-01",
    "Country": "AU"
  },
  "QuoteUrl": "https://www.rentalcover.com/payment/AB12-345C-INS/?_lang=en&utm_campaign=api_quote_url&utm_medium=link&utm_source=destinationusa"
}

Back To Top

Status

The Status endpoint enables the RentalCover.com server to respond with the booking details (including status) of the specified booking reference.

Endpoint: /insurances/status

Method: GET

Example Request:

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

Example Response (same response as purchase):

{  
  "BookingId": "12345",
  "Reference": "AB12-345C-INS",
  "Status": "PendingConfirm",
  "FromDate": "2015-03-19 00:00:00",
  "ToDate": "2015-03-22 00:00:00",
  "TotalAmount": 60,
  "InsuranceCoverAmount": 3000,
  "SupplierReference": null,
  "Expired": false,
  "CoveredDays": 4,
  "Discount": 0,
  "DestinationCountry": "Australia",
  "DestinationCountryObject": {  
    "Code": "AU",
    "Name": "Australia",
    "PhoneCode": "+61"
  },
  "Currency": "AUD",
  "TotalAmountFormatted": "AU$60.00",
  "InsuranceCoverAmountFormatted": "AU$3,000.00",
  "DiscountFormatted": "AU$0.00",
  "DailyAmountFormatted": "AU$15.00",
  "Disclaimer": "By clicking the button above you accept website <a href=\"https:\/\/www.rentalcover.com\/terms\" target=\"_blank\">terms<\/a> & the policy provided by RentalCover.com.  \r\n\tYou agree that these documents have been provided to you via the links and understand that you may print copies of them. You have noted the exclusions and limitations, which include passengers with existing medical conditions. You are authorised to buy travel insurance on behalf of all passengers in this booking, and all passengers meet the eligibility criteria. \r\n",
  "Policy": {  
    "GapCoverAmount": "3500.00",
    "Name": "Zero Excess Rental Cover",
    "Type": "RoadsideAssistance",
    "Code": "RC001",
    "Excess": "0.00",
    "Inclusions": "<li>Rental vehicle excess cover: $AU$3,000.00 plus $3500 Free Gap Cover. Gap cover is sold free of charge with all RentalCover.com policies. You do not need to take the optional excess reduction at the depot as $AU$3,000.00 + $3500 is sufficient to cover your standard liability).<\/li><br\/><li>Important: While the rental company will charge your credit card for the damages (up to the standard liability) you would then make a claim to RentalCover.com.<\/li><br\/>As with all other RentalCover.com policies, this policy includes the following which are typically excluded by the rental companies:<br\/><li>Windscreen, tyre, roof &amp; underbody repairs.<\/li><br\/><li>Single vehicle accidents.<\/li><br\/><li>Hitting an animal.<\/li><br\/><li>Accidents after dusk.<\/li><br\/><li>Weather-related and water damage.<\/li><br\/><li>Key loss\/replacement.<\/li><br\/><li>Additional drivers that are nominated on the rental agreement<\/li><br\/><li>Demurrage (the supplier&#039;s lost rental while a vehicle is off the road for repairs).<\/li><br\/><li>Maximum claim: $3500.<\/li><br\/><li>Claim Fee: $0<\/li><br\/><li>Cost: Free with any RentalCover.com purchase!<\/li><br\/>Exclusions:<br\/>This cover does not cover the following events:<br\/><li>Does not cover damages sustained while driving on unsealed roads.<\/li><br\/><li>Does not cover damage caused where the terms of Rental Contract have been breached.<\/li><br\/><li>Does not cover damage caused by an event that leads to a police investigation.<\/li><br\/><li>Does not cover damage caused to the Vehicle in any way by part or total water submersion or salt water. * Damage caused to the Vehicle by the renter\u2019s wilful or negligent conduct or contravention of any legislation or regulation controlling vehicular traffic<\/li><br\/><li>Does not cover damage caused due to use of incorrect or contaminated fuel.<\/li><br\/>Where required, RentalCover.com will utilise the resources of the claims team that handled the original claim application (i.e. the primary RentalCover.com policy issuer) and will exercise their discretion.",
    "Description": "This policy covers payments that you make for damages\/repairs to any rental vehicle anywhere in Australia. There is nil excess payable on a claim (whereas the rental companies charge $330-$1000 if you take their &quot;reduced&quot; excess). You do not need the supplier&#039;s excess reduction (collision damage waiver), instead you pay the supplier for repairs and claim that &quot;excess cost&quot; from RentalCover.com. Covers all drivers on the rental agreement aged 19 to 75, for travel anywhere in Australia on the dates shown. Note that there may be a refundable bond charged to your credit card when you do not take the supplier&#039;s excess reduction (card fees may apply).",
    "SellingPoints": "<li>No exclusions!<\/li><br\/><li>Includes $3500 Free Gap Cover, free with any RentalCover.com purchase.<\/li><br\/><li>Includes single vehicle accidents<\/li><br\/><li>Includes windscreens &amp; tyre damage<\/li><br\/><li>Covers you if you hit an animal or if you are driving at night.<\/li>",
    "RoadsideAssistanceBlob": "NMC Freecall Hotline is 855-613-8252 or +1-469-941-5569. Emergencies On The Road: If your car requires towing due to one of these, follow the 5 steps below: key loss, a mechanical fault, smashed windscreen/headlights or an accident... <li>Call the rental company and let them know that you have your own roadside assistance provider that includes towing. They will advise the towing dropoff point, then;</li> <li>Call NMC (see above). You will need your RentalCover.com reference number (B1LS-82TR-INS).</li> <li>NMC will send a tow truck &amp; you will pay NMC whilst on the call.</li> <li>You will meet the tow truck &amp; go to the delivery point with them.</li> <li>Claim all the costs that you incurred via&nbsp;<a href='http://www.rentalcover.com/claims'>rentalcover.com/claims</a>. Our goal is to reimburse you within 7 days.</li> Otherwise, if you have locked your keys in the car or have a flat tyre, empty fuel tank or dead battery... ? You do not need to call the rental company. Just call NMC who will arrange a vehicle to perform repairs. You will pay NMC and any related costs would be claimed via&nbsp;<a href='http://www.rentalcover.com'>rentalcover.com/claims</a>.",
    "GapCoverAmountFormatted": "AU$3,500.00",
    "ExcessFormatted": "AU$0.00",
    "PdsUrl": false,
    "SupplierName": "RentalCover",
    "ModifyUrl": "http:\/\/www.rentalcover.com\/modify\/AB12-345C-INS",
    "CancelUrl": "http:\/\/www.rentalcover.com\/cancel\/AB12-345C-INS"
  },
  "Customer": {  
    "FirstName": "Jack",
    "LastName": "Smith",
    "Email": "jacksmith@myemail.com.au",
    "Age": 21,
    "Country": "AU"
   }
}

 

Back To Top

Update

The Update endpoint is used to fetch the updated policy assuming the FromDate has not yet passed. The update endpoint does not actually update the data on RentalCover server.

Allowed Updates
  • Duration (ToDateFromDate)
  • Cover amount (VehicleStdLiabilityLow / VehicleStdLiabilityHigh)
  • Customer (FirstName, LastName, CustomerAge, Address1, Address2, City, Region, PostalCode, Phone)
  • Vehicle infomation (VehicleNettPrice)
Request Parameters
X_API_KEY string [varchar(32)] required
API Key, provided by RentalCover.com
QuoteOnly boolean [0/1] required 
If set to 1 then returned update will not be saved. An additional update call with 0 parameter will be required if the update is to be saved. Typical user flow; user requests update with new details. System responds "For this update there will be [no charge | a refund of $x | a charge of $x]. Would you like to proceed?" Upon confirmation, the Update endpoint should be called again, with boolean set to 0. Using tokenisation, the API will apply the refund, or charge to the original customer credit card.
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 dropoff
FirstName string required 
Customer first name (if unknown use NULL)
LastName string required 
Customer first name (if unknown use NULL)
Email string required 
Customer email cannot be changed during update as Reference and Customer Email act as unique identifier. To update customer email, please use updateCustomer endpoint
Country string [varchar(2)] required 
ISO 3166 two character country code for customer country of residence or IP
Currency string [varchar(3)]
See Supported List of currencies
FromLocationName string
City name of vehicle pickup
ToLocationName string
City name of vehicle drop off
Address1 string
Customer street address line 1
Address2 string
Customer street address line 2
City string
Customer suburb
PostalCode string
Customer postcode or zip code
Phone string
Customer phone
OtherEmail string
Customer other email
Region string
Customer region / state
OtherDriveAge1 integer
Age of second driver
OtherDriveAge2 integer
Age of third driver
CoverAmount float
The amount of cover required
VehicleStdLiabilityHigh float
If >1 standard liability available for vehicle, this is the higher amount. If only 1 standard liability this is that amount.
VehicleStdLiabilityLow float
If >1 standard liability available for the vehicle this is the lower amount. If only 1 standard liability available, use VehicleStdLiabilityHigh. Policy quotes will use this amount to determine the amount of cover required. If this value isn’t passed in the request then CoverAmount will be used.
VehicleStdLiabilityCurrency string [varchar(3)]
Currency of vehicle’s standard liability
VehicleSupplierId string
Vehicle supplier ID
VehicleSupplierIdTwo string
Vehicle supplier ID of second supplier
VehicleSupplierName string
Vehicle supplier name
VehicleSupplierCountryId string [varchar(2)]
Vehicle supplier country code
VehicleName string
Vehicle name
VehicleCategory string
Vehicle category (if SIPP not used. e.g. ACRISS code)
VehicleCode string
Vehicle SIPP code
VehicleBerths string
Vehicle berths
VehicleOffroad4x4 boolean default is false 
Whether the vehicle is an off-road 4 Wheeled Drive
VehicleClass string
Vehicle class
VehicleRentalGross float
The retail price of the vehicle
VehicleNettPrice float
The wholesale price of the vehicle paid by the OTA
ContactCustomer boolean [0|1]
Whether to allow RC email contact with customer
LanguageCode string [varchar(2)] default is en 
Two character language code. See supported languages
VehiclePickupTime datetime in UTC
The vehicle pickup time in UTC with offset (Atom format)
VehiclePickupCity string [varchar(50)]
VehiclePickupCountry string [varchar(2)]
VehicleDropoffTime datetime in UTC
The vehicle drop off time in UTC with offset (Atom format)
VehicleDropoffCity string [varchar(50)]
VehicleDropoffCountry string [varchar(2)]
VehicleTypes string [100]
Comma separated list of vehicle types. Codes here: car,motorhome,campervan,
4x4,minibus,lighttruck,bus
Example: car,motorhome,bus
Endpoint: /insurances/update

Method: POST

Example Request:

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"VehicleStdLiabilityLow":1000.00,"VehicleStdLiabilityHigh":5500.00,"FromDate":"2015-04-22 00:00:00","ToDate":"2015-04-23 00:00:00", "CustomerAge":21, "FirstName":"Jack", "LastName":"Smith","Email":"jacksmith@myemail.com.au","Country":"AU"}' \
https://api-staging.rentalcover.com/insurances/update/AB12-345C-INS

Example Response (same response as purchase):

{  
  "BookingId": "12345",
  "Reference": "AB12-345C-INS",
  "Status": "PendingConfirm",
  "FromDate": "2015-03-19 00:00:00",
  "ToDate": "2015-03-22 00:00:00",
  "TotalAmount": 60,
  "InsuranceCoverAmount": 3000,
  "SupplierReference": null,
  "Expired": false,
  "CoveredDays": 4,
  "Discount": 0,
  "DestinationCountry": "Australia",
  "DestinationCountryObject": {  
    "Code": "AU",
    "Name": "Australia",
    "PhoneCode": "+61"
  },
  "Currency": "AUD",
  "TotalAmountFormatted": "AU$60.00",
  "InsuranceCoverAmountFormatted": "AU$3,000.00",
  "DiscountFormatted": "AU$0.00",
  "DailyAmountFormatted": "AU$15.00",
  "Disclaimer": "By clicking the button above you accept website <a href=\"https:\/\/www.rentalcover.com\/terms\" target=\"_blank\">terms<\/a> & the policy provided by RentalCover.com.  \r\n\tYou agree that these documents have been provided to you via the links and understand that you may print copies of them. You have noted the exclusions and limitations, which include passengers with existing medical conditions. You are authorised to buy travel insurance on behalf of all passengers in this booking, and all passengers meet the eligibility criteria. \r\n",
  "Policy": {  
    "GapCoverAmount": "3500.00",
    "Name": "Zero Excess Rental Cover",
    "Type": "RoadsideAssistance",
    "Code": "RC001",
    "Excess": "0.00",
    "Inclusions": "<li>Rental vehicle excess cover: $AU$3,000.00 plus $3500 Free Gap Cover. Gap cover is sold free of charge with all RentalCover.com policies. You do not need to take the optional excess reduction at the depot as $AU$3,000.00 + $3500 is sufficient to cover your standard liability).<\/li><br\/><li>Important: While the rental company will charge your credit card for the damages (up to the standard liability) you would then make a claim to RentalCover.com.<\/li><br\/>As with all other RentalCover.com policies, this policy includes the following which are typically excluded by the rental companies:<br\/><li>Windscreen, tyre, roof &amp; underbody repairs.<\/li><br\/><li>Single vehicle accidents.<\/li><br\/><li>Hitting an animal.<\/li><br\/><li>Accidents after dusk.<\/li><br\/><li>Weather-related and water damage.<\/li><br\/><li>Key loss\/replacement.<\/li><br\/><li>Additional drivers that are nominated on the rental agreement<\/li><br\/><li>Demurrage (the supplier&#039;s lost rental while a vehicle is off the road for repairs).<\/li><br\/><li>Maximum claim: $3500.<\/li><br\/><li>Claim Fee: $0<\/li><br\/><li>Cost: Free with any RentalCover.com purchase!<\/li><br\/>Exclusions:<br\/>This cover does not cover the following events:<br\/><li>Does not cover damages sustained while driving on unsealed roads.<\/li><br\/><li>Does not cover damage caused where the terms of Rental Contract have been breached.<\/li><br\/><li>Does not cover damage caused by an event that leads to a police investigation.<\/li><br\/><li>Does not cover damage caused to the Vehicle in any way by part or total water submersion or salt water. * Damage caused to the Vehicle by the renter\u2019s wilful or negligent conduct or contravention of any legislation or regulation controlling vehicular traffic<\/li><br\/><li>Does not cover damage caused due to use of incorrect or contaminated fuel.<\/li><br\/>Where required, RentalCover.com will utilise the resources of the claims team that handled the original claim application (i.e. the primary RentalCover.com policy issuer) and will exercise their discretion.",
    "Description": "This policy covers payments that you make for damages\/repairs to any rental vehicle anywhere in Australia. There is nil excess payable on a claim (whereas the rental companies charge $330-$1000 if you take their &quot;reduced&quot; excess). You do not need the supplier&#039;s excess reduction (collision damage waiver), instead you pay the supplier for repairs and claim that &quot;excess cost&quot; from RentalCover.com. Covers all drivers on the rental agreement aged 19 to 75, for travel anywhere in Australia on the dates shown. Note that there may be a refundable bond charged to your credit card when you do not take the supplier&#039;s excess reduction (card fees may apply).",
    "SellingPoints": "<li>No exclusions!<\/li><br\/><li>Includes $3500 Free Gap Cover, free with any RentalCover.com purchase.<\/li><br\/><li>Includes single vehicle accidents<\/li><br\/><li>Includes windscreens &amp; tyre damage<\/li><br\/><li>Covers you if you hit an animal or if you are driving at night.<\/li>",
    "RoadsideAssistanceBlob": "NMC Freecall Hotline is 855-613-8252 or +1-469-941-5569. Emergencies On The Road: If your car requires towing due to one of these, follow the 5 steps below: key loss, a mechanical fault, smashed windscreen/headlights or an accident... <li>Call the rental company and let them know that you have your own roadside assistance provider that includes towing. They will advise the towing dropoff point, then;</li> <li>Call NMC (see above). You will need your RentalCover.com reference number (AB12-345C-INS).</li> <li>NMC will send a tow truck &amp; you will pay NMC whilst on the call.</li> <li>You will meet the tow truck &amp; go to the delivery point with them.</li> <li>Claim all the costs that you incurred via&nbsp;<a href='http://www.rentalcover.com/claims'>rentalcover.com/claims</a>. Our goal is to reimburse you within 7 days.</li> Otherwise, if you have locked your keys in the car or have a flat tyre, empty fuel tank or dead battery... ? You do not need to call the rental company. Just call NMC who will arrange a vehicle to perform repairs. You will pay NMC and any related costs would be claimed via&nbsp;<a href='http://www.rentalcover.com'>rentalcover.com/claims</a>.",
    "GapCoverAmountFormatted": "AU$3,500.00",
    "ExcessFormatted": "AU$0.00",
    "PdsUrl": false,
    "SupplierName": "RentalCover.com",
    "ModifyUrl": "http:\/\/www.rentalcover.com\/modify\/AB12-345C-INS",
    "CancelUrl": "http:\/\/www.rentalcover.com\/cancel\/AB12-345C-INS"
  },
  "Customer": {  
    "FirstName": "Jack",
    "LastName": "Smith",
    "Email": "jacksmith@myemail.com.au",
    "Age": 21,
    "Country": "AU"
   }
}

 

Back To Top

Purchase

The Purchase endpoint enables the RentalCover.com server to book a quoted policy based on the parameters provided.

A previously generated quote must be created before a purchase can be made, the reference for this quote is passed in the AgentReference field.

Currency Code is not supported in Purchase request. If Currency code is used, it will be ignored.

The purchase request sent after modification is different to the purchase request sent after Quote. If an auto re-bill feature is enabled for a partner, the following fields are optional during the Purchase Request: CardHolder, CardNumber, CardExpiry, CardSecurityCode.

For CDW policy to receive a $2 discount for NY residents, the PostalCode parameter has to include the postcode for the resident in which case it will calculate the discount at $9/day for NY residents.

Request Parameters
AgentReference string required
The Reference field passed in the response from the Quote endpoint
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
DestinationCountry string [ISO 3166(2)] required
Customer destination country code
FromDate date required
Policy start date
ToDate date required
 Policy end date
PolicyCode string required
 The Policy.Code field passed in the quote response
FirstName string required
Customer first name
LastName string required
 Customer last name
Email string required
Customer email
Country string [ISO 3166(2)] required
Customer country code
Address1 string required
Customer address. IF UNKNOWN: Include a default address, e.g. c/- Travel Jigsaw
City string required
Customer city. IF UNKNOWN: Include a default
PostalCode string required
Customer postcode or zip code. IF UNKNOWN: Include a default
CardHolder string required after Quote Request
Credit card name
CardNumber string [0-9] required after Quote Request
Credit card number
CardExpiry string [mmyy] required after Quote Request
Credit card expiry date
CardSecurityCode string required after Quote Request
Credit card CVV
Address2 string
Customer street address line 2
Region string
Customer region. IF UNKNOWN: Include a default
Phone string
Customer phone (mobile preferred, ; format: +61413333333)
OtherEmail string
Secondary email
LanguageCode string [2]
default is en Preferred language code. See supported languages
CoverAmount float
The required amount of cover
Discount float
The amount of discount required,  if available
PartnerCardFees float
Partner credit card fee
AutoRebill boolean
For customers who have already booked with us , 
AutoRebill = true will charge their credit card and you do not need to pass us the credit card
details like CardHolder,CardNumber,
CardExpiry,CardSecurityCode.
Response Attributes

Note that response properties with the text Formatted appended are formatted with the relevant currency code and symbol.

BookingId integer 
Internal ID of booking (primary key)
Reference string
Unique booking reference for each policy booked. Customers will receive this reference in confirmation emails. Also used in purchase and cancel requests.
Status string
Status of booking:
Received: policy has been quoted but not yet paid for.
PendingConfirm: policy has been paid for.
Confirmed: policy has been paid for and confirmed.
Cancelled: policy has been cancelled.
PartiallyPaid: policy has been partially paid for however there are amounts outstanding. Usually as the result of a modification which increased the price.
FromDate datetime 
Start date/time of booking
ToDate datetime 
End date/time of booking
TotalAmount float
Total amount customer is to pay for the policy (already includes discounts and markups)
InsuranceCoverAmount float
Amount of cover the policy includes
SupplierReference string
Supplier’s policy reference once purchased
Expired boolean
Flag whether the policy has expired
CoveredDays integer
Number of days the customer is covered for
Discount float
Amount of discount that has been applied to the TotalAmount
DestinationCountry string
Full name of destination country of travel
DestinationCountryObject.Code string
ISO 3166 two character Destination country code
DestinationCountryObject.Name string
Full name of destination country of travel
DestinationCountryObject.PhoneCode string
Destination country phone prefix
Currency string
Three character currency of the booking
TotalAmountFormatted string
Total amount customer must pay for the policy (already includes discounts and markups). Includes currency formatting.
InsuranceCoverAmountFormatted string
Amount of cover the policy includes
DiscountFormatted string
Amount of discount that has been applied to the TotalAmount
DailyAmountFormatted string 
TotalAmount / No. Days
TotalAmountOutstanding float 
Amount outstanding to complete purchase of policy. Will either be the same value as TotalAmount if no modification has been made.
TotalAmountOutstandingFormatted string
Formatted version of total amount outstanding.
TotalAmountRefunded float 
Amount refunded after a modification that reduced the price.
TotalAmountRefundedFormatted string
Formatted version of total amount refunded
Disclaimer string
Policy disclaimer
Policy.GapCoverAmount float
Amount of gap cover that the policy includes
Policy.Name string
Name of the policy
Policy.Type string
Type of the policy
Policy.Code string
Policy code
Policy.Excess string
Amount of excess
Policy.Inclusions string
Policy inclusions
Policy.Description string
Policy description
Policy.SellingPoints string
Policy selling points / benefits
Policy.RoadsideAssistanceBlob string
Roadside assistance text. Can be used by support staff, CRM, or within email templates
Policy.GapCoverAmountFormatted string
Amount of gap cover that the policy includes
Policy.ExcessFormatted string
Amount of excess
Policy.PdsUrl string
URL to the policy PDS PDF
Policy.SupplierName string
Name of the policy supplier
Policy.ModifyUrl string
URL that allows the policy to be modified (if not using API endpoint)
Policy.CancelUrl string
URL that allows the policy to be cancelled (if not using API endpoint)
Customer.FirstName string
First name of customer
Customer.LastName string
Last name of customer
Customer.Email string
Email address of customer
Customer.Age string
Age of customer
Customer.Country string
Customer country code
Customer.Coupons object
0:n coupons, not returned if no coupons available.
Customer.Coupons.[coupon_code]  string
Coupon code
Customer.Coupons.[coupon_code].Title  string
Coupon title
Customer.Coupons.[coupon_code].Value  integer
Value of coupon
Customer.Coupons.[coupon_code].ValueType  string
Fixed or percentage
Customer.Coupons.[coupon_code].AmountRemaining  float
Amount remaining on coupon [null]
Customer.Coupons.[coupon_code].EffectiveFrom  date
Date that coupon is effective from
Customer.Coupons.[coupon_code].EffectiveTo  date
Date that coupon is effective to
Customer.Coupons.[coupon_code].Ters  string
Coupon terms and conditions
QuoteUrl string
Quote URL of the policy. Used in confirmation emails to customer. Renders the payment page. Not returned in v2 of API.
Purchase General Errors

General errors will return a HTTP 400 response with a description of the error. See below for the list of Purchase general errors.

  • Policy cannot be purchased or modified after the date of travel
  • Booking details not found
  • Invalid or expired coupon, please try again or remove coupon
  • Payment validation failed, please make sure your credit card details are correct or try another card
  • Booking not found

Endpoint: /insurances/purchase

Method: POST

Optional Endpoint:
/insurances/purchase/<reference:[A-Z0-9\-]+>
  To be used if AgentReference is your reference, in this case the Policy reference is passed within the URL.

Example Request:

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"AgentReference":"AB12-345C-INS","PolicyCode":"RC001","FromDate":"2014-12-17 00:00:00","ToDate":"2014-12-19 00:00:00", "CustomerAge":21, "DestinationCountry":"AU", "FirstName":"Jack", "LastName":"Smith","Address1":"21 This Street","City":"Sydney","Email":"jacksmith@myemail.com.au","Country":"AU","CardHolder":"TEST TEST","CardNumber":"4111111111111111","CardExpiry":"1216","CardSecurityCode":"111"}' \
https://api-staging.rentalcover.com/insurances/purchase

Example Response:

{  
  "BookingId": "12345",
  "Reference": "AB12-345C-INS",
  "Status": "PendingConfirm",
  "FromDate": "2015-03-19 00:00:00",
  "ToDate": "2015-03-22 00:00:00",
  "TotalAmount": 60,
  "InsuranceCoverAmount": 3000,
  "SupplierReference": null,
  "Expired": false,
  "CoveredDays": 4,
  "Discount": 0,
  "DestinationCountry": "Australia",
  "DestinationCountryObject": {  
    "Code": "AU",
    "Name": "Australia",
    "PhoneCode": "+61"
  },
  "Currency": "AUD",
  "TotalAmountFormatted": "AU$60.00",
  "InsuranceCoverAmountFormatted": "AU$3,000.00",
  "DiscountFormatted": "AU$0.00",
  "DailyAmountFormatted": "AU$15.00",
  "Disclaimer": "By clicking the button above you accept website <a href=\"https:\/\/www.rentalcover.com\/terms\" target=\"_blank\">terms<\/a> & the policy provided by RentalCover.com.  \r\n\tYou agree that these documents have been provided to you via the links and understand that you may print copies of them. You have noted the exclusions and limitations, which include passengers with existing medical conditions. You are authorised to buy travel insurance on behalf of all passengers in this booking, and all passengers meet the eligibility criteria. \r\n",
  "Policy": {  
    "GapCoverAmount": "3500.00",
    "Name": "Zero Excess Rental Cover",
    "Type": "RoadsideAssistance",
    "Code": "RC001",
    "Excess": "0.00",
    "Inclusions": "<li>Rental vehicle excess cover: $AU$3,000.00 plus $3500 Free Gap Cover. Gap cover is sold free of charge with all RentalCover.com policies. You do not need to take the optional excess reduction at the depot as $AU$3,000.00 + $3500 is sufficient to cover your standard liability).<\/li><br\/><li>Important: While the rental company will charge your credit card for the damages (up to the standard liability) you would then make a claim to RentalCover.com.<\/li><br\/>As with all other RentalCover.com policies, this policy includes the following which are typically excluded by the rental companies:<br\/><li>Windscreen, tyre, roof &amp; underbody repairs.<\/li><br\/><li>Single vehicle accidents.<\/li><br\/><li>Hitting an animal.<\/li><br\/><li>Accidents after dusk.<\/li><br\/><li>Weather-related and water damage.<\/li><br\/><li>Key loss\/replacement.<\/li><br\/><li>Additional drivers that are nominated on the rental agreement<\/li><br\/><li>Demurrage (the supplier&#039;s lost rental while a vehicle is off the road for repairs).<\/li><br\/><li>Maximum claim: $3500.<\/li><br\/><li>Claim Fee: $0<\/li><br\/><li>Cost: Free with any RentalCover.com purchase!<\/li><br\/>Exclusions:<br\/>This cover does not cover the following events:<br\/><li>Does not cover damages sustained while driving on unsealed roads.<\/li><br\/><li>Does not cover damage caused where the terms of Rental Contract have been breached.<\/li><br\/><li>Does not cover damage caused by an event that leads to a police investigation.<\/li><br\/><li>Does not cover damage caused to the Vehicle in any way by part or total water submersion or salt water. * Damage caused to the Vehicle by the renter\u2019s wilful or negligent conduct or contravention of any legislation or regulation controlling vehicular traffic<\/li><br\/><li>Does not cover damage caused due to use of incorrect or contaminated fuel.<\/li><br\/>Where required, RentalCover.com will utilise the resources of the claims team that handled the original claim application (i.e. the primary RentalCover.com policy issuer) and will exercise their discretion.",
    "Description": "This policy covers payments that you make for damages\/repairs to any rental vehicle anywhere in Australia. There is nil excess payable on a claim (whereas the rental companies charge $330-$1000 if you take their &quot;reduced&quot; excess). You do not need the supplier&#039;s excess reduction (collision damage waiver), instead you pay the supplier for repairs and claim that &quot;excess cost&quot; from RentalCover.com. Covers all drivers on the rental agreement aged 19 to 75, for travel anywhere in Australia on the dates shown. Note that there may be a refundable bond charged to your credit card when you do not take the supplier&#039;s excess reduction (card fees may apply).",
    "SellingPoints": "<li>No exclusions!<\/li><br\/><li>Includes $3500 Free Gap Cover, free with any RentalCover.com purchase.<\/li><br\/><li>Includes single vehicle accidents<\/li><br\/><li>Includes windscreens &amp; tyre damage<\/li><br\/><li>Covers you if you hit an animal or if you are driving at night.<\/li>",
    "RoadsideAssistanceBlob": "NMC Freecall Hotline is 855-613-8252 or +1-469-941-5569. Emergencies On The Road: If your car requires towing due to one of these, follow the 5 steps below: key loss, a mechanical fault, smashed windscreen/headlights or an accident... <li>Call the rental company and let them know that you have your own roadside assistance provider that includes towing. They will advise the towing dropoff point, then;</li> <li>Call NMC (see above). You will need your RentalCover.com reference number (AB12-345C-INS).</li> <li>NMC will send a tow truck &amp; you will pay NMC whilst on the call.</li> <li>You will meet the tow truck &amp; go to the delivery point with them.</li> <li>Claim all the costs that you incurred via&nbsp;<a href='http://www.rentalcover.com/claims'>rentalcover.com/claims</a>. Our goal is to reimburse you within 7 days.</li> Otherwise, if you have locked your keys in the car or have a flat tyre, empty fuel tank or dead battery... ? You do not need to call the rental company. Just call NMC who will arrange a vehicle to perform repairs. You will pay NMC and any related costs would be claimed via&nbsp;<a href='http://www.rentalcover.com'>rentalcover.com/claims</a>.",
    "GapCoverAmountFormatted": "AU$3,500.00",
    "ExcessFormatted": "AU$0.00",
    "PdsUrl": false,
    "SupplierName": "RentalCover.com",
    "ModifyUrl": "http:\/\/www.rentalcover.com\/modify\/AB12-345C-INS",
    "CancelUrl": "http:\/\/www.rentalcover.com\/cancel\/AB12-345C-INS"
  },
  "Customer": {  
    "FirstName": "Jack",
    "LastName": "Smith",
    "Email": "jacksmith@myemail.com.au",
    "Age": 21,
    "Country": "AU"
   }
}

 

Back To Top

CoverOptOut

The CoverOptOut endpoint allows the requestor to specify that a customer has opted in or out of RentalCover.com.

This endpoint must be called if a customer is opting out of RentalCover.com.

Request Parameters
Reference string required
The RentalCover.com booking reference (passed in endpoint URL)
CoverOptIn boolean required
0 = customer opted out 1 = customer opted in
PartnerReference string
Your internal booking reference

Endpoint: /insurances/coverOptOut

Method: POST

Example Request:

curl -i -X POST \
-H "X_API_KEY: [my-api-key]" \
-H "Content-Type: application/json" \
-d '{"AgentReference":"123123123"}' \
https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS

Example Successful Response:

"success"

Back To Top

Cancel

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

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
Cancel General Errors

General errors will return a HTTP 400 response with a description of the error. See below for the list of Cancel general errors.

  • Booking not found
  • Booking can not be cancelled

Endpoint: /insurances/cancel

Method: DELETE or POST
Using POST allows a CancelReason to be Posted to the endpoint

 

Example Request (DELETE):

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

Example Request (POST):

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

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

 

Back To Top

Supported Currencies

Supported Currencies

Currency Credit Card Types
AUD Australian Dollar Visa/Mastercard/Amex
GBP British Pound Visa/Mastercard/Amex
USD US Dollar Visa/Mastercard/Amex
NZD New Zealand Dollar Visa/Mastercard/Amex
EUR Euro Visa/Mastercard/Amex
CHF Swiss Franc Visa/Mastercard/Amex
CNY Chinese Yuan Visa/Mastercard/Amex
JPY Japanese Yen Visa/Mastercard/Amex
SGD Singapore Dollar Visa/Mastercard/Amex
CAD Canadian Dollar Visa/Mastercard/Amex
DKK Danish Kroner Visa/Mastercard/Amex
KRW Korean Won Visa/Mastercard/Amex
SAR Saudi Arabian Riyal Visa/Mastercard/Amex
SEK Swedish Krona Visa/Mastercard/Amex
MXN Mexican Peso Visa/Mastercard
HKD Hong Kong Dollar Visa/Mastercard/Amex
NOK Norway Kroner Visa/Mastercard/Amex
THB Thai Baht Visa/Mastercard/Amex
TRY Turkish Lira Visa/Mastercard/Amex
HUF Hungarian Forint Visa/Mastercard
PLN Polish Zloty Visa/Mastercard/Amex
TWD New Taiwan Dollar Visa/Mastercard/Amex
ILS Israeli New Shekel Visa/Mastercard/Amex
INR Indian Rupee Visa/Mastercard
CZK Czech Koruna Visa/Mastercard
ZAR South African Rand Visa/Mastercard/Amex
ARS Argentine Peso Visa/Mastercard
BRL Brazilian Real Visa/Mastercard
BGN Bulgaria Leva Visa/Mastercard/Amex
HRK Croatia Kuna Visa/Mastercard/Amex
RON Romania New Lei Visa/Mastercard/Amex
UAH Ukraine Hryvnia Visa/Mastercard/Amex
RSD Serbia Dinar Visa/Mastercard/Amex
RUB Russia Ruble Visa/Mastercard/Amex
AED Emirati Dirham Visa/Mastercard/Amex
MAD Moroccan Dirham Visa/Mastercard/Amex
CLP Chilean Peso Visa/Mastercard
COP Colombia Peso Visa/Mastercard
EGP Egypt Pound Visa/Mastercard/Amex
ISK Iceland Kronur Visa/Mastercard/Amex
KZT Kazakhstan Tenge Visa/Mastercard/Amex
MUR Mauritius Rupee Visa/Mastercard
MYR Malaysia Ringgit Visa/Mastercard/Amex
PHP Philippines Peso Visa/Mastercard/Amex
BSD Bahamas Dollar Visa/Mastercard/Amex
IDR Indonesia Rupiah Visa/Mastercard/Amex
QAR Qatar Rial Visa/Mastercard/Amex
VND Vietnam Dong Visa/Mastercard/Amex

Back To Top

Supported Languages

Supported Languages

On endpoints that support the LanguageCode parameter, use these codes to return data in the specified language. All other language codes will return data in English.

en English (default)
fr French
de German
es Spanish
nl Dutch
it Italian
pt Portuguese (Portuguese)
br Portuguese (Brazilian)
pl Polish
zh Simplified Chinese
hk Traditional Chinese
no Norwegian
fi Finnish
ko Korean
da Danish
sv Swedish
ja Japanese
ar Arabic

Back To Top

Snowplow Tags

MAIN_TRACKER

Add the following JS code to the <head> section on every page of the booking path.

The [partner_id] needs to be replaced with your provided partner_id.

Examples;

/*<![CDATA[*/
;(function(p,l,o,w,i,n,g){if(!p[i]){p.GlobalSnowplowNamespace=p.GlobalSnowplowNamespace||[];
p.GlobalSnowplowNamespace.push(i);p[i]=function(){(p[i].q=p[i].q||[]).push(arguments)
};p[i].q=p[i].q||[];n=l.createElement(o);g=l.getElementsByTagName(o)[0];n.async=1;
n.src=w;g.parentNode.insertBefore(n,g)}}(window,document,"script","//d1fc8wv8zag5ca.cloudfront.net/2.6.1/sp.js","wlt_trk"));
window.analytics||(window.analytics=[]),window.analytics.methods=["identify","track","trackLink","trackForm","trackClick","trackSubmit","page","pageview","ab","alias","ready","group","on","once","off"],window.analytics.factory=function(t){return function(){var a=Array.prototype.slice.call(arguments);return a.unshift(t),window.analytics.push(a),window.analytics}};for(var i=0;i<window.analytics.methods.length;i++){var method=window.analytics.methods[i];window.analytics[method]=window.analytics.factory(method)}window.analytics.load=function(t){var a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src=("https:"===document.location.protocol?"https://":"http://")+"d2dq2ahtl5zl1z.cloudfront.net/analytics.js/v1/"+t+"analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n)},window.analytics.SNIPPET_VERSION="2.0.8",
window.analytics.load("yqa2m7k7yz");
window.wlt_trk("newTracker", "cf", "collector.rentalcover.com", {
appId: "[partner_id]",platform: "web",cookieName: "_wlt_",encodeBase64: false
});
window.wlt_trk('trackPageView');
/*]]>*/

 

Back To Top

BOOKING_CONFIRMATION

Add the following JS code to the <head> section on booking confirmation page, immediately after the main tracker script.

Replace all variables with relevant values.

Examples;

window.wlt_trk('addTrans',
    '[order_id]',
    '[partner_domain]',
    '[order_total]',
    '0',
    '0',
    '[customer_city]',
    '[customer_state]',
    '[customer_country]'
);
window.wlt_trk('addItem',
    '[order_item_id]',
    '[vehicle_code]',
    '[vehicle_name]',
    '[vehicle_supplier]',
    '[item_price]',
    '[quantity]'
);window.wlt_trk('addItem',
    '[order_item_id]',
    '[policy_code]',
    '[policy_name]',
    '[policy_supplier]',
    '[policy_price]',
    '[quantity]'
);window.wlt_trk(['trackTrans']);

Back To Top

QUOTE_REQUEST

Add the following JS code to the <head> section on search results page, immediately after the main tracker script.

Replace [from_location], [to_location], [from_date], [to_date], and [customer_age] with the relevant information.

Example;

window.wlt_trk('trackStructEvent','quote','quote_step_1','[from_location] to [to_location]','[from_date] to [to_date]','[cover_opt]');

 

Back To Top

SEARCH_RESULTS

Add the following JS code to the <head> section on search results page, immediately after the main tracker script.

Replace [from_location], [to_location], [from_date], [to_date], and [customer_age] with the relevant information.

Examples;

window.wlt_trk('trackStructEvent','search','car_search','[from_location] to [to_location]','[from_date] to [to_date]','[customer_age]');

 

Back To Top

USER_TRACKING

Add the following JS code to the <head> section on any RentalCover.com integrated page where the user_id is known, i.e. if they are logged in, immediately after script (1)

The [user_id] needs to be replaced with your provided user_id.

Examples;

window.wlt_trk('setUserId', '[user_id]');

 

Back To Top

Non-API Functions

Non-API Functions

This is a quick solution for implementing on your My Bookings page if a customer did not attach RentalCover.com to their booking. Alternatively, some partners add a widget into the “My Bookings” front end that utilises the API. It can also be used by Meta Search sites and other affiliates.

Back To Top

Custom URL Pre-Populate Function

It is possible to pre-populate the RentalCover.com home page form fields by passing in the following optional request parameters. If all fields are included the form will submit.

Request Parameters
FromDate date [yyyy-mm-dd]
ToDatedate [yyyy-mm-dd]
Age integer
FirstName string
LastName string
Phone string
Emailstring (urlencoded)
CountryOfTravelCode string
CustomerCountryCode string

Back To Top

Powered by RentalCover.com Logo

he Powered By RentalCover.com logo and associated tracking code should be placed on the quote page where you would normally offer excess reduction to the user.

Here is how the logo will appear:

Powered by RentalCover.com

Examples:

<a href="http://www.rentalcover.com/?utm_source=[partner_id]&utm_medium=rc_logo&utm_campaign=rc_logo" target="_blank">
<img src="http://www.rentalcover.com/themes/carrental/img/powered-by-rc-oval.png" /></a>
<script type="text/javascript">
window.wlt_trk('trackStructEvent','rc_logo','impression','powered-by-rc-oval.png','','');
</script>

Back To Top

Promotional Buttons

The following buttons and HTML are for adding RentalCover.com links within content and booking path pages.

Save 50% Off Insurance

“Save 50% Off Insurance” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr1.png" border="" alt="Save 50% Off Insurance"></a>

 

Save 50% on Cover for Rental Vehicles

“Save 50% on Cover for Rental Vehicles” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr2.png" border="" alt="Save 50% on Cover for Rental Vehicles"></a>

Don't get stuck with a $5,000 bill

“Don’t get stuck with a $5,000 bill” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr3.png" border="" alt="Don't get stuck with a $5,000 bill"></a>

Save $30 per day on Rental Vehicle Cover

“Save $30 per day on Rental Vehicle Cover” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr4.png" border="" alt="Save $30 per day on Rental Vehicle Cover"></a>

Why Pay $35 per day for Excess Reduction

“Why Pay $35 per day for Excess Reduction” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr5.png" border="" alt="Why Pay $35 per day for Excess Reduction"></a>

Save 50% off InsurancePowered by RentalCover.com

“Save 50% off Insurance” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_button&utm_campaign=rc_button"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rr6.png" border="" alt="Save 50% Off Insurance"></a>

“Powered by RentalCover.com” button:

<a href="http://www.rentalcover.com/?FromDate=[FromDate]&ToDate=[ToDate]&Age=[Age]&Email=[Email]&FirstName=[FirstName]&LastName=[LastName]&Phone=[Phone]&CountryOfTravelCode=[CountryOfTravelCode]&CustomerCountryCode=[CustomerCountryCode]&utm_source=[partner_id]&utm_medium=rc_logo&utm_campaign=rc_logo"><img src="//s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/rc-button.png" border="" alt="Powered By RentalCover.com"></a>

 

Back To Top

Errors

Errors

RentalCover.com uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted, a charge failed etc.), and codes in the 5xx range indicate an error with RentalCover.com’s servers (you should contact us if you receive these errors).

  • Validation or bad request errors will return a HTTP 400 response with a description of the error.
  • General errors will return a HTTP 400 response with a description of the error. See below for the general errors of each endpoint.
  • Server exceptions will return a HTTP 500 response with the message “Unexpected internal error”. You should contact us if you receive this error.
  • Invalid or missing API key will return a HTTP 401 response.
  • Invalid endpoints will return a HTTP 404 response.

The RentalCover.com API uses the following error codes:

Error Code Meaning
400 Bad Request
401 Unauthorized
500 Internal Server Error

Back To Top

Release Notes

V2.2.10: Vehicle types added to API

Vehicle types options are added to the APIs.

Quote and Update endpoints will make use of these options. Here are the vehicle types:

  • car
  • motorhome
  • campervan
  • 4x4
  • minibus
  • lighttruck
  • bus

Back To Top

V2.2.8: Live with arabic languages

Live with Arabic language for APIs and website.

Back To Top

V2.2.7: SpecialMessage for CDW policies

Special Messaging has been added for CDW policies which says “For NY State billing address the price will be $9 per day”.

Back To Top

V2.2.6: Release Date TBA

Updates are only saved during Purchase request if additional payment is required
  • All API requests to the Update endpoint will not save the actual update and a status of PartiallyPaid will not be returned
  • The Update response will contain booking information as if the booking was updated however the booking is not updated until a Purchase request is made.
  • An exception to this is when an Update request is made that results in a refund or no additional funds required (i.e. no Purchase request is required), in this case the booking details will be saved as part of the Update request.

Back To Top

V2.2.5: Release Date 06-April-2016

Added support for tokens during modification

We have added support for tokens during modification so that the Update endpoint does not have to use the credit card details.

Back To Top

V2.2.4: Release Date 11-March-2016

Added support for new languages

We have added support for new languages. New languages added are as below:

sv Swedish
ja Japanese

Please refer to the full list of supported languages.

Back To Top

V2.2.3: Release Date 26-Feb-2016

Added support for new languages

We have added support for new languages. New languages added are as below:

zh Simplified Chinese
hk Traditional Chinese
no Norwegian
fi Finnish
ko Korean
da Danish

Please refer to the full list of supported languages.

Back To Top

V2.2.2: Release Date 17-Feb-2016

Update Logo to use HTTPS instead of HTTP

We have changed the URL for logos. They will use HTTPS instead of HTTP in the URL from here onwards. Please refer to the Content, Quote and Purchase responses.

Back To Top

V2.2: Release Date 11-Feb-2016

Content endpoint for CDW policy type

The Content endpoint for CDW policy type has some additional fields as compared to the Content endpoint for roadside assistance. Below are the additional fields. The same fields with an example response are also updated in the API reference.

  • AcceptCover
  • BookButton1With
  • BookButton1Without
  • RefuseCover
  • InsurerLogo
  • CheckboxImage
CDW policy implementation with RoadSideAssistanceCoverOption

This is a new policy type that has to be implemented for all CDW policies. At this stage, testing can be carried out in staging using the below example requests. To use production, please replace the URL http://api.staging.rentalcover.com/insurances/quote into https://api.rentalcover.com/insurances/quote.

We will shortly incorporate Roadside Assistance Cover (RAC) as an additional option that can be attached to a CDW Policy request via the API. To add RAC to CDW, the following attribute has to be added to the API request which can take 2 possible values (true or false):

"RoadSideAssistanceCoverOption" : "1" / "0"

As of now, you can start using the default option "RoadSideAssistanceCoverOption" : "0" in the Quote API request which can be later switched to "1" after we incorporate the RAC to CDW.

Example
{
"PartnerContent": {
"AcceptCover": "Yes, I'd like to purchase Collision Damage Coverage - Domestic USA Testing for US$12.00 per day.",
"BookButton1With": "Reserve My Rental Car",
"BookButton1Without": "Reserve My Rental Car",
"RefuseCover": "No, thanks.",
},
"InsurerLogo": "https://s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/suppliers/aonLogo.png",
"Policy": {
"CheckboxImage": "https://s3-ap-southeast-2.amazonaws.com/rentalcover-data/img/checkbox.png"
}
}

Back To Top

V2.1.8: Release Date 08-Dec-2015

Added MobileShortDescription response field

Content endpoint, comparison module response.

Back To Top

V2.1.7: Release Date 07-Dec-2015

Support for PartnerSite

Quote endpoint that allows all of a partner’s sites to be represented in confirmation emails.

Back To Top

V2.1.6: Release Date 03-Dec-2015

Support for VehicleRentalGross

Added new field for VehicleRentalGross in Quote Request/Purchase Request. Allows RentalCover.com to optimise based on basket value rather than insurance value including extras such as baby seats, GPS, etc.

Back To Top

V2.1.5: Release Date 23-Nov-2015

Support for additional currencies
Currency Credit Card Types
COP Colombia Peso Visa/Mastercard
EGP Egypt Pound Visa/Mastercard/Amex
ISK Iceland Kronur Visa/Mastercard/Amex
KZT Kazakhstan Tenge Visa/Mastercard/Amex
MUR Mauritius Rupee Visa/Mastercard
MYR Malaysia Ringgit Visa/Mastercard/Amex
PHP Philippines Peso Visa/Mastercard/Amex
BSD Bahamas Dollar Visa/Mastercard/Amex
IDR Indonesia Rupiah Visa/Mastercard/Amex
QAR Qatar Rial Visa/Mastercard/Amex
VND Vietnam Dong Visa/Mastercard/Amex

Back To Top

V2.1.4: Release Date 04-Nov-2015

Changes to the Content endpoint
  • Partner specific fields:
    Please see the API reference for more information. Note that the PartnerContent property can contain many field names and descriptions that are specific to each partner, please contact your account manager to obtain the list of possible fields.
  • Disclaimer and Short Description added to the Inclusions Content API

Back To Top

V2.1.3: Release Date 28-Oct-2015

Customer IP address in Quote requests

Customer IP address can be now passed as a parameter in the Quote endpoint. The optional string parameter UserIPAddress can be sent in the Quote request to allow RentalCover.com to save the customer IP address.

Cancellation Reason in Cancellation requests

Cancellation of an insurance policy can be done by hitting a Cancellation endpoint with the unique reference number of the policy. Now another POSTrequest for cancellations is available. The POST requests allows the caller to pass in a reason for cancellation in the request.

Support for additional currencies

Now added support for more currencies as shown in table below:

Currency Credit Card Types
ARS Argentine Peso Visa/Mastercard
BRL Brazilian Real Visa/Mastercard
BGN Bulgaria Leva Visa/Mastercard/Amex
HRK Croatia Kuna Visa/Mastercard/Amex
RON Romania New Lei Visa/Mastercard/Amex
UAH Ukraine Hryvnia Visa/Mastercard/Amex
RSD Serbia Dinar Visa/Mastercard/Amex
RUB Russia Ruble Visa/Mastercard/Amex
AED Emirati Dirham Visa/Mastercard/Amex
MAD Moroccan Dirham Visa/Mastercard/Amex
CLP Chilean Peso Visa/Mastercard
Changes to the Content API

Changes to the Content endpoint include the following logic:

  • if LDWIncluded = true, then TheftIncluded = dont_show
  • if LDWIncluded = false, then TheftIncluded = true

Back To Top

v2.1: Release Date 07-Sep-2015

Multi-Currency API support

The Quote endpoint now accepts an optional Currency parameter. If passed, the Quote response will be generated and returned in the requested currency. All subsequent actions relating to this quote will be in that currency (i.e. Purchase, Update, Cancel).

Possible currency codes and currencies are:

Currency Credit Card Types
AUD Australian Dollar Visa/Mastercard/Amex
USD US Dollar Visa/Mastercard/Amex
EUR Euro Visa/Mastercard/Amex
NZD New Zealand Dollar Visa/Mastercard/Amex
GBP UK Pound Visa/Mastercard/Amex

 

Specifying the Currency parameter while using the Quote endpoint will ensure that all of the following are in the specified currency:

  1. Policy pricing calculation including daily rates, minimum extension daily price, cover amount upgrade fee and cover amount increment fee.
  2. All currency amounts within the policy text of the policy document such as the Cover Amount, Free Gap Cover Amount, and Excess.
  3. All currency amounts in the email templates
  4. All amounts in the Invoice / Certificate of Insurance (COI)

If the Currency parameter is ignored the base currency of a policy will be used as default. This will ensure that the current API requests are still processed properly and no errors responses are generated.

Steps to implement multi-currency:

Backend:

  • Add the Currency parameter to the API request while requesting quotes. As an example, if a customer is requesting the NZD then pass Currency=NZD in the Quote request. This will ensure that all values in the response will be in NZD.

Frontend:

  • Ensure that the values are displayed in the correct format and currency.
Language Support

RentalCover.com APIs support multiple languages. The API does not use ISO codes. Please map your languages to those shown in the table below.

en English (default)
fr French
de German
zh Chinese – simplified
hk Chinese – traditional
es Spanish
nl Dutch
it Italian
pt Portuguese (Portuguese)
br Portuguese (Brazilian)
he Hebrew
pl Polish

 

Known Issues:

  • The Policy Disclosure Statement (PDS) is being returned in English.
    Fix Date: W/B 16-Sep-15

Back To Top

V2.1.1: Release Date 28-Sep-2015

Support for additional currencies

Additional currencies are now supported through the API. Find the list of currencies that are supported in the table below. The table has an additional entry that lists the credit card type supported for each of the currencies.

Currency Credit Card Types
AUD Australian Dollar Visa/Mastercard/Amex
GBP British Pound Visa/Mastercard/Amex
USD US Dollar Visa/Mastercard/Amex
NZD New Zealand Dollar Visa/Mastercard/Amex
EUR Euro Visa/Mastercard/Amex
CHF Swiss Franc Visa/Mastercard/Amex
CNY Chinese Yuan Visa/Mastercard/Amex
JPY Japanese Yen Visa/Mastercard/Amex
SGD Singapore Dollar Visa/Mastercard/Amex
CAD Canadian Dollar Visa/Mastercard/Amex
DKK Danish Kroner Visa/Mastercard/Amex
KRW Korean Won Visa/Mastercard/Amex
SAR Saudi Arabian Riyal Visa/Mastercard/Amex
SEK Swedish Krona Visa/Mastercard/Amex
MXN Mexican Peso Visa/Mastercard
HKD Hong Kong Dollar Visa/Mastercard/Amex
NOK Norway Kroner Visa/Mastercard/Amex
THB Thai Baht Visa/Mastercard/Amex
TRY Turkish Lira Visa/Mastercard/Amex
HUF Hungarian Forint Visa/Mastercard
PLN Polish Zloty Visa/Mastercard/Amex
TWD New Taiwan Dollar Visa/Mastercard/Amex
ILS Israeli New Shekel Visa/Mastercard/Amex
INR Indian Rupee Visa/Mastercard
CZK Czech Koruna Visa/Mastercard
ZAR South African Rand

Back To Top

V2.1.2: Release Date 09-Oct-2015

Dynamic generation of Product Disclosure Statement (PDS)

PDS is now generated dynamically. This means the PDS links sent out to customers via email will use the language and currency specified during purchase. This change does not require any change to the APIs.

Back To Top