post_rates_prebook
Create a prebook session to verify hotel rate availability and final pricing before payment, returning a prebookId for completing the booking.
Instructions
Overview
Step 1 of 2 in the booking flow. Create a prebook session to check the availability of a rate and get final pricing before payment. This prebookId needed to complete the booking.
When to Use
Before payment - Always call this before completing a booking
Rate confirmation - Verify final pricing and availability
Session creation - Generate a checkout session for your payment flow
What You Get
Prebook ID - Required for the next step (completing the booking)
Final pricing - Confirmed rates with all fees and taxes
Terms and conditions - Cancellation policies and booking rules
Room details - Complete information about the selected rooms
Key Features
Live availability check - Verifies the rate is available before you collect payment
Payment SDK support - Set
usePaymentSdk=trueto use client-side payment formsReusable - PrebookId can be used for multiple bookings if needed
Quick Start
Provide the offerId from your hotel rates search and set usePaymentSdk (true/false). Returns a prebookId to use in the next step.
Next Step: Use the prebookId with /rates/book to complete the booking.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| addons | No | A list of additional services or extras that can be added to the booking. For example, adding an Uber voucher or an esim card. The final booking amount is the sum of the offer's total price and the cost of any addons. Each addon's price is added individually to reflect all extras in the billed total. | |
| offerId | Yes | The unique identifier of the selected offer from the search results. | |
| payment | No | Optional payment configuration when usePaymentSdk is true | |
| timeout | No | ||
| bedTypeIds | No | An optional array of bed type IDs to specify preferred bed configurations for the rooms being booked. The availability of specific bed types depends on the hotel's inventory. | |
| voucherCode | No | An optional voucher code to apply discounts to the booking. The vouchers API allows creation of these discounts | |
| usePaymentSdk | Yes | Specifies whether the fields needed to call the payment processing SDK are returned. Set to true if using the SDK for payment processing. | |
| includeCreditBalance | No | Optional flag to include credit line information in the response. When set to true, credit line details will be returned if the user has a credit line available. |