Cancel A Booking

The cancellation request takes the following form.

Request

Parameters

Name Type Description
LoginDetails object See the Login section.
BookingReference string Required.
Reason string Required.

 

<?xml version="1.0" encoding="UTF-8"?>
<CancelRequest>
  <LoginDetails>
    <Login>xmltest</Login>
    <Password>xmltest</Password>
    <Version>6.0</Version>
  </LoginDetails>
  <BookingReference>2042284</BookingReference>
  <Reason>Example reason text.</Reason>
</CancelRequest>

Response

Parameters

Name Type Description
RequestInfo RequestInfo See the Request section.
ReturnStatus ReturnStatus See the ReturnStatus section.
BookingDetails object  
   BookingReference string  
   Status string  
   CancellationReason string The original reason given with the cancellation request; may be wrapped/prefixed with additional info.
   Amount decimal Any amount due as a result of cancellation penalty.
   Currency string Three letter ISO 4217 currency code.
   DueDate date string Not returned when Amount is zero. Depreciated and may not be returned.

 

<?xml version="1.0" encoding="UTF-8"?>
<CancelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ReturnStatus>
    <Success>True</Success>
    <Exception />
  </ReturnStatus>
  <BookingDetails>
    <BookingReference>2042284</BookingReference>
    <Status>Cancelled</Status>
    <CancellationReason>Example reason text.</CancellationReason>
    <Amount>123.45</Amount>
    <Currency>USD</Currency>
    <DueDate>2022-06-27</DueDate>
  </BookingDetails>
</CancelResponse>