Check Rate

POST 
/v2/hotels/checkrate

Introduction

Re-confirms the current price and availability of specific room rates previously returned by a v2/hotels/availability search, immediately before booking. Suppliers are queried live (not from cache), so this call is slower than a plain search and is meant to be used right before creating a reservation, not for browsing.

A rate that is no longer available comes back as a 404 — treat that as "this specific rate is gone," not as a generic search returning no results.

Request

application/json

Body

Deliberately minimal: rateTokens alone identifies the hotel(s), room rates, dates and occupancy.

Room rates from different hotels can be mixed in the same call, but they must all share the same checkin/checkout/occupancy.

rateTokens string[]required

Tokens of the room rates to re-confirm, as returned by a prior availability search (roomRates[].rateToken). Can span multiple hotels, but must all share the same checkin/checkout/occupancy.

locale stringnullable

Desired language/locale for the response's text.

searchId stringnullable

The searchId returned by the availability search these room rates came from. Passing it back links this check into that search for correlation purposes. If omitted, the response comes back with a new, unrelated searchId.

Responses

200

application/json

Schema

Schema

hotels object[]
List of hotels with their re-confirmed rates.
Array [
hotel objectrequired
id stringrequired
Internal Niara ID of the hotel.
name stringrequired
Hotel name.
cityName stringnullable
Name of the hotel's city.
countryName stringnullable
Name of the hotel's country.
address stringnullable
Hotel address.
position objectnullable
Geographic coordinates of the hotel.
latitude numbernullable
Latitude of the hotel.
longitude numbernullable
Longitude of the hotel.
roomRates object[]
Re-confirmed rates for the hotel.
Array [
bookingToken stringrequired
Opaque token identifying this re-confirmed rate. Pass it to v2/booking to book it. Expires 15 minutes after being issued.
roomType objectrequired
id stringrequired
Room type ID.
name stringrequired
Room type name.
time objectrequired
startDate stringrequired
Rate start date.
endDate stringrequired
Rate end date.
priceComposition objectrequired
net objectnullable
Net value (before taxes), when available.
value numberrequired
Monetary amount.
currency stringrequired
Currency code (ISO 4217).
taxes objectnullable
Tax amount, when available.
value numberrequired
Monetary amount.
currency stringrequired
Currency code (ISO 4217).
total objectnullable
Total value (net + taxes), when available.
value numberrequired
Monetary amount.
currency stringrequired
Currency code (ISO 4217).
cancelPolicy objectrequired
nonRefundable booleannullable
Indicates whether the rate is non-refundable, when known.
inPenalty booleannullable
Indicates whether cancellation is currently within the penalty period.
penaltyDate stringnullable
Date from which cancellation starts incurring a penalty.
paymentOptions object[]nullable
Payment/guarantee options available for this rate.
Array [
type stringrequired
Payment option type (e.g. credit card, PIX, pay-at-hotel).
id stringrequired
Payment option ID.
enabled booleannullable
Whether this payment option is currently usable for this rate, when known.
internalType stringnullable
Internal payment-option classification.
alias stringnullable
Display name for the payment option.
description stringnullable
Human-readable description.
disabledReason stringnullable
Why this option is disabled, when enabled is false.
credentialType stringnullable
Supplier credential type behind this payment option, when relevant.
includeExtraOptions object[]nullable
Extras that can be bundled with this payment option.
Array [
id stringrequired
Extra item ID.
label stringnullable
Extra item label.
]
]
meal objectnullable
breakfast booleannullable
Whether breakfast is included.
lunch booleannullable
Whether lunch is included.
dinner booleannullable
Whether dinner is included.
allInclusive booleannullable
Whether the rate is all-inclusive.
name stringnullable
Meal plan name.
description stringnullable
Meal plan description.
ratePlan objectnullable
id stringnullable
Rate plan ID.
name stringnullable
Rate plan name.
type stringnullable
Rate plan type.
public booleannullable
Whether the rate plan is publicly published.
package booleannullable
Whether the rate plan is a package (bundled with extras).
inclusions object[]nullable
Items included in the rate plan.
Array [
id stringnullable
Inclusion ID.
name stringnullable
Inclusion name.
description stringnullable
Inclusion description.
]
descriptions objectnullable
roomType object[]nullable
Room type descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
meal object[]nullable
Meal plan descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
ratePlan object[]nullable
Rate plan descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
cancelPolicy object[]nullable
Cancellation policy descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
generalPolicies object[]nullable
General policy descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
payment object[]nullable
Payment-related descriptions.
Array [
name stringnullable
Description name/title.
description stringnullable
Description text.
]
offers object[]nullable
Promotional offers applied to the rate.
Array [
name stringnullable
Offer name.
discount numbernullable
Discount value/percentage.
freeNights integernullable
Number of free nights granted by the offer, when applicable.
discountType nullable
Possible values: [STAY_DISCOUNT, DISCOUNT, FREE_NIGHT, LAST_MINUTE, null]
Discount type.
nightsRequired integernullable
Nights required to qualify for the offer, when applicable.
]
]
]
searchId stringnullable

Search identifier to be included in the payload of the subsequent calls of the booking flow, useful for correlating them.

Example (from schema)

{
  "hotels": [
    {
      "hotel": {
        "id": "string",
        "name": "string",
        "cityName": "string",
        "countryName": "string",
        "address": "string",
        "position": {
          "latitude": 0,
          "longitude": 0
        }
      },
      "roomRates": [
        {
          "bookingToken": "string",
          "roomType": {
            "id": "string",
            "name": "string"
          },
          "time": {
            "startDate": "string",
            "endDate": "string"
          },
          "priceComposition": {
            "net": {
              "value": 0,
              "currency": "string"
            },
            "taxes": {
              "value": 0,
              "currency": "string"
            },
            "total": {
              "value": 0,
              "currency": "string"
            }
          },
          "cancelPolicy": {
            "nonRefundable": true,
            "inPenalty": true,
            "penaltyDate": "string"
          },
          "paymentOptions": [
            {
              "type": "string",
              "id": "string",
              "enabled": true,
              "internalType": "string",
              "alias": "string",
              "description": "string",
              "disabledReason": "string",
              "credentialType": "string",
              "includeExtraOptions": [
                {
                  "id": "string",
                  "label": "string"
                }
              ]
            }
          ],
          "meal": {
            "breakfast": true,
            "lunch": true,
            "dinner": true,
            "allInclusive": true,
            "name": "string",
            "description": "string"
          },
          "ratePlan": {
            "id": "string",
            "name": "string",
            "type": "string",
            "public": true,
            "package": true,
            "inclusions": [
              {
                "id": "string",
                "name": "string",
                "description": "string"
              }
            ]
          },
          "descriptions": {
            "roomType": [
              {
                "name": "string",
                "description": "string"
              }
            ],
            "meal": [
              {
                "name": "string",
                "description": "string"
              }
            ],
            "ratePlan": [
              {
                "name": "string",
                "description": "string"
              }
            ],
            "cancelPolicy": [
              {
                "name": "string",
                "description": "string"
              }
            ],
            "generalPolicies": [
              {
                "name": "string",
                "description": "string"
              }
            ],
            "payment": [
              {
                "name": "string",
                "description": "string"
              }
            ]
          },
          "offers": [
            {
              "name": "string",
              "discount": 0,
              "freeNights": 0,
              "nightsRequired": 0
            }
          ]
        }
      ]
    }
  ],
  "searchId": "string"
}

Loading...