GetBookingId

Returns detailed bookings made on the OTA. See the Booking Format section of the documentation for the full booking format specification.

Credit/debit card data

If your GetBookingId responses can include guest credit/debit card data
(the Payments object), your channel must be enabled for secure card
handling. A PCI Attestation of Compliance (AoC) document is required before
card data can be enabled for a channel.

Retrieval of card data is handled over a secure path configured on the
Cloudbeds side; your GetBookingId implementation returns the Payments
object as documented in the booking format, with no special handling on your
end.

Within the Payments object, CardNumber and SeriesCode must be encoded
as JSON strings
(quoted values, e.g. "SeriesCode": "143"), never as bare
JSON numbers. Card data is tokenized in place with non-numeric tokens;
unquoted numeric values cannot be tokenized.

A booking whose GetBookingId response contains card data is silently
dropped and not imported
(no error can be returned on GetBookingId)
unless your channel has been enabled for card handling.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
≥ 1

Property ID on the Cloudbeds channel manager

string
required

Username, login or property ID on the OTA

string
required

Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.

string
required

Property ID on the OTA, if OTA supports multiple properties under one ota_property_id/ota_property_password combination. See GetSubProperties for more details.

string
required
^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$

Request reference ID, used for debugging and support requests.

string
required

Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.

string
required
^[a-z0-9]+$

OTA ID as given by Cloudbeds

string
enum
required
Allowed:
string
required

OTA booking ID of the booking to be retrieved.

string

Versioning string if returned by GetBookingList. May be used to retrieve a specific version of the booking.

Response

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json