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 | The customer's state, region or territory, this is a 2 or 3-letter code. See supported regions. |
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 | 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. |
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,busExample: car,motorhome,bus |
Additional user-defined data, provided as a valid JSON object or JSON string. This field allows clients to send supplementary information relevant to their specific use case. The structure and content of this object are entirely determined by the client. | |
| "securitytoken": "39456fdhUIHIUH", |