Cancellation Event

Sample Booking Cancellation Request Payload

POST

curl --location '[your_server_endpoint]' --header 'Content-Type: application/json' --header 'X-Signature: [shared_secret]' --data-raw '[request_payload]'

Expected Response

{"Status" : "Received"}

Here is an example of a request payload:

{
  "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

Field	Type	Description
Event	string	Event type
Bookings	array	Array of bookings. This array can contain multiple bookings if the booking is a bundled booking
Bookings.Booking.BookingId	string	Internal ID of the booking
Bookings.Booking.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 the purchase and cancel requests.
Bookings.Booking.Type	string	Type of the Policy
Bookings.Booking.Code	string	Policy code
Bookings.Booking.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).
Bookings.Booking.MetaData	json string	This is the MetaData passed in quote/purchase request
Status	string	See booking statuses.
Currency	string	Three character currency of the booking.
TotalAmount	float	Total amount customer is to pay for the policy (already includes discounts and markups)
TotalAmountFormatted	string	Total amount customer must pay for the policy (already includes discounts and markups). Includes currency formatting.
PartnerSiteCode	string
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
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.
FromDate	datetime	Start date/time of booking
ToDate	datetime	End date/time of booking
CancelledOn	datetime	Cancel date/time of booking
Source	string	The source of the booking like Frontend, Backend, Api
CancelReason	string	The cancel reason

Expected Response