Skip to content

Hotel Cancellation

After complete the booking then if user needs to cancel a Hotel then it has to follow below process.

Hotel cancellation flow there are 2 section as given below.

  • Get cancellation charge
  • Cancel the Hotel Booking

Before canceling the booking cancellation charges can be viewed from the cancellation charges response.

Refer below table to refer the suppliers who support each scenario.

Supplier Support get
cancellation charge		 Support
cancellation
Hotelbeds YES YES
DOTW YES YES
LOH YES YES
Rezlive NO YES
TBO Holidays NO YES
TBO India NO YES
Yalago YES YES
Nitvana NOW YES YES
MMT NO YES
Yatra NO YES

Both Get-cancellation-charge and Hotel-cancellation will be used same API call by mentioning action in the command attribute.

Note:
Few attributes in below sample response are supplier specific, hence there can be possibility these attributes will not appear in the response. We recommend you to parse these fields as mentioned in the sample responses.

Get cancellation charge

api/v1/reservation/hotel-cancel
Tags Attribute Description
HotelCancellationCriteria (JsonObject)
command*
(String)		 Command should be "cancellationCharges" to get cancellation charges
bookingReferenceId*
(String)		 Unique Key for the booking
hotel cancellation charge request
1
2
3
4
{
    "command": "cancellationCharges",
    "bookingReferenceId": "BKR-2022-004045"
}
Tags Attribute Description
HotelCancellationChargesResponse (JsonObject)
bookingReferenceId*
(String)		 Unique Key for the booking
command*
(String)		 the command returns as "cancellationCharges" on the cancellation charges response
bookingStatus*
(String)		 The status of the booking
currency* Applicable currency for cancellation charges
cancellationCharge (JsonObject) Applicable currency for cancellation charges
supplierCancellationCharge *
(Double)		 Supplier cancellation charge amount
adminCancellationCharge *
(Double)		 Admin cancellation charge amount
totalCancellationCharges *
(Double)		 Total cancellation charges
hotel cancellation charge response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "meta": {
    "success": true,
    "statusCode": "",
    "statusMessage": "",
    "actionType": "",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
  },
  "warnings": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Check In Time' can't be blank",
      "value": "Check In Time might be changed"
    }
  ],
  "errors": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Field 'bookingReferenceId' can't be blank",
      "value": "Field 'bookingReferenceId' can't be blank",
      "source": {
        "field": "bookingReferenceId",
        "pointer": "/BookingCancelCriteria/bookingReferenceId"
      },
      "title": "Required field",
      "type": "validation_error"
    }
  ],
  "commonData": {
    "searchKey": "string",
    "productCode": "string",
    "culture": "string"
  },
  "data": {
    "bookingReferenceId": "bkr-2019-09421",
    "command": "cancel",
    "bookingStatus": "cancelled",
    "transactionId": "80136",
    "currency": "INR",
    "cancellationCharge": [
      {
        "supplierCancellationCharge": 9177.0,
        "adminCancellationCharge": 723.0,
        "totalCancellationCharges": 9900.0,
      }
    ]
  }
}



Hotel cancellation

api/v1/reservation/hotel-cancel
Tags Attribute Description
HotelCancellationCriteria (JsonObject)
command*
(String)		 The command should be 'cancel' to perform the hotel cancellation
bookingReferenceId*
(String)		 Unique Key for tje booking
hotel cancellation request
1
2
3
4
{
    "command": "cancel",
    "bookingReferenceId": "BKR-2022-004045"
}
Tags Attribute Description
HotelCancellationResponse (JsonObject)
bookingReferenceId*
(String)		 Unique Key for the booking
command*
(String)		 the command should be "cancel" in order to cancel a booking
bookingStatus*
(String)		 The status of the booking
currency* Applicable currency for cancellation charges
cancellationCharge (JsonObject) Applicable currency for cancellation charges
supplierCancellationCharge *
(Double)		 Supplier cancellation charge amount
adminCancellationCharge *
(Double)		 Admin cancellation charge amount
totalCancellationCharges *
(Double)		 Total cancellation charges
hotel cancellation response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "meta": {
    "success": true,
    "statusCode": "",
    "statusMessage": "",
    "actionType": "",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
  },
  "warnings": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Check In Time' can't be blank",
      "value": "Check In Time might be changed"
    }
  ],
  "errors": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Field 'bookingReferenceId' can't be blank",
      "value": "Field 'bookingReferenceId' can't be blank",
      "source": {
        "field": "bookingReferenceId",
        "pointer": "/BookingCancelCriteria/bookingReferenceId"
      },
      "title": "Required field",
      "type": "validation_error"
    }
  ],
  "commonData": {
    "searchKey": "string",
    "productCode": "string",
    "culture": "string"
  },
  "data": {
    "bookingReferenceId": "BKR-2022-005590",
    "command": "cancel",
    "bookingStatus": "cancelled",
    "transactionId": "80136",
    "currency": "INR",
    "cancellationCharge": [
      {
        "supplierCancellationCharge": 9177.0,
        "adminCancellationCharge": 723.0,
        "totalCancellationCharges": 9900.0,
      }
    ]
  }
}