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.
{
"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 & 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'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 "reduced" excess). You do not need the supplier's excess reduction (collision damage waiver), instead you pay the supplier for repairs and claim that "excess cost" 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'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 & 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 & you will pay NMC whilst on the call.</li> <li>You will meet the tow truck & go to the delivery point with them.</li> <li>Claim all the costs that you incurred via <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 <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":"[email protected]",
"Age":21,
"Country":"AU"
}
}{
"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 & 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'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 "reduced" excess). You do not need the supplier's excess reduction (collision damage waiver), instead you pay the supplier for repairs and claim that "excess cost" 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'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 & 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 & you will pay NMC whilst on the call.</li> <li>You will meet the tow truck & go to the delivery point with them.</li> <li>Claim all the costs that you incurred via <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 <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":"[email protected]",
"Age":21,
"Country":"AU"
}
}
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 (50 character limit)
Address2 string
Customer street address line 2 (50 character limit)
City string
Customer suburb
PostalCode string
Customer postcode or zip code
Phone string
Customer phone
OtherEmail string
Customer other email
Region string
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 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
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.
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
