# Cancellation Event

#### Sample Booking Cancellation Request Payload

{% tabs %}
{% tab title="POST" %}
curl --location '\[your\_server\_endpoint]'\
\--header 'Content-Type: application/json'\
\--header 'X-Signature: \[shared\_secret]'\
\--data-raw '\[request\_payload]'
{% endtab %}

{% tab title="Expected Response" %}
{"Status" : "Received"}
{% endtab %}
{% endtabs %}

Here is an example of a request payload:

```json
{
  "Event": "BOOKING_CANCELLED",
  "Bookings":[{
    "BookingId":"12345"
    "Reference":"AB12-345C-INS"
    "Type":"FullProtection"
    "Code":"FULLPROTECTION11",
    "SupplierReference": "CXCSUK8F7C0U",
    "MetaData": "{\"provider_id\":\"COVERGENIUSCARSWHISKY\",\"kayak_click_id\":\"jPUXmEez5KHES08hs1vbQQ\"}"
  },
  {
    "BookingId":"12346"
    "Reference":"CD12-345C-INS"
    "Type":"ExpressBagges"
    "Code":"EB HK to ROW Tracking - BRB",
    "SupplierReference": "CRURUK8F7C4U",
    "MetaData": "{\"provider_id\":\"COVERGENIUSCARSWHISKY\",\"kayak_click_id\":\"jPUXmEez5KHES08hs1vbQQ\"}"
  } 
  ],
    "Status": "Cancelled",
    "Currency": "USD",
    "TotalAmount": 60,
    "TotalAmountFormatted": "US$0.00",
    "PartnerSiteCode": "affiliate",
    "PartnerReference":"123456",
    "PartnerCollectingPayment": false,
    "FromDate":"2015-03-19 00:00:00",
    "ToDate":"2015-03-22 00:00:00",
    "CancelledOn":"2024-05-01 10:20:25",
    "Source":"Frontend",
    "CancelReason":"I am not taking a car rental at all/my trip has been cancelled"
}
```

### **Request Parameters** <a href="#request-parameters" id="request-parameters"></a>

<table><thead><tr><th>Field</th><th width="125">Type</th><th>Description</th></tr></thead><tbody><tr><td>Event</td><td>string</td><td>Event type</td></tr><tr><td>Bookings</td><td>array</td><td>Array of bookings. This array can contain multiple bookings if the booking is a bundled booking</td></tr><tr><td>Bookings.Booking.BookingId</td><td>string</td><td>Internal ID of the booking</td></tr><tr><td>Bookings.Booking.Reference</td><td>string</td><td>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 the purchase and cancel requests.</td></tr><tr><td>Bookings.Booking.Type</td><td>string</td><td>Type of the Policy</td></tr><tr><td>Bookings.Booking.Code</td><td>string</td><td>Policy code</td></tr><tr><td>Bookings.Booking.SupplierReference</td><td>string</td><td>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).</td></tr><tr><td>Bookings.Booking.MetaData</td><td>json string</td><td>This is the <strong>MetaData</strong> passed in quote/purchase request</td></tr><tr><td>Status</td><td>string</td><td>See <a href="https://docs.covergenius.com/rentalcover/endpoints/status#booking-statuses">booking statuses</a>.</td></tr><tr><td>Currency</td><td>string</td><td>Three character currency of the booking.</td></tr><tr><td>TotalAmount</td><td>float</td><td>Total amount customer is to pay for the policy (already includes discounts and markups)</td></tr><tr><td>TotalAmountFormatted</td><td>string</td><td>Total amount customer must pay for the policy (already includes discounts and markups). Includes currency formatting.</td></tr><tr><td>PartnerSiteCode</td><td>string</td><td></td></tr><tr><td>PartnerReference</td><td>string</td><td>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</td></tr><tr><td>PartnerCollectingPayment</td><td>boolean</td><td>Indicates whether the partner is collecting the payment. If <code>PartnerCollectingPayment</code> = true, you do not need to pass us the credit card details like <code>CardHolder</code>,<code>CardNumber</code>,<code>CardExpiry</code>,<code>CardSecurityCode</code>.</td></tr><tr><td>FromDate</td><td>datetime</td><td>Start date/time of booking</td></tr><tr><td>ToDate</td><td>datetime</td><td>End date/time of booking</td></tr><tr><td>CancelledOn</td><td>datetime</td><td>Cancel date/time of booking</td></tr><tr><td>Source</td><td>string</td><td>The source of the booking like Frontend, Backend, Api</td></tr><tr><td>CancelReason</td><td>string</td><td>The cancel reason</td></tr></tbody></table>

**Expected Response**\\


---

# 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/webhook/events/cancellation-event.md?ask=<question>
```

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.