Bookings

Cancel a booking

post/v2/bookings/cancel

Request

  • Base URL: https://provider-api-sandbox.holidu.com
  • URL: https://provider-api-sandbox.holidu.com/v2/bookings/cancel
  • Auth: API key in header api-key

Query parameters

providerstring
providerBookingIdstring

Provider booking id. Either this or holiduBookingId is required.

holiduBookingIdinteger

Holidu booking id. Either this or providerBookingId is required.

cancellationFeenumber
reason'PROVIDER_NO_PAYMENT' | 'PROVIDER_OVERBOOKED' | 'CUSTOMER_WRONG_PRICE' | 'CUSTOMER_WRONG_FACILITIES' | 'CUSTOMER_UNKNOWN_REASON' | 'CUSTOMER_REBOOKING' | 'CUSTOMER_PERSONAL' | 'CUSTOMER_ALTERNATIVE_HOLIDU_PRICE' | 'CUSTOMER_ALTERNATIVE_HOLIDU_LOCATION' | 'CUSTOMER_ALTERNATIVE_HOLIDU_OTHER' | 'CUSTOMER_ALTERNATIVE_ELSEWHERE_PRICE' | 'CUSTOMER_ALTERNATIVE_ELSEWHERE_LOCATION' | 'CUSTOMER_ALTERNATIVE_ELSEWHERE_OTHER' | 'CUSTOMER_TRAVEL_RESTRICTIONS_VISA' | 'CUSTOMER_TRAVEL_RESTRICTIONS_COVID' | 'CUSTOMER_TRAVEL_RESTRICTIONS_OTHER' | 'CUSTOMER_PROVIDER_REQUEST_BOOK_ELSEWHERE' | 'CUSTOMER_PROVIDER_REQUEST_AVAILABILITY' | 'CUSTOMER_PROVIDER_REQUEST_OTHER' | 'CUSTOMER_PROPERTY_QUALITY' | 'CUSTOMER_OTHER' | 'HOLIDU_TEST_BOOKING' | 'HOLIDU_NO_PAYMENT' required

Response

The booking was cancelled

cancellationStatus'ALREADY_CANCELLED' | 'CANCELLATION_SUCCESSFUL' | 'BOOKING_DELETED'

Status of the cancellation request

Example response

{
  "cancellationStatus": "CANCELLATION_SUCCESSFUL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.