BookingConfirm
The BookingConfirm operation is a mandatory step that accepts a Quote ID obtained from a RegionSearch or HotelSearch operation.
When you send a BookingConfirm request, you will receive a full Booking Response. The booking with the selected hotel is finalized once the BookingConfirm request is successfully processed.
The response time for this operation is 120 seconds or less.
The following rules apply when specifying the request:
- Finalises the booking for the Quote Id included in your request
- The timeout for this operation is 120 seconds
BookingConfirm Syntax
Request Header
POST /BookingConfirm
Content-Type: “application/json”
AuthApiKey: <Your Auth API key>
Accept-Encoding: “gzip,br”
Request Body Schema
| Field Name | Data Type | Description |
|---|---|---|
|
QuoteId |
String |
A unique identifier for the quote (e.g., “979740232-23”). |
|
AgentReference (Optional) |
String |
A custom reference that will be added to the booking and is exposed in booking elements. |
|
Room |
Array |
A list of rooms with their details (e.g., one room with adult and child). |
|
Adult |
Array |
A list of adults in the room. |
|
title |
String |
The title of the adult (e.g., “Mr”). |
|
first |
String |
The first name of the adult (e.g., “Rohit”). |
|
last |
String |
The last name of the adult (e.g., “WavhalTest”). |
|
Child |
Array |
A list of children in the room. |
|
Age |
Integer |
The age of the child (e.g., 3). |
|
title |
String |
The title of the child (e.g., “Mstr”). |
|
first |
String |
The first name of the child (e.g., “Rohit”). |
|
last |
String |
The last name of the child (e.g., “Child-Test”). |
Response Body Schema
| Field Name | Data Type | Mandatory | Description |
|---|---|---|---|
|
Currency |
String | Yes |
Currency code for the booking (e.g., “EUR”). All rates will be displayed in the default currency associated with your Stuba account |
|
CommitLevel |
String | Yes |
Commit level of the booking (e.g., “confirm”). |
|
Booking |
Object | Yes |
Contains details of the booking. |
|
Id |
String | Yes |
Unique identifier for the booking. |
|
Creationdate |
Date | Yes |
Date the booking was created. (YYYY-MM-DD) |
|
AgentReference |
String | Yes |
Agent-provided reference for the booking. |
|
Hotelbookings |
Array of Object | Yes |
List of hotel bookings included in this booking. |
|
Id |
Integer | Yes |
Unique identifier for this specific hotel booking. |
|
HotelId |
Integer | Yes |
Unique identifier of the hotel. |
|
Hotelname |
String | Yes |
The name of the hotel |
|
Creationdate |
Date | Yes |
Date the hotel booking was created. (YYYY-MM-DD) |
|
ArrivalDate |
Date | Yes |
Arrival date for the hotel stays. (YYYY-MM-DD) |
|
Nights |
Integer | Yes |
Number of nights for this booking. |
|
Totalprice |
Float | Yes |
The total price for HotelBooking. |
|
Status |
String | Yes |
Status of the hotel booking (e.g., “confirmed”). |
|
Rooms |
Array of Object | Yes |
List of rooms booked in this hotel. |
|
RoomType |
Object | Yes |
Details of the room type. |
|
Code |
String | Yes |
Code of the room type. |
|
Text |
String | Yes |
Description of the room type. |
|
Mealtype |
Object | Yes |
Details of the meal plan. |
|
Code |
String | Yes |
Meal type code. |
|
Text |
String | Yes |
Description of the meal plan (e.g., “Breakfast”). |
|
Adult |
Array of Object | Yes |
List of adult guests in the room. |
|
Id |
Integer | Yes |
Unique identifier for the adult guest. |
|
Title |
String | Yes |
Title of the adult guest (e.g., “Mr”, “Mrs”). |
|
First |
String | Yes |
First name of the adult guest. |
|
Last |
String | Yes |
Last name of the adult guest. |
|
Child |
Array of Object | Yes |
List of child guests in the room (empty if none). |
|
Messages (zero or more) |
Array | Yes |
Special notes provided by the hotel are provided here. These must be displayed to the guests. |
|
Type |
String | No |
Type of message (e.g., “General”, “Internal Note”). |
|
Text |
String | No |
Message text content. |
|
Status |
String | Yes |
Status of the room booking (e.g., “confirmed”). |
|
CanxFees |
Array | Yes |
List of cancellation fees applicable to the room. |
|
Startdate |
Date | No |
Date from which the cancellation fee applies. (YYYY-MM-DD) Note: If no start date returned, cancellation charges are applicable at booking confirmation |
|
Amount |
Float | Yes |
Amount of the cancellation fee. |
|
Cancellationpolicystatus |
String | Yes |
Cancellation policy type for the room (e.g., “Refundable”, “Nonrefundable”, “Unknown”). |
HAPI Response Samples
Samples
No Show: Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.
" }, { "type": "Internal Note", "text": "Estimated total amount of taxes & fees for this booking:30.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 14:00-.Car park NO.Minimum check-in age 18." } ], "status": "confirmed", "canxFees": [ { "amount": 283.08 } ], "cancellationPolicyStatus": "NonRefundable" } ] }, { "id": 663174272, "hotelId": 75316, "hotelName": "Landmark Summit Hotel", "creationDate": "2025-11-10", "arrivalDate": "2025-11-23", "nights": 2, "totalPrice": 283.08, "status": "confirmed", "rooms": [ { "roomType": { "code": "1002210", "text": "Double Deluxe" }, "mealType": { "code": "1000041", "text": "Room only" }, "adult": [ { "id": 358349503, "title": "Ms", "first": "TESTC", "last": "TEST" }, { "id": 358349504, "title": "Mr", "first": "TESTD", "last": "TEST" } ], "child": [], "messages": [ { "type": "General", "text": "** ATTN ** Take extra care to read notes, especially for any nationality/market exclusions which could override guest nationality selected ** ATTN **
No Show: Should the guest fail to arrive on the check in date and we have not been notified of any cancellations or amendments in advance, they will be deemed a no show. For same day cancellation or no shows, 100% cancellation charges apply.
" }, { "type": "Internal Note", "text": "Estimated total amount of taxes & fees for this booking:30.00 Utd. Arab Emir. Dirham payable on arrival. Please note that the city tax for accommodations with more than 1 bedroom shall be charged per bedroom per night. Check-in hour 14:00-.Car park NO.Minimum check-in age 18." } ], "status": "confirmed", "canxFees": [ { "amount": 283.08 } ], "cancellationPolicyStatus": "NonRefundable" } ] } ] } }