Reservations PUSH
Overview
The Reservations PUSH API operates using SOAP/XML and facilitates the automatic deliver of reservation data, including reservations, modifications, and cancellations from the SiteMinder Platform to the PMS system. These reservations are generated from the hotel's connected booking channels and are pushed to the PMS.
Message Exchange Flow:
SiteMinder to PMS: SiteMinder sends
OTA_HotelResNotifRQto the PMS's endpoint to deliver reservations, modifications, and cancellations.PMS to SiteMinder: PMS responds with
OTA_HotelResNotifRSto confirm delivery of the reservation (success or failure).PMS to SiteMinder: The PMS must send
OTA_HotelAvailNotifRQto SiteMinder with the updated availability after the reservation is processed on the PMS system, refer to the Availability and Restrictions API.
Integration Requirements
Web Service Endpoint
The PMS must provide a web service endpoint for SiteMinder to push OTA_HotelResNotifRQ messages and receive corresponding OTA_HotelResNotifRS responses indicating success or failure.
The endpoint must use a registered domain name.
Direct IP addresses are not supported and cannot be used as endpoints.
Protocol & Security
All communication must occur over HTTPS using TLS 1.2 or higher. The pmsXchange service sends reservations over port 443.
Non-secure (HTTP) connections are not permitted.
SOAP messages must include a SOAP Security header for authentication and a SOAP Body containing the OTA message.
Communication is handled via synchronous request/response pairs, where each message is atomic-processed entirely or not at all.
SOAP Message Structure
All SOAP messages (Requests/Responses) exchanged between SiteMinder and the PMS/RMS must:
Adhere to the SOAP message format.
Encapsulate the OTA message within the SOAP Body.
Requests must include a SOAP Security Header for authentication purposes.
Responses must be returned in a SOAP envelope. However, the SOAP Header should be empty.
Authentication
SiteMinder will include authentication credentials within the SOAP Security header of each request that contains the OTA_HotelResNotifRQ message in the body.
The PMS must provide SiteMinder with a single username and password for authentication. These credentials must be global and used across all hotels connected through the integration.
Credentials must follow a strong password policy:
Minimum of 8 charaters
Must include a mix of uppercase and lowercase letters, numbers, and at least one special character (e.g., ! @ # ? ])
Do not use
<,>,&,",'in usernames or passwords, as they can cause issues with the Web Service
Content-Type
All SOAP XML requests and responses to SiteMinder must have a Content-Type of 'text/xml; charset=utf-8'. Other Content-Types will not be accepted.
IP Whitelisting
To ensure seamless communication, you must whitelist the following SiteMinder IP addresses. This allows SiteMinder to send messages from its environments to your web service endpoint. The IPs listed below are for the Pre-Production (Test) Environment.
Pre-Production (Test) Environments to whitelist:
52.13.134.140
34.213.128.113
35.164.250.223
Production IP addresses will be provided separately when you are ready to move to Production Environment. Please ensure you request these from our Partner Integration team if your system requires whitelisting of IPs.
Request Structure
Security Header
The Security Header structure conveys authentication information.
Example:
<SOAP-ENV:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header>
<wsse:Security soap:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken>
<wsse:Username>USERNAME</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">SECRET</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<OTA_HotelResNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
<!-- ... other elements and attributes have been omitted for brevity ... -->
</OTA_HotelResNotifRQ>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>OTA_HotelResNotifRQ Specification
When a new reservation, modification or cancellation message is received in the SiteMinder Platform, it stores each reservation contained in the incoming message. SiteMinder Platform then attempts to push each OTA_HotelResNotifRQ message to the PMS web service endpoint.
The message consists of a list of HotelReservation elements. The content may vary since SiteMinder delivers reservations from multiple upstream sources (Booking Channels), many of which have significantly different reservation formats and data structures.
In general, the following applies to HotelReservations:
A HotelReservation represents a single reservation made with an upstream system.
A HotelReservation can include one or more RoomStays, one for each booked room type.
A RoomStay signifies a stay in a specific room type over a continuous timespan; non-continuous stays (split stays) will result in multiple RoomStays.
A HotelReservation may have zero, one, or multiple ResGuests associated with either the RoomStay they occupy or the reservation itself.
<OTA_HotelResNotifRQ
xmlns="http://www.opentravel.org/ota/2003/05" EchoToken="echo-abc123" PrimaryLangID="en-us" ResStatus="Commit" Target="Production" TimeStamp="2025-03-09T21:32:52+02:00" Version="2.001">
<HotelReservations>
<!-- ... other elements and attributes have been omitted for brevity ... -->
</HotelReservations>
</OTA_HotelResNotifRQ>OTA_HotelResNotifRQ
Element
1
Root element for the request.
@xmlns
String
1
Defines the XML namespace for the request. Will be set to http://www.opentravel.org/OTA/2003/05
@ResStatus
String
1
Always "Commit"
@EchoToken
String
1
Unique identifier for the request, used to match requests and responses.
@PrimaryLangID
String
1
Always en-us
@Target
String
1
Always "Production"
@TimeStamp
DateTime
1
Time when the request was generated.
@Version
Decimal
1
Specifies the API version. Current Version 2.001
Hotel Reservation
<HotelReservations>
<HotelReservation CreateDateTime="2025-05-12t00:45:23+00:00" ResStatus="Book">
<POS>
<Source>
<RequestorID Type="22" ID="SITEMINDER"/>
<BookingChannel Primary="True" Type="7">
<CompanyName Code="RTG">Ratestogo</CompanyName>
</BookingChannel>
</Source>
<Source>
<BookingChannel Primary="False" Type="7">
<CompanyName>Expedia</CompanyName>
</BookingChannel>
</Source>
</POS>
<UniqueID Type="14" ID="RTG-5-0"/>
................
</HotelReservation>
</HotelReservations>HotelReservations
Element
1
Contains the reservation details.
HotelReservation
Element
1
Contains the specific reservation information.
@CreateDateTime
DateTime
1
Date and time when the reservation was first made. Mandatory if ResStatus is "Book".
@ResStatus
String
1
Status is:
"Book"
"Modify"
"Cancel"
@LastModifyDateTime
DateTime
0..1
This indicates the last date and time when the reservation was last modified. Mandatory if ResStatus is "Modify" or "Cancel".
UniqueID
Element
1..2
The reservation reference in SiteMinder.
The first UniqueID element will contain the unique identifier for the entire reservation. This identifier will identify the reservation through any subsequent modifications or cancellations.
The second UniqueID element with ID_Context="MESSAGE_UNIQUE_ID" is the unique id for this message. This identifier should be used to confirm the message once processed
@Type
Integer
1
Value '14' is the unique ID for the reservation in Siteminder. Value '16' is the unique id for the message transferring the reservation.
@ID
String
1
Identifier of the reservation according to SiteMinder.
POS
Element
1
Contains source details.
Source
Element
1..2
Contains BookingChannel details. A second POS / Source node can be present to define a secondary channel source
RequestorID
Element
1
@ID
String
1
Value is always 'SITEMINDER'
@Type
Integer
1
Fixed at 22 (ESRP)
BookingChannel
Element
1
@Type
Integer
1
Always '7' for 'Internet'.
@Primary
Boolean
1
Indicates the primary booking source
CompanyName
String
1
Name of the Booking Channel.
NOTE: This name is subject to change/variation by the Booking Channel. Please use the @Code attribute below to identify Booking Channels on incoming reservations.
RoomStays
<RoomStays>
<RoomStay MarketCode="Corporate" PromotionCode="STAYANDSAVE" SourceOfBusiness="Radio">
<RoomTypes>
<RoomType RoomType="Double Room" RoomTypeCode="DR" NonSmoking="true" Configuration="2 Beds and 1 cot">
<!-- Additional RoomType elements -->
</RoomType>
</RoomTypes>
<RatePlans>
<!-- Additional RatePlan elements -->
</RatePlan>
</RatePlans>
<RoomRates>
<RoomRate RoomTypeCode="DR" RatePlanCode="RAC1" NumberOfUnits="1">
<!-- Additional RoomRate elements -->
</RoomRate>
</RoomRates>
<!-- Additional RoomStay elements -->
</RoomStay>
</RoomStays>RoomStays
Element
1
Contains details of all room stays.
RoomStay
Element
1..n
One instance of RoomStay per room type booked.
@PromotionCode
String
0..1
If configured, this is the promotion code indicating, for instance, a specific marketing campaign (not the rate code).
@MarketCode
String
0..1
A code to match a market segment for the booking.
@SourceOfBusiness
String
0..1
Specifies where the business came from e.g. radio, newspaper ad, etc.
RoomTypes
<RoomTypes>
<RoomType RoomType="Double Room" RoomTypeCode="DR" NonSmoking="true" Configuration="2 Beds and 1 cot">
<RoomDescription>
<Text>Double room</Text>
</RoomDescription>
<AdditionalDetails>
<AdditionalDetail Type="4" Code="PIA">
<DetailDescription>
<Text>Room paid in advance with credit card</Text>
</DetailDescription>
</AdditionalDetail>
<AdditionalDetail Type="5" Code="ECB">
<DetailDescription>
<Text>Continental breakfast included</Text>
</DetailDescription>
</AdditionalDetail>
</AdditionalDetails>
</RoomType>
</RoomTypes>RoomTypes
Element
0..1
Provides more information about the room type for this room stay.
RoomType
Element
0..1
Contains specific information about the room type.
@RoomTypeCode
String
0..1
Code of the room booked.
@NonSmoking
Boolean
0..1
Provided by the source channel
@Configuration
String
0..1
Information about the bedding configuration
RoomDescription
Element
0..1
Description of the room.
@Text
String
0..1
Name of the room.
AdditionalDetails
Element
0..n
Additional room information provided by the source channel.
AdditionalDetail
Element
0..n
@Type
Integer
1
Please refer to the OTA Additional Detail Type (ADT) Code Table Common usages are
43: Meal plan information 15: Promotion information
@Code
String
0..1
Reference code provided by the source channel
DetailDescription
Element
0..1
@Text
String
1
Details provided by the source channel
RatePlans
<RatePlans>
<RatePlan RatePlanCode="RAC1" EffectiveDate="2025-03-12" ExpireDate="2025-03-14" RatePlanName="RACK Rate1">
<RatePlanDescription>
<Text>Long Stay Discount</Text>
</RatePlanDescription>
<AdditionalDetails>
<AdditionalDetail Type="15" Code="EB1">
<DetailDescription>
<Text>Stay n Save promotion grants 10% discount</Text>
</DetailDescription>
</AdditionalDetail>
<AdditionalDetail Type="43">
<DetailDescription>
<Text>Continental breakfast included</Text>
</DetailDescription>
</AdditionalDetail>
</AdditionalDetails>
</RatePlan>
</RatePlans>RatePlans
Element
0..1
Provides more information about the rate plan for this room stay.
RatePlan
Element
0..n
Contains details about the specific rate plan.
@RatePlanCode
String
0..1
Code of the rate booked.
@RatePlanName
String
0..1
@EffectiveDate
1
The effective date of the RatePlan
@ExpireDate
Date
1
The expire date for a RatePlan, this should be considered an exclusive date, the date for which the current rate plan information is no longer valid.
RatePlanDescription
Element
0..1
Description of the rate plan.
@Text
String
0..1
AdditionalDetails
Element
0..n
Additional rate plan information provided by the source channel.
AdditionalDetail
Element
0..n
@Type
Integer
1
Please refer to the OTA Additional Detail Type (ADT) Code Table Common usages are
43: Meal plan information 15: Promotion information
@Code
String
0..1
Reference code provided by the source channel
DetailDescription
Element
0..1
@Text
String
1
Details provided by the source channel
RoomRates
<RoomRates>
<RoomRate RoomTypeCode="DR" RatePlanCode="RAC1" NumberOfUnits="1">
<Rates>
<Rate UnitMultiplier="2" RateTimeUnit="Day" EffectiveDate="2025-03-12" ExpireDate="2025-03-14">
<Base AmountBeforeTax="100.00" AmountAfterTax="110.00" CurrencyCode="USD">
<Taxes Amount="10.00">
<Tax Code="19" Percent="10" Amount="10.00">
<TaxDescription>
<Text>GST 10 percent</Text>
</TaxDescription>
</Tax>
</Taxes>
</Base>
<Total AmountBeforeTax="102.50" AmountAfterTax="112.75" CurrencyCode="USD">
<Taxes Amount="10.25">
<Tax Code="19" Percent="10" Amount="10.25">
<TaxDescription>
<Text>GST 10 percent</Text>
</TaxDescription>
</Tax>
</Taxes>
</Total>
</Rate>
<!-- Additional Rate -->
</Rates>
<ServiceRPHs>
<ServiceRPH RPH="1"/>
<!-- Additional ServiceRPH -->
</ServiceRPHs>
</RoomRate>
<!-- Additional RoomRate -->
</RoomRates>RoomRates
Element
1
A RoomStay can include multiple RoomRate, each containing several rates. This occurs when a single room is booked, but different rate plans apply across the duration of the stay.
RoomRate
Element
1..n
One RoomRate per RoomStay. Multiple rates are listed under the RoomRate.
@RoomTypeCode
String
1
Code of the room booked.
@RatePlanCode
String
1
Code of the rate plan booked.
@NumberOfUnits
Integer
1
Always 1. Each room will be listed in it's own RoomStay element.
Rates
Element
0..1
Rate will contain a timespan for which a rate will apply for a room type. Multiple instances of Rate will be sent if rate changes apply.
Rate
Element
1..n
Contains the daily rate information which matches the entire date range specified in the RoomStay/TimeSpan element.
@UnitMultiplier
Integer
1
Equal to the number of days between EffectiveDate and ExpireDate. Multiply with the UnitMultiplier to get the total cost for the date span.
@RateTimeUnit
String
1
Always Day.
@EffectiveDate
Date
1
Starting date of the rate. This date is inclusive.
@ExpireDate
Date
1
First day after the applicable period. This date is exclusive.
Base
Element
0..1
Base/Gross per-day amount charged for the room.
@AmountBeforeTax
Decimal
0..1
The unit amount before tax
@AmountAfterTax
Decimal
0..1
The unit amount after tax
@CurrencyCode
String
0..1
Use ISO 4217 currency codes.
Taxes
Element
0..1
Contains details of the taxes applied.
@Amount
0..1
The unit tax amount
Tax
Element
0..n
Contains specific tax information.
@Code
String
1
Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount
Decimal
0..1
Tax amount applied.
@Percentage
0..1
Tax percentage
TaxDescription
0..1
Text description of the tax
@Text
String
1
Total
Element
0..1
Base Rate + any additional occupants and fees/extras. If empty, assume the Base amount equals the Total amount.
NOTE: It is possible that some OTAs do not provide any form of Rate information and as such a RoomRate / Rate / Total cannot be provided in such cases. Currently Hotelbeds (HBD) is a known channel that does not always provide Rate information.
NOTE: Any extras that are to be included in the RoomRate total will be linked through the ServiceRPH node.
@AmountBeforeTax
Decimal
0..1
The total amount before tax
@AmountAfterTax
Decimal
0..1
The total amount after tax
@CurrencyCode
String
1
Use ISO 4217 currency codes.
Taxes
Element
0..1
Contains details of the total taxes applied.
@Amount
Decimal
0..1
The total tax amount
Tax
Element
0..n
Contains specific tax information.
@Code
String
0..1
Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount
Decimal
0..1
Tax amount applied.
@Percentage
0..1
Tax percentage
TaxDescription
0..1
Text description of the tax
@Text
String
1
ServiceRPHs
Element
0..1
Container for the ServiceRPH elements.
ServiceRPH
Element
0..n
Links a service to the Service information at the RoomRate level.
@RPH
Integer
1..n
Links a Service to the Service information provided at the HotelReservation level (if applicable) to this RoomRate
GuestCounts
<GuestCounts>
<GuestCount AgeQualifyingCode="10" Count="2"/>
<GuestCount AgeQualifyingCode="8" Count="1"/>
<GuestCount AgeQualifyingCode="7" Count="1"/>
</GuestCounts>GuestCounts
Element
1
Total guest counts for adult, child, and infant. Adult count must always be sent.
GuestCount
Element
0..3
@AgeQualifyingCode
Integer
1
10 = Adult (mandatory)
8 = Child (optional)
7 = Infant (optional)
@Count
Integer
1
Number of guests for this age group.
TimeSpan
<TimeSpan Start="2025-10-05" End="2025-10-08"/>TimeSpan
Element
1
Contains the timespan for the RoomStay.
@Start
Date
1
Check-in date.
@End
Date
1
Check-out date. Must be after Start.
RoomStay Total
<Total CurrencyCode="USD" AmountBeforeTax="500.00" AmountAfterTax="615.00">
<Taxes Amount="115.00">
<Tax Amount="50.00" Code="10">
<TaxDescription>
<Text>Occupancy Tax</Text>
</TaxDescription>
</Tax>
<Tax Amount="65.00" Code="13">
<TaxDescription>
<Text>Sales Tax</Text>
</TaxDescription>
</Tax>
</Taxes>
</Total>Total
Element
0..1
The total amount of the RoomStay.
@AmountBeforeTax
Decimal
0..1
The total amount before tax
@AmountAfterTax
Decimal
0..1
The total amount after tax
@CurrencyCode
String
0..1
Use ISO 4217 currency codes.
Taxes
Element
0..1
Contains details of the taxes applied.
@Amount
Decimal
0..1
The total tax amount
Tax
Element
0..n
Contains specific tax information.
@Code
String
1
Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount
Decimal
0..1
Amount of the tax/fee transferred.
@Percentage
0..1
Tax percentage
TaxDescription
Element
0..1
Text description of the tax
@Text
String
1
BasicPropertyInfo
<BasicPropertyInfo HotelCode="HOTELCODE" HotelName="The Hotel Name"/>BasicPropertyInfo
Element
0..1
Contains basic identification details for the hotel associated with the reservation.
BasicPropertyInfo will always be sent as either part of the RoomStay or ResGlobalInfo, depending on your setup in SiteMinder. We recommend receiving the BasicPropertyInfo as part of the ResGlobalInfo due to how Booking.com cancellation messages are sent.
@HotelCode
String
1
Identifier for the hotel.
@HotelName
String
0..1
Name of the hotel.
ServiceRPHs
<ServiceRPHs>
<ServiceRPH RPH="1"/>
<!-- Additional ServiceRPH elements -->
</ServiceRPHs>ServiceRPHs
Element
0..1
Container for the ServiceRPH elements.
ServiceRPH
Element
1..n
Service at the RoomStay level.
@RPH
Integer
1
Links a Service to the Service information provided at the HotelReservation level (if applicable).
ResGuestRPHs
<ResGuestRPHs>
<ResGuestRPH RPH="1"/>
<!-- Additional ResGuestRPH elements -->
</ResGuestRPHs>ResGuestRPHs
Element
0..1
Container for the ResGuestRPH elements.
ResGuestRPH
Element
1..n
Container for the RPH attribute.
Comments
<Comments>
<Comment>
<Text>See the room stay comments here</Text>
</Comment>
</Comments>Comments
Element
0..1
Contains comment for the RoomStay.
Comment
Element
1..n
Holds the actual comment.
Text
Element
1
The content of the comment.
PCI sensitive data is prohibited.
Services
<Services>
<Service ServiceInventoryCode="EXTRA_BED" Inclusive="true" ServiceRPH="1" Quantity="1" ID="12346" ID_Context="CHANNEL" Type="18">
<Price>
<Base AmountBeforeTax="2.50" AmountAfterTax="2.75" CurrencyCode="EUR">
<Taxes Amount="0.25">
<Tax Code="19" Percent="10" Amount="0.25">
<TaxDescription>
<Text>GST 10 percent</Text>
</TaxDescription>
</Tax>
</Taxes>
</Base>
<Total AmountBeforeTax="5.00" AmountAfterTax="5.50" CurrencyCode="EUR">
<Taxes Amount="0.50">
<Tax Code="19" Percent="10" Amount="0.50">
<TaxDescription>
<Text>GST 10 percent</Text>
</TaxDescription>
</Tax>
</Taxes>
</Total>
<RateDescription>
<Text>Extra person charge EUR 2.50 per day for cot</Text>
</RateDescription>
</Price>
<ServiceDetails>
<TimeSpan Start="2025-03-12" End="2025-03-14"/>
</ServiceDetails>
</Service>
<!-- Additional Service elements -->
</Services>Services
Element
0..1
Contains service details provided to guests.
Service
Element
1..n
Represents a non-room product provided to guests.
@ServiceInventoryCode
String
1
Identifier code for the service. Refer to Service and Extra Charge. Channels/OTA's will use this list as a guide to code the extras/services or can use their own codes as well. Please request the property or the channel for the full list of extras/services and the codes configured in each channel.
@ID
String
0..1
Reference ID for the extra/service provided by the source booking channel.
@ServiceRPH
Integer
0..1
Links the Service to a RoomStay or RatePlan. ServiceRPH absence indicates a HotelReservation-level charge.
@Inclusive
Boolean
1
Must be set to TRUE, as SiteConnect reports totals as inclusive of charges and extras.
@Quantity
Integer
1
Number of units included in the charge. This value does not affect the total amount.
@ID_Context
String
0..1
Always "CHANNEL"
@Type
Integer
1
Always "18"
Price
Element
1
Container for pricing details of the service.
Base
Element
0..1
Base amount per unit charged for the service.
@CurrencyCode
String
0..1
Use ISO 4217 currency codes.
@AmountAfterTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountBeforeTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
Taxes
Element
0..1
Contains details of the taxes applied.
@Amount
Decimal
0..1
Total taxes amount
Tax
Element
1
Contains specific tax information.
@Percentage
Decimal
0..1
Percentage rate of the applied tax.
@Amount
Decimal
0..1
Tax amount applied.
TaxDescription
Element
0..1
Container for a detailed description of the tax.
Text
Element
1
Text description of the tax.
Total
Element
1
Container for the total amount of the service.
@CurrencyCode
0..1
Use ISO 4217 currency codes.
@AmountAfterTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountBeforeTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
Taxes
Element
0..1
Contains details of the taxes applied.
@Amount
Decimal
0..1
Total taxes amount
Tax
Element
1
Contains specific tax information.
@Percentage
Decimal
0..1
Percentage rate of the applied tax.
@Amount
Decimal
0..1
Tax amount applied.
TaxDescription
Element
0..1
Container for a detailed description of the tax.
Text
Element
1
Text description of the tax.
RateDescription
Element
0..1
Container for a description of the rate applied to the service.
Text
Element
1
A text description of the service/extra.
ServiceDetails
Element
0..1
Container for additional service details.
TimeSpan
Element
0..1
Contains the time span for which the service is provided.
@Start
Date
0..1
Start date of service.
@End
Date
0..1
Last date of service.
ResGuests
<ResGuests>
<ResGuest ResGuestRPH="1" ArrivalTime="10:30:00" Age="8" PrimaryIndicator="true">
<Profiles>
<ProfileInfo>
<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
<Profile ProfileType="1">
<Customer>
<PersonName>
<NamePrefix>Mr</NamePrefix>
<GivenName>James</GivenName>
<MiddleName>Herbert</MiddleName>
<Surname>Bond</Surname>
</PersonName>
<Telephone PhoneNumber="555-1234"/>
<Telephone PhoneNumber="555-4321" PhoneUseType="4"/>
<Telephone PhoneNumber="0411444000" PhoneTechType="5"/>
<Telephone PhoneNumber="213451515" PhoneTechType="3"/>
<Email>[email protected]</Email>
<Address>
<AddressLine>Claretta House</AddressLine>
<AddressLine>Tower Bridge Close</AddressLine>
<CityName>London</CityName>
<PostalCode>EC1 2PG</PostalCode>
<StateProv>Middlesex</StateProv>
<CountryName>United Kingdom</CountryName>
</Address>
<CustLoyalty MembershipID="1234567890" ProgramID="FrequentFlyer" ExpiryDate="2017-03-31"/>
</Customer>
</Profile>
</ProfileInfo>
</Profiles>
<Comments>
<Comment Name="ArrivalDetails">
<Text>Arriving by coach</Text>
</Comment>
<Comment Name="DepartureDetails">
<Text>Departure flight QF123</Text>
</Comment>
</Comments>
</ResGuest>
<!-- Additional ResGuest elements -->
</ResGuests>ResGuests
Element
1
Contains the guests for the reservation.
ResGuest
Element
1..n
Contains the specific guest details.
@PrimaryIndicator
Boolean
0..1
Indicates the primary guest on a reservation:
1 primary guest
0 secondary guests
@Age
Integer
0..1
The age of the guest
@ArrivalTime
Time
0..1
Arrival time of the guest.
Profiles
Element
1
Contains the guest profile information.
ProfileInfo
Element
1
Contains the profile information for the guest.
UniqueID
Element
0..n
Contains profile ids provided by the source channel.
@Type
Integer
1
Always "16"
@ID
1
The reference identifier for the profile as provided by the source channel
@ID_Context
String
1
CHANNEL: To specify that this is a channel reference id
Profile
Element
1
Contains detailed customer profile information.
@ProfileType
Integer
1
Must be set to 1 (Customer).
Customer
Element
1
Contains detailed guest information.
PersonName
Element
1
Contains the name information for the guest.
@NamePrefix
String
0..1
Title of the guest. Mr. Mrs. Ms. Miss Dr.
@GivenName
String
1
First name of the guest.
@MiddleName
String
0..1
Middle name of the guest.
@Surname
String
1
Last name of the guest.
Telephone
Element
0..4
Contains telephone information related to the guest.
@PhoneNumber
String
1
Contains the actual number (maximum 32 characters).
@PhoneUseType
Integer
0..1
The type of phone use for example daytime, nighttime, work. If this field is blank this is the primary phone, otherwise PhoneUseType="4" denotes a secondary or nighttime phone
@PhoneTechType
Integer
0..1
The type of phone technology. If not provided it should be assumed as a landline
5: Mobile
3: Fax
Email
Element
0..1
Contact email address.
Address
Element
0..1
Address information of the guest.
@AddressLine
String
0..n
Address lines for the guest.
@CityName
String
0..1
City of residence.
@PostalCode
String
0..1
Postal code.
@StateProv
String
0..1
State or province name.
@CountryName
String
0..1
Contains country information (maximum 64 characters). This is a free-text field, so a variety of formats may be received—for example: Australia, AUS, AU, etc.
CustLoyalty
Element
0..1
Contains loyalty information for the customer.
@ProgramID
String
0..1
The code or name of the membership program ('Hertz', 'AAdvantage', etc.).
@MembershipID
String
0..1
Account identification number for this particular member in this particular program.
@ExpiryDate
Date
0..1
Expiry date for this particular membership record in this particular program.
Document
Element
0..1
Detailed document information for the guest.
@BirthCountry
String
0..1
Birth country of the document holder. Use ISO 3166 A-2 country codes.
@BirthDate
Date
0..1
Indicates the date of birth as indicated in the document. Use ISO 8601 date format.
@BirthPlace
String
0..1
Specifies the birth place of the document holder (e.g., city, state, county, province).
@DocHolderNationality
String
0..1
Country of nationality of the document holder. Use ISO 3166 A-2 country codes.
@DocID
String
1
Unique number assigned by authorities to the document.
@DocIssueAuthority
String
0..1
Indicates the group or association that granted the document.
@DocIssueCountry
String
0..1
Country where the document was issued. Use ISO 3166 A-2 country codes.
@DocIssueLocation
String
0..1
Indicates the location where the document was issued.
@DocIssueStateProv
String
0..1
State or Province where the document was issued.
@EffectiveDate
Date
0..1
Indicates the starting date.
@ExpireDate
Date
0..1
Indicates the ending date.
@Gender
String
0..1
Identifies the gender:
Female
Male
Unknown
DocumentHolderName
Element
0..1
The name of the document holder in unformatted text (Mr. Sam Jones). If no DocumentHolderName is included, the guest name fields will be assumed as the holder name.
Comments
Element
0..1
Container for extra information about the guest.
Comment
Element
0..2
Holds the actual comment.
@Name
String
0..1
Identifier for the comment. Current supported names are:
ArrivalDetails: Details about the guest's mode of arrival
DepartureDetails: Details about the guest's mode of departure
Text
Element
1
The content of the comment.
PCI sensitive data is prohibited.
ResGlobalInfo
<ResGlobalInfo>
<HotelReservationIDs>
<HotelReservationID ResID_Type="14" ResID_Value="123456789"/> <!-- Reservation ID -->
<HotelReservationID ResID_Type="26" ResID_Value="987654321"/> <!-- Itinerary ID -->
<HotelReservationID ResID_Type="34" ResID_Value="74a63a92-d988334"/> <!-- Payment Context ID -->
</HotelReservationIDs>
<!-- ... other elements and attributes have been omitted for brevity ... -->
</ResGlobalInfo>ResGlobalInfo
Element
1
Contains global information about the reservation.
HotelReservationIDs
Element
0..1
Contains the HotelReservationID.
HotelReservationID
Element
0..3
Reference number/string or PNR as supplied by the booking channel.
If this reservation is linked under an itinerary, the itinerary ID will be supplied as a second HotelReservationID.
@ResID_Type
String
1
Will be one of the following values:
14: OTA code for 'Travel Agent PNR'.
26: OTA code for 'Associated itinerary reservation'.
34: OTA code for “Master Reference”.
@ResID_Value
String
1
For @ResID_Type 14 this is the actual reference number/string supplied by the booking channel (maximum 64 characters).
For @ResID_Type 26 will be the itinerary identifier for one or more bookings in an itinerary as provided by the source booking channel.
For @ResID_Type 34 this is the reference number/string used as identifier for payment transaction.
ResID_Value could potentially contain special characters such as '/'.
ResComments
<Comments>
<Comment>
<Text>See the reservation comments here</Text>
</Comment>
<!-- Additional Comment elements -->
</Comments>Comments
Element
0..1
Contains comment for the reservation.
Comment
Element
1..n
Holds the actual comment.
Text
String
1
Content of the comment.
PCI sensitive data is prohibited.
ReservationTotal
<Total CurrencyCode="EUR" AmountBeforeTax="558.00" AmountAfterTax="620.00">
<Taxes Amount="62.00">
<Tax Code="35" Amount="62.00" Percent="10" CurrencyCode="EUR"/>
</Taxes>
</Total>Total
Element
1
Total amount for the reservation. This includes all RoomStays and any additional fees or charges that apply.
@CurrencyCode
String
1
Use ISO 4217 currency codes.
@AmountBeforeTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
@AmountAfterTax
Decimal
0..1
At least one of AmountAfterTax or AmountBeforeTax must be set.
Taxes
Element
0..1
Contains details of the taxes applied.
@Amount
Decimal
0..1
Total tax amount
Tax
Element
1
Contains specific tax information.
@Code
String
0..1
Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
@Amount
Decimal
0..1
Tax amount applied.
@Percent
0..1
Tax percentage applied.
@CurrencyCode
String
0..1
Use ISO 4217 currency codes.
Memberships
<Memberships>
<Membership ProgramCode="AAdvantage" AccountID="AA14567890"/>
</Memberships>Memberships
Element
0..1
A list of Memberships. Memberships provides a list of reward programs. This data is taken from ResGuest / CustLoyalty.
Membership
Element
0..n
ProgramCode
String
0..1
The code or name of the membership program ('Hertz', 'AAdvantage', etc.). Equivalent to ProgramID.
AccountID
String
0..1
The account identification number for this particular member in this particular program. Equivalent to MembershipID.
Fees
<Fees>
<Fee TaxInclusive="true" Type="Inclusive" Code="27" Amount="5.00">
<Taxes Amount="0.45"/>
<Description Name="Commission">
<Text>Commission - $5 flat fee</Text>
</Description>
</Fee>
</Fees>Fees
Element
0..1
Container for added fees/commission
Fee
Element
1..n
@TaxInclusive
String
1
Content of the comment.
PCI sensitive data is prohibited.
@Type
Integer
1
Always 'Inclusive'
@Amount
Decimal
0..1
Commission amount
Taxes
Element
0..1
Taxes amount
@Amount
Decimal
0..1
Description
Element
0..1
@Name
String
0..1
Commission: Commission against the total of the reservation.
Text
Element
0..1
A description of the fee
Guarantee
If the PMS is not PCI compliant, it will not receive credit card information directly. However, you can choose to work with a proxy service provider for credit card tokenization.
<Guarantee>
<GuaranteesAccepted>
<GuaranteeAccepted>
<PaymentCard CardCode="VI" CardType="1" CardNumber="4444444444444444" ExpireDate="1114">
<CardHolderName>John Smith</CardHolderName>
</PaymentCard>
</GuaranteeAccepted>
</GuaranteesAccepted>
<Comments>
<Comment Name="PaymentReferenceId">
<Text>123124151616</Text>
</Comment>
</Comments>
<GuaranteeDescription>
<Text>Payment accepted up front</Text>
</GuaranteeDescription>
</Guarantee>Guarantee
Element
0..1
Guarantee provided with the reservation. Used if no deposit is paid for the reservation.
GuaranteesAccepted
Element
1
Contains the details of accepted guarantees.
GuaranteeAccepted
Element
1
Specific details of the accepted guarantee.
PaymentCard
Element
1
Details of the payment card used for the guarantee.
@CardType
String
0..1
Must be set to 1 (Credit Card) or 2 (Debit Card).
@CardNumber
String
0..1
Actual credit card number.
@ExpireDate
String
0..1
Expiry date of the credit card (format MMyy).
@MaskedCardNumber
String
0..1
May be used to send a concealed or partial credit card number (e.g. "xxxxxxxxxxxx4444" or "4444").
CardHolderName
Element
0..1
Name of the cardholder.
ThreeDomainSecurity
Element
0..1
Contains 3DS (Three Domain Security) transaction details.
Results
Element
1
Transaction results. IMPORTANT NOTE: SCA / 3DS details will only be provided if received from an SCA / 3DS compatible booking agent.
@ThreeDSVersion
String
1
3DS version used for authentication.
@XID
String
0..1
Transaction identifier resulting from authentication processing.
When ThreeDSVersion = 1.x.x the transaction identifier MUST be provided in the @XID attribute.
@DSTransactionID
String
0..1
Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
When ThreeDSVersion = 2.x.x the transaction identifier MUST be provided in the @DSTransactionID attribute.
@CAVV
String
0..1
Cardholder Authentication Verification Value (CAVV); Authentication Verification Value (AVV); Universal Cardholder Authentication Field (UCAF)
Comments
Element
0..1
The actual information related to the payment.
Comment
Element
1..3
Holds the actual comment.
@Name
String
1
Current supported names:
PaymentGatewayName: The name of the payment gateway
PaymentGatewayAuthCode: The authorization code of the payment gateway
PaymentReferenceId: If a reference was provided for any payment
Text
Element
1
Information related to the payment.
PCI sensitive data is prohibited.
GuaranteeDescription
Element
0..1
Information about the form of guarantee.
Text
Element
1
Information related to the guarantee.
PCI sensitive data is prohibited.
DepositPayments
<DepositPayments>
<GuaranteePayment>
<AmountPercent Amount="30.00" CurrencyCode="USD" Percent="20.00"/>
<Description>
<Text>20% Deposit</Text>
</Description>
</GuaranteePayment>
</DepositPayments> DepositPayments
Element
0..1
Deposit provided with the reservation.
GuaranteePayment
Element
1
Contains details of the payment guarantee for the reservation.
AmountPercent
Element
1
Represents the percentage of the total charge allocated for the deposit, rounded to two decimal places.
If Total/AmountAfterTax is provided, the percentage will be based on that value. Otherwise, if only Total/AmountBeforeTax is provided, the percentage will be calculated based on that value.
@Amount
Decimal
0..1
A monetary amount taken for the deposit.
@CurrencyCode
String
0..1
Use ISO 4217 currency codes.
@Percent
Integer
0..1
The percentage used to calculate the amount.
@TaxInclusive
0..1
Indicates if tax is included in @Amount
Description
Element
0..1
A text description of the deposit
Text
Element
1
Customer / Company / TravelAgent
<Profiles>
<ProfileInfo>
<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
<Profile ProfileType="1">
<Customer>
<Document DocID="P123456" DocType="18" Gender="unknown" BirthDate="1920-02-29" BirthCountry="US" BirthPlace="Sydney" DocHolderNationality="AU" DocIssueAuthority="ImmigionNNNNNNNN" DocIssueCountry="AU" DocIssueLocation="Sydney" DocIssueStateProvince="QLD" EffectiveDate="2020-01-01" ExpireDate="2025-01-01">
<DocumentHolderName>James Herbert</DocumentHolderName>
</Document>
<PersonName>
<NamePrefix>Mr</NamePrefix>
<GivenName>James</GivenName>
<MiddleName>Herbert</MiddleName>
<Surname>Bond</Surname>
</PersonName>
<Telephone PhoneNumber="555-1234"/>
<Telephone PhoneNumber="555-4321" PhoneUseType="4"/>
<Telephone PhoneNumber="0411444000" PhoneTechType="5"/>
<Telephone PhoneNumber="213451515" PhoneTechType="3"/>
<Email>[email protected]</Email>
<Address>
<AddressLine>Claretta House</AddressLine>
<AddressLine>Tower Bridge Close</AddressLine>
<CityName>London</CityName>
<PostalCode>EC1 2PG</PostalCode>
<StateProv>Middlesex</StateProv>
<CountryName>United Kingdom</CountryName>
<CompanyName>MI6</CompanyName>
</Address>
<CustLoyalty MembershipID="1234567890" ProgramID="FrequentFlyer" ExpiryDate="2017-03-31"/>
</Customer>
</Profile>
</ProfileInfo>
<!-- Additional ProfileInfo elements -->
</Profiles> Profiles
Element
1
Contains the profile information.
ProfileInfo
Element
1..3
UniqueID
Element
0..n
Contains profile ids provided by the source channel. Available for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent)
@Type
Integer
1
Always "16"
@ID
1
The reference identifier for the profile as provided by the source channel
@ID_Context
String
1
CHANNEL: To specify that this is a channel reference id
IATA: To specify that this is an IATA identifier for a travel agent
Profile
Element
1
Contains detailed customer profile information.
@ProfileType
Integer
1
Defines the type of profile:
1 Customer (mandatory)
2 GDS (optional)
3 Corporate (optional)
4 Travel Agent (optional)
5 Wholesaler (optional)
21 Arranger (optional)
Customer
Element
1
Contains detailed guest information.
PersonName
Element
1
Contains the name information for the guest.
NamePrefix
Element
0..1
Title of the guest.
GivenName
Element
1
First name of the guest.
MiddleName
Element
0..1
Middle name of the guest.
Surname
Element
1
Last name of the guest.
Telephone
Element
0..4
Contains telephone information related to the guest.
@PhoneNumber
String
1
Contains the actual number (maximum 32 characters).
@PhoneUseType
Integer
0..1
The type of phone use for example daytime, nighttime, work. If this field is blank this is the primary phone, otherwise PhoneUseType="4" denotes a secondary or nighttime phone
@PhoneTechType
Integer
0..1
The type of phone technology. If not provided it should be assumed as a landline
5: Mobile
3: Fax
Email
Element
0..1
Contact email address.
Address
Element
0..1
Address information of the guest.
AddressLine
Element
0..n
Address lines for the guest.
CityName
Element
0..1
City of residence.
PostalCode
Element
0..1
Postal code.
StateProv
Element
0..1
State or province name.
CountryName
Element
0..1
Contains country information (maximum 64 characters). This is a free-text field, so a variety of formats may be received—for example: Australia, AUS, AU, etc.
CompanyName
Element
1
Name of the company. Used for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) only. While can be received in ProfileType 1 , it is not standard practice..
CustLoyalty
Element
0..1
Contains loyalty information for the customer.
@ProgramID
String
0..1
Defined membership program name or ID applicable to the program.
@MembershipID
String
0..1
Account identification number for this particular member in this particular program.
@ExpiryDate
Date
0..1
Expiry date for this particular membership record in this particular program.
Document
Element
0..1
Detailed document information for the guest.
@BirthCountry
String
0..1
Birth country of the document holder. Use ISO 3166 A-2 country codes.
@BirthDate
Date
0..1
Indicates the date of birth as indicated in the document. Use ISO 8601 date format.
@BirthPlace
String
0..1
Specifies the birth place of the document holder (e.g., city, state, county, province).
@DocHolderNationality
String
0..1
Country of nationality of the document holder. Use ISO 3166 A-2 country codes.
@DocID
String
1
Unique number assigned by authorities to the document.
@DocIssueAuthority
String
0..1
Indicates the group or association that granted the document.
@DocIssueCountry
String
0..1
Country where the document was issued. Use ISO 3166 A-2 country codes.
@DocIssueLocation
String
0..1
Indicates the location where the document was issued.
@DocIssueStateProv
String
0..1
State or Province where the document was issued.
@EffectiveDate
Date
0..1
Indicates the starting date.
@ExpireDate
Date
0..1
Indicates the ending date.
@Gender
String
0..1
Identifies the gender:
Female
Male
Unknown
DocumentHolderName
Element
0..1
The name of the document holder in unformatted text (Mr. Sam Jones). If no DocumentHolderName is included, the guest name fields will be assumed as the holder name.
BasicPropertyInfo
<BasicPropertyInfo HotelCode="HOTELCODE" HotelName="The Hotel Name"/>BasicPropertyInfo
Element
0..1
Contains basic identification details for the hotel associated with the reservation.
BasicPropertyInfo will always be sent as either part of the RoomStay or ResGlobalInfo, depending on your setup in SiteMinder. We recommend receiving the BasicPropertyInfo as part of the ResGlobalInfo due to how Booking.com cancellation messages are sent.
@HotelCode
String
1
Identifier for the hotel.
@HotelName
String
0..1
Name of the hotel.
Response Structure
OTA_HotelResNotifRS Specification
The OTA_HotelResNotifRS message is sent from the PMS in response to the OTA_HotelResNotifRQ request. It confirms whether the reservation request was successfully received and processed by the PMS (success or failure).
The response must be returned within 60 seconds of receiving the request.
If no valid response is received, pmsXchange will retry the request:
Once every minute, up to 10 attempts
From the 11th attempt onward, retries occur every 5 minutes
This continues until a successful response is received or the request times out
<OTA_HotelResNotifRS xmlns="HTTP://WWW.OPENTRAVEL.ORG/OTA/2003/05" EchoToken="37078e8a-f75e-421a-b0af-34d476dfdf5a" Version="1" TimeStamp="2025-03-12T21:54:20+11:00">
<Success/>
<HotelReservations>
<HotelReservation>
<ResGlobalInfo>
<HotelReservationIDs>
<HotelReservationID ResID_Source="PMS" ResID_Type="40" ResID_Value="{PMSCONFIRMID}"/>
</HotelReservationIDs>
</ResGlobalInfo>
</HotelReservation>
</HotelReservations>
</OTA_HotelResNotifRS>
OTA_HotelResNotifRS
Element
1
Root element
@xmlns
String
1
Defines the XML namespace for the request. Will be set to http://www.opentravel.org/OTA/2003/05
@EchoToken
String
1
Unique identifier for the request, used to match requests and responses.
@TimeStamp
DateTime
1
Time when the request was generated.
@Version
String
1
Specifies the API version. Must be set to 1.0
Success
Element
0..1
Either Success or Error element present
Errors
Element
0..1
Contains a list of errors
Error
Element
1
Should be at least one node if there is an Errors Node
@ShortText
String
1
An abbreviated, human-readable version of the error message that still provides enough context to understand the issue.
HotelReservations
Element
1
Root Element. Mandatory if Success is sent.
HotelReservation
Element
1
Contains the specific reservation information.
ResGlobalInfo
Element
1
Mandatory if the reservation is part of a successful delivery batch
HotelReservationIDs
Element
1
Contains PMS reservation identifier
HotelReservationID
Element
1
PMS reservation identifier
@ResID_Source
String
1
Always 'PMS'
@ResID_Type
Integer
1
Always '40'
@ResID_Value
String
1
The identifier of the reservation created by the PMS. This is the reservation ID in the PMS.
Last updated
Was this helpful?