# 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. **Endpoint:** `/insurances/purchase` **Method:** `POST` **Optional Endpoint:**`/insurances/purchase/` {% hint style="info" %} Optional Endpoint is to be used if `AgentReference` is your reference, in this case the Policy reference is passed within the URL. {% endhint %} {% tabs %} {% tab title="POST /insurances/purchase" %} ```perl 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 ``` {% endtab %} {% tab title="Response" %} ```graphql { "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 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":"
  • 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>
  • 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>As with all other RentalCover.com policies, this policy includes the following which are typically excluded by the rental companies:
  • Windscreen, tyre, roof & underbody repairs.<\/li>
  • Single vehicle accidents.<\/li>
  • Hitting an animal.<\/li>
  • Accidents after dusk.<\/li>
  • Weather-related and water damage.<\/li>
  • Key loss\/replacement.<\/li>
  • Additional drivers that are nominated on the rental agreement<\/li>
  • Demurrage (the supplier's lost rental while a vehicle is off the road for repairs).<\/li>
  • Maximum claim: $3500.<\/li>
  • Claim Fee: $0<\/li>
  • Cost: Free with any RentalCover.com purchase!<\/li>Exclusions:This cover does not cover the following events:
  • Does not cover damages sustained while driving on unsealed roads.<\/li>
  • Does not cover damage caused where the terms of Rental Contract have been breached.<\/li>
  • Does not cover damage caused by an event that leads to a police investigation.<\/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>
  • Does not cover damage caused due to use of incorrect or contaminated fuel.<\/li>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":"
  • No exclusions!<\/li>
  • Includes $3500 Free Gap Cover, free with any RentalCover.com purchase.<\/li>
  • Includes single vehicle accidents<\/li>
  • Includes windscreens & tyre damage<\/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...
  • 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;
  • Call NMC (see above). You will need your RentalCover.com reference number (AB12-345C-INS).
  • NMC will send a tow truck & you will pay NMC whilst on the call.
  • You will meet the tow truck & go to the delivery point with them.
  • Claim all the costs that you incurred via rentalcover.com/claims. Our goal is to reimburse you within 7 days.
    • 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 rentalcover.com/claims.", "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" } }{ "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 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":"
  • 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>
  • 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>As with all other RentalCover.com policies, this policy includes the following which are typically excluded by the rental companies:
  • Windscreen, tyre, roof & underbody repairs.<\/li>
  • Single vehicle accidents.<\/li>
  • Hitting an animal.<\/li>
  • Accidents after dusk.<\/li>
  • Weather-related and water damage.<\/li>
  • Key loss\/replacement.<\/li>
  • Additional drivers that are nominated on the rental agreement<\/li>
  • Demurrage (the supplier's lost rental while a vehicle is off the road for repairs).<\/li>
  • Maximum claim: $3500.<\/li>
  • Claim Fee: $0<\/li>
  • Cost: Free with any RentalCover.com purchase!<\/li>Exclusions:This cover does not cover the following events:
  • Does not cover damages sustained while driving on unsealed roads.<\/li>
  • Does not cover damage caused where the terms of Rental Contract have been breached.<\/li>
  • Does not cover damage caused by an event that leads to a police investigation.<\/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>
  • Does not cover damage caused due to use of incorrect or contaminated fuel.<\/li>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":"
  • No exclusions!<\/li>
  • Includes $3500 Free Gap Cover, free with any RentalCover.com purchase.<\/li>
  • Includes single vehicle accidents<\/li>
  • Includes windscreens & tyre damage<\/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...
  • 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;
  • Call NMC (see above). You will need your RentalCover.com reference number (AB12-345C-INS).
  • NMC will send a tow truck & you will pay NMC whilst on the call.
  • You will meet the tow truck & go to the delivery point with them.
  • Claim all the costs that you incurred via rentalcover.com/claims. Our goal is to reimburse you within 7 days.
    • 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 rentalcover.com/claims.", "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" } } ``` {% endtab %} {% endtabs %} ## **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` (50 character limit) | | `City` string **required** | Customer city. IF UNKNOWN: Include a default | | `PostalCode` string **required** | Customer postcode or zip code. IF UNKNOWN: Include a default | | `XPayCustomerToken`string after Quote Request and XPay tokenization | XPay Token ID generated from XPay tokenization workflow. More info [here](https://docs.covergenius.com/xpay-api-partner-docs/tokenization). | | `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 (50 character limit) | | `Region` string | The customer's state, region or territory, this is a 2 or 3-letter code. See [supported regions](/rentalcover/supported-regions.md). | | `Phone` string | Customer phone (mobile preferred, ; format: `+61413333333`) | | `OtherEmail` string | Secondary email | | `LanguageCode` string \[2] | default is `en` Preferred language code. | | `CoverAmount` float | The required amount of cover | | `PolicyPrice` float | Price of partner policy (if partner sets price). If < RC policy then partner price will be used. | | `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.

    | | `PartnerCollectingPayment` boolean | Indicates whether the partner is collecting the payment. If `PartnerCollectingPayment` = true, 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 | See [booking statuses](/rentalcover/endpoints/status.md#booking-statuses). | | `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 | | `Commission.TotalCommission` string | Total commission for the partner | | `Commission.TotalCommissionFormatted` string | Total commission for the partner, including currency formatting. | | `SettlementCurrencyObject.SettlementCurrency` string | Three character settlement currency of the booking. | | `SettlementCurrencyObject. SettlementAmount` float | Total amount customer must pay for the policy, in the settlement currency rate (already includes discounts and markups) | | `SettlementCurrencyObject. SettlementAmountFormatted` string | Formatted version of the Settlement Amount. | | `SettlementCurrencyObject. Commission.SettlementCommission` float | Total commission for the partner, in the settlement currency rate | | `SettlementCurrencyObject. Commission.SettlementCommissionFormatted` string | Formatted version of the SettlementCommission | ## --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://partner-docs.covergenius.com/rentalcover/endpoints/purchase.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.