Create (deprecated)
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/booking/agent';const options = { method: 'POST', 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 POST \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/booking/agent \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullBooks inventory on behalf of the agent identified by the managing entity, debiting their TripPay balance for the booking amount and returning the resulting confirmations.
Deprecated — removed after Thu, 01 Oct 2026 00:00:00 GMT. Use the wink.partner.v1.Booking/CreateBooking gRPC rpc instead, which requires an idempotency key so a retry cannot double-book and double-debit.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Show bookings for managing entity identifier
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Booking request including room selection, dates, and traveler details
Request to create a booking on behalf of a guest through a travel agent, containing one or more room entries along with display preferences and session context.
object
The desired currency
Example
USDThe desired language
Example
enList of room configuration booking requests. Each entry is a separately booked room.
Booking request submitted by an affiliate agent on behalf of a guest, extending the standard booking request with agent-specific external reference fields.
object
Ancillary add-ons such as spa services, meeting rooms, activities, or special amenities to accompany the room booking.
object
Channel-specific inventory blocking identifier for this ancillary reservation.
Example
7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52End date and time for the ancillary reservation (ISO-8601 format with timezone).
Example
2026-01-20T18:00:00.000+07:00Unique ancillary item identifier
Example
d5a4f2e3-7b0e-4a6d-8c5f-4d9e3b1a6c75Quantity of the ancillary being reserved (e.g., 2 spa passes, 3 activity slots).
Example
2Start date and time for the ancillary reservation (ISO-8601 format with timezone).
Example
2026-01-20T14:00:00.000+07:00Transactional travel inventory identifier linking to the actual inventory being reserved.
Example
8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29Type of ancillary (e.g., PLACE for a venue, SPA for spa services)
Example
PLACETravel inventory type identifier (e.g., venue, activity, service).
Example
8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29Example
{ "channelInventoryIdentifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "endDate": "2026-01-20T18:00:00.000+07:00", "identifier": "d5a4f2e3-7b0e-4a6d-8c5f-4d9e3b1a6c75", "quantity": 2, "startDate": "2026-01-20T14:00:00.000+07:00", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "type": "PLACE", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29"}Optional bedroom layout choice identifier if the property offers multiple configurations (e.g., king vs. twin beds).
Example
e6b3a1c9-2d7f-4a5b-8c0e-1f9d4a2b6c37Date when guest departs the premises (optional if nights is specified).
Example
2026-01-25External customer identifier
Example
customer-1External fee array
object
Withdrawal fee description
Example
Fee charged for booking confirmationFee amount
object
Monetary amount value
Example
1250ISO 4217 currency code
Example
USDExample
{ "amount": 1250, "currency": "USD"}Unique system ID.
Example
ABC1234Type of fee
Example
BOOKINGExample
{ "description": "Fee charged for booking confirmation", "fee": 450, "identifier": "ABC1234", "type": "BOOKING"}External booking code generated by the affiliate
Example
external-booking-code-1External transaction identifier
Example
external-transaction-1Unique hotel (property) record identifier.
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Number of nights for the stay (optional if endDate is specified).
Example
5Room configuration specifying guest occupancy (adults, children) and room requirements.
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Unique master rate identifier that made this room type and rate plan available for booking.
Example
5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73Special requests from the guest to the property (room location, amenities, dietary requirements, etc.).
Example
Please arrange a late check-in and prepare the room with champagne and rose petals for our anniversary.Date when guest arrives on the premises.
Example
2026-01-20Details of the person making the booking (name, email, phone, etc.).
object
First name
Example
AlexandraLast name
Example
BeaumontTelephone
Example
0123456789Example
{ "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "0123456789"}External metadata
object
Example
{ "ancillaries": [ { "channelInventoryIdentifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "endDate": "2026-01-20T18:00:00.000+07:00", "identifier": "d5a4f2e3-7b0e-4a6d-8c5f-4d9e3b1a6c75", "quantity": 2, "startDate": "2026-01-20T14:00:00.000+07:00", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "type": "PLACE", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" } ], "bedroomConfigurationIdentifier": "e6b3a1c9-2d7f-4a5b-8c0e-1f9d4a2b6c37", "endDate": "2026-01-25", "externalCustomerIdentifier": "customer-1", "externalFees": [ { "description": "Fee charged for booking confirmation", "fee": 450, "identifier": "ABC1234", "type": "BOOKING" } ], "externalSupplierBookingCode": "external-booking-code-1", "externalTransactionIdentifier": "external-transaction-1", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "nights": 5, "promotionalCodes": [ "WELCOMELUX25" ], "roomConfiguration": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "roomRateIdentifier": "5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73", "specialRequests": "Please arrange a late check-in and prepare the room with champagne and rose petals for our anniversary.", "startDate": "2026-01-20", "user": { "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "0123456789" }}Where did the booking occur
Example
https://www.traveliko.comIntegrator can choose to include a unique identifier to help identify the collection of bookings
Example
trace-1Example
{ "displayCurrency": "USD", "displayLanguage": "en", "rooms": [ { "ancillaries": [ { "channelInventoryIdentifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "endDate": "2026-01-20T18:00:00.000+07:00", "identifier": "d5a4f2e3-7b0e-4a6d-8c5f-4d9e3b1a6c75", "quantity": 2, "startDate": "2026-01-20T14:00:00.000+07:00", "transactionalTravelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "type": "PLACE", "typeIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29" } ], "bedroomConfigurationIdentifier": "e6b3a1c9-2d7f-4a5b-8c0e-1f9d4a2b6c37", "endDate": "2026-01-25", "externalCustomerIdentifier": "customer-1", "externalFees": [ { "description": "Fee charged for booking confirmation", "fee": 450, "identifier": "ABC1234", "type": "BOOKING" } ], "externalSupplierBookingCode": "external-booking-code-1", "externalTransactionIdentifier": "external-transaction-1", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "nights": 5, "promotionalCodes": [ "WELCOMELUX25" ], "roomConfiguration": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "roomRateIdentifier": "5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73", "specialRequests": "Please arrange a late check-in and prepare the room with champagne and rose petals for our anniversary.", "startDate": "2026-01-20", "user": { "firstName": "Alexandra", "lastName": "Beaumont", "telephone": "0123456789" } } ], "sourceUrl": "https://www.traveliko.com", "traceId": "trace-1"}Responses
Section titled “Responses”Agent booking created; contains booking confirmations and totals
Result of a booking confirmation operation, containing all created bookings and associated point earnings.
object
List of all bookings whether they were successful or not
object
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
The user who made the booking (may be an agent, not the traveler — see getGuestUser()).
object
First name
Full name
Last name
Telephone
User identifier
User-friendly booking confirmation code.
Booking lifecycle status.
Whether the booking can still be voluntarily cancelled (no later than the arrival day).
Cancellation details, present only when the booking is cancelled.
object
Human-readable reason for cancellation.
The cancellation policy type that was applied.
When the booking was cancelled.
Who cancelled the booking.
User identifier of the person who cancelled.
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.
Reason category for a booking cancellation
Free-form comment, used internally and by some channel managers.
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
Datetime this record was first created
The kind of booking (normal, test, etc.) — used to derive rate source.
The customization/branding context this booking was made under.
object
Whether to append text to the existing booking customization page title.
Choose the card design to use on our web component cards.
Choose how you large you want our web component cards to be.
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
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Datetime this record was first created
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.
Set a fixed itinerary end date ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
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 your users to see Google Maps in your hosted booking customization, go to Google Maps and create an API key for your site.
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.
If you are self-hosting our booking customization, let us know where it is hosted. Note: This url needs to be secured with SSL.
Unique identifier for this record.
Datetime this record was last updated
Choose how you want our web component cards laid out.
Customize booking confirmation emails by adding a custom logo to your configuration.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Engine configuration name
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.
Engine configuration record creator identifier
Name of company owner.
Indicates whether this configuration is primary. A primary configuration cannot be removed.
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.
Control how many adults / children will be staying and how many of that room to book. Defaults to: One room, two adults.
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
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
Flag to indicate you are self-hosting our booking customization and not using our default booking customization url.
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.
An integrator can choose to disable outgoing emails to properties because they want to do that themselves.
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.
Show unavailable inventory card when inventory not currently for sale. Otherwise, it displays a normal card but without the price.
Set a fixed itinerary start date. ONLY populate this field if you want to fix the itinerary date. Also, leave numberOfAdvanceDays and numberOfStayDays empty.
Sales channel sub-type.
Choose how you want our web components to look and more closely match with your own site style.
object
Body color
Danger color
Dark color
Info color
Light color
Muted color
Primary color
Secondary color
Success color
Warning color
White color
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
Optional access token for providers that require authentication
Consent category for GDPR/CCPA compliance
Custom image URL for IMAGE type pixels. Will be loaded as a 1x1 tracking pixel.
Custom JavaScript code for CUSTOM provider type. Will be injected into the page.
Whether this tracking pixel is currently active
Unique identifier for this tracking pixel
User-friendly name for this tracking pixel
Page types where this pixel should fire. Empty list or containing ALL means fire on all pages.
Provider-specific pixel ID (e.g., Facebook Pixel ID, Google Ads Conversion ID)
Tracking pixel provider
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}’
Type of tracking pixel delivery mechanism
If true, we use numberOfAdvanceDays / numberOfStayDays properties - false, we use startDate / endDate
Authenticated user identifier
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.
Action to complete once a user clicks on the CTA button on inventory.
Human-readable summary of additional charges, pre-computed from the raw entity’s derived getter.
Fixed fee for early check-in, if applicable.
object
Monetary amount value
ISO 4217 currency code
Percentage of first night charged for early check-in (alternative to fixed fee).
Full URL of the property logo, optimized for emails.
Full financial breakdown (beneficiaries, per-type amounts, currencies).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Whether funds have been recorded in the supplier’s ledger.
Date the booking’s funds become available to the supplier.
Whether all funds have been processed for this booking.
UUID grouping multiple bookings made together in a single multi-room transaction.
Guest user associated with a booking, optionally linked to a Wink platform profile
object
First name
Full name
Last name
Optional profile record
object
Datetime this record was first created
Unique identifier for this record.
Datetime this record was last updated
Detailed customer information for this profile
object
Primary address line
Secondary address line
Date of birth in ISO 8601 format
Number of children
Country of citizenship
City name
Array of emergency contact information for the customer
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Country code (ISO 3166-1 alpha-2)
Identifies the gender of the customer.
Primary language (ISO 639-1 code)
Marital status of the traveler
Array of customer’s pets
object
Pet name
Pet type
Postal code
Preferred currency for monetary values (ISO 4217 code)
State or province
Customer preferences
object
Known allergies
Preferred hotel bed type
Beverage preferences
Preferred business services
Cuisine preference
Food preferences
Preferred food service facilities
Guest type classification
Preferred hotel chain name
Interest preferences
Meal preference
Pet-friendly preferences
Preferred accessibility features
Preferred hotel property amenities
Preferred hotel property locations
Preferred hotel property types
Preferred recreation services
Preferred hotel room amenities
Preferred hotel room locations
Preferred security features
Preference for smoking allowed rooms
Profile identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
User email address
User first name
Full name
User last name
User phone number
Profile picture URL
User identifier
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.
Telephone
User identifier
Whether this booking has rate-plan-level extra charges.
The property this booking belongs to.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Profile image of the general manager.
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in.
When the guest has to check out.
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 where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
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
If pets are allowed, property can further limit on weight.
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.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
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.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Year the property was constructed.
Absolute URL of the property’s featured image.
Unique identifier for this record.
Datetime this record was last updated
Fixed fee for late checkout, if applicable.
object
Monetary amount value
ISO 4217 currency code
Percentage of first night charged for late checkout (alternative to fixed fee).
Cloudinary identifier for the property logo, for potential reuse.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
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
Net total sales amount in source currency, summed across SALE-type beneficiaries; null when not resolvable.
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
Original affiliate agency fee percentage at booking time.
Original commission percentage at booking time.
Original platform fee percentage at booking time.
Original supplier agency fee percentage at booking time.
Payment vendor/transaction metadata (transaction identifier, self-acquiring/self-disbursing flags, vendor-specific data).
object
The specific invoice this booking was registered on
The date/time the invoice was generated
Unique charge id from the vendor.
Unique customer id from the vendor.
Fees associated with this booking.
object
Withdrawal fee description
Fee amount
object
Monetary amount value
ISO 4217 currency code
Unique system ID.
Type of fee
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.
Unique session id from the vendor.
Unique transaction id from the vendor.
Name of acquiring vendor
Vendor specific values that are returned in a successful response
object
How this booking was paid for (Stripe, agent, etc.).
Third-party vendor integrated with the Wink platform for payment acquiring or disbursement
Vendor-specific payment metadata (payment method type, wallet type, etc.).
object
List of payouts disbursed to beneficiaries.
object
Account identifier of the beneficiary receiving funds.
Account name of the beneficiary.
Beneficiary type (SALE, COMMISSION, TRIP_PAY, etc.).
Payout amount in display currency.
Unique payout identifier.
Payout amount in internal (USD) currency.
When the payout was processed.
Payout amount in source currency.
Payout status (PENDING, COMPLETED, FAILED).
External withdrawal/transfer ID from payment processor.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
Refund details, present only when a refund has been issued.
object
Whether the booking should be cancelled when this refund is approved. Applied at admin-approval time, not at request time.
When the refund was created.
Human-readable description.
Refund amount in display (user) currency.
Unique refund identifier.
Refund amount in internal (USD/capture) currency.
When the refund was processed by Stripe.
Reason for the refund.
Stripe receipt URL for the refund.
Who requested the refund.
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.
Refund amount in source (supplier/hotel) currency.
Current status of this refund.
Stripe refund processing fee in internal (capture) currency, captured asynchronously via webhook from balance_transaction.fee.
Stripe Refund ID.
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
The currency for these amounts.
The gross amount.
Full name of ancillary in English.
The gross amount minus fees and commissions.
The gross amount minus fees and commissions.
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 given to us by channel manager / CRS / PMS.
The currency for these amounts.
The rate date.
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.
Displays extra charge accounting details, pre-computed from the raw entity’s derived getReportingExtraChargeList().
object
Currency code for these amounts.
Description of the extra charge.
Gross amount of the extra charge.
Name of the extra charge.
Net amount after fees and commissions.
Net amount minus any refund. Null if no refund applies.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
The guest’s review of the stay, present only after the guest has submitted one.
object
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
Category of the question (e.g., COMFORT, SERVICE, VALUE).
Review question identifier that this answer responds to.
Display order of this answer within the review.
Guest’s numeric rating for this question on a 0-10 scale.
Hotel has approved the guest’s photo for public display on their profile.
Hotel has approved this review text for public display on their profile.
Average rating across all question answers (0-10 scale).
Booking identifier this review is associated with.
Datetime this record was first created
Property (hotel) identifier this review is for.
Unique identifier for this record.
Cloudinary image identifier for guest’s photo from their stay.
Datetime this record was last updated
User identifiers who ‘liked’ this review.
Private feedback message from guest to hotel manager. Not publicly displayed.
Hotel has submitted a response to this review.
Hotel’s public response to the guest review.
Date and time the review was submitted.
Guest’s room number during their stay.
Guest’s personal rating of their room on a 0-10 scale.
Guest’s written review text.
Guest who submitted the review.
object
Guest’s email address.
Guest’s first name.
Guest’s full name.
Guest’s last name.
Guest’s phone number.
User identifier
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-time room stay snapshot (occupancy, dates, price, room/rate-plan).
object
Active cancellation policy resolved at booking time.
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
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.
The actual amount of adults as determined by the hotel’s policy.
Ancillary services attached to this room stay.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
Desired bedroom layout
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
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.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
The actual amount of children as determined by the hotel’s policy.
Check-out date
Rate plan-level extra charges
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
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
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
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Guest assigned to this room stay (lead occupant).
object
First name
Full name
Last name
Optional profile record
object
Datetime this record was first created
Unique identifier for this record.
Datetime this record was last updated
Detailed customer information for this profile
object
Primary address line
Secondary address line
Date of birth in ISO 8601 format
Number of children
Country of citizenship
City name
Array of emergency contact information for the customer
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Country code (ISO 3166-1 alpha-2)
Identifies the gender of the customer.
Primary language (ISO 639-1 code)
Marital status of the traveler
Array of customer’s pets
object
Pet name
Pet type
Postal code
Preferred currency for monetary values (ISO 4217 code)
State or province
Customer preferences
object
Known allergies
Preferred hotel bed type
Beverage preferences
Preferred business services
Cuisine preference
Food preferences
Preferred food service facilities
Guest type classification
Preferred hotel chain name
Interest preferences
Meal preference
Pet-friendly preferences
Preferred accessibility features
Preferred hotel property amenities
Preferred hotel property locations
Preferred hotel property types
Preferred recreation services
Preferred hotel room amenities
Preferred hotel room locations
Preferred security features
Preference for smoking allowed rooms
Profile identifier
Indicates whether the user wants to share this profile of themselves with hotel(s)
User details
object
User email address
User first name
Full name
User last name
User phone number
Profile picture URL
User identifier
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.
Telephone
User identifier
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
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
Datetime this record was first created
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
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.
Price details. Already quantity-scaled — its totals and breakdown represent all booked rooms.
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Stay total in wink currency (per-room x quantity).
object
Monetary amount value
ISO 4217 currency code
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Number of identical rooms booked of this type. The one money-bearing quantity.
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Stay total in hotel currency (per-room x quantity).
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
Stay total in user specified currency (per-room x quantity).
object
Monetary amount value
ISO 4217 currency code
Number of identical rooms of this type. Display only — the money-bearing quantity lives on price (BookingStayRateLightweight).
Rate plan used for this stay
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Guest room details.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
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
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
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.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
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.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
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
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
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.
Absolute URL of room image
Master rate identifier
Master rate internal name
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
Check-in 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
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
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.
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
URL or social network identifier to social network profile
Type of social network.
Source (supplier) currency code.
object
Travel blocking address (if applicable)
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Number of guests that are part of this reservation.
Travel blocking contact (if applicable)
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Date end time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
Hotel identifier
Ancillary identifier
Cloudinary image identifier
Absolute URL to image of inventory
Description of travel inventory in traveler language (if available). Defaults to English.
Name of travel inventory in traveler language (if available). Defaults to English.
Name of inventory
Pricing information for this ancillary.
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
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
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
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
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
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
Pricing type
Date start time when reservation was made for. Optional — null for ancillaries with no specific schedule (e.g. PER_STAY/PER_USE items).
Travel inventory identifier
Inventory type
Travel inventory identifier
Free-form special requests text.
Google Maps static image URL for email display.
Google Maps interactive URL for click-through.
Audit trail of status transitions.
object
Who or what triggered the transition.
Status before the transition.
Human-readable reason for the transition.
When the transition occurred.
Status after the transition.
Stripe PaymentIntent identifier for this booking’s payment, when paid via Stripe.
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
Total commissions percentage.
Total commissions percentage, adjusted for any refund.
Total fees and commissions percentage.
Total fees and commissions percentage, adjusted for any refund.
Total platform + payment-processing fee percentage.
Total platform + payment-processing fee percentage, adjusted for any refund.
Total payment-processing fee percentage.
Total payment-processing fee percentage, adjusted for any refund.
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
Platform (Wink) fee percentage only, as a fraction of gross.
Total platform fee percentage, adjusted for any refund.
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
Total loyalty tokens earned for this booking.
Device/location/referrer/itinerary snapshot captured at booking time.
object
User’s currency preference
Dates and travel info.
object
How many total children for this stay
Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.
How many total guests for this stay
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.
Room configurations
Room Configuration
object
Number of adults
Children configurations
Child configuration
object
Age of children
Number of children
Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.
How many total rooms for this stay
Start date of itinerary
User’s language preference
The preferred user lifestyle.
User can pass the current room configuration index to retrieve rates specifically for that room configuration.
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.
Total points to be earned by Wink
Total amount of money to be paid by the user in source currency
object
Monetary amount value
ISO 4217 currency code
Total amount of money to be paid by the user in display currency
object
Monetary amount value
ISO 4217 currency code
Example
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