Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Bookings

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.

post/GetBookingId

Request body

mya_property_idinteger required

Property ID on the Cloudbeds channel manager

ota_property_idstring required

Username, login or property ID on the OTA

ota_property_passwordstring required

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

ota_property_sub_idstring 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.

guidstring required

Request reference ID, used for debugging and support requests.

shared_secretstring required

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

ota_cidstring required

OTA ID as given by Cloudbeds

verb'GetBookingId' required
booking_idstring required

OTA booking ID of the booking to be retrieved.

versionstring

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

Response

GetBookingId

OR