Check Rate API

This is an important step following the availability API request. Here, you need to provide the details of the specific room you intend to book.

This API should be invoked to reconfirm the rate details and obtain the cancellation policy, as well as any associated rate comments.

API details

POST /api/v1/hotel/booking-api/check-rate/rooms

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
Accept-Encoding	gzip

Body

Name	Type	Description
hotelId	Integer	HotelId
tokenNumber	String	Unique code for an availability request received from availability response.
rateKey	String	Unique key of the specific room received from availability response
fromDate	String	checkin date
toDate	String	checkout date
noOfAdults	Integer	No of adults in a room
noOfChildren	Integer	No of children in a room
childrenAges	Array	Age of each children in a room
nationality	String	nationality of the guest

Sample Request

{
    "hotelId": 100018,
    "tokenNumber": "RA_1728413337142",
    "rateKey": "40221e490acbd10955a41d128029a56e",
    "fromDate":"2024-10-17",
    "toDate": "2024-10-20",
    "rooms": [
        {
        "noOfAdults": 1,
        "noOfChildren": 0,
        "childrenAges": []
        }
    ],
    "nationality": "IN"
}

Response details

Response General data

Name	Type	Description
tokenNumber	String	Unique code for an availability request.
fromDate	String	Checkin Date
toDate	String	Check out Date
nationality	String	Guest Nationality ISO code
roomPaxes	Array	roomPaxes.noOfAdults roomPaxes.noOfChildren roomPaxes.childrenAges[]
noOfNights	Integer	Total stay nights

Response Guest required data

Name	Type	Description
roomId	Integer	room number
type	String	guest type data
ageRequired	boolean	true : Mandatory to pass guest age
genderRequired	boolean	true: Mandatory to pass guest gender

Response Hotel data

Name	Type	Description
hotelId	Integer	Unique Id for the hotel
hotelName	String	Name of the hotel

Response Room data

Name	Type	Description
rateKey	String	Unique Id for the specific rate
standardName	String	Name of the room provided by room mapping provider
roomName	String	Name of the room provided by supplier
roomMaster	Boolean	true: if room details available in room master false : If room details not available in room master
roomMasterCode	String	Unique room code for mapping from room master
boardName	String	Name of the board type
boardMaster	Boolean	true: if board details available in board master false : If board details not available in board master
boardMasterId	Integer	Unique board code for mapping from board master
occupancies	Array	occupancies.name occupancies.maxCount
cancellationPolicies	Array	cancellationPolicies.from : Date from which the policy comes in effect cancellationPolicies.amount : charge
rateComments	String	Important info to be displayed to guest before booking
netPrice	Number	Total price

Sample Response

{
    "success": true,
    "data": {
        "tokenNumber": "RA_1728413337142",
        "fromDate": "2024-10-17",
        "toDate": "2024-10-20",
        "nationality": "IN",
        "noOfNights": 3,
        "roomPaxes": [
            {
                "noOfAdults": 1,
                "noOfChildren": 0,
                "childrenAges": []
            }
        ],
        "travellerDetails": [
            {
                "roomId": 1,
                "type": "adult",
                "ageRequired": false,
                "genderRequired": false
            }
        ],
        "hotel": {
            "hotelId": 112,
            "hotelName": "Nine Hotel"
        },
        "standardName": "Standard Room",
        "rate": {
            "rateKey": "40221e490acbd10955a41d128029a56e",
            "roomName": "Standard Room",
            "roomMaster": true,
            "roomMasterCode": "X1-1046",
            "boardName": "bed and breakfast",
            "boardMaster": true,
            "boardMasterId": 10003,
            "netPrice": 771,
            "cancellationPolicies": [
                {
                    "from": "06-10-2024",
                    "amount": 385.50
                },
                {
                    "from": "08-10-2024",
                    "amount": 585.50
                },
            ],
            "rateComments": [
                "price excludes mandatory tourism fees and is payable directly at the hotel."
            ],
            "occupancies": {
                "name": "Single",
                "maxCount": 1
            }
        }
    }
}