Test Rate / Availability
const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/sandbox/booking';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '""'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/sandbox/booking \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '""'Test whether the rates and availability for a sales channel is coming backing the way the property wants
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Create test booking for property ID
Example
hotel-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Test booking request body for property ID
Responses
Section titled “ Responses ”Created
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Communicates whether the booking was created normally or if it failed or was just for testing.
Unique record identifier for the collection of bookings that were made at the same time.
Which customization configuration record did the entity application used to facilitate in making this booking happen.
object
Unique customization configuration identifier
Engine configuration name
Authenticated user identifier
Engine configuration record creator identifier
Name of company owner.
Sales channel sub-type.
Control which currency your users see prices in initially.
Control which language your users see text in initially.
Control which lifestyle contextx your users see initially.
Customize booking confirmation emails by adding a custom logo to your configuration.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
If you are self-hosting our booking customization, let us know where it is hosted. Note: This url needs to be secured with SSL.
Flag to indicate you are self-hosting our booking customization and not using our default booking customization url.
Choose how you want our web components to look and more closely match with your own site style.
object
Primary color
Secondary color
Success color
Danger color
Warning color
Info color
Light color
Dark color
Body color
Muted color
White color
Choose how you large you want our web component cards to be.
Choose how you want our web component cards laid out.
Choose the card design to use on our web component cards.
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long and how many days in advance (this field), of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
You can control the initial itinerary date used to retrieve travel inventory prices. You can do it in one of two ways: 1. Dynamically set the date by indicating how long (this field) and how many days in advance, of today’s date, you want to display prices for. 2. Set a fixed date to display prices for. Option 1 is the most shared. Option 2 is for when you want to create a new customization and apply it to a specific event that occurs on a specific date. If you don’t use either of these options, the itinerary will default to today’s date with one night stay. ONLY populate this field if you want to control the itinerary date. Also, leave startDate and endDate empty.
Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Control how many adults / children will be staying and how many rooms. Defaults to: One room, two adults.
Room Configuration
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
If true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate
If you’ve received special promotional codes from suppliers to give to your audience, you can choose to bake these code directly into the price by entering them here.
An integrator can choose to disable outgoing emails to properties because they want to do that themselves.
An integrator can choose to disable outgoing emails to users because they want to do that themselves.
An integrator can choose to disable notifying the property’s channel manager. Note: This should ONLY be done for testing.
Action to complete once a user clicks on the CTA button on inventory.
GeoNames have been created at https://geonames.org and contain geographical destinations we use as geoname data to associate travel inventory with a location.
object
GeoName identifier
GeoNameLightweight type
Name of city
Url name
Ascii name of city
Coordinate points of the city
object
Timezone
Country
object
ISO code
Country name
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
Country sub division
object
Sub-country name
Sub-country ascii name
Sub-country GeoNames identifier
Country sub sub division
object
Show unavailable inventory card when inventory not currently for sale. Otherwise, it displays a normal card but without the price.
Whether to display rankings (lifestyle, eco score and reviews) on hotel landing page.
This feature flag controls whether to let a user move away from the hotel landing page using search.
Tracking pixels and web beacons for analytics and conversion tracking.
object
Unique identifier for this tracking pixel
User-friendly name for this tracking pixel
Type of tracking pixel delivery mechanism
Tracking pixel provider
Consent category for GDPR/CCPA compliance
Whether this tracking pixel is currently active
Provider-specific pixel ID (e.g., Facebook Pixel ID, Google Ads Conversion ID)
Optional access token for providers that require authentication
Custom JavaScript code for CUSTOM provider type. Will be injected into the page.
Custom image URL for IMAGE type pixels. Will be loaded as a 1x1 tracking pixel.
Page types where this pixel should fire. Empty list or containing ALL means fire on all pages.
Event triggers that cause this pixel to fire, with optional custom parameters.
object
The event type that triggers this pixel
Custom key-value parameters to include with the event
object
Parameter name (e.g., ‘currency’, ‘value’, ‘content_id’)
Parameter value. Can be a static value or a placeholder like ‘{booking.total}’
Custom font for the booking engine. Null means use the system default.
Unique user-friendly booking geoname. This code should be used when corresponding with travelers.
User details for the authenticated person that made the booking.
object
User identifier
First name
Last name
Telephone
Full name
User session state as it was when the user made the booking.
object
Dates and travel info.
object
Start date of itinerary
Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.
Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.
Room configurations
Room Configuration
object
Number of adults
Children configurations
Child configuration
object
Number of children
Age of children
Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.
How many total children for this stay
How many total rooms for this stay
How many total guests for this stay
User’s language preference
User’s currency preference
User can pass the current room configuration index to retrieve rates specifically for that room configuration.
The preferred user lifestyle.
The URL the booking occurred
List of all social network account property has for the traveler to get in touch.
Social network
object
Type of social network.
URL or social network identifier to social network profile
User review created by the traveler after the booking completed.
object
Unique review identifier identifying this record.
Booking identifier identifier booking this review is associated with.
Hotel identifier this booking is associated with.
User details of creator of booking.
object
User identifier
First name
Last name
Telephone
Full name
Date of review.
Total points divided by number of questions.
List of user review answers.
object
Question identifier
Question category
Sort key
Value
Private message from guest to the hotel. Is not displayed on property profile.
Property can response to traveler review. Response goes on public review profile and can be seen by others.
Reviewer can upload her best picture from the property. Cloudinary image identifier.
Free text record created by traveler
Hotel allows the review text to be displayed as part of their profile.
Hotel allows the user-generated image to be displayed as part of their profile.
List of member identifiers who liked the textual review
Guest’s room number during their stay.
Guest’s room rating
Returns true if property has responded to the review given by the guest.
Full url of the image logo optimized for emails
Logo cloudinary identifier for potential reuse
Combined property data.
object
Unique hotel record identifier.
Hotel trade name
Hotel local name if different from the trade name or if it is the local language.
Name of hotel chain if applicable.
Name of hotel brand
Unique URL-friendly name slug of hotel
Event shorter name
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Number of bookings for this property on the wink.travel platform.
Aggregate score based on all current user reviews.
Geo-location
object
Short and long welcome text
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Count of total reviews left by users at this property.
Contact details for reservations desk
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Property’s social network accounts
Social network
object
Type of social network.
URL or social network identifier to social network profile
Property images.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Property videos.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Basic property policy record.
object
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates how guests can access the Internet on the property.
Indicates where internet is available in and around the property.
Indicates whether parking is available at the property.
Indicates what type of parking is available at the property.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
If pets are allowed, property can further limit on weight.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
When the guest has to check out.
When the guest can check in.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Number of attractions property has listed on its profile.
Number of activites property has listed on its profile.
Number of places property has listed on its profile.
Number of restaurants property has on its profile.
Number of meeting rooms property has on its profile.
Number of spas property has on its profile.
Number of add-ons property has on its profile.
General manager related data.
object
Name of GM currently managing the property.
Cloudinary image identifier of GM currently managing the property.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Localized welcome message from GM.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Supported OTA specification LOC code. See OTA geoname data
Supported OTA specification SEG code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Supported OTA specification ARC code. See OTA geoname data
Year the property was constructed.
Currency code for property.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it’s there to compare it against other properties.
A property’s package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it’s there to compare it against other properties.
A property’s loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it’s there to compare it against other properties.
A property’s popular score is based on calculating number of bookings across room types. There is no max score; it’s there to compare it against other properties.
A property’s experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it’s there to compare it against other properties.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Number of rooms / keys for this property.
Property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Whether property is active
Free text where the traveler can add a message to the property.
Internal comment field the platform can add and make available to channel manager partners.
Early check-in charge fixed amount that is due if guest checks out early.
object
Late check-out charge fixed amount that is due if guest checks out late.
object
Early check-in charge calculated in percent of first room night price.
Early check-in charge calculated in percent of first room night price.
Absolute URL of hotel image that can be used as-is
Url of map image that can be sent via email
Url of map image location on Google Maps
Place to store related data
object
Single room stay for the booking. Multi-room is modelled as sibling Booking documents joined by groupIdentifier.
object
Guest room details.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Typical one night rate during regular remand period
object
Typical one night rate in a distressed period
object
Desired bedroom layout
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
The actual amount of adults as determined by the hotel’s policy.
The actual amount of children as determined by the hotel’s policy.
Number of identical rooms of this type. Display only — the money-bearing quantity lives on price (BookingStayRate).
Price details. Already quantity-scaled — its totals and breakdown represent all booked rooms.
object
object
object
object
Number of identical rooms booked of this type. The one money-bearing quantity.
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
object
The date this night’s rate applies to.
Source daily rate identifier.
Rate plan identifier this night was priced from.
Guest room identifier this night was priced from.
Origin of the rate (WINK, EXELY, etc.).
Per-room base (rack) rate for the night in hotel currency.
object
Per-room base (rack) rate for the night in wink currency.
object
Per-room base (rack) rate for the night in user specified currency.
object
Per-room net rate for the night in hotel currency.
object
Per-room net rate for the night in wink currency.
object
Per-room net rate for the night in user specified currency.
object
Number of identical rooms booked of this type.
Net rate for the night across all rooms (per-room rate x quantity) in hotel currency.
object
Net rate for the night across all rooms (per-room rate x quantity) in wink currency.
object
Net rate for the night across all rooms (per-room rate x quantity) in user specified currency.
object
Promotional discount percent applied to the night.
Channel / membership discount percent applied to the night.
Premium percent applied to the night.
Localized descriptions of the discounts / offers applied to the night.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Whether this night is the check-in date.
Whether this night is the check-out date (not charged).
Whether this night is the last charged night.
Adults staying.
Children staying.
Hotel to user currency exchange rate for the night.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate for the night.
object
Source
Target
Exchange rate
Timestamp
Per-night, quantity-scaled financial breakdown (beneficiary split).
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Stay total in user specified currency (per-room x quantity).
object
Stay total in hotel currency (per-room x quantity).
object
Stay total in wink currency (per-room x quantity).
object
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
Master rate identifier
Master rate internal name
Rate plan used for this stay
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
List of perks that came with the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
This is how perks get sorted when in a list
Rate plan-level extra charges
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
Active cancellation policy resolved at booking time.
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Ancillary services attached to this room stay.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Absolute URL of room image
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Guest assigned to this room stay (lead occupant).
object
User identifier
First name
Last name
Telephone
Optional profile record
object
Profile identifier
User identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
First name
Last name
Telephone
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifier the gender of the customer.
Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.
Marital status of the traveler.
The number of children of the customer.
Name of the (self-professed) country that is clamided for citizenship.
Address line 1
Address line 2
City
State
Postal code
Country
Type of funds preferred for reviewing monetary values, in ISO 4217 codes
The primary language of the customer
Array of emergency contact information for the customer
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Array of customer’s pets
object
Pet name
Pet type
Customer preferences
object
Indicates preference for hotel property locations.
Indicates preference for hotel property types.
Identifies a preferred company by name.
Indicates preferences for hotel property amenities.
Indicates preference for the type of recreation services in a hotel
Indicates preference for type of business services in a hotel
Indicates preference of rtype of security features in a hotel
Indicates preferences for type of features required to meet the needs of persons with physical challenges, disabilities, etc.
Indicates preference for smooking allowed rooms..
Indicates preference for hotel room locations.
Indicates preferences for the size and features of hotel bed types.
Indicates preferences for type of food listener facilities in a hotel.
Indicates preferences for hotel room amenities.
Guest type
Indicates meal preference.
Indicates cuisine preference.
Indicates interest preference
Indicates beverage preference.
Indicates food preference.
Indicates allergies
Indicates pet preferences
Full name
Check-in date
Check-out date
object
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
Persisted booking lifecycle status.
How the booking was paid for: STRIPE or AGENT.
Stripe payment details (PaymentIntent, charge, card info, fees).
object
Name of acquiring vendor
Unique session id from the vendor.
Unique transaction id from the vendor.
Unique customer id from the vendor.
Unique charge id from the vendor.
The date/time the invoice was generated
The specific invoice this booking was registered on
Fees associated with this booking.
object
Unique system ID.
Fee amount
object
Type of fee
Withdrawal fee description
Vendor specific values that are returned in a successful response
object
Stripe PaymentIntent ID, denormalized for indexing.
Cancellation details. Non-null means the booking is cancelled.
object
When the booking was cancelled.
Who cancelled the booking.
The cancellation policy type that was applied.
User identifier of the person who cancelled.
Human-readable reason for cancellation.
True when the traveler refund for this booking is notified once at the group level (a single aggregated trippay_payment_refund email). The Stripe refund-settlement webhook reads this to suppress the per-booking traveler refund email and avoid duplicates.
Refund issued against this booking, if any. A booking has at most one refund.
object
Unique refund identifier.
Stripe Refund ID.
Refund amount in source (supplier/hotel) currency.
Refund amount in internal (USD/capture) currency.
Refund amount in display (user) currency.
Human-readable description.
Reason for the refund.
Current status of this refund.
Who requested the refund.
When the refund was created.
When the refund was processed by Stripe.
Stripe receipt URL for the refund.
Stripe refund processing fee in internal (capture) currency, captured asynchronously via webhook from balance_transaction.fee.
Whether the booking should be cancelled when this refund is approved. Applied at admin-approval time, not at request time.
Wink admin’s response to the refund request. Kept separate from description so the admin’s reply never overwrites the requester’s (traveler/hotel) original text.
List of payouts disbursed to beneficiaries.
object
Unique payout identifier.
Account identifier of the beneficiary receiving funds.
Account name of the beneficiary.
Beneficiary type (SALE, COMMISSION, TRIP_PAY, etc.).
Payout amount in source currency.
Payout amount in internal (USD) currency.
Payout amount in display currency.
Payout status (PENDING, COMPLETED, FAILED).
When the payout was processed.
External withdrawal/transfer ID from payment processor.
Audit trail of status transitions.
object
Status before the transition.
Status after the transition.
When the transition occurred.
Who or what triggered the transition.
Human-readable reason for the transition.
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Whether all funds have been processed for this booking.
Whether funds have been recorded in supplier’s ledger.
Whether the booking can still be voluntarily cancelled (no later than the arrival day).
Rate origin. This is usually the property channel manager.
Convenience data point to check if any add-on offers are in this booking.
Convenience data point to get to breakfast quickly.
Convenience data point to get to brunch quickly.
Convenience data point to get to lunch quickly.
Convenience data point to get to dinner quickly.
Convenience data point to get to all-inclusive quickly.
Convenience data point to get to all-inclusive with alcohol quickly.
Convenience data point to check if any room type ancillaries are in this booking.
Convenience data point to check if any food is included in this booking.
Convenience data point to check if any restaurant reservations are included in this booking.
Convenience data point to check if any meeting room reservations are included in this booking.
Convenience data point to check if any spa reservations are included in this booking.
Convenience data point to check if any activity reservations are included in this booking.
Convenience data point to check if any attractions reservations are included in this booking.
Convenience data point to check if any place reservations are included in this booking.
Displays rate accounting details
object
The rate date.
The rate given to us by channel manager / CRS / PMS.
The derived amount based on promotions, member discounts etc within our platform.
The gross amount minus fees and commissions.
The net amount minus potential refund. Null if booking contains no refund.
The currency for these amounts.
Displays ancillary accounting details
object
Full name of ancillary in English.
The gross amount.
The gross amount minus fees and commissions.
The gross amount minus fees and commissions.
The currency for these amounts.
Displays extra charge accounting details.
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
Meeting room reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Restaurant reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Spa reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Activity reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Attraction reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Place reservation records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Room type ancillary records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Add-on records.
object
Ancillary identifier
Hotel identifier
Travel inventory identifier
Travel inventory identifier
Name of inventory
Pricing type
Inventory type
Pricing information for this ancillary.
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Number of guests that are part of this reservation.
Cloudinary image identifier
Absolute URL to image of inventory
Name of travel inventory in traveler language (if available). Defaults to English.
Description of travel inventory in traveler language (if available). Defaults to English.
Travel blocking contact (if applicable)
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Travel blocking address (if applicable)
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "creation": "NORMAL", "groupIdentifier": "", "customization": "", "bookingCode": "", "user": "", "userSession": "", "serverUrl": "", "socials": "", "review": "", "emailHeaderLogoUrl": "", "logoIdentifier": "", "hotel": "", "specialRequests": "", "comment": "", "earlyCheckInCharge": "", "lateCheckOutCharge": "", "earlyCheckInChargePercent": "", "lateCheckOutChargePercent": "", "hotelImageUrl": "", "staticMapImageUrl": "", "staticMapUrl": "", "metadata": "", "roomStay": "", "bookingStatus": "INITIALIZED", "paymentType": "STRIPE", "paymentDetails": "", "stripePaymentIntentId": "", "cancellation": "", "refund": "", "payoutList": [ "" ], "statusHistory": [ "" ], "financialBreakdown": { "displayPriceQuote": { "source": "", "target": "", "exchangeRate": "", "timestamp": "" }, "internalPriceQuote": { "source": "", "target": "", "exchangeRate": "", "timestamp": "" }, "beneficiaryList": [ null ] }, "fundsProcessed": false, "fundsAddedToLedger": false, "cancellable": false, "rateSource": "", "hasAddOns": false, "hasBreakfast": false, "hasBrunch": false, "hasLunch": false, "hasDinner": false, "hasAllInclusive": false, "hasAllInclusivePlusAlcohol": false, "hasRoomTypeAncillaries": false, "hasFood": false, "hasRestaurants": false, "hasMeetingRooms": false, "hasSpas": false, "hasActivities": false, "hasAttractions": false, "hasPlaces": false, "reportingDailyRateList": [ "" ], "reportingAncillaryList": [ "" ], "reportingExtraChargeList": [ "" ], "beneficiaryList": [ null ], "meetingRooms": "", "restaurants": "", "spas": "", "activities": "", "attractions": "", "places": "", "roomTypeAncillaries": "", "addOns": ""}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}