Cancel
const url = 'https://api.wink.travel/api/booking/f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92';const options = { method: 'PATCH', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.wink.travel/api/booking/f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullCancels a single booking on behalf of the authenticated traveler, applying the cancellation policy and any resulting refund. The cancellation detail captures the reason.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Cancel booking by identifier
Example
f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Cancellation reason and any supporting notes
Details describing the reason and type of a booking cancellation
object
Cancellation type
Example
CC_INVALIDReason for cancellation
Example
Death in the familyExample
{ "cancellationType": "CC_INVALID", "reason": "Death in the family"}Responses
Section titled “Responses”Booking cancelled successfully
Lightweight, read-only projection of a booking, used by cross-domain consumers (channel managers, caldav, reporting, accounting, email templating, analytics) and every booking-web/booking-mcp surface.
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
User-friendly booking confirmation code.
Free-form comment, used internally and by some channel managers.
Free-form special requests text.
Source (supplier) currency code.
The kind of booking (normal, test, etc.) — used to derive rate source.
Booking lifecycle status.
The property this booking belongs to.
object
Unique hotel record identifier.
Timestamp of the last update to this property aggregate record.
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
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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
Monetary amount value
ISO 4217 currency code
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 of the property.
object
Name of GM currently managing the property.
Profile image of the general manager.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
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.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
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.
City location
object
GeoName identifier
GeoNameLightweight type
Name of city
Url name
Ascii name of city
Coordinate points of the city
object
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
ISO 3166-1 alpha-2 country code for the country this location belongs to
IANA timezone identifier for the location
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
Official name of the county or district in its local script
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
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 available
Booking-time room stay snapshot (occupancy, dates, price, room/rate-plan).
object
Guest room details.
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
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 inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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 inventory (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 inventory.
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 inventory 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.
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
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.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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.
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
Floor number on which this room type is located.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). 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.
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). 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.
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Desired bedroom layout
object
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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 (BookingStayRateLightweight).
Price details. Already quantity-scaled — its totals and breakdown represent all booked rooms.
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Number of identical rooms booked of this type. The one money-bearing quantity.
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Stay total in user specified currency (per-room x quantity).
object
Monetary amount value
ISO 4217 currency code
Stay total in hotel currency (per-room x quantity).
object
Monetary amount value
ISO 4217 currency code
Stay total in wink currency (per-room x quantity).
object
Monetary amount value
ISO 4217 currency code
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
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
List of perks that came with the master rate
Lightweight projection of a platform perk for use in public-facing APIs, search results, and rate configuration, omitting internal admin fields.
object
Unique identifier for this record.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Datetime this record was first created
Datetime this record was last updated
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
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Active cancellation policy resolved at booking time.
object
Unique identifier for this record.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
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.
Datetime this record was first created
Datetime this record was last updated
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Absolute URL of room image
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Guest assigned to this room stay (lead occupant).
object
User identifier
First name
Last name
Telephone
Optional profile record
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Profile identifier
User identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
User first name
User last name
User email address
User phone number
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifies the gender of the customer.
Date of birth in ISO 8601 format
Marital status of the traveler
Number of children
Country of citizenship
Primary address line
Secondary address line
City name
State or province
Postal code
Country code (ISO 3166-1 alpha-2)
Preferred currency for monetary values (ISO 4217 code)
Primary language (ISO 639-1 code)
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
Preferred hotel property locations
Preferred hotel property types
Preferred hotel chain name
Preferred hotel property amenities
Preferred recreation services
Preferred business services
Preferred security features
Preferred accessibility features
Preference for smoking allowed rooms
Preferred hotel room locations
Preferred hotel bed type
Preferred food service facilities
Preferred hotel room amenities
Guest type classification
Meal preference
Cuisine preference
Interest preferences
Beverage preferences
Food preferences
Known allergies
Pet-friendly preferences
Full name
Check-in date
Check-out date
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The user who made the booking (may be an agent, not the traveler — see getGuestUser()).
object
User identifier
First name
Last name
Telephone
Full name
The customization/branding context this booking was made under.
object
Unique identifier for this record.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
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 occupancy and guest composition for a single or multiple identical rooms
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Age of each child in this group (years)
Number of identical rooms with this configuration
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
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
ISO 3166-1 alpha-2 country code for the country this location belongs to
IANA timezone identifier for the location
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
Official name of the county or district in its local script
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
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.
Tracking pixel or web beacon configuration that fires on specified booking events 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.
Defines a booking funnel event that causes a tracking pixel to fire, together with optional custom key-value parameters sent with the event
object
The event type that triggers this pixel
Custom key-value parameters to include with the event
Key-value parameter passed with a tracking pixel event; values may be static strings or runtime placeholders such as {booking.total}
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.
Your GA4 Measurement ID (G-XXXXXXX). Configured client-side via gtag; the purchase event fires on the thank-you page, not server-side.
If you want to track analytics and you have a GTM Container ID, enter it here. Treated as a black box and loaded client-side; the container’s own tags decide what fires.
Indicates whether this configuration is primary. A primary configuration cannot be removed.
Datetime this record was first created
Datetime this record was last updated
Cancellation details, present only when 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 details, present only when a refund has been issued.
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.
Per-day reporting rate breakdown, pre-computed from the raw entity’s derived getReportingDailyRateList().
Reporting data for a single night of a booking stay, including base, gross, and net amounts for accounting purposes.
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.
Net total sales amount in source currency, summed across SALE-type beneficiaries; null when not resolvable.
object
Monetary amount value
ISO 4217 currency code
Net amount in source currency from the financial breakdown; null when not resolvable.
Net total of platform/processing fees and commissions in source currency; null when not resolvable.
object
Monetary amount value
ISO 4217 currency code
Whether this booking has rate-plan-level extra charges.
Human-readable summary of additional charges, pre-computed from the raw entity’s derived getter.
Vendor-specific payment metadata (payment method type, wallet type, etc.).
object
Explicit per-child ages captured on the user’s selected room configuration at booking time, when present (channel-manager-omnibees fallback data); empty when not present.
UUID grouping multiple bookings made together in a single multi-room transaction.
Full URL of the property logo, optimized for emails.
Cloudinary identifier for the property logo, for potential reuse.
Absolute URL of the property’s featured image.
Google Maps static image URL for email display.
Google Maps interactive URL for click-through.
Fixed fee for early check-in, if applicable.
object
Monetary amount value
ISO 4217 currency code
Fixed fee for late checkout, if applicable.
object
Monetary amount value
ISO 4217 currency code
Percentage of first night charged for early check-in (alternative to fixed fee).
Percentage of first night charged for late checkout (alternative to fixed fee).
Stripe PaymentIntent identifier for this booking’s payment, when paid via Stripe.
How this booking was paid for (Stripe, agent, etc.).
Original platform fee percentage at booking time.
Original commission percentage at booking time.
Original supplier agency fee percentage at booking time.
Total fees and commissions percentage.
Total fees and commissions percentage, adjusted for any refund.
Total commissions percentage, adjusted for any refund.
Total payment-processing fee percentage.
Total payment-processing fee percentage, adjusted for any refund.
Total platform fee percentage, adjusted for any refund.
Full financial breakdown (beneficiaries, per-type amounts, currencies).
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Payment vendor/transaction metadata (transaction identifier, self-acquiring/self-disbursing flags, vendor-specific data).
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
Monetary amount value
ISO 4217 currency code
Type of fee
Withdrawal fee description
Vendor specific values that are returned in a successful response
object
Whether the booking’s travel agent acquires (collects) the guest payment themselves, outside Wink/TripPay. Snapshot of the agent’s setting at booking time.
Whether the booking’s travel agent disburses funds to the supplier themselves, outside Wink/TripPay. Snapshot of the agent’s setting at booking time. When self-acquires AND self-disburses are both true, the SALE and COMMISSION amounts never touch Wink’s ledger and are not withdrawable.
Device/location/referrer/itinerary snapshot captured at booking time.
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.
Per-ancillary reporting accounting details, pre-computed from the raw entity’s derived getReportingAncillaryList().
Reporting data for a single ancillary booking, including gross and net amounts in the property’s source currency.
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.
The guest’s review of the stay, present only after the guest has submitted one.
object
Unique identifier for this record.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Booking identifier this review is associated with.
Property (hotel) identifier this review is for.
Guest who submitted the review.
object
User identifier
Guest’s first name.
Guest’s last name.
Guest’s email address.
Guest’s phone number.
Guest’s full name.
Date and time the review was submitted.
Average rating across all question answers (0-10 scale).
Guest’s answers to each review question with their scores.
A guest’s recorded answer to a single review question, including the score and question metadata.
object
Review question identifier that this answer responds to.
Category of the question (e.g., COMFORT, SERVICE, VALUE).
Display order of this answer within the review.
Guest’s numeric rating for this question on a 0-10 scale.
Private feedback message from guest to hotel manager. Not publicly displayed.
Hotel’s public response to the guest review.
Cloudinary image identifier for guest’s photo from their stay.
Guest’s written review text.
Hotel has approved this review text for public display on their profile.
Hotel has approved the guest’s photo for public display on their profile.
User identifiers who ‘liked’ this review.
Guest’s room number during their stay.
Guest’s personal rating of their room on a 0-10 scale.
Hotel has submitted a response to this review.
Datetime this record was first created
Datetime this record was last updated
The URL the booking occurred on.
List of all social network accounts the 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
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.
Original affiliate agency fee percentage at booking time.
Total platform + payment-processing fee percentage.
Total platform + payment-processing fee percentage, adjusted for any refund.
Platform (Wink) fee percentage only, as a fraction of gross.
Total commissions percentage.
Total loyalty tokens earned for this booking.
Date the booking’s funds become available to the supplier.
Whether all funds have been processed for this booking.
Whether funds have been recorded in the supplier’s ledger.
Displays extra charge accounting details, pre-computed from the raw entity’s derived getReportingExtraChargeList().
object
Name of the extra charge.
Description of the extra charge.
Gross amount of the extra charge.
Net amount after fees and commissions.
Net amount minus any refund. Null if no refund applies.
Currency code for these amounts.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Reason category for a booking cancellation
Whether the booking can still be voluntarily cancelled (no later than the arrival day).
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Third-party vendor integrated with the Wink platform for payment acquiring or disbursement
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Guest user associated with a booking, optionally linked to a Wink platform profile
object
User identifier
First name
Last name
Telephone
Optional profile record
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Profile identifier
User identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
User first name
User last name
User email address
User phone number
Profile picture URL
Full name
Detailed customer information for this profile
object
Identifies the gender of the customer.
Date of birth in ISO 8601 format
Marital status of the traveler
Number of children
Country of citizenship
Primary address line
Secondary address line
City name
State or province
Postal code
Country code (ISO 3166-1 alpha-2)
Preferred currency for monetary values (ISO 4217 code)
Primary language (ISO 639-1 code)
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
Preferred hotel property locations
Preferred hotel property types
Preferred hotel chain name
Preferred hotel property amenities
Preferred recreation services
Preferred business services
Preferred security features
Preferred accessibility features
Preference for smoking allowed rooms
Preferred hotel room locations
Preferred hotel bed type
Preferred food service facilities
Preferred hotel room amenities
Guest type classification
Meal preference
Cuisine preference
Interest preferences
Beverage preferences
Food preferences
Known allergies
Pet-friendly preferences
Full name
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Example
{ "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12", "version": 3, "hotel": { "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name": "The Siam Residences, Bangkok", "localName": "เดอะสยาม เรสซิเดนซ์", "chain": "The Siam Collection", "brand": "The Siam Residences", "urlName": "the-siam-residences-bangkok-thailand", "uniqueId": "siam-residences-bkk", "starRating": 5, "bookings": 6054, "aggregateReviewRating": 8.7, "location": { "type": "Point", "coordinates": [ 100.5581533, 13.7370197 ] }, "descriptions": [ { "title": "Luxury Riverside Retreat", "description": "An elegant riverside sanctuary in the heart of Bangkok.", "language": "en" } ], "aggregateGreendexRating": 7, "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "totalReviews": 989, "reservations": { "firstName": "Somchai", "lastName": "Phattanapong", "phone": "+66-2-123-4567" }, "socials": [ { "platform": "INSTAGRAM", "handle": "thesiamresidences" } ], "images": [ { "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "sort": 10, "published": true } ], "videos": [], "thirdPartyReviews": [], "attractions": 5, "activities": 3, "places": 9, "restaurants": 2, "meetingRooms": 2, "spas": 1, "addOns": 5, "locationCategory": "34", "segmentCategory": "7", "hotelCategory": "45", "architecturalStyle": "7", "whenBuilt": "1927", "currencyCode": "THB", "score": 70, "hotelAmenityCodes": [ "1", "7" ], "propertyAccessibilityCodes": [ "1" ], "propertySecurityCodes": [ "7" ], "numberOfRooms": 32, "address": { "line1": "3/2 Khao Road", "city": "Bangkok", "state": "Bangkok", "postalCode": "10300", "countryCode": "TH" }, "available": true }, "roomStay": { "room": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12", "version": 3, "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "featuredInd": false, "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "location": { "type": "POINT", "coordinates": [ 100.5581533, 13.7370197 ] }, "descriptions": [ { "name": "Deluxe River View Suite", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "creator": "USER", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82" } ], "multimedias": [ { "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "source": "CLOUDINARY", "sort": 10, "angle": null, "width": 2560, "height": 1600, "published": true, "category": "2", "descriptions": [ { "title": "Lobby Entrance", "description": "Elegant lobby of The Siam Residences", "language": "en" } ], "lifestyleType": null, "attribution": [], "isLandscape": true } ], "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "commissionable": true, "name": "Archery lesson", "proximityCode": "1", "sort": 1, "minAgeAppropriateCode": "1", "bookable": true, "active": true, "socials": [ { "type": "INSTAGRAM", "location": "https://www.instagram.com/thesiamresidences" } ], "pricePoint": "THREE", "recognitionList": [ { "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "category": "AWARD", "type": "PERCENT_RATING", "provider": "Michelin", "rating": 8.5, "maxRating": 10, "date": "2026-01-14", "officialAppointmentInd": true, "ratingSymbol": "*" } ], "publishStatus": "PUBLISHED", "maxOccupancy": 2, "minOccupancy": 1, "quantity": 40, "nonSmoking": true, "bedroomConfigurationList": [ { "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Master Suite Layout", "bedroomList": [ { "type": "MASTER", "bedList": [ { "bedTypeCode": "1", "quantity": 2 } ] } ] } ], "size": 55, "maxAdultOccupancy": 1, "maxChildOccupancy": 0, "bathroomCount": 0, "livingRoomCount": 0, "maxRollaways": 0, "roomCategory": "1", "floor": "3", "roomLocationCode": "1", "roomViewCode": "1", "composite": false, "compositeCount": 2, "roomClassificationCode": "1", "roomArchitectureCode": "1", "roomGender": "Female", "sharedRoomInd": false, "maxCribs": 1, "includedAdultOccupancy": 2, "includedChildOccupancy": 0 }, "bedroomConfiguration": { "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Master Suite Layout", "bedroomList": [ { "type": "MASTER", "bedList": [ { "bedTypeCode": "1", "quantity": 2 } ] } ] }, "adults": 2, "children": 0, "quantity": 1, "price": { "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "quantity": 2, "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "offerDetails": [ { "description": "This is a longer description in the specified language.", "language": "en", "creator": "USER", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } }, "roomRateIdentifier": "5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73", "roomRateInternalName": "Master Rate 1", "ratePlan": { "name": "BAR 1", "breakfast": false, "brunch": false, "lunch": false, "dinner": false, "allInclusive": false, "allInclusivePlusAlcohol": false }, "perkTypes": [ "PERK_FREE_DRINK_VOUCHER", "PERK_EARLY_CHECKIN" ], "extraCharges": { "items": [ { "ratePlanLevelFee": { "descriptions": [ { "description": "This is a longer description in the specified language.", "language": "en", "creator": "USER", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "fixedAmount": 450, "type": "PER_DAY" }, "unitPrice": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" } }, "activeCancellationPolicy": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "version": 3, "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "refundable": false, "advanceCancellationFreeOfCharge": "UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL", "refundableCancellationCharge": "FIFTY_PERCENT", "noShowCharge": "SAME_AS_CANCELLATION_FEE", "nonRefundableCancellationCharge": "SEVENTY_PERCENT", "nonRefundableDeadline": "SEVEN_DAYS_BEFORE_ARRIVAL", "nonRefundableAfterDeadlineCancellationCharge": "ONE_HUNDRED_PERCENT", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12" }, "ancillaryList": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "roomImageUrl": "https://path.to/room-image.jpg", "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] }, "guestUser": { "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "+1 212 555 1212", "profile": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12", "version": 3, "profileIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "share": true, "user": { "firstName": "Alexandra", "lastName": "Beaumont", "phone": "+66212658866", "profilePictureUrl": "https://res.cloudinary.com/wink/image/upload/v1/user/alexandra-beaumont.jpg", "fullName": "Alexandra Beaumont" }, "personal": { "gender": "FEMALE", "birthDate": "1985-06-15", "maritalStatus": "MARRIED", "childQuantity": 2, "citizenship": "Thailand", "address1": "123 Petchburi Road", "address2": "Ratchathewi District", "city": "Bangkok", "state": "Bangkok", "postalCode": "10400", "country": "TH", "preferredCurrency": "USD", "language": "en", "contactPerson": [ { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", } ], "petInfo": [ { "name": "Luna", "type": "Golden Retriever" } ] }, "preferences": { "propertyLocationPref": "Beachfront", "propertyTypePref": "Luxury Resort", "hotelChainPref": "Mandarin Oriental", "physChalFeaturePref": "Wheelchair accessible rooms", "smokingAllowed": false, "roomLocationPref": "High floor with city view", "bedTypePref": "King bed", "foodSrvcPref": "In-room dining", "guestType": "Business traveler", "mealPref": "Continental breakfast", "cuisinePref": "Thai" } }, "fullName": "Alexandra Beaumont" }, "startDate": "2025-12-24", "endDate": "2025-12-27", "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "booker": { "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "+1 212 555 1212", "fullName": "Alexandra Beaumont" }, "customization": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "version": 3, "name": "Luxury Travel Portal", "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "Premium Hotels International", "subType": "APPLICATION", "defaultCurrency": "THB", "defaultLanguage": "en", "defaultLifestyle": "LIFESTYLE_HEALTH_FITNESS", "logos": [ { "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "identifier": "the-siam-residences/lobby-entrance", "type": "IMAGE", "source": "CLOUDINARY", "sort": 10, "angle": null, "width": 2560, "height": 1600, "published": true, "category": "2", "descriptions": [ { "title": "Lobby Entrance", "description": "Elegant lobby of The Siam Residences", "language": "en" } ], "lifestyleType": null, "attribution": [], "isLandscape": true } ], "hostedBookingEngineUrl": "https://book.thesiamresidences.com/reservations", "selfHosted": true, "themeColors": { "primary": "#dc3545", "secondary": "#6c757d", "success": "#28a745", "danger": "#dc3545", "warning": "#ffc107", "info": "#17a2b8", "light": "#f8f9fa", "dark": "#343a40", "body": "#212529", "muted": "#6c757d", "white": "#ffffff" }, "cardLayout": "VERTICAL", "layout": "INFORMATIONAL", "cardDesign": "DEFAULT", "numberOfAdvanceDays": 7, "numberOfStayDays": 3, "startDate": "2026-07-15", "endDate": "2026-07-22", "roomConfigurations": [ { "adults": 2, "children": [ { "quantity": 2, "age": 7 } ], "quantity": 1 } ], "useDays": true, "sendBookingNotificationEmailsToProperty": true, "sendBookingNotificationEmailsToBooker": true, "sendBookingNotificationEmailsToChannelManager": true, "wcBookClickAction": "IBE_MODAL", "city": { "geoNameId": "1609350", "type": "CITY", "name": "Bangkok", "urlName": "bangkok-thailand", "asciiName": "Bangkok", "alternateNames": [ "Krung Thep", "BKK" ], "location": { "type": "POINT", "coordinates": [ 100.5581533, 13.7370197 ] }, "featureClass": "P", "featureCode": "PPLC", "countryCode": "TH", "alternateCountryCodes": [], "admin1Code": "40", "admin2Code": "2401", "admin3Code": "", "admin4Code": "", "population": 10539415, "elevation": 5, "digitalElevationModel": "3", "timezone": "Asia/Bangkok", "modificationDate": "2023-06-15", "radiusInMeters": 50000, "country": { "iso": "TH", "iso3": "THA", "isoNumeric": 764, "fips": "TH", "name": "Thailand", "capital": "Bangkok", "area": 514000, "population": 69428524, "continent": "AS", "topLevelDomain": ".th", "currencyCode": "THB", "currencyName": "Baht", "phone": "66", "postalCodeFormat": "#####", "postalCodeRegEx": "^(\\d{5})$", "languages": [ "th" ], "geoNameId": "1605651", "neighbors": [ "LA", "MM", "KH", "MY" ] }, "subCountry": { "code": "TH.40", "countryCode": "TH", "subCountryCode": "40", "name": "Bangkok", "asciiName": "Bangkok", "geoNameId": "1609350" }, "subSubCountry": { "code": "TH.40.2401", "countryCode": "TH", "subCountryCode": "40", "subSubCountryCode": "2401", "name": "Bangkok District", "asciiName": "Bangkok District", "geoNameId": "1609352" } }, "showUnavailableCard": false, "showRankings": true, "showSearch": true, "trackingPixels": [ { "identifier": "f8e4b2c9-3a7d-4c1f-9e5b-2d6f1a8c4e73", "name": "Facebook Conversion Pixel", "type": "JAVASCRIPT", "provider": "FACEBOOK", "consentCategory": "MARKETING", "enabled": true, "pixelId": "1234567890", "accessToken": "EAABsbCS0kB4BAAI...", "customScript": "!function(f,b,e,v,n,t,s){/* custom pixel code */}(window, document);", "customImageUrl": "https://res.cloudinary.com/wink/image/upload/v1/pixel/conversion.gif", "triggers": [ { "eventType": "PURCHASE", "parameters": [ { "key": "currency", "value": "USD" } ] } ] } ], "googleAnalyticsMeasurementId": "G-ABCDEF1234", "googleTagManagerContainerId": "GTM-XXXXX", "primary": true, "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12" }, "cancellation": { "cancelledOn": "2026-01-15T10:30:00Z", "cancellerType": "TRAVELER", "cancellationType": "FREE_CANCELLATION", "cancellerUserIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "cancelReason": "Guest changed travel plans", "groupRefundNotified": false }, "refund": { "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "stripeRefundId": "re_abc123", "sourceAmount": 450, "internalAmount": 12.75, "displayAmount": 12.75, "description": "Guest requested cancellation", "reason": "REQUESTED_BY_CUSTOMER", "status": "SUCCEEDED", "requestor": "BY_ADMIN", "createdDate": "2026-01-15T10:30:00Z", "processedDate": "2026-01-15T10:30:00Z", "receiptUrl": "https://pay.stripe.com/receipts/abc123", "stripeRefundFee": 0.5, "cancelOnRefund": "NONE", "response": "Approved — refunding 50% per policy." }, "reportingDailyRateList": [ { "date": "2026-01-15", "baseAmount": 450, "grossAmount": 405, "netAmount": 360, "netAmountWithRefund": 360, "currency": "USD" } ], "netTotalSalesSourceAmount": { "amount": 1250, "currency": "USD" }, "netTotalFeesAndCommissionsSourceAmount": { "amount": 1250, "currency": "USD" }, "hasAdditionalCharges": false, "earlyCheckInCharge": { "amount": 1250, "currency": "USD" }, "lateCheckOutCharge": { "amount": 1250, "currency": "USD" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] }, "paymentDetails": { "vendor": "STRIPE", "sessionIdentifier": "s_abc123", "transactionIdentifier": "pi_3abc123", "customerIdentifier": "cus_abc123", "chargeIdentifier": "ch_abc123", "agentInvoicedDate": "2017-12-22T03:07:58.742+0000", "agentInvoiceIdentifier": "invoice-1", "fees": [ { "identifier": "ABC1234", "fee": 450, "type": "BOOKING", "description": "Fee charged for booking confirmation" } ], "selfAcquires": false, "selfDisburses": false }, "userSession": { "itinerary": { "startDate": "2024-01-01", "endDate": "2024-01-02", "nights": 7, "items": [ { "adults": 2, "children": [ { "quantity": 2, "age": 8 } ] } ] }, "language": "en", "currency": "USD", "promotionalCodes": [ "promo-1" ], "selectedRoomConfigurationIndex": 0, "lifestyle": "LUXURY" }, "reportingAncillaryList": [ { "name": "Thai Massage", "grossAmount": 450, "netAmount": 405, "netAmountWithRefund": 405, "currency": "USD" } ], "review": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "version": 3, "bookingIdentifier": "f4d1c8e5-2b9a-4f3d-9e7c-1b6a5d3f8c92", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "user": { "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "+66 2 126 8866", "fullName": "Alexandra Beaumont" }, "reviewDate": "2026-01-14T09:30:00", "averageScore": 8.7, "answers": [ { "questionIdentifier": "4d7c2a6b-9e3f-4b1a-8d0c-7f5e1a9b3c62", "category": "SERVICE", "sort": 1, "value": 7 } ], "messageFromGuest": "Dear GM, I would like to say thank you so much for taking the time to show my husband and me around the premises and the secret cave behind the property.", "responseFromHotel": "Thank you so much for taking the time to share such wonderful feedback about your stay at The Siam Residences. We're delighted that you and your husband had such a memorable experience. We look forward to welcoming you back soon!", "imageIdentifier": "wink/review/siam-residences-2026-01-14-xyz123abc", "text": "Our stay was amazing! The staff made us feel truly welcomed, and the traditional Thai breakfast was exceptional. Can recommend highly to all. Felt like home.", "approvedText": true, "approvedImage": false, "roomNumber": "501", "roomRating": 9, "responded": false, "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12" }, "socials": [ { "type": "INSTAGRAM", "location": "https://www.instagram.com/thesiamresidences" } ], "payoutList": [ { "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "Hotel Sunrise", "beneficiaryType": "SALE", "sourceAmount": 450, "internalAmount": 12.75, "displayAmount": 12.75, "status": "COMPLETED", "processedDate": "2026-01-15T10:30:00Z", "withdrawalId": "tr_abc123" } ], "statusHistory": [ { "fromStatus": "PENDING", "toStatus": "CONFIRMED", "timestamp": "2026-01-15T10:30:00Z", "actor": "stripe-webhook", "reason": "Payment confirmed by Stripe" } ], "fundsProcessed": false, "fundsAddedToLedger": false, "reportingExtraChargeList": [ { "name": "Late checkout fee", "description": "The charge is 50.00 USD and is charged per day.", "grossAmount": 450, "netAmount": 405, "netAmountWithRefund": 405, "currency": "USD" } ], "meetingRooms": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "restaurants": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "spas": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "activities": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "attractions": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "places": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "roomTypeAncillaries": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "addOns": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ], "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ], "cancellable": false, "netTotalSalesSourceAmountOrZero": { "amount": 1250, "currency": "USD" }, "totalSalesSourceAmount": { "amount": 1250, "currency": "USD" }, "totalPlatformFeeSourceAmount": { "amount": 1250, "currency": "USD" }, "totalPaymentProcessingFeeSourceAmount": { "amount": 1250, "currency": "USD" }, "commissionableSourceAmount": { "amount": 1250, "currency": "USD" }, "totalAffiliateAgencyFeesSourceAmount": { "amount": 1250, "currency": "USD" }, "totalSupplierAgencyFeesSourceAmount": { "amount": 1250, "currency": "USD" }, "guestUser": { "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "+1 212 555 1212", "profile": { "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "createdDate": "2026-01-14T09:30:00", "lastUpdate": "2026-02-03T16:45:12", "version": 3, "profileIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "userIdentifier": "c3a9f2e1-8b4d-4c7a-a1e2-5f0b6d9e2c84", "share": true, "user": { "firstName": "Alexandra", "lastName": "Beaumont", "phone": "+66212658866", "profilePictureUrl": "https://res.cloudinary.com/wink/image/upload/v1/user/alexandra-beaumont.jpg", "fullName": "Alexandra Beaumont" }, "personal": { "gender": "FEMALE", "birthDate": "1985-06-15", "maritalStatus": "MARRIED", "childQuantity": 2, "citizenship": "Thailand", "address1": "123 Petchburi Road", "address2": "Ratchathewi District", "city": "Bangkok", "state": "Bangkok", "postalCode": "10400", "country": "TH", "preferredCurrency": "USD", "language": "en", "contactPerson": [ { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", } ], "petInfo": [ { "name": "Luna", "type": "Golden Retriever" } ] }, "preferences": { "propertyLocationPref": "Beachfront", "propertyTypePref": "Luxury Resort", "hotelChainPref": "Mandarin Oriental", "physChalFeaturePref": "Wheelchair accessible rooms", "smokingAllowed": false, "roomLocationPref": "High floor with city view", "bedTypePref": "King bed", "foodSrvcPref": "In-room dining", "guestType": "Business traveler", "mealPref": "Continental breakfast", "cuisinePref": "Thai" } }, "fullName": "Alexandra Beaumont" }, "ancillaryList": [ { "identifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "name": "Thai Massage Spa Treatment", "pricingType": "PER_USE", "type": "ADD_ON", "price": { "sourceToUserCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "sourceToInternalCurrencyQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyPromotionalModifier": -40, "sourcePromotionalModifier": -40, "internalPromotionalModifier": -40, "userSpecifiedCurrencyPremiumModifier": 40, "sourcePremiumModifier": 40, "internalPremiumModifier": 40, "userSpecifiedCurrencyChannelModifier": -10, "sourceChannelModifier": -10, "internalChannelModifier": -10, "quantity": 1, "sourceTotal": { "amount": 1250, "currency": "USD" }, "internalTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "startDate": "2017-12-22T03:07:58.742+0000", "endDate": "2017-12-22T08:07:58.742+0000", "attendees": 2, "imageIdentifier": "cloudinary-image-1", "imageUrl": "https://path.to.image.com/this-is-me.jpg", "localizedName": "Plass 1", "localizedDescription": "place-1", "contact": { "firstName": "Alexandra", "lastName": "Beaumont", "phoneNumber": "+12125551212", "fullName": "Alexandra Beaumont", }, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "state": "CA", "postalCode": "90210", "county": "Alameda county", "city": "Bangkok", "countryCode": "TH", "country": "United States", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States" }, "financialBreakdown": { "displayPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "internalPriceQuote": { "source": "USD", "target": "THB", "exchangeRate": 33.5, "timestamp": 1705233000000 }, "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "sourceCurrency": "THB", "displayCurrency": "USD", "internalCurrency": "USD", "sourceAmount": 450, "displayAmount": 450, "internalAmount": 450, "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "pendingRefunds": [ { "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45, "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45 } ], "netSourceAmount": 450, "netDisplayAmount": 450, "netInternalAmount": 450, "reconciled": false } ] } } ]}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable