Get Booking Details

curl "$UNIFYSTAYS_BASE_URL/hotels/book/ubk_eGQ0dW9uV1Vi/details" \
  -H "x-api-key: $UNIFYSTAYS_API_KEY"

{
  "contract_version": "2",
  "success": true,
  "message": "Booking confirmed.",
  "data": {
    "booking_id": "ubk_eGQ0dW9uV1Vi",
    "accepted_offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
    "booked_offer": {
      "offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
      "revision": 2,
      "quote_context": {
        "hotel": { "id": "13553916", "name": "Ramada Plaza by Wyndham Dubai Deira" },
        "check_in": "2026-05-26",
        "check_out": "2026-05-28",
        "nights": 2
      },
      "rooms": [
        {
          "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
          "mapping_status": "UNMAPPED",
          "unifystays_room": null,
          "provider_room": { "name": "Standard Room, 2 Twin Beds" }
        }
      ]
    },
    "guests": [
      {
        "guest_id": "guest_1",
        "guest_type": "ADULT",
        "is_lead_guest": true,
        "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
        "answers": [
          {
            "requirement_id": "br_first_name_all_guests_2",
            "code": "FIRST_NAME",
            "value": "Meera"
          }
        ]
      }
    ],
    "references": {
      "booking_id": "ubk_eGQ0dW9uV1Vi",
      "client_reference": "US-1776255131000",
      "supplier_booking_id": "TJ202487947162",
      "supplier_booking_code": null,
      "hotel_confirmation_number": "HCN-482910"
    },
    "lifecycle": {
      "status": "CONFIRMED",
      "is_terminal": true,
      "created_at": "2026-04-15T12:12:11.000Z",
      "updated_at": "2026-04-15T12:15:11.000Z",
      "completed_at": "2026-04-15T12:15:11.000Z",
      "processing_reason": null,
      "action_required": false,
      "available_actions": ["GET_DETAILS", "CANCEL"],
      "review_expires_at": null,
      "hold_deadline_at": null
    },
    "voucher": {
      "available": true,
      "url": null,
      "hotel_confirmation_number": "HCN-482910",
      "note": null
    },
    "current_cancellation": {
      "refundability": "REFUNDABLE",
      "policy_stage": "FINAL",
      "free_cancellation_until": {
        "local_datetime": "2026-05-20T23:59:59",
        "timezone": "UTC",
        "utc_datetime": "2026-05-20T23:59:59.000Z"
      },
      "policy_text": "Free cancellation until 20 May 2026.",
      "penalties": [],
      "no_show": null
    },
    "cancellation_outcome": { "status": "NOT_REQUESTED", "charge": null },
    "failure": null,
    "confirmed_details": null
  }
}

GET

hotels

book

{booking_id}

details

curl "$UNIFYSTAYS_BASE_URL/hotels/book/ubk_eGQ0dW9uV1Vi/details" \
  -H "x-api-key: $UNIFYSTAYS_API_KEY"

{
  "contract_version": "2",
  "success": true,
  "message": "Booking confirmed.",
  "data": {
    "booking_id": "ubk_eGQ0dW9uV1Vi",
    "accepted_offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
    "booked_offer": {
      "offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
      "revision": 2,
      "quote_context": {
        "hotel": { "id": "13553916", "name": "Ramada Plaza by Wyndham Dubai Deira" },
        "check_in": "2026-05-26",
        "check_out": "2026-05-28",
        "nights": 2
      },
      "rooms": [
        {
          "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
          "mapping_status": "UNMAPPED",
          "unifystays_room": null,
          "provider_room": { "name": "Standard Room, 2 Twin Beds" }
        }
      ]
    },
    "guests": [
      {
        "guest_id": "guest_1",
        "guest_type": "ADULT",
        "is_lead_guest": true,
        "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
        "answers": [
          {
            "requirement_id": "br_first_name_all_guests_2",
            "code": "FIRST_NAME",
            "value": "Meera"
          }
        ]
      }
    ],
    "references": {
      "booking_id": "ubk_eGQ0dW9uV1Vi",
      "client_reference": "US-1776255131000",
      "supplier_booking_id": "TJ202487947162",
      "supplier_booking_code": null,
      "hotel_confirmation_number": "HCN-482910"
    },
    "lifecycle": {
      "status": "CONFIRMED",
      "is_terminal": true,
      "created_at": "2026-04-15T12:12:11.000Z",
      "updated_at": "2026-04-15T12:15:11.000Z",
      "completed_at": "2026-04-15T12:15:11.000Z",
      "processing_reason": null,
      "action_required": false,
      "available_actions": ["GET_DETAILS", "CANCEL"],
      "review_expires_at": null,
      "hold_deadline_at": null
    },
    "voucher": {
      "available": true,
      "url": null,
      "hotel_confirmation_number": "HCN-482910",
      "note": null
    },
    "current_cancellation": {
      "refundability": "REFUNDABLE",
      "policy_stage": "FINAL",
      "free_cancellation_until": {
        "local_datetime": "2026-05-20T23:59:59",
        "timezone": "UTC",
        "utc_datetime": "2026-05-20T23:59:59.000Z"
      },
      "policy_text": "Free cancellation until 20 May 2026.",
      "penalties": [],
      "no_show": null
    },
    "cancellation_outcome": { "status": "NOT_REQUESTED", "charge": null },
    "failure": null,
    "confirmed_details": null
  }
}

Use this endpoint when you need the full booking record: itinerary pages, confirmation emails and vouchers, support tools, customer history and finance reconciliation. It sits at the end of the flow (search, rooms, prebook, book) and is how you read back what was booked.

Status, details or idempotency lookup?

You want to…	Call
Poll a booking that is in progress	Get Booking Status. It is lightweight.
Show the itinerary, guests, voucher data or the cancellation policy	This endpoint.
Recover after Create Booking timed out and you have no `booking_id`	Find Booking by Idempotency-Key.
Browse many bookings	List Bookings.

Request example

curl "$UNIFYSTAYS_BASE_URL/hotels/book/ubk_eGQ0dW9uV1Vi/details" \
  -H "x-api-key: $UNIFYSTAYS_API_KEY"

Response example

booked_offer is the full offer object from rooms and prebook. It is shortened here to the fields used in this page.

{
  "contract_version": "2",
  "success": true,
  "message": "Booking confirmed.",
  "data": {
    "booking_id": "ubk_eGQ0dW9uV1Vi",
    "accepted_offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
    "booked_offer": {
      "offer_id": "off_65db5f20d91b47d3a73d834dfa44c50e",
      "revision": 2,
      "quote_context": {
        "hotel": { "id": "13553916", "name": "Ramada Plaza by Wyndham Dubai Deira" },
        "check_in": "2026-05-26",
        "check_out": "2026-05-28",
        "nights": 2
      },
      "rooms": [
        {
          "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
          "mapping_status": "UNMAPPED",
          "unifystays_room": null,
          "provider_room": { "name": "Standard Room, 2 Twin Beds" }
        }
      ]
    },
    "guests": [
      {
        "guest_id": "guest_1",
        "guest_type": "ADULT",
        "is_lead_guest": true,
        "room_allocation_id": "ra_957cff0ac25243f29eb43bc32eb82136",
        "answers": [
          {
            "requirement_id": "br_first_name_all_guests_2",
            "code": "FIRST_NAME",
            "value": "Meera"
          }
        ]
      }
    ],
    "references": {
      "booking_id": "ubk_eGQ0dW9uV1Vi",
      "client_reference": "US-1776255131000",
      "supplier_booking_id": "TJ202487947162",
      "supplier_booking_code": null,
      "hotel_confirmation_number": "HCN-482910"
    },
    "lifecycle": {
      "status": "CONFIRMED",
      "is_terminal": true,
      "created_at": "2026-04-15T12:12:11.000Z",
      "updated_at": "2026-04-15T12:15:11.000Z",
      "completed_at": "2026-04-15T12:15:11.000Z",
      "processing_reason": null,
      "action_required": false,
      "available_actions": ["GET_DETAILS", "CANCEL"],
      "review_expires_at": null,
      "hold_deadline_at": null
    },
    "voucher": {
      "available": true,
      "url": null,
      "hotel_confirmation_number": "HCN-482910",
      "note": null
    },
    "current_cancellation": {
      "refundability": "REFUNDABLE",
      "policy_stage": "FINAL",
      "free_cancellation_until": {
        "local_datetime": "2026-05-20T23:59:59",
        "timezone": "UTC",
        "utc_datetime": "2026-05-20T23:59:59.000Z"
      },
      "policy_text": "Free cancellation until 20 May 2026.",
      "penalties": [],
      "no_show": null
    },
    "cancellation_outcome": { "status": "NOT_REQUESTED", "charge": null },
    "failure": null,
    "confirmed_details": null
  }
}

Field guide

Offer and guests

Field	What it means	How to use it
`data.booking_id`	The Unifystays booking ID.	Your key for this booking.
`data.accepted_offer_id`	The offer that was booked. Equals `booked_offer.offer_id`.	Informational. Send it to Confirm Hold when you confirm a held booking.
`data.booked_offer`	The offer exactly as accepted at booking time: hotel and dates in `quote_context` (`hotel`, `check_in`, `check_out`), `rooms`, pricing, payment terms and the cancellation policy that applied. It does not change after booking.	Build the itinerary from it. This is what the guest agreed to.
`data.booked_offer.rooms[]`	One entry per booked room, with `room_allocation_id`, `provider_room` and optional `unifystays_room`.	`unifystays_room` can be `null`. Display `provider_room` then. Never use room mapping as reservation identity.
`data.guests[]`	Every guest with `guest_id`, `guest_type` (`ADULT`, `CHILD`, `INFANT`), `is_lead_guest`, `room_allocation_id` and `answers[]`.	Join to a room with `room_allocation_id`. Contains personal data.
`data.guests[].answers[]`	What you submitted for each booking requirement: `requirement_id`, `code` (such as `FIRST_NAME`), `value`.	Show the guest names from the `FIRST_NAME` and `LAST_NAME` answers.

References: which number to show

Field	What it means	How to use it
`data.references.booking_id`	Unifystays booking ID.	Your own key.
`data.references.supplier_booking_id`	The supplier’s primary booking or order ID. `null` until assigned.	Store it. Quote it to support or to the supplier.
`data.references.supplier_booking_code`	A distinct secondary supplier code. `null` when the supplier has only one.	Store it when present.
`data.references.hotel_confirmation_number`	The hotel’s own confirmation number. `null` until the hotel confirms. Can arrive after `CONFIRMED`.	Show it to the guest as the hotel confirmation number.
`data.references.client_reference`	A reference Unifystays generated and sent to the supplier, when one exists.	Not your order reference. Key on `booking_id`.

These three are different things. Do not treat them as interchangeable.

Lifecycle

Field	What it means	How to use it
`data.lifecycle.status`, `is_terminal`	The booking status and whether it is final.	Meanings are in Get Booking Status.
`data.lifecycle.processing_reason`	Why it is not simply done, or `null`.	See Get Booking Status.
`data.lifecycle.action_required`, `available_actions`	Whether a person must act, and what you can do.	Drive your buttons from `available_actions`.
`data.lifecycle.review_expires_at`, `hold_deadline_at`	Review quote deadline, or the hold deadline.	Show when present.
`data.lifecycle.created_at`, `updated_at`, `completed_at`	ISO 8601 UTC times. `completed_at` is `null` while in progress.	Display or log.
`data.failure`	`code` and a generic `message`. `null` unless the booking has a failure code.	Branch on `code`. Do not show or parse `message`.

Voucher

Field	What it means	How to use it
`data.voucher.available`	`true` when the booking is `CONFIRMED` and the hotel confirmation number is known.	Show a ready voucher only when `true`. Otherwise show “confirmed, hotel number to follow” and read again later.
`data.voucher.hotel_confirmation_number`	The number to print on the voucher.	Print it.
`data.voucher.note`	A note from the hotel or supplier about the confirmation.	Show when present.
`data.voucher.url`	A hosted voucher link. Currently always `null`.	Build the voucher yourself from `booked_offer`, `guests` and `references`.

Cancellation

Field	What it means	How to use it
`data.current_cancellation`	The policy in force now. When the supplier reports a final policy after booking, it replaces the one in `booked_offer` (`policy_stage: "FINAL"`).	Show the policy and `free_cancellation_until`. To cancel, get a quote. Do not compute the charge yourself.
`data.cancellation_outcome.status`	`NOT_REQUESTED`, `PENDING` (supplier processing), `CANCELLED`, `REJECTED` (supplier refused, booking stays active) or `UNKNOWN` (answer uncertain, being verified).	Show the right message. Read again while `PENDING` or `UNKNOWN`.
`data.cancellation_outcome.charge`	The charge applied, as Money. `null` when none was reported (this does not mean zero).	Display after cancellation.
`data.cancellation_outcome.display_charge`	`charge` in the booking’s display currency, frozen when the cancellation was recorded.	Show it next to `charge`. `null` when `charge` is `null`.
`data.cancellation_outcome.display_fx`	The rate behind `display_charge`. It is the booking’s frozen rate, or the rate frozen with the cancellation when the charge was in another currency (then `rate_updated_at` is `null`).	Use for audit.
`data.display_total`	What the booking costs in the display currency it was made with, as Money, at the rate frozen when it was priced. Later exchange-rate changes never alter it.	Show it where you show the booking price. `null` for bookings made before display currencies existed.
`data.display_fx`	The frozen rate behind `display_total`: `rate`, `rate_updated_at` (when the exchange-rate source last updated it; `null` when it gave none) and `frozen_at` (when the booking froze it).	Use for audit.
`data.confirmed_details.pricing.display_payable_total`, `display_selling_total`, `display_refunded_total`, `display_vat_total`	The matching `pricing` amounts in the display currency, at the booking’s frozen rate.	`null` when the source amount is `null` or in a different currency than the booking.
`data.current_cancellation.penalties[].display_amount`	Each penalty in the display currency, at the booking’s frozen rate.	Show with the policy. `null` when no frozen rate exists.

Confirmed details (supplier’s post-booking record)

data.confirmed_details is what the supplier reports after booking. It is null until that record has been read, for example while the booking is PROCESSING. It is separate from booked_offer, which never changes.

Field	What it means	How to use it
`supplier_status`	The supplier’s own status text.	Display only. Use `lifecycle.status` for logic.
`supplier_created_at`, `supplier_modified_at`	When the supplier created or last changed the booking.	Support and audit.
`check_in`, `check_out`	Dates as the supplier holds them.	Compare with `booked_offer.quote_context`. Tell support if they differ.
`is_cancellable`	Whether the supplier says it can be cancelled.	Informational. Use `available_actions` for the decision.
`rooms[]`	Room name, meal plan, bed configuration, adults, children and quantity as the supplier confirmed them.	Show on the voucher if you want the supplier’s wording.
`pricing`	`payable_total`, `selling_total`, `refunded_total`, `vat_total`, each Money or `null`.	Reconciliation. All amounts are `amount_minor` with `currency_exponent`.
`payment`	Supplier payment type, who pays, paid time, due, pending and invoice ID.	Reconciliation. Supplier-defined text.
`voucher_comment`	A comment the supplier wants on the voucher.	Print it when present.

Booking details contain guest personal data and supplier confirmation information. Call this endpoint from trusted backend services only and limit who can see the data.

The Money object is always { amount_minor, currency, currency_exponent }. 17700 with exponent 2 is 177.00.

Next step

To cancel, use Quote Cancellation and then Cancel Booking.

Authorizations

x-api-key

string

header

required

Environment-specific API key created in the Unifystays portal

Headers

X-Unifystays-Contract-Version

enum<string>

default:2

Hotel API contract version. Optional: 2 is the current version and the default.

Available options:

2

X-Unifystays-Currency

string

ISO 4217 currency for display amounts (display_ledger, display_amount, commercial_display). Optional: defaults to your organization's display currency, USD unless configured. Read pricing.display_currency in the response.

Required string length: 3

Example:

"EUR"

Path Parameters

booking_id

string

required

Unifystays booking ID returned by Create Booking (ubk_...).

Example:

"ubk_eGQ0dW9uV1Vi"

Response

contract_version

string

required

Response contract version.

Example:

"2"

success

boolean

required

True when the request succeeded.

Example:

true

message

string

required

Human-readable summary. Do not parse it.

Example:

"Booking confirmed."

data

object

required

The full booking record.

Show child attributes

Overview

Destination & master data

Search & hotels

Bookings

Webhook endpoints

Webhook logs

Status, details or idempotency lookup?

Request example

Response example

Field guide

Offer and guests

References: which number to show

Lifecycle

Voucher

Cancellation

Confirmed details (supplier’s post-booking record)

Next step

Authorizations

Headers

Path Parameters

Response

​Status, details or idempotency lookup?

​Request example

​Response example

​Field guide

​Offer and guests

​References: which number to show

​Lifecycle

​Voucher

​Cancellation

​Confirmed details (supplier’s post-booking record)

​Next step

Authorizations

Headers

Path Parameters

Response

Status, details or idempotency lookup?

Request example

Response example

Field guide

Offer and guests

References: which number to show

Lifecycle

Voucher

Cancellation

Confirmed details (supplier’s post-booking record)

Next step