# Pull (SM -> PMS) ## What is Reservations Pull (SM -> PMS)? **Reservations Pull (SM -> PMS)** is a delivery method where the Property Management Systems (PMS) actively retrieve undelivered reservations, modifications, and cancellations from SiteMinder at regular intervals. This integration ensures that PMSs receive up-to-date booking information from various channels, maintaining consistency and reducing the risk of overbooking. {% hint style="warning" %} **Delivery Method Configuration**: The reservation delivery method (PUSH or PULL) is configured at the PMS level and applies to all properties using your integration. It is not possible to have some properties using Reservations PULL while others use Reservations PUSH. Once configured, all hotels connected to your PMS will retrieve reservations using the same method. {% endhint %} ## Integration Requirements Understand the essential requirements for API integration, including connectivity, authentication, message formats, and security protocols.

Category	Requirement
Web Service Endpoint	SiteMinder will provide a single global endpoint for all hotels for PMS to send pull requests `OTA_ReadRQ` and receive reservation responses `OTA_ResRetrieveRS`. Test Environment Endpoint: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}
Authentication	SiteMinder will provide a single username/password for all hotels (PMS Level authentication). PMS must include authentication credentials within the SOAP Security header of each request (`OTA_ReadRQ` and `OTA_NotifReportRQ`).
Message Structure	All messages must adhere to the SOAP message format. OTA message must be encapsulated within the SOAP Body. Requests must include a SOAP Security Header for authentication. Responses will be returned in a SOAP envelope with empty SOAP Header.
Content-Type	`text/xml; charset=utf-8`
Version	`SOAP 1.1`
Protocol & Security	All communication must occur over HTTPS using TLS 1.2 or higher. Non-secure (HTTP) connections are not permitted. Communication is synchronous request/response pairs. Each message is atomic - processed entirely or not at all.

## Message Exchange Flow When using the pull method, your PMS requests reservations from SiteMinder at regular intervals (typically every 2-5 minutes) using a synchronous SOAP/HTTPS exchange. SiteMinder responds with any pending reservations, modifications, and cancellations that haven't been delivered yet. This process involves two request-response cycles to ensure reliable delivery and confirmation. 1. **Pull Request (PMS to SiteMinder)**: `OTA_ReadRQ`\ Requests undelivered reservations, modifications, and cancellations from SiteMinder. 2. **Reservations Response (SiteMinder to PMS):** `OTA_ResRetrieveRS`\ Delivers a list of reservations (new bookings, modifications, and cancellations) in response to the pull request. 3. **Confirmation Request (PMS to SiteMinder):** `OTA_NotifReportRQ`\ Confirms successful receipt or reports processing failure of the received reservations by the PMS. 4. **Receipt Response (SiteMinder to PMS):** `OTA_NotifReportRS`\ Acknowledges the confirmation and completes the pull transaction cycle. {% hint style="warning" %} The PMS must send `OTA_HotelAvailNotifRQ` to SiteMinder with the **updated availability** after the reservations, modifications, and cancellations are processed on the PMS system. Refer to the [Availability and Restrictions](/pmsxchange-api/reference/availability.md). {% endhint %} ## Security Header The Security Header is a mandatory SOAP header that authenticates every request from your PMS to SiteMinder endpoint. It contains the username and password credentials that we provide to the PMS during integration setup. **Key Requirements:** * **Validation**: Our endpoint will validate these credentials on every request. * **Scope**: One set of credentials is used for all properties in your integration. * **Security**: Credentials are transmitted as plain text within the HTTPS encrypted channel. * **Response**: Invalid credentials will return a SOAP fault with appropriate error code. {% hint style="info" %} The only acceptable value for the **Password @Type** attribute is *.* Plain text passwords are acceptable as all communication is done over encrypted HTTP (HTTPS). {% endhint %} {% tabs %} {% tab title="Pull Request" %} Requests must include a SOAP Security Header for authentication. ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Reservations Response" %} Responses must be returned in a SOAP envelope with an empty SOAP Header. ```xml

``` {% endtab %} {% tab title="Confirmation Request" %} Requests must include a SOAP Security Header for authentication. ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Receipt Response" %} Responses must be returned in a SOAP envelope with an empty SOAP Header. ```xml

``` {% endtab %} {% endtabs %} ## Multiplicity In the SOAP Specification tables **M** refers to the number of instances or occurrences of an element or attribute that are allowed or required in a given context. It defines how many times a particular component (element or attribute) can appear within a specific structure.

M	Definition
1	The element or attribute must be present exactly once.
0..1	The element or attribute is optional; it can be present zero or one time.
0..n	The element or attribute can be present zero or more times, with no upper limit (where n represents an infinite number of occurrences).
1..n	The element or attribute must be present at least once and can be present any number of times, with no upper limit.
n..m	Specific range, the element or attribute must be present at least n times and no more than m times (where n and m are specific numbers).

## 1. Pull Request The PMS uses `OTA_ReadRQ` to pull reservations from SiteMinder at regular intervals between 2-5 minutes. The request frequency must be no more than every 2 minutes (e.g. not every 1 minute) and no less than every 5 minutes (e.g. not every 6 minutes). {% hint style="info" %} **PMS Level** requests all undelivered reservations for all hotels, while **Hotel Level** requests all undelivered reservations only for the hotel specified in the request. The PMS must chose only one level for the full connectivity and avoid using both levels. {% endhint %} {% tabs %} {% tab title="PMS Level" %} Returns all undelivered reservations, modifications, and cancellations for all hotels\ associated with PMS code: `{PMSCODE}` **Requirements:** PMS Level authentication. ```xml ``` {% endtab %} {% tab title="Hotel Level" %} Returns all undelivered reservations, modifications, and cancellations for a specific\ hotel with code: `{HOTELCODE}` **Requirements:** Either PMS Level or Hotel Level authentication. ```xml ``` {% endtab %} {% tab title="Book Only" %} Returns only new reservations (`ResStatus="Book"`) for a specific hotel with code: `{HOTELCODE}`, excluding modifications and cancellations. **Requirements:** Either PMS Level or Hotel Level authentication. ```xml ``` {% endtab %} {% tab title="Modify Only" %} Returns only modifications (`ResStatus="Modify"`) for a specific hotel with code: `{HOTELCODE}`, excluding new reservations and cancellations. **Requirements:** Either PMS Level or Hotel Level authentication. ```xml ``` {% endtab %} {% tab title="Cancel Only" %} Returns only cancellations (`ResStatus="Cancel"`) for a specific hotel with code: `{HOTELCODE}`, excluding new reservations and modifications. **Requirements:** Either PMS Level or Hotel Level authentication. ```xml ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`OTA_ReadRQ`	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`
`@EchoToken`	String	1	Unique identifier for the request, used to match requests and responses. Preferred format: UUID `8-4-4-4-12`.
`@TimeStamp`	DateTime	1	Time when the request was generated. TimeStamp must use `ISO 8601` format.
`@Version`	Decimal	1	Specifies the API version. Must be set to `1.0`.
`POS / Source / RequestorID`	Element	1	Identifies the system which is sending the request. Container for the PMS code.
`@Type`	Integer	1	Fixed at `22` (ESRP)
`@ID`	String	1	PMS Code assigned by SiteMinder. Remains the same throughout the messages.
`ReadRequests`	Element	1
`ReadRequests / HotelReadRequest`	Element	1
`@HotelCode`	String	0..1	Hotel code as recognised by SiteMinder. If omitted, all reservations for the PMS will be returned. Note: This attribute is only optional for central property management systems. It is mandatory for on-site systems.
`SelectionCriteria`	Element	1
`@SelectionType`	String	1	Must be "`Undelivered`"
`@ResStatus`	Enumeration	0..1	Specifies the booking status: `Book` `Modify` `Cancel`

## 2. Reservations Response ### OTA\_ResRetrieveRS The `OTA_ResRetrieveRS` message returns a list of HotelReservation elements in response to the pull request. Content varies as SiteMinder aggregates reservations from multiple booking channels, each with different formats and data structures. **Key Concepts** #### ReservationsList * Container element returned by SiteMinder in response to pull requests * May contain zero, one, or multiple HotelReservation elements * Empty when no pending reservations are available #### HotelReservation * Represents a single booking from one channel * Multiple reservations can be returned in one ReservationsList * Each includes all associated rooms, guests, and payments #### RoomStays * Container for all room bookings within each reservation * Each room type booked creates a separate RoomStay * Example: 2 Double Rooms + 1 Suite = 3 RoomStay elements #### Split Stays * When a guest changes room type during their stay * Creates multiple RoomStays with different date ranges * Example: Double Room (Jan 1-3) + Suite (Jan 3-5) = 2 RoomStays #### Guest Assignment * ResGuests can be linked to specific RoomStays via ResGuestRPH * Some channels provide no guest details (ResGuests may be empty) * Primary guest indicated by PrimaryIndicator="true" #### Guest Assignment * Daily rates can be found at `RoomRates.RoomRate.Rates.Rate/BaseRoomRates.RoomRate.Rates.Rate/Base` - room charge per night, excluding extras * When `Rate/Total` exceeds `Rate/Base`, extra charge is included in the daily rate. Service details for this extra are not guaranteed. OTA may embed charges in the total without providing a corresponding `Services` element * The RoomStay Total at `RoomStays.RoomStay.Total` covers all daily rates and any room-stay-level extras * The ReservationTotal at `ResGlobalInfo.Total` is the authoritative total for the entire reservation. It includes all room stays + any services or extras applied at the reservation level. Always use this as the final amount for the reservation. #### Batch Processing * Single pull request can retrieve multiple reservations * Each HotelReservation processed independently * All retrieved reservations must be confirmed via `OTA_NotifReportRQ` {% tabs %} {% tab title="Reservations Found" %} * Contains `` element. * Includes `` with one or more reservations. * Each reservation has unique SiteMinder identifiers (e.g., `ABC-1234567890`, `CBA-0987654321`), with the corresponding message IDs (e.g., `isuokfr1pyc2ntest7` and `pbp6s5j08test9n0zi`). ```xml ``` {% endtab %} {% tab title="No Reservations Found" %} * Contains `` element. * No `` element (indicates no pending reservations). ```xml ``` {% endtab %} {% tab title="Error" %} * Contains `` element instead of `` * Indicates business logic error (e.g., invalid hotel code, authentication failure) ```xml Invalid Hotel Code ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`OTA_ResRetrieveRS`	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. Preferred format: UUID `8-4-4-4-12`.
`@TimeStamp`	DateTime	1	Time when the response was generated. TimeStamp must use `ISO 8601` format.
`@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	Single error information containing free text.
`@Type`	String	1	Type of error. Refer to Error Warning Types (EWT).
`@Code`	String	1	Code representing the error. Refer to Error Codes (ERR).

### ReservationsList ```xml ```

Element / @Attribute	Type	M	Description
`ReservationsList`	Element	0..1	Contains a list of retrieved reservations.
`HotelReservation`	Element	1..n	Contains the specific reservation information.
`@CreateDateTime`	DateTime	1	Date and time when the reservation was first made. Must be set when `ResStatus` is `Book`. `CreateDateTime` must follow the `ISO 8601` Date and Time format.
`@LastModifyDateTime`	DateTime	0..1	Date and time when the reservation was last modified. Must be set when `ResStatus` is `Modify` or `Cancel`. `LastModifyDateTime` must follow the `ISO 8601` Date and Time format.
`@ResStatus`	Enumeration	1	Specifies the booking status: `Book` `Modify` `Cancel`
`UniqueID`	Element	1..2	Unique identifier of the reservation in SiteMinder. - The first UniqueID `Type="14"`is the unique identifier for the entire reservation and through any subsequent modifications or cancellations. The second UniqueID `Type="16"` with `ID_Context="MESSAGE_UNIQUE_ID"` is the unique ID for this message. This identifier must be used to confirm the message once processed.
`@Type`	Integer	1	`Type="14"`: Identifier for the reservation in SiteMinder. `Type="16"`: Identifier for the message transferring the reservation.
`@ID`	String	1	SiteMinder reservation ID. Refer to the `HotelReservationID` attribute for the booking source/channel reservation ID.
`@ID_Context`	String	0..1	Present for the second UniqueID and always will be "`MESSAGE_UNIQUE_ID`"

### Source {% tabs %} {% tab title="Source" %} ```xml Booking Channel ``` {% endtab %} {% tab title="Second Source" %} ```xml Booking Channel Booking Channel Affilate ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`POS`	Element	1	Contains `Source` details.
`Source`	Element	1..2	Contains `BookingChannel` details.
`RequestorID`	Element	1	Only present in the first `Source` element. Identifies the system sending the reservation.
`@Type`	Integer	1	Must be set to `22` (ESRP).
`@ID`	String	1	Always `SITEMINDER`
`BookingChannel`	Element	1	Contains booking channel information.
`@Primary`	Boolean	1	`true` for the primary booking channel in the first Source element. `false` in the second Source element, if present.
`@Type`	Integer	1	Always `7` for 'Internet'.
`CompanyName`	Element	1	Name of the Booking Channel. NOTE: This name is subject to change/variation by the Booking Channel. Use the `Code` attribute below to identify the booking channels.
`@Code`	String	0..1	Code of the booking channel. See the Booking Agent Codes Table for reference.

### RoomStays ```xml ```

Element / @Attribute	Type	M	Description
`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 ```xml Double room Room paid in advance with credit card Continental breakfast included ```

Element / @Attribute	Type	M	Description
`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..1	Additional room information provided by the source channel.
`AdditionalDetail`	Element	0..n
`@Type`	Integer	1	Refer to the Additional Detail Type (ADT). 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	Contains the description `Text`.
`@Text`	String	1	Details provided by the source channel.

### RatePlans ```xml Long Stay Discount Stay n Save promotion grants 10% discount Continental breakfast included ```

Element / @Attribute	Type	M	Description
`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	Name of the rate plan.
`@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	Contains the description `Text`.
`@Text`	String	0..1	Details provided about the rate plan.
`AdditionalDetails`	Element	0..1	Additional rate plan information provided by the source channel.
`AdditionalDetail`	Element	0..n
`@Type`	Integer	1	Refer to the Additional Detail Type (ADT). 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	Contains the description `Text`.
`@Text`	String	1	Details provided by the source channel.

### RoomRates {% tabs %} {% tab title="Room Rates" %}

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

{% endtab %} {% tab title="Same Rate per Night" %} ```xml ``` {% endtab %} {% tab title="Same Rate per Night + Extras" %} This example shows daily rates when the same rate applies to both dates (2025-10-05 and 2025-10-06) and there are additional charges. ```xml ``` {% endtab %} {% tab title="Different Rate per Night" %} ```xml ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`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`	Decimal	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`	Decimal	0..1	Tax percentage.
`TaxDescription`	Element	0..1	Contains the tax description `Text`.
`@Text`	String	1	Text description of the tax.
`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** ```xml ```

Element / @Attribute	Type	M	Description
`GuestCounts`	Element	1	Total guest counts for adult, child, and infant. Adult count must always be sent.
`GuestCount`	Element	1..3	Represents the count for a specific age group.
`@AgeQualifyingCode`	Integer	1	`10` - Adult (mandatory) `8` - Child (optional) `7` - Infant (optional)
`@Count`	Integer	1	Number of guests for this age group.

### TimeSpan ```xml ```

Element / @Attribute	Type	M	Description
`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 {% hint style="info" %} This total covers the room stay only. It does not include services or extras applied at the reservation level. See [Reservation Total](https://developer.siteminder.com/pmsxchange-api/reference/reservations/push#reservationtotal) for the complete reservation amount. {% endhint %} ```xml Occupancy Tax Sales Tax ```

Element / @Attribute	Type	M	Description
`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`	Decimal	0..1	Tax percentage.
`TaxDescription`	Element	0..1	Contains the tax description `Text`.
`@Text`	String	1	Text description of the tax

### **BasicPropertyInfo** ```xml ```

Element / @Attribute	Type	M	Description
`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 ```xml ```

Element / @Attribute	Type	M	Description
`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 ```xml ```

Element / @Attribute	Type	M	Description
`ResGuestRPHs`	Element	0..1	Container for the `ResGuestRPH` elements.
`ResGuestRPH`	Element	1..n	Container for the `RPH` attribute.
`@RPH`	Integer	1	Links the `RoomStay` to `ResGuest`. Find the links in ResGuests.

### **Comments** ```xml See the room stay comments here ```

Element / @Attribute Type M Description

Comments Element 0..1 Contains comment for the RoomStay.

Comment Element 1..n Holds the actual comment.

Element / @Attribute	Type	M	Description
`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.

Text

Element

The content of the comment.

PCI sensitive data is prohibited.

### Services Extras and services in reservation XML can be identified through multiple attributes. Use this multi-layered approach to ensure reliable mapping: **1. Use the ID attribute**: Map extras using the `@ID` attribute when present. This is the channel's unique identifier for the specific extra or service. **2. Use ServiceInventoryCode**: If `@ID` is not provided, use the `@ServiceInventoryCode` attribute, which is always present. Reference the Service and Extra Charge table for commonly used codes, or request the complete code list from the hotelier for their specific connected channels. **3. Keyword Detection**: Implement keyword detection logic that scans `` for common terms like "Parking," "Breakfast," "Spa," etc. This ensures that extras sent under different codes (`EXTRA`, `MEAL`, `OTHER`) by various channels are still correctly matched in your PMS, even when codes vary between booking sources. ```xml GST 10 percent GST 10 percent Extra person charge EUR 2.50 per day for cot ```

Element / @Attribute	Type	M	Description
`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.
`@Code`		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@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.
`@Code`		1	Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT).
`@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 ```xml Mr James Herbert Bond james.bond@mi5.co.uk

Claretta House Tower Bridge Close London EC1 2PG Middlesex United Kingdom

Arriving by coach Departure flight QF123 ```

Element / @Attribute	Type	M	Description
`ResGuests`	Element	1	Contains the guests for the reservation.
`ResGuest`	Element	1..n	Contains the specific guest details.
`@ResGuestRPH`	Integer	0..1	Links the `ResGuest` to `RoomStay`. Find the links in ResGuestRPHs.
`@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.
`@DocType`	String	1	Indicates the type of document. Refer to Document Type Code (DOC).
`@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 ```xml ```

Element / @Attribute	Type	M	Description
`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. Refer to Payment Transaction Record. `ResID_Value` could potentially contain special characters such as `/`.

### **ResComments** ```xml See the reservation comments here ```

Element / @Attribute Type M Description

Comments Element 0..1 Contains comment for the reservation.

Comment Element 1..n Holds the actual comment.

Element / @Attribute	Type	M	Description
`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.

Text

String

Content of the comment.

PCI sensitive data is prohibited.

### ReservationTotal ```xml ```

Element / @Attribute	Type	M	Description
`Total`	Element	0..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 ```xml ```

Element / @Attribute	Type	M	Description
`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 ```xml Commission - $5 flat fee ```

Element / @Attribute	Type	M	Description
`Fees`	Element	0..1	Container for added fees/commission.
`Fee`	Element	1..n	The actual fees/commission.
`@TaxInclusive`	String	1	Content of the comment. PCI sensitive data is prohibited.
`@Type`	Integer	1	Always `Inclusive`
`@Code`	Integer	1	See OTA Fee Tax Type (FTT) code table.
`@Amount`	Decimal	0..1	Commission amount.
`Taxes`	Element	0..1	Taxes amount.
`@Amount`	Decimal	0..1	Actual tax amount.
`Description`	Element	0..1	Container of the comission `Text`.
`@Name`	String	0..1	`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**](/pmsxchange-api/additional-resources/credit-card-tokenization.md). {% tabs %} {% tab title="Credit Card" %} ```xml John Smith 123124151616 Payment accepted up front ``` {% endtab %} {% tab title="ThreeDomainSecurity" %} ```xml John Smith ``` {% endtab %} {% tab title="Payment Gateway" %} ```xml Paypal 123143253467 123124151616 Payment accepted up front ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`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).
`@CardCode`	String	1	2-character code of the credit card issuer. Refer to Payment Card Provider Codes.
`@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)
`@ECI`	String	1	Refer to Electronic Commerce Indicator.
`@PAResStatus`	String	0..1	Refer to Transactions Status Result Identifier.
`@SignatureVerification`	String	0..1	Refer to Transaction Signature Status.
`@Enrolled`	String	0..1	Refer to Status of Authentication.
`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** {% tabs %} {% tab title="Deposit Only" %} ```xml 20% Deposit ``` {% endtab %} {% tab title="Credit Card + Deposit" %} ```xml Bruce Wayne 20% Deposit ``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`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	Contained of the deposit description `Text`.
`Text`	Element	1	Text description.

### Customer / Corporate / TravelAgent {% tabs %} {% tab title="Customer" %} **Customer:** The individual who made the booking and serves as the primary contact for the reservation. This may or may not be the same person as the guest staying in the room. {% code overflow="wrap" expandable="true" %} ```xml James Herbert Mr James Herbert Bond james.bond@mi5.co.uk

Claretta House Tower Bridge Close London EC1 2PG Middlesex United Kingdom MI6

``` {% endcode %} {% endtab %} {% tab title="Corporate" %} **Corporate:** The company or organisation associated with the booking, typically where a negotiated corporate rate applies or the reservation is billed to a company account. {% code overflow="wrap" expandable="true" %} ```xml Joe Smith

American Express

``` {% endcode %} {% endtab %} {% tab title="Travel Agent" %} **Travel Agent:** The agency or intermediary that sourced the booking on behalf of the customer, typically identified by an IATA or ARC number for commission reconciliation purposes. {% code overflow="wrap" expandable="true" %} ```xml Mis Moneypenny

STA Travel

``` {% endcode %} {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`Profiles`	Element	1	Contains the profile information.
`ProfileInfo`	Element	1..3	Contains the profiles.
`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)
`@ShareAllMarketInd`	Boolean	0..1	Customer has 'opted in' to receive marking information (EU Customers).
`@ShareAllOptOutInd`	Boolean	0..1	Customer has 'opted out' of receiving marking information (Non EU).
`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.
`@DocType`	String	1	Indicates the type of document. Refer to Document Type Code (DOC).
`@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** ```xml ```

Element / @Attribute	Type	M	Description
`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.

## 3. Confirmation Request Using `OTA_NotifReportRQ` the PMS sends a confirmation message to SiteMinder for the delivery of reservations, modifications, or cancellations. If not confirmed, the information will be resent in response to the `OTA_ReadRQ` message. Confirmation of delivery does not guarantee that the reservation was successfully created in the PMS. The `OTA_NotifReportRQ` message can be used to confirm any erroneous deliveries. The structure of the `OTA_NotifReportRQ` does not permit a mix of successfully processed and erroneous reservations in the same message. Successfully processed reservations must be confirmed in separate `OTA_NotifReportRQ` messages from those that could not be processed. {% hint style="warning" %} SiteMinder will automatically mark a reservation as 'Error' (fail) under the following conditions: * **20 Delivery Attempts:** The reservation has been requested (`OTA_ReadRQ`) at least 20 times without receiving a valid `OTA_NotifReportRQ`. * **14-Day Timeout:** No delivery attempts have been made for 14 days. * **1-Hour Timeout:** At least one delivery attempt has been made, and it has been 1 hour since the first attempt. **Important:** This mechanism is a fail-safe feature; we expect to receive either a 'Success' or 'Error' `OTA_NotifReportRQ`. It should not be relied upon for handling reservations that cannot be processed. {% endhint %} {% tabs %} {% tab title="Confirm Reservation" %} * The presence of the `` element indicates that the reservation was created in the PMS. * The UniqueID Type 16 element informs SiteMinder which reservation message is being confirmed. * The `HotelReservationID` holds the ID of the newly created reservation in the PMS. ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Confirm Modification" %} * The presence of the `` element indicates that the modification was processed in the PMS. * The UniqueID Type 16 element informs SiteMinder which modification message is being confirmed. * The `HotelReservationID` holds the ID of the reservation modified in the PMS. ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Confirm Cancellation" %} * The presence of the `` element indicates that the cancellation was processed in the PMS. * The UniqueID Type 16 element informs SiteMinder which cancellation message is being confirmed. * The `HotelReservationID` holds the ID of the reservation cancelled in the PMS. ```xml

USERNAME PASSWORD

``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Confirm Multiple Reservations" %} * The presence of the `` element indicates that the reservations were created in the PMS. * The UniqueID Type 16 element informs SiteMinder which reservation message is being confirmed. * The `HotelReservationID` holds the ID of the newly created reservation in the PMS. {% hint style="warning" %} It is not necessary for all reservations retrieved in a single ReadRQ to be confirmed in one `OTA_NotifReportRQ` message. If it’s more convenient for the PMS to send one `OTA_NotifReportRQ` for each reservation, that approach is perfectly acceptable. {% endhint %} ```xml

USERNAME PASSWORD

``` {% endtab %} {% tab title="Confirm with Errors" %} * The presence of the `` element indicates that the reservation was **not created** in the PMS. * The UniqueID Type 16 element informs SiteMinder which reservation is being confirmed. * **No** **`HotelReservationID`** is present if the PMS was unable to save the reservation. ```xml

USERNAME PASSWORD

Invalid room type

``` {% endtab %} {% endtabs %}

Element / @Attribute	Type	M	Description
`OTA_NotifReportRQ`	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`
`@EchoToken`	String	1	Unique identifier for the request, used to match requests and responses. Preferred format: UUID `8-4-4-4-12`.
`@TimeStamp`	DateTime	1	Time when the request was generated. TimeStamp must use `ISO 8601` format.
`@Version`	Decimal	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 if the reservation, modification or cancellation failed to process
`Error`	Element	1..n	Should be at least one node if there is an Errors node.
`@Type`	Integer	1	Type of error. Refer to Error Warning Types (EWT).
`@Code`	Integer	0..1	Code representing the error. Refer to Error Codes (ERR).
`NotifDetails / HotelNotifReport`	Element	1
`HotelReservations / HotelReservation`	Element	1..n	One for each reservation being confirmed.
`@CreateDateTime`	dateTime	0..1	The time the reservation was created in the PMS. Mandatory if `ResStatus` is `Book`.
`@LastModifyDateTime`	dateTime	0..1	The time the reservation was updated in the PMS. Mandatory if `ResStatus` is `Modify` or `Cancel`.
`@ResStatus`	String	0..1	Specifies the booking status: `Book` `Modify` `Cancel`
`UniqueID`	Element	1	The identifier of the reservation message as known to SiteMinder.
`@Type`	Integer	1	Always `16`
`@ID`	String	1	UniqueID of Type 16 from the OTA_ResRetrieveRS
`ResGlobalInfo`	Element	0..1	Mandatory if the reservation is part of a successful delivery batch.
`HotelReservationIDs / HotelReservationID`	Element	1	PMS reservation identifier.
`@ResID_Type`	Integer	1	Always `14`
`@ResID_Value`	String	1	The identifier of the reservation created by the PMS. This is the reservation ID in the PMS.

## 4. **Receipt Response** The `OTA_NotifReportRS` message is sent to the PMS as a response to the `OTA_NotifReportRQ` message, confirming that SiteMinder successfully processed the request. {% tabs %} {% tab title="Success Response" %} ```xml

``` {% endtab %} {% tab title="Error Response" %} ```xml

Could not find Notifications to confirm with notification id='3123456'

``` {% endtab %} {% endtabs %} ## Reservation XML Samples

Maximum Content XML

{% code overflow="wrap" %} ```xml

ExpediaExpedia Affilate AccountDouble roomRoom paid in advance with credit cardCancellation deadline 10/10/2012Continental breakfast includedLong Stay DiscountStay n Save promotion grants 10% discountContinental breakfast includedExpedia CollectDiscounted Daily RateSingle Night Discount PromoContinental breakfast includedExpedia CollectGST 10 percentGST 10 percentGST 10 percentGST 10 percentnon-smoking Room requested, king bedGST 10 percentGST 10 percentExtra person charge $2.50 (ex GST) per day for cotGST 10 percentGST 10 percentExtra person charge $2.50 (ex GST) per day for cotGST 10 percentGST 10 percentExtra bathrobe $5.00 (incl GST) per personGST 10 percentGST 10 percentCar Park - Undercover Parking (Clearance 2.2 meter or 7.2 feet) $5.00 (incl GST) per dayMrJamesHerbertBondjames.bond@mi5.co.uk

Claretta HouseTower Bridge CloseLondonEC1 2PGMiddlesexUnited Kingdom

Arriving by coachDeparture flight QF123John Smith123124151616Payment accepted up front50% DepositCommission - $5 flat feeGST 10 percentMrJamesHerbertBondjames.bond@mi5.co.uk

Claretta HouseTower Bridge CloseLondonEC1 2PGMiddlesexUnited KingdomMI6

JoeSmith

American Express

MisMoneypenny

STA Travel

will be arriving after 6 pm

``` {% endcode %}

Minimum Content XML

{% code overflow="wrap" %} ```xml

ExpediaExpedia Affilate AccountJamesBond

``` {% endcode %}

## Common Questions

What happens if reservations fail to be delivered to my PMS?

SiteMinder times out the reservation after repeated failures. The hotel receives an email advising them to contact their PMS provider. Always send delivery confirmation to prevent timeouts and ensure reservations are tracked.

Do I always receive both Before and After Tax amounts?

No. You receive whichever amounts the channel provides. Some channels send both `AmountBeforeTax` and `AmountAfterTax`, others send only one. Your PMS must handle both scenarios.

Why don't the daily rates in reservations match the rates I sent?

There are three common scenarios: **1. Channel Discounts or Promotions** The guest used a channel discount, so the final booked amount differs from your pushed rate. **2. No Daily Rates Provided** Some channels only send the total stay cost. SiteMinder calculates daily rates by averaging the RoomStay Total across the number of nights. **3. Missing Rates for Specific Dates** Channels may omit daily rates for certain dates (e.g., free night promotions). SiteMinder averages the RoomStay Total to determine daily rates.

Why is the reservation missing data that the property says was sent?

SiteMinder forwards all data received from booking channels without modification. Missing data means the channel didn't provide it. The property must verify with the channel directly. **Exception:** Credit card/document IDs may be disabled for PCI/PII compliance - contact Partner Integrations to enable.

What are the differences between Guests and Customers?

**Customer**: The contact person or individual who made the booking. Found in `ResGlobalInfo/Profile` with `Type="1"`. **Guests**: The individuals who will check in and stay in the room. Found in `ResGuests/Profile`. If the Customer is also staying in the room, they appear in both sections.

Why is <ResGuestRPHs> sometimes missing?

It's optional for single-guest reservations. `` links guests to room stays in multi-room/multi-guest bookings. For single-guest reservations, the association is implicit, so channels may omit this element.

Can I send multiple PMS reference IDs for reservations with multiple RoomStays?

No. Each UniqueID can only have one `ResID_Value` in SiteMinder. If your PMS splits multi-RoomStay reservations into separate bookings, you cannot send multiple PMS reference IDs back in one reservation confirmation. Channels rarely send multiple `RoomStays` with broken date ranges in one reservation. They typically create separate reservations, each with its own `UniqueID`, so each gets its own distinct `ResID_Value`.

Why do all extras get classified as "EXTRA"?

SiteMinder can only classify extras if the channel classifies them when sending the reservation. Most channels (including Direct Booking test accounts) do not categorize extras according to the OTA standard, so they all appear as "EXTRA" by default. Your PMS should handle extras with generic "EXTRA" classification as the most common scenario.

How do I identify which extras are booked for which room?

Match ServiceRPH values to link extras to rooms. **Example:** * `RoomStay/ServiceRPH@RPH="1"` → links to `Services/Service@ServiceRPH="1"` * This associates that service with that specific RoomStay

Do you forward channel commissions?

Only if the channel provides commission details. When commission information is available, SiteMinder includes it in the `Fees` section: * Fixed commission amount in `Fee@Amount` * Commission percentage in `Fee/Description` Most channels do not provide commission data.

Do you support full credit card numbers?

Yes, when the channel provides them. SiteMinder forwards full credit card numbers if provided by the channel. However, if a channel only provides partial information (typically 3-4 digits), you'll receive the partial card number in `PaymentCard@MaskedCardNumber`. Hotels can obtain full card details from the channel's extranet or booking confirmation email if needed.

Can I receive the CVC/CVV code?

No. PCI regulations prohibit sending card number and CVC together. Hotels can find CVC in: * SiteMinder reservation confirmation emails (if enabled) * Channel extranet

Do you support Virtual Credit Cards (VCC)?

Yes. Virtual credit cards are delivered as standard credit cards in the `PaymentCard` element. There are no VCC-specific attributes - they use the same structure as regular credit cards (`CardNumber`, `CardCode`, `ExpireDate`, `CardHolderName`). Your PMS processes VCCs the same way as standard credit cards.

Why am I not receiving credit card details or guest document IDs?

PCI/PII compliance restrictions prevent automatic delivery of sensitive data. Contact Partner Integrations team to enable this data if your PMS is PCI compliant.

{% hint style="success" icon="sparkles" %} ## Still have questions? Use the **Ask** button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues. If you need more support, visit [Integration Support](/integration-support/integration-support.md). {% endhint %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.siteminder.com/pmsxchange-api/reference/reservations/pull.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.