BookingCancel
BookingCancel operation allows the cancellation of a booking made with Stuba. The operation will calculate any applicable cancellation charges and confirm the chargeable amount that will be invoiced. Cancellation of a booking will cancel all rooms confirmed under the Stuba Booking ID provided in your request.
BookingCancel Request Syntax
Request Header
POST /BookingCancel
Content-Type: “application/json”
AuthApiKey: <Your Auth API Key>
Accept-Encoding: “gzip,br”
Request Body Schema
| Field Name | Data Type | Description |
|---|---|---|
|
BookingId |
Integer |
Numeric Id for the booking to cancel |
Response Body Schema
| Field Name | Data Type | Description |
|---|---|---|
|
Currency |
String |
Currency code for the booking (e.g., “EUR”). |
|
CommitLevel |
String |
Indicates the commit level with which the cancellation was performed |
|
Booking |
Object |
Contains details of the booking. |
|
Id |
String |
Unique identifier for the booking. |
|
CreationDate |
Date |
Date when the booking was created. (YYYY-MM-DD) |
|
HotelBooking
|
Array of Object |
List of hotel bookings within this booking. |
|
Id |
String |
Unique identifier for this specific hotel booking. |
|
Price |
Float |
Total price for this hotel booking. |
|
Status |
String |
Status of the hotel booking (e.g., “cancelled”). |
|
Room |
Object |
Details of the room associated with this booking. |
|
Price |
Float |
Price of the room. |
|
Status |
String |
Status of the room (e.g., “cancelled”). |
|
CanxFees |
Array of Object |
List of cancellation fees associated with this room. |
|
From |
Date |
Date from which the cancellation fee applies. (YYYY-MM-DD) |
|
Amount |
Float |
Amount of the cancellation fee. |
|
Charges (0 or more) |
Array of Object |
A list of any cancellation charges that have been applied at the time of booking cancellation. |
|
id |
String |
A unique ID for the applicable cancellation charge. |
|
CreationDate |
String |
Date when the cancellation charge was applied. (YYYY-MM-DD) |
|
Price |
Float |
Total price for this applied cancellation charge. |
|
AssociatedItemId |
String |
The Hotel Booking Id where cancellation charges have been applied. |
HAPI Response Samples
Samples