:circle-bolt: | Get Started | /pages/FjOoYmv6gdAghMjHd36L | |
:signs-post: | Integration Requirements | /pages/QAcsxocYxcXDPXxGFtrD | |
:code: | API Overview | /pages/sPIguB2mVMgXp8s3guST |
| Item | Details |
|---|---|
| Reservation SOAP endpoint | Your HTTPS endpoint URL for Reservations Push (SM -> PMS) |
| Credentials | username and password for SiteMinder to authenticate against your Reservation SOAP endpoint |
| Inventory REST endpoint | For Rooms and Rates (PMS -> SM), Restrictions (SM -> PMS) and Rates (SM -> PMS) |
| Credentials | username and password for SiteMinder to authenticate against your Inventory REST endpoint |
| Pricing Model | Whether you'll implement Per Day Pricing (PDP) or Occupancy Based Pricing (OBP). |
| Item | Details |
|---|---|
| SOAP endpoint | https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID} |
| REST endpoint | https://tpi-pmsx.preprod.siteminderlabs.com/core-api/pmses/{pmsCode} |
| Credentials | username and password (same both endpoints) |
| Identifiers | RequestorID / pmsCode |
| Hotel Code | HotelCode |
| Hotel Test Account | Platform that includes pre-configured room types and rate plans, to verify pushed inventory updates and reservation delivery status. |
| Hotel Booking Engine | Guest reservation simulator. |
| Model | Credentials | SOAP/XML | REST/JSON |
|---|---|---|---|
| PMS-level (recommended) | One set for all properties | ✅ | ✅ |
| Hotel-level (legacy) | Per-property credentials | ✅ | ❌ |
| EWT | Error Type | Description |
|---|---|---|
| 1 | Unknown | Indicates an unknown error. |
| 3 | Biz rule | Indicates that the XML message has passed a low-level validation check, but that the business rules for the request message were not met. |
| 4 | Authentication | Indicates the message lacks adequate security credentials |
| 6 | Authorization | Indicates the message lacks adequate security credentials |
| 10 | Required field missing | Indicates that a required element or attribute, as defined by the schema or agreed upon by trading partners, is missing from the message. In the context of pmsXchange, this error will also be returned if the XML message does not conform to the data type restrictions specified by the XML schema. |
| 12 | Processing exception | Indicates that an undefined exception occurred during the processing of the request. |
| Error Name | Error Description | |
|---|---|---|
| Invalid Endpoint | Authentication failed - PMS does not exist | |
| Invalid Requestor ID | Inconsistent PMS codes. PMS 'PMSCODE' does not match RequestorID 'PMSCODEX' | |
| Invalid Credentials | Authentication failed - PMS received request with invalid username/password | |
| Invalid Hotel Code | PMS is not authorized to access hotel with HotelCode=HOTELCODE | |
| System error | ||
| Unable to process |
What is the difference between RoomTypeCode and InventoryTypeCode?
Both identify the same room type, just used in different message types:
* `InvTypeCode` = Used to identify the room type in inventory updates (availability, restrictions, rates)
* `RoomTypeCode` = Used to identify the room type in reservations messages
Use the `roomTypeCode` from the `room-rates` endpoint for both.
Can I use the room-rates endpoint with hotel-level authentication?
No. The `room-rates` endpoint requires PMS-level authentication (same credentials for all properties).
If you're using hotel-level authentication, contact Partner Integrations to migrate to PMS-level.
How often should I call the room-rates endpoint?
During initial setup and when mapping changes occur.
This endpoint is for configuration retrieval, not real-time polling:
* Initial Integration: Pull room rates during PMS setup
* On Demand: When mapping issues are reported or rooms/rates are added
* Periodic Sync: Optional weekly or monthly check for configuration updates
Avoid polling frequently, room rate configurations don't change often.
What is the difference between Rooms and Rates (PMS -> SM) and Rooms and Rates (SM -> PMS) endpoint?
The direction of the API call is different: * **Rooms and Rates (SM -> PMS)**: PMS calls SiteMinder to retrieve room and rate configuration * **Rooms and Rates (PMS -> SM)**: SiteMinder calls the PMS to retrieve room and rate configuration Rooms and Rates (PMS -> SM) also includes additional metadata like `rateSetupType` and `unsupportedData` to communicate rate configuration and limitations.When should I use NO_RATES vs NO_UPDATES in unsupportedData?
Use these codes to communicate data limitations:
* `NO_RATES`: Use for derived rates or when only restrictions should be updated, but not pricing
* `NO_UPDATES`: Use when the room rate should not receive any updates (restrictions or rates)
For derived rates, set `rateSetupType` to "Derived" and include `NO_RATES` in `unsupportedData`.
How often will SiteMinder call this endpoint?
SiteMinder calls this endpoint during: * Initial hotel setup and configuration * On-demand when mapping issues are detected * Periodic synchronization to detect configuration changes This is not a real-time polling endpoint. The PMS should return the current configuration state when called.| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRQ | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
POS / Source / RequestorID | 1 | ||
@Type | 1 | Fixed at 22 (ESRP) | |
@ID | String | ||
AvailStatusMessages | Element | 1 | Container for availability and restriction status messages. |
@HotelCode | String | 1 | Identifier for the hotel. |
AvailStatusMessage | Element | 1..n | Single availability or restriction status message. |
@BookingLimit | Integer ≥ 0 | 0..1 | Sets the number of rooms available for sale. |
StatusApplicationControl | Element | 1 | Contains date and room identification information. Note: No overlapping dates allowed. |
@Start | Date | 1 | The start date for which the update is being set. This date is inclusive. |
@End | Date | 1 | The end date for which the update is being set. This date is inclusive. |
@InvTypeCode | String | 1 | Identifies the room type. |
Mon, Tue, Weds, Thur, Fri, Sat, Sun | Boolean | 0..1 | The day-of-week indicators are used to specify which days a rate update applies to. These indicators accept values of
|
LengthsOfStay | Element | 0..1 | Used for Minimum Stay and Maximum Stay. |
LengthOfStay | Element | 1..2 | Single length of stay information. |
@MinMaxMessageType | String | 1 | Can be one of the following:
|
@Time | Integer > 0 | 1 | Specifies the number of days related to a stay.
|
RestrictionStatus | Element | 0..1 | Used to restrict the room for Stop Sell, Closed to Arrivals, and Closed to Departure. |
@Status | String | 1 | Values:
|
@Restriction | String | 0..1 | Values:
If no type is specified, assume a full close or open for the room rate. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
Can I send availability and restrictions updates in the same message?
Yes, but send them separately for better processing. The `OTA_HotelAvailNotifRQ` message supports both, but separate requests provide clearer error handling and easier troubleshooting.How often should I send availability and restrictions updates?
Send delta updates in real-time as changes occur in your PMS (within 2 minutes). Only send data that has changed - do not resend unchanged availability or restrictions.Can I send full flushes daily to ensure complete synchronization?
No. Full flushes are only for initial setup or when requested by SiteMinder support. Delta updates (changes only) are required in production. Frequent full flushes cause system overload and must be avoided.When availability or restrictions change for a date, do I need to include all data in the message?
No. Send only what changed. If availability changed, send only the new availability value. If a restriction changed, send only that restriction. Do not include unchanged data in your message. Send changes only for the specific room type and rate plan that changed - do not include other room types or rate plans.What happens when availability and restrictions conflict?
Restrictions take priority over availability. **Priority order:** 1. **Stop Sell** - Overrides everything; if closed, room rate cannot be booked 2. **CTA/CTD** - Controls arrival/departure when Stop Sell is open 3. **Availability** - Room count when restrictions allow booking **Both must allow booking:** * Stop Sell = Close, Availability = 10 → Cannot book (restrictions block) * Stop Sell = Open, Availability = 0 → Cannot book (no inventory) * Stop Sell = Open, Availability = 10 → Can book ✓ Update availability and restrictions independently - stored availability activates when restrictions open.Can I set different restrictions for different rate plans on the same room type?
Yes. Restrictions are set at the room rate level, while availability is set at the room type level. **Availability (Room Level):** * Applied to the entire room type (InvTypeCode only) * All rate plans share the same availability pool * Example: 10 Double Rooms available for ALL rate plans **Restrictions (Room Rate Level):** * Applied to specific room/rate combinations (InvTypeCode + RatePlanCode) * Each rate plan can have independent restrictions * Example: Double Room - BAR (Stop Sell = Close), Double Room - B\&B (Stop Sell = Open)Does SiteMinder automatically reduce availability for all reservation types?
No. Only new bookings trigger automatic reduction for quick channel updates. Your PMS must send availability updates via `OTA_HotelAvailNotifRQ` for all reservation types (Book, Modify, Cancel) - you are the master source of availability data.How many dates in advance does SiteMinder support?
Up to 750 days in the future. Properties can configure their inventory distribution window between 400-750 days based on their preferences.Do you support Minimum/Maximum Stay Through?
No. pmsXchange only supports standard MinLOS/MaxLOS (applied on check-in date). Stay Through restrictions (applied when any part of the reservation touches a date) are not currently supported.Do you support Patterned Length of Stay (e.g., only 7, 14, 21, or 28 days)?
Not directly, but use multiple rate plans with different MinLOS values. Example: Create "Weekly" (MinLOS = 7), "Bi-Weekly" (MinLOS = 14), and "Monthly" (MinLOS = 28) rate plans for the same room type, each with appropriate pricing.| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRQ | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
POS / Source / RequestorID | 1 | ||
@Type | 1 | Fixed at 22 (ESRP) | |
@ID | String | ||
AvailStatusMessages | Element | 1 | Container for availability and restriction status messages. |
@HotelCode | String | 1 | Identifier for the hotel. |
AvailStatusMessage | Element | 1..n | Single availability or restriction status message. |
@BookingLimit | Integer ≥ 0 | 0..1 | Sets the number of rooms available for sale. |
StatusApplicationControl | Element | 1 | Contains date and room identification information. Note: No overlapping dates allowed. |
@Start | Date | 1 | The start date for which the update is being set. This date is inclusive. |
@End | Date | 1 | The end date for which the update is being set. This date is inclusive. |
@InvTypeCode | String | 1 | Identifies the room type. |
@RatePlanCode | String | 1 | Identifies the rate plan. |
Mon, Tue, Weds, Thur, Fri, Sat, Sun | Boolean | 0..1 | The day-of-week indicators are used to specify which days a rate update applies to. These indicators accept values of
|
LengthsOfStay | Element | 0..1 | Used for Minimum Stay and Maximum Stay. |
LengthOfStay | Element | 1..2 | Single length of stay information. |
@MinMaxMessageType | String | 1 | Can be one of the following:
|
@Time | Integer > 0 | 1 | Specifies the number of days related to a stay.
|
RestrictionStatus | Element | 0..1 | Used to restrict the room for Stop Sell, Closed to Arrivals, and Closed to Departure. |
@Status | String | 1 | Values:
|
@Restriction | String | 0..1 | Values:
If no type is specified, assume a full close or open for the room rate. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
Can I send availability and restrictions updates in the same message?
Yes, but send them separately for better processing. The `OTA_HotelAvailNotifRQ` message supports both, but separate requests provide clearer error handling and easier troubleshooting.How often should I send availability and restrictions updates?
Send delta updates in real-time as changes occur in your PMS (within 2 minutes). Only send data that has changed - do not resend unchanged availability or restrictions.Can I send full flushes daily to ensure complete synchronization?
No. Full flushes are only for initial setup or when requested by SiteMinder support. Delta updates (changes only) are required in production. Frequent full flushes cause system overload and must be avoided.When availability or restrictions change for a date, do I need to include all data in the message?
No. Send only what changed. If availability changed, send only the new availability value. If a restriction changed, send only that restriction. Do not include unchanged data in your message. Send changes only for the specific room type and rate plan that changed - do not include other room types or rate plans.What happens when availability and restrictions conflict?
Restrictions take priority over availability. **Priority order:** 1. **Stop Sell** - Overrides everything; if closed, room rate cannot be booked 2. **CTA/CTD** - Controls arrival/departure when Stop Sell is open 3. **Availability** - Room count when restrictions allow booking **Both must allow booking:** * Stop Sell = Close, Availability = 10 → Cannot book (restrictions block) * Stop Sell = Open, Availability = 0 → Cannot book (no inventory) * Stop Sell = Open, Availability = 10 → Can book ✓ Update availability and restrictions independently - stored availability activates when restrictions open.Can I set different restrictions for different rate plans on the same room type?
Yes. Restrictions are set at the room rate level, while availability is set at the room type level. **Availability (Room Level):** * Applied to the entire room type (InvTypeCode only) * All rate plans share the same availability pool * Example: 10 Double Rooms available for ALL rate plans **Restrictions (Room Rate Level):** * Applied to specific room/rate combinations (InvTypeCode + RatePlanCode) * Each rate plan can have independent restrictions * Example: Double Room - BAR (Stop Sell = Close), Double Room - B\&B (Stop Sell = Open)Does SiteMinder automatically reduce availability for all reservation types?
No. Only new bookings trigger automatic reduction for quick channel updates. Your PMS must send availability updates via `OTA_HotelAvailNotifRQ` for all reservation types (Book, Modify, Cancel) - you are the master source of availability data.How many dates in advance does SiteMinder support?
Up to 750 days in the future. Properties can configure their inventory distribution window between 400-750 days based on their preferences.Do you support Minimum/Maximum Stay Through?
No. pmsXchange only supports standard MinLOS/MaxLOS (applied on check-in date). Stay Through restrictions (applied when any part of the reservation touches a date) are not currently supported.Do you support release period?
No, there is no native release-period field, so a PMS wanting the same functional outcome must send Stop Sell for the release-window dates instead of a dedicated release-period value.Do you support Patterned Length of Stay (e.g., only 7, 14, 21, or 28 days)?
Not directly, but use multiple rate plans with different MinLOS values. Example: Create "Weekly" (MinLOS = 7), "Bi-Weekly" (MinLOS = 14), and "Monthly" (MinLOS = 28) rate plans for the same room type, each with appropriate pricing.Why must I queue updates for offline processing instead of processing them immediately?
Due to the high volume of restriction updates, processing them synchronously would block SiteMinder from sending subsequent updates. Your PMS should: 1. Receive the update and return 200 OK immediately 2. Queue the update for asynchronous processing 3. Process the queued updates offline without blocking new incoming requests This ensures continuous data flow and prevents update backlogs.What happens if my PMS doesn't support a specific restriction type?
SiteMinder only sends restriction types that your PMS supports. During integration setup, you specify which restriction types your PMS can handle. Unsupported restriction types won't be included in the update messages, reducing unnecessary data transmission and processing.How many dates can be included in a single update message?
Each message can contain up to 760 dates for a specific room rate code combination. The actual number depends on the update period configured by the hotel. Each date in the array represents a separate day's restrictions.How should I handle the Retry-After header in 429 responses?
When your PMS returns a `429` (Too Many Requests) response, include the `Retry-After` header with the number of seconds SiteMinder should wait before retrying. This allows you to implement rate limiting and back-pressure when your system is under high load.
Example: `Retry-After: 60` tells SiteMinder to wait 60 seconds before sending the next update.
| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element/Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelRateAmountNotifRQ | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
POS / Source / RequestorID | 1 | ||
@Type | 1 | Fixed at 22 (ESRP) | |
@ID | 1 | ||
RateAmountMessages | Element | 1 | Container for rate status messages. |
@HotelCode | String | 1 | Identifier for the hotel. |
RateAmountMessage | Element | 1..n | Single rate status message. |
StatusApplicationControl | Element | 1 | Contains date and room identification information. Note: No overlapping dates allowed. |
@InvTypeCode | String | 1 | Identifies the room. |
@RatePlanCode | String | 1 | Identifies the rate. |
Rates | Element | 1 | Container for rate information. |
Rate | Element | 1 | Contains individual rate information. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
@Start | Date | 1 | The start date for which the update is being set. This date is inclusive. |
@End | Date | 1 | The end date for which the update is being set. This date is inclusive. |
Mon, Tue, Weds, Thur, Fri, Sat, Sun | 0..1 | The day-of-week indicators are used to specify which days a rate update applies to. These indicators accept values of
| |
BaseByGuestAmts | Element | 1 | Base charge for a given number of guests. |
BaseByGuestAmt | Element | 1 | Contains individual rate amounts. |
@AmountAfterTax | Decimal | 0..1 | Either Positive decimal value for the rate amount after tax. |
@AmountBeforeTax | Decimal | 0..1 | Either @AmountAfterTax or @AmountBeforeTax must be included. Positive decimal value for the rate amount after tax. |
@NumberOfGuests | Integer | 0..1 | Number of guests in the room. Mandatory for OBP. |
@AgeQualifyingCode | Element | 0..1 | Age qualification for the rate:
Mandatory for OBP. |
AdditionalGuestAmounts | Element | 0..1 | For OBP: Additional charges for extra guests based on age qualification. |
AdditionalGuestAmount | Element | 0..2 | For OBP: Contains details of extra guest charges. |
@AgeQualifyingCode | String | 1 | Age qualification for the extra guest charge:
|
@Amount | Decimal | 1 | Extra charge amount. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelRateAmountNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
What is the difference between PDP and OBP?
* PDP (Per Day Pricing): Single rate per room per night.\ Example: $100/night for a Double Room (any occupancy) * OBP (Occupancy Based Pricing): Rates vary by guest count.\ Example: $80 (1 guest), $100 (2 guests), $120 (3 guests), $140 (4 guests), $160 (5 guests). Choose the pricing model that matches how your PMS stores rates. You only need to certify one model during integration.How often should I send rates updates?
Send delta updates in real-time as changes occur in your PMS (within 2 minutes). Only send data that has changed - do not resend unchanged rates.Can I send full flushes daily to ensure complete synchronization?
No. Full flushes are only for initial setup or when requested by SiteMinder support. Delta updates (changes only) are required in production. Frequent full flushes cause system overload and must be avoided.When rates change for a date, do I need to include all data in the message?
No. Send changes only for the specific room type and rate plan that changed - do not include other room types or rate plans.How many dates in advance does SiteMinder support?
Up to 750 days in the future. Properties can configure their inventory distribution window between 400-750 days based on their preferences.Do you support Weekly, Monthly or Package Rates?
Only daily rates are supported. * **Weekly/Monthly**: Not supported - send daily rates instead * **Packages** (room + extras): Include all charges in your daily rate amountHow do I send Extra / Supplement / Discount rates to SiteMinder?
Send your full daily rate including all extras - SiteMinder does not support separate supplement charges. **Your rate should include:** * Base room rate * Any included extras (breakfast, parking, etc.) * Any supplements or add-ons **Channel discounts/promotions:** Managed by channels, not sent via pmsXchange.Do you support Seasonal Rates?
pmsXchange does not currently support Seasonal Rates. However, you may use Stop Sell restrictions to control when rate plans are available. Create separate rate plans for each season and use Stop Sell to open/close them for the appropriate date ranges.For OBP, is pricing per adult or per guest (adults + children)?
Per adult only. `NumberOfGuests` represents the number of adults in the room. Use `AgeQualifyingCode="10"` with `NumberOfGuests` (1-5) to specify rates for different adult counts. Child charges are handled separately using the `AdditionalGuestAmounts` element.Should I implement both rate endpoints or just one?
You only need to implement one rate endpoint based on your PMS capabilities: * **Per Day Pricing** (`/rates`): Implement this if your PMS stores a single daily rate with optional extra person charges * **Occupancy Based Pricing** (`/occupancy-based-rates`): Implement this if your PMS stores separate rates for different occupancy levels (1-5 adults) SiteMinder automatically converts between formats using the room rate configuration in the Platform, so you'll receive data in the format your PMS supports regardless of how it's configured in the Platform.Why must I queue updates for offline processing instead of processing them immediately?
Due to the high volume of rate updates, processing them synchronously would block SiteMinder from sending subsequent updates. Your PMS should: 1. Receive the update and return 200 OK immediately 2. Queue the update for asynchronous processing 3. Process the queued updates offline without blocking new incoming requests This ensures continuous data flow and prevents update backlogs.How many dates can be included in a single update message?
Each message can contain up to 760 dates for a specific room rate code combination. The actual number depends on the update period configured by the hotel. Each date in the array represents a separate day's rates.How should I handle the Retry-After header in 429 responses?
When your PMS returns a `429` (Too Many Requests) response, include the `Retry-After` header with the number of seconds SiteMinder should wait before retrying. This allows you to implement rate limiting and back-pressure when your system is under high load.
Example: `Retry-After: 60` tells SiteMinder to wait 60 seconds before sending the next update.
| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| IP Whitelisting | Pre-Production IP addresses:
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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. Preferred format: UUID 8-4-4-4-12. |
@TimeStamp | DateTime | 1 | Time when the request was generated. TimeStamp must use ISO 8601 format. |
@PrimaryLangID | String | 1 | Always en-us |
@Target | String | 1 | Always Production |
@Version | Decimal | 1 | Specifies the API version. Current Version 2.001 |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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.CreateDateTime must follow the ISO 8601 Date and Time format. |
@ResStatus | String | 1 | Status is:
|
@LastModifyDateTime | DateTime | 0..1 | This indicates the last date and time when the reservation was last modified. Mandatory if ResStatus is Modify or Cancel.LastModifyDateTime must follow the ISO 8601 Date and Time format. |
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 |
@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 | Only present in the first Source element. Identifies the system sending the reservation. |
@ID | String | 1 | Always SITEMINDER |
@Type | Integer | 1 | Fixed at 22 (ESRP) |
BookingChannel | Element | 1 | Contains booking channel information. |
@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. Use the |
@Code | String | 0..1 | Code of the booking channel. See the Booking Agent Codes Table for reference. |
| 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. |
| 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).
|
@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. |
| 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).
|
@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>
<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>
| 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. 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. |
| 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 |
|
@Count | Integer | 1 | Number of guests for this age group. |
| 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. |
| 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 |
| 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. |
| 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). |
| 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. |
| 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. |
| 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 SiteMinder 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. |
| 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:
|
@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:
|
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:
|
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:
|
Text | Element | 1 | The content of the comment. PCI sensitive data is prohibited. |
| 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:
|
@ResID_Value | String | 1 | For For
|
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
@DSTransactionID | String | 0..1 | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. When |
@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:
|
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. |
| 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. |
| 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 idIATA 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:
|
@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
|
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:
|
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. |
| 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. |
Success Response (<Success/>) |
|
Error Response (<Errors>) |
|
| No/Invalid Response (timeout, HTTP error, invalid XML) |
|
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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. 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 | 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. |
Maximum Content XML
{% code overflow="wrap" %} ```xmlMinimum Content XML
{% code overflow="wrap" %} ```xmlWhat 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.
`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 RoomStayDo 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 extranetDo 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.| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| 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:
|
| 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). |
| 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:
|
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 |
|
@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" |
| 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 |
|
@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 | String | 0..1 | Code of the booking channel. See the Booking Agent Codes Table for reference. |
| 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. |
| 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).
|
@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. |
| 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).
|
@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>
<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>
| 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. 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. |
| 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 |
|
@Count | Integer | 1 | Number of guests for this age group. |
| 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. |
| 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 |
| 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. |
| 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). |
| 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. |
| 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. |
| 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 SiteMinder 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. |
| 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:
|
@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:
|
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:
|
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:
|
Text | Element | 1 | The content of the comment. PCI sensitive data is prohibited. |
| 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:
|
@ResID_Value | String | 1 | For For
|
| 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. |
| 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. |
| 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. |
| 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. |
| 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 |
@DSTransactionID | String | 0..1 | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. When |
@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:
|
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. |
| 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. |
| 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 idIATA 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:
|
@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
|
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:
|
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. |
| 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. |
| 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. Must include a free-text, meaningful, human-readable description of the error. |
@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:
|
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. |
Maximum Content XML
{% code overflow="wrap" %} ```xmlMinimum Content XML
{% code overflow="wrap" %} ```xmlWhat 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.
`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 RoomStayDo 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 extranetDo 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.| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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 |
@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. Current Version 1.0 |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
HotelReservations | Element | 1 | Contains the reservation details. |
HotelReservation | Element | 1 | Contains the specific reservation information. |
@ResStatus | Enumeration | 1 | Status is:
|
@CreateDateTime | DateTime | 1 | Date and time when the reservation was first made.
|
@LastModifyDateTime | DateTime | 0..1 | This indicates the last date and time when the reservation was last modified. Mandatory if a message relating to this reservation has already been uploaded. If the same LastModifyDateTime is sent in multiple reservation events, only the first will be processed and the rest ignored since it is considered as the same reservation version.LastModifyDateTime must follow the ISO 8601 Date and Time format. |
@CreatorID | String | 0..1 | The creator ID could be a software system identifier or an identifier of an employee responsible for the creation. |
@LastModifierID | String | 0..1 | Identifies the last software system or person to modify a record. |
@WalkInIndicator | Boolean | 0..1 | Used to identify if the reservation is a walk-in reservation. This attribute is mandatory if a reservation has been generated in the PMS. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
POS | Element | 1 | Point of Sale (POS) identifies the party or connection channel making the request. |
Source | Element | 1..10 | This holds the details about the requestor. It may be repeated to also accommodate the delivery systems. Provides information on the source of a request. |
RequestorID | Element | 1 | This identifies the system which is sending the reservation. This element must appear in the first Source element. |
@Type | Integer | 1 | 10 for PMS |
@ID | String | 1 | PMS Code assigned by SiteMinder. Remains the same throughout the messages. |
BookingChannel | Element | 0..1 | Contains booking channel information. |
@Type | Integer | 1 | The type of booking channel:
|
@Primary | Boolean | 0..1 |
|
CompanyName | Element | 1 | Identifies the company that is associated with the booking channel. |
@Code | String | 0..1 | Identifies a company by the company code. The Code must identify the specific booking channel code using our Booking Agent Codes. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
UniqueID | Element | 1 | Used to provide PMS and/or CRS identifiers. An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). |
@ID | String | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RoomStays | Element | 1 | A collection of RoomStay objects. Room stays associated with this reservation. |
RoomStay | Element | 1..n | One instance of RoomStay per room type booked. |
@MarketCode | String | 0..1 | The code that relates to the market being sold to (e.g., the corporate market, packages). |
@SourceOfBusiness | String | 0..1 | To specify where the business came from e.g. radio, newspaper ad, etc. |
@PromotionCode | String | 0..1 | If configured, this is the promotion code indicating, for instance, a specific marketing campaign (not the rate code). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RoomTypes | Element | 0..1 | A collection of Room Types associated with a particular Room Stay. |
RoomType | Element | 0..1 | Provides details regarding rooms, usually guest rooms. Can be sent to give more information on the room type for this room stay. |
@RoomType | String | 0..1 | A code value that indicates the type of room for which this request is made, e.g.: double, king, etc. Values may use the Hotel Descriptive Content table or a codes specific to the property or hotel brand. |
@RoomTypeCode | String | 0..1 | Specific system room type code, ex: A1K, A1Q etc. |
@RoomCategory | Integer | 0..1 | Indicates the category of the room. Typical values would be |
@RoomID | Integer | 0..1 | A string value representing the unique identification of a room if the request is looking for a specific room. |
@NonSmoking | Boolean | 0..1 | Non-smoking indicator. |
@Configuration | String | 0..1 | Textual description of room configuration. |
RoomDescription | Element | 0..1 | Textual information regarding the room. |
@Text | Element | 0..n | A text description of the room |
AdditionalDetails | Element | 0..1 | Container for additional information about this room. |
AdditionalDetail | Element | 1..n | |
@Type | Integer | 0..1 | Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to the Additional Detail Type (ADT). Some common usages are: 43 - Meal plan information15 - Promotion information |
@Code | String | 0..1 | Trading partner code associated to AdditionalDetailType. |
DetailDescription | Element | 0..1 | Textual description of AdditionalDetail information. |
Text | Element | 0..n | A text description of AdditionalDetail |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RatePlans | Element | 0..1 | A collection of Rate Plans associated with a particular Room Stay. |
RatePlan | Element | 0..1 | Defines the details of the rate plan as used in the booking process. |
@RatePlanName | String | 0..1 | Provides the name of the rate plan or group. Typically used with RatePlanType to further describe the rate plan. |
@EffectiveDate | Date | 0..1 | The effective date of the RatePlan. |
@ExpireDate | Date | 0..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. |
@RatePlanCode | String | 0..1 | Code of the rate booked. |
RatePlanDescription | Element | 0..1 | Textual description of the RatePlan. |
Text | Element | 0..n | A text description of the RatePlan. |
RatePlanInclusions | Element | 0..1 | Defines charges that are included in this rate plan. |
@TaxInclusive | Boolean | 0..1 | Indicates that service fees are included in the rate. |
@ServiceFeeInclusive | Boolean | 0..1 | Indicates that tax is included in the rate. |
RatePlanInclusionDescription | Element | 0..1 | Textual description of what is included in the rate plan. |
Text | Element | 0..1 | A text description of the RatePlanInclusionDescription |
MealsIncluded | Element | 0..1 | Container. |
@MealPlanIndicator | Boolean | 0..1 | When true, a meal plan is included in this rate plan. When false, a meal plan is not included in this rate plan. |
@MealPlanCodes | String | 0..1 | Used to identify the types of meals included with a rate plan. Refer to OpenTravel Code List Meal Plan Type (MPT) |
AdditionalDetails | Element | 0..1 | Textual description of AdditionalDetail information. |
AdditionalDetail | Element | 0..1 | A text description of AdditionalDetail |
@Type | Integer | 0..1 | Used to define the type of information being sent (e.g., rate description, property description, room information). Refer to OpenTravel Code List Additional Detail Type (ADT) Some common usages are: 43 - Meal plan information15 - Promotion information |
@Code | String | 0..1 | Trading partner code associated to AdditionalDetailType. |
DetailDescription | Element | 0..1 | Textual description of AdditionalDetail information. |
Text | Element | 0..n | A text description of AdditionalDetail |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RoomRates | Element | 0..1 | Contains details of the rates applied to the room stay. |
RoomRate | Element | 1..n | One RoomRate per RoomStay. Multiple rates are listed under the RoomRate. |
@InvBlockCode | String | 0..1 | Code that identifies an inventory block. |
@NumberOfUnits | Integer | 0..1 | Must be set to 1. If there are multiple RoomStays for the same RoomTypeCode and RatePlanCode, multiple RoomStay elements should be sent. |
@RoomID | String | 0..1 | A string value representing the unique identification of a room. |
@RoomTypeCode | String | 0..1 | Code of the room booked. |
@RatePlanCode | String | 0..1 | Code of the rate plan booked. Must be included if RoomStay / RatePlans is present. |
@RatePlanCategory | String | 0..1 | Hotel systems often group multiple rate plans into a single category. This refers to that category that is specific to the hotel CRS/ PMS and should not be confused with a GDS rate category. |
@EffectiveDate | Date | 1 | Indicates the starting date. |
@ExpireDate | Date | 1 | ExpireDate is the first day after the applicable period (e.g. when expire date is 2012-04-03 the last date of the period is 2012-04-02). Format yyyy-MM-dd. This date is exclusive. |
Rates | Element | 0..1 | Container that will contain instances of Rates. |
Rate | Element | 1..n | 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. |
@UnitMultiplier | Integer | 1 | Must be set to 1. |
@EffectiveDate | Date | 1 | Starting date of the rate. This date is inclusive. |
@ExpireDate | Date | 1 | Expire date is the first day after the applicable period. This date is not inclusive. |
Base | Element | 1 | Base amount charged for the accommodation. |
@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. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..5 | Text description of the taxes. |
Text | Element | 0..n | Textual description of the tax |
Total | Element | 1 | Total amount charged, including additional occupants and fees. If empty, assume the Base amount equals the Total amount. |
@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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
@Amount | Decimal | 0..1 | Tax amount applied. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Tax | Element | 0..99 | An individual tax per tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | Integer | 0..1 | The type of tax being applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Integer | 0..1 | A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value). |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..5 | Text description of the taxes. |
Text | String | 0..n | Textual description of the tax |
Total | Element | 1 | The Total amount charged for the accommodation or service per unit of time. |
@AmountBeforeTax | Integer | 0..1 | The Total amount charged for the accommodation or service per unit of time. |
@AmountAfterTax | Integer | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | A collection of taxes. |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
@Amount | Integer | 0..1 | A monetary amount of tax. |
Tax | Element | 0..99 | An individual tax per tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | Integer | 0..1 | The type of tax is applied to the total. Refer to the OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Integer | 0..1 | A monetary amount of tax. if zero, assume use of the Percent attribute (Amount or Percent must be a zero value). |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Tax percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | String | 0..5 | Text description of the taxes. |
Text | String | 0..n | Textual description of the tax |
ServiceRPHs | Element | 0..1 | A collection of unsigned integers that reference the RPH (Reference Place holder) attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached this RoomRate. |
ServiceRPH | Element | 1..n | This is a reference placeholder used as an index for a service to be associated with this stay |
@RPH | Integer | 1 | Provides a unique reference to the service. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
GuestCounts | Element | 1 | Total guest counts, divided by age group (adult, child, infant). Adult count must always be sent. |
GuestCount | Element | 1..n | Represents the count for a specific age group. |
@AgeQualifyingCode | Integer | 1 |
|
@Count | Integer | 1 | Number of guests for this age group. |
@Age | Integer | 0..1 | Age of the guest, required only for children and infants. |
@AgeBucket | String | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. |
| 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. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Guarantee | Element | 0..1 | Guarantee provided with the reservation. Used if no deposit is paid for the reservation. |
@GuaranteeCode | String | 0..1 | Contains the details of accepted Guarantee Code. |
@GuaranteeType | Enumeration | 0..1 | An enumerated type defining the guarantee to be applied to this reservation. Value: |
GuaranteesAccepted | Element | 0.1 | The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context. |
GuaranteeAccepted | Element | 1..n | Guarantee Detail. One of PaymentCard, Voucher, DirectBill elements must be included within GuranteeAccepted. |
@PaymentTransactionTypeCode | String | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
PaymentCard | Element | 0..1 | Specific payment card information. Details of a debit or credit card. |
@CardCode | String | 1 | 2-character code of the credit card issuer. Refer to Payment Card Provider Codes. |
@EffectiveDate | String | 0..1 | Indicates the starting date. format MMyy). |
@ExpireDate | String | 0..1 | Expiry date of the credit card (format MMyy). |
CardHolderName | Element | 0..1 | Card Holder Name |
CardNumber | String | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. |
@Mask | String | 0..1 | Masked data. |
@Token | Integer | 0..1 | Tokenized information. |
@TokenProviderID | String | 0..1 | Provider ID. |
Voucher | Element | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
@SeriesCode | String | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
DirectBill | Element | 0..1 | Details of a direct billing arrangement. |
@DirectBill_ID | Integer | 0..1 | Identifier for the organization to be billed directly for travel services. |
GuaranteeDescription | Element | 0..1 | Text description relating to the Guarantee. |
Text | Sting | 0..n | Textual information relating to the Guarantee. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
DepositPayments | Element | 0..1 | A collection of required payments. |
GuaranteePayment | Element | 1..n | Used to define the deposit policy, guarantees policy, and/or accepted forms of payment. |
AcceptedPayments | Element | 0..1 | Collection of forms of payment accepted for payment. Used to define the types of payments accepted. |
AcceptedPayment | Element | 0..1 | An acceptable form of payment. |
@PaymentTransactionTypeCode | String | 0..1 |
|
PaymentCard | Element | 0..1 | Specific payment card information. Details of a debit or credit card. NOTE: PCI-sensitive payment card information should not be included in the message. Do not attempt to send any payment card data for there isn't a specific element or attribute in the API. |
@CardCode | String | 0..1 | Issuer code. See OTA Payment Card Provider Codes |
@EffectiveDate | Date | 0..1 | Indicates the starting date. |
@ExpireDate | Date | 0..1 | Indicates the ending date. |
CardHolderName | Element | 0..1 | Card holder name. |
CardNumber | Element | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. |
@Mask | String | 0..1 | Masked data. |
@Token | Integer | 0..1 | Tokenized information. |
@TokenProviderID | String | 0..1 | Provider ID. |
Voucher | Element | 0..1 | Details of a paper or electronic document indicating prepayment. |
@SeriesCode | Integer | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
DirectBill | Element | 0..1 | Details of a direct billing arrangement. |
@DirectBill_ID | Integer | 0..1 | Identifier for the organization to be billed directly for travel services. |
AmountPercent | Element | 0..1 | Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated. |
@Percent | Integer | 0..1 | The percentage used to calculate the amount. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount taken for the deposit. |
@NmbrOfNights | Integer | 0..1 | The number of nights of the hotel stay that are used to calculate the fee amount. |
Taxes | Element | 0..1 | A collection of taxes relating to the deposit. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Integer | 0..1 | |
Tax | Element | 0..99 | An individual tax. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | String | 0..1 | Code identifying the fee (e.g., agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..5 | Text description of the taxes. |
Text | Element | 0..n | Textual description of the tax |
Deadline | Element | 0..2 | Payment deadline, absolute or relative. |
@AbsoluteDeadline | DateTime | 0..1 | Defines the absolute deadline. Either this or the offset attributes may be used. |
@OffsetTimeUnit | String | 0..1 | The units of time, e.g.: days, hours, etc., that apply to the deadline. |
@OffsetUnitMultiplier | Integer | 0..1 | The number of units of DeadlineTimeUnit. |
@OffsetDropTime | String | 0..1 | An enumerated type indicating when the deadline drop time goes into effect. |
Description | Element | 0..5 | Text description of the Payment in a given language. |
Text | String | 0..n | Textual information information relating to the payment. |
Address | String | 0..1 | The address to which a deposit may be sent. |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). |
AddressLine | Element | 0..5 | Address including any relevant street number. |
CityName | Element | 0..1 | City. |
PostalCode | Element | 0..1 | Postal code. |
StateProv | Element | 0..1 | State, province, or region name or code needed to identify location. |
@StateCode | Integer | 0..1 | The standard code or abbreviation for the state, province, or region. |
CountryName | Element | 0..1 | The name or code of a country (as used in an address). |
@Code | Integer | 0..1 | ISO 3166 code for a country. |
| Element / Attribute | Type | M | Description |
|---|---|---|---|
Discount | Element | 0..1 | Discount percentage and/or Amount, code and textual reason for discount. |
@TaxInclusive | Boolean | 0..1 | Is Discount tax inclusive. |
@Percent | Integer | 0..1 | Percentage value of the discount. |
@DiscountCode | String | 0..1 | Specifies the type of discount (e.g., No condition, LOS, Deposit or Total amount spent). |
@AmountBeforeTax | Decimal | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). |
@AmountAfterTax | Decimal | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | A collection of taxes relating to Discount |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
Tax | Element | 0..1 | This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | Integer | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..1 | Text description of the taxes. |
Text | Element | 0..1 | Textual description of the tax |
DiscountReason | Element | 1 | Text description of Discount Reason. |
Text | Element | 1 | Textual description of Discount Reason. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Total | Element | 0..1 | The total amount charged for the service including additional amounts and fees. |
@AmountBeforeTax | Decimal | 0..1 | The total amount not including any associated tax (e.g., sales tax, VAT, GST or any associated tax). |
@AmountAfterTax | Decimal | 0..1 | The total amount including all associated taxes (e.g., sales tax, VAT, GST or any associated tax). |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | A collection of taxes relating to Discount |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
Tax | Element | 0..1 | This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | String | 0..1 | Code identifying the fee (e.g., agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..5 | Text description of the taxes. |
Text | Element | 0..n | Textual description of Discount Reason. |
| 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. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Memberships | Element | 0..1 | A collection of Membership objects. Memberships provides a list of reward programs which may be credited with points accrued from the guest's activity. Which memberships are to be applied to which part is determined by each object's SelectedMembershipRPHs collection. |
Membership | Element | 1..n | The SelectedMembership object identifies the frequent customer reward program and (optionally) indicates points awarded for stay activity. |
@ProgramCode | String | 0..1 | The code or name of the membership program ('Hertz', 'AAdvantage', etc.). |
@AccountID | String | 0..1 | The account identification number for this particular member in this particular program. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Comments | Element | 0..1 | Contains comment for the RoomStay. |
Comment | Element | 1 | Holds the actual comment. |
@GuestViewable | Boolean | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. |
Text | Element | 1 | The content of the comment. PCI sensitive data is prohibited. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SpecialRequests | Element | 0..1 | Contains special requests for the RoomStay. |
SpecialRequest | Element | 1..n | The SpecialRequests related to the RoomStay. |
@RequestCode | String | 0..1 | This identifies a special request for this reservation and is typically hotel-specific. |
@CodeContext | String | 0..1 | Identifies the source authority for the RequestCode. |
Text | Element | 0..n | Textual information relating to the SpecialRequest. |
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Services | Element | 0..1 | This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays). |
Service | Element | 1..n | A Service object represents a non-room product provided to guests. Service products may have associated inventory and charges. |
@ServicePricingType | String | 0..1 | An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. |
@ServiceCategoryCode | String | 0..1 | The representation of the specific service category for the service being reserved. |
@ServiceInventoryCode | String | 0..1 | Identifier code for the service. Refer to Service and Extra 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. |
@ServiceRPH | Integer | 0..1 | Links the Service to a RoomStay or RatePlan. ServiceRPH absence indicates a HotelReservation-level charge. |
@Type | Integer | 0..1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). |
@ID | String | 0..1 | Reference ID for the extra/service provided by the source booking channel. |
@ID_Context | String | 0..1 | Used to identify the source of the identifier (e.g., IATA, ABTA). |
Price | Element | 0..99 | Container for pricing details of the service. |
Total | Element | 0..1 | The total amount charged for this rate including additional occupant amounts and fees.The total amount charged for the service including additional amounts and fees. |
@AmountAfterTax | Decimal | 0..1 | The total amount not including any associated tax. At least one of AmountAfterTax or AmountBeforeTax must be set. |
@AmountBeforeTax | Decimal | 0..1 | The total amount including any associated tax. At least one of AmountAfterTax or AmountBeforeTax must be set. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
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 | 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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount. |
Tax | Element | 0..99 | Contains specific tax information. |
@Code | 1 | Indicates the specific tax or fee that is being transferred. Refer to Fee Tax Type (FTT). | |
@Amount | Decimal | 0..1 | Tax amount applied. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Percentage rate of the applied tax. |
TaxDescription | Element | 0..5 | Text description of the taxes in a given language |
Text | Element | 1 | Text description of the tax. |
ServiceDetails | Element | 0..1 | Container for additional service details. |
GuestCounts | Element | 0..1 | A collection of Guest Counts associated to the whole Reservation or a particular Room Stay or Service. |
GuestCount | Element | 0..99 | A recurring element that identifies the number of guests and ages of the guests. |
@AgeQualifyingCode | Integer | 0..1 | A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). |
@Age | Integer | 0..1 | Defines the age of a guest. |
@Count | Integer | 0..1 | The number of guests in one AgeQualifyingCode or Count. Valid value between 1 and 9999. |
@AgeBucket | String | 0..1 | This defines the age range category or bucket into which a guest can be booked. It is typically used in conjunction with the age qualifying code to further define the applicable age range. |
TimeSpan | Element | 0..1 | Contains the time span for which the service is provided. |
@Start | Date | 0..1 | The starting value of the time span. |
@End | Date | 0..1 | The ending value of the time span. |
Comments | Element | 0..1 | A collection of Comment objects. Comments which apply to the Service. |
Comment | Element | 0..n | Comment details. |
@GuestViewable | Boolean | 0..1 | When true, the comment may be shown to the consumer. When false, it may not be. |
Text | Element | 0..n | Service detail comments |
ServiceDescription | Element | 0..1 | Description of the service |
Text | Element | 0..n | A text description of the service |
ServiceCategory | Element | 0..n | Hotel systems often group multiple services into a single category. This refers to the category specific to the hotel CRS/PMS. |
@ServiceCategoryCode | String | 1 | The representation of the specific service category for the service being reserved. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
BillingInstructionCode | Element | 0..n | Billing codes apply to a set of instructions for a set of transactions that are routed to a designated folio. |
@BillingCode | String | 1 | The individual billing code that applies to a set of instructions that are routed to a designated folio. |
@AccountNumber | String | 0..1 | Identifies the account number where the charges will be routed. |
@Start | Date | 0..1 | The starting value of the time span. |
@End | Date | 0..1 | The ending value of the time span. |
@AuthorizationCode | Integer | 0..1 | The authorization code associated with the billing code. |
@Description | String | 0..1 | A short description of the billing code or instructions. |
ResGuestRPH | Element | 0..1 | A reference to a guest ID object that may be defined in ResGuests/ResGuest |
@RPH | Integer | 0..1 | A unique reference to the guest ID. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
ResGuests | Element | 0..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. |
@AgeQualifyingCode | Integer | 0..1 | A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). Refer to OpenTravel Code List Age Qualifying Code (AQC). |
@ArrivalTime | Time | 0..1 | Arrival time of the guest. |
@PrimaryIndicator | Boolean | 0..1 | When true, indicates this is the primary guest. Only one ResGuest can be the primary guest. |
@Age | Integer | 0..1 | The age of the guest. |
Profiles | Element | 0..1 | Contains the guest profile information. |
ProfileInfo | Element | 1..n | Contains the profile information for the guest. |
UniqueID | Element | 0..9 | A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems. |
@ID | Integer | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
@Type | Integer | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). |
@ID_Context | String | 0..1 | Used to identify the source of the identifier. |
Profile | Element | 1 | Contains detailed customer profile information. |
@ProfileType | Integer | 1 | Must be set to 1 (Customer). |
@ShareAllOptOutInd | Boolean | 1 | Customer has 'opted out' of receiving marking information (Non EU). |
@ShareAllMarketInd | Boolean | 1 | Customer has 'opted in' to receive marking information (EU Customers). |
Customer | Element | 0..1 | Contains detailed guest information. |
@VIP_Indicator | Boolean | 0..1 | If true, indicates a very important person. |
@CustomerValue | String | 0..1 | The supplier's ranking of the customer (e.g., VIP, numerical ranking). |
@BirthDate | Date | 0..1 | The customer’s birthday information. |
PersonName | Element | 0..1 | Contains the name information for the guest. |
@Language | String | 0..1 | The language code for which the name data is represented. |
@NameType | Integer | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). |
NamePrefix | Element | 0..3 | Title of the guest. |
GivenName | Element | 0..5 | First name of the guest. |
MiddleName | Element | 0..3 | The middle name of the person name. |
Surname | Element | 1 | Last name of the guest. |
NameSuffix | Element | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) |
NameTitle | Element | 0..5 | Degree or honours (e.g., Ph.D., M.D.) |
Telephone | Element | 0..5 | Contains telephone information related to the guest. Max 5 per reservation. |
@PhoneLocationType | Integer | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). |
@PhoneTechType | Integer | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). |
@CountryAccessCode | Integer | 0..1 | Code assigned by telecommunications authorities for international country access identifier. |
@AreaCityCode | Integer | 0..1 | Code assigned for telephones in a specific region, city, or area. |
@PhoneNumber | Integer | 0..1 | Telephone number assigned to a single location. |
@Remark | String | 0..1 | A remark associated with the telephone number. |
@FormattedInd | Boolean | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
Email | Element | 0..5 | Contact email address. Max 5 per reservation. |
@EmailType | Integer | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). |
@DefaultInd | Boolean | 0..5 | When true, indicates a default value should be used. |
Address | Element | 0..5 | Address information of the guest. |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). |
AddressLine | Element | 0..5 | 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. |
@StateCode | String | 0..1 | The standard code or abbreviation for the state, province, or region. |
CompanyName | Element | 0..1 | Identifies a company. |
@Code | String | 0..1 | ISO 3166 code for a country. |
CountryName | Element | 0..1 | Country name (maximum 64 characters). |
@Code | String | 0..1 | ISO 3166 code for a country. |
CustLoyalty | Element | 0..25 | Loyalty program information for the customer. |
@ProgramID | String | 0..1 | The ProgramID attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent Traveller and Company ID. |
@MembershipID | Integer | 0..1 | The membershipID attribute will indicate the actual number. |
@LoyalLevel | String | 0..1 | Indicates special privileges in the program assigned to an individual. |
@LoyalLevelCode | Integer | 0..1 | Provides a numeric code assigned to a particular loyalty level. |
@SignupDate | Date | 0..1 | Indicates the starting date of the program. |
@EffectiveDate | Date | 0..1 | Indicates the expiration date of the program. |
@ExpireDate | Date | 0..1 | Indicates the customer’s sign-up date. |
@Remark | String | 0..1 | A remark associated with the customer's loyalty program. |
CompanyInfo | Element | 0..1 | Detailed information about a company. |
CompanyName | Element | 0..1 | Identifies a company by name. |
@Code | String | 0..1 | Identifies a company by the company code. |
AddressInfo | Element | 0..5 | |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). |
AddressLine | Element | 0..5 | These lines will contain free-form address details. |
CityName | Element | 0..1 | City (e.g., Dublin), town, or postal station. |
StateProv | Element | 0..1 | State, province, or region name. |
@StateCode | String | 0..1 | The standard code or abbreviation for the state, province, or region. |
PostalCode | String | 0..1 | Post Office Code number. |
CountryName | String | 0..1 | Country name (e.g., Ireland). |
@Code | Integer | 0..1 | ISO 3166 code for a country. |
TelephoneInfo | Element | 0..n | Information on a telephone number for the company. |
@PhoneLocationType | Integer | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). |
@PhoneTechType | Integer | 0..1 | Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). |
@CountryAccessCode | Integer | 0..1 | Code assigned by telecommunications authorities for international country access identifier. |
@AreaCityCode | Integer | 0..1 | Code assigned for telephones in a specific region, city, or area. |
@PhoneNumber | Integer | 1 | Telephone number assigned to a single location. |
@FormattedInd | Boolean | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
@Remark | String | 0..1 | A remark associated with the telephone number. |
Email | Element | 0..5 | Information on an email address for the company. |
@EmailType | Integer | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
ContactPerson | Element | 0..n | Information on a contact person for the company. Name of an individual and appropriate contact information. May be contact information for the customer or someone affiliated with the customer. |
PersonName | Element | 0..1 | |
@Language | String | 0..1 | The language code for which the name data is represented. |
@NameType | Integer | 0..1 | Former, Nickname, Alternate, etc. Please refer to OpenTravel Code List Name Type (NAM). |
NamePrefix | Element | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) |
GivenName | Element | 0.5 | Given name, first name or names. |
MiddleName | Element | 0..3 | The middle name of the person name. |
Surname | Element | 1 | Family or last name. |
NameSuffix | Element | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) |
NameTitle | Element | 0..5 | Degree or honours (e.g., Ph.D., M.D.) |
Telephone | Element | 0..5 | Information on a telephone number for the customer. Max 5 per reservation. |
@PhoneLocationType | Integer | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT). |
@PhoneTechType | Integer | 0..1 | Indicates the type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT). |
@CountryAccessCode | Integer | 0..1 | Code assigned by telecommunications authorities for international country access identifier. |
@AreaCityCode | Integer | 0..1 | Code assigned for telephones in a specific region, city, or area. |
@PhoneNumber | Integer | 1 | Telephone number assigned to a single location. |
@FormattedInd | Boolean | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
@Remark | String | 0..1 | A remark associated with the telephone number. |
Address | Element | 0..5 | Detailed information on an address for the contact person for the company. |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). |
AddressLine | String | 0..5 | These lines will contain free-form address details. |
CityName | String | 0..1 | City (e.g., Dublin), town, or postal station. |
StateProv | String | 0..1 | State, province, or region name. |
@StateCode | String | 0..1 | The standard code or abbreviation for the state, province, or region. |
PostalCode | Element | 0..1 | Post Office Code number. |
CountryName | Element | 0..1 | Country name (e.g., Ireland). |
@Code | Integer | 0..1 | ISO 3166 code for a country. |
Email | Element | 0..5 | Information on an email address for the contact person for the company. Max 5 per reservation. |
@EmailType | Integer | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
SpecialRequests | Element | 0..1 | |
SpecialRequest | Element | 1..n | The SpecialRequest object indicates special requests for a particular guest, service or reservation. |
@RequestCode | String | 0..1 | This identifies a special request for this reservation and is typically hotel-specific. |
@CodeContext | String | 0..1 | Identifies the source authority for the RequestCode. |
Text | Element | 0..1 | Provides more information about the request code or describes requests that are yet uncoded. |
Comments | Element | 0..1 | Comment section relating to the ResGuest. |
Comment | Element | 1 | Comment details. |
@GuestViewable | Boolean | 1 | This indicates that the comment can be seen by the guest and is necessary when two different types of comments are passed: one which is guest-viewable and one that isn’t. |
Text | Element | 1 | Textual description of Comments. |
ServiceRPHs | Element | 0..1 | |
ServiceRPH | Element | 1..n | This is a reference placeholder used as an index for a service to be associated with this guest. |
@RPH | Integer | 1 | Services ID |
ArrivalTransport | Element | 0..1 | Contains information about the arrival transportation for a guest |
TransportInfo | Element | 1..n | Indicates transportation information for a guest. |
@Type | String | 0..1 | Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other. |
@ID | String | 0..1 | Identifier of this transportation method (e.g., flight number). |
@Time | DateTime | 0..1 | Time of transportation. The local time of the location, indicated by the LocationCode. |
DepartureTransport | Element | 0..1 | Contains information about the departure transportation for a guest |
TransportInfo | Element | 1..n | Indicates transportation information for a guest. |
@Type | String | 0..1 | Method of conveyance of this guest. Values: Air, Rail, Bus, Boat, Private Auto, Other. |
@ID | String | 0..1 | Identifier of this transportation method (e.g., flight number). |
@Time | DateTime | 0..1 | Time of transportation. The local time of the location, indicated by the LocationCode. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
ResGlobalInfo | Element | 1 | Contains global information about the reservation. |
GuestCounts | Element | 0..1 | |
GuestCount | Element | 1..99 | A recurring element that identifies the number of guests and ages of the guests. |
@AgeQualifyingCode | Integer | 0..1 | A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class. Refer to OpenTravel Code List Age Qualifying Code (AQC). |
@Age | Integer | 0..1 | Defines the age of a guest. |
@Count | Integer | 0..1 | The number of guests in one AgeQualifyingCode or Count. Valid value between 1 and 9999. |
@AgeBucket | Integer | 0..1 | Defines the age range category or bucket a guest can be booked into. This is typically used in conjunction with the age qualifying code to further define the applicable age range. |
Timespan | Element | 1 | The Time Span which covers the Reservation |
@Start | Date | 1 | The ending value of the time span (Check in date) |
@End | Date | 1 | The starting value of the time span (Check out date) |
Memberships | Element | 0..1 | A collection of Membership objects. Memberships provides a list of reward progream which may be credited with points accrued from the guest's activity. |
Membership | Integer | 0..n | The Membership object identifes the frequent customer reward program. |
@ProgramCode | Integer | 0..1 | The code or name of the membership program ('Hertz', 'AAdvantage', etc.). |
@AccountID | Integer | 0..1 | The account identification number for this particular member in this particular program. |
Comments | String | 0..1 | A collection of Comment objects. Comments which apply to the Service. |
Comment | String | 0..n | Comment details. |
@GuestViewable | Boolean | 0..1 | When true, the comment may be shown to the consumer. When false, the comment may not be shown to the consumer. |
Text | String | 0..n | Reservation comments |
SpecialRequests | String | 0..1 | |
SpecialRequest | String | 1..n | The SpecialRequest object indicates special requests for a particular guest, service or reservation. |
@RequestCode | String | 1..n | This identifies a special request for this reservation and is typically hotel-specific. |
@CodeContext | String | 0..1 | Identifies the source authority for the RequestCode. |
Text | String | 0..n | Provides more information about the request code or provides description for requests that are yet uncoded. |
Guarantee | Element | 0..5 | The guarantee information to hold a reservation |
@GuaranteeCode | String | 0..1 | Guarantee Code |
@GuaranteeType | String | 0..1 | An enumerated type defining the guarantee to be applied to this reservation. Value: |
GuaranteesAccepted | Element | 0..1 | The guarantee information associated to the reservation. A maximum of 5 occurances are available for use depending on the context. |
GuaranteeAccepted | Element | 1..n | Guarantee Detail. |
@PaymentTransactionTypeCode | Enumeration | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
PaymentCard | Integer | 0..1 | Specific payment card information. Details of a debit or credit card. NOTE: PCI sensitive information is out of scope in Payment card. Please do not attempt to parse any 'out of scope' elements / data |
@CardCode | Integer | 0..1 | Issuer code. See OTA Payment Card Provider Codes |
@EffectiveDate | Date | 0..1 | Indicates the starting date. |
@ExpireDate | Date | 0..1 | Indicates the ending date. |
CardHolderName | String | 0..1 | |
CardNumber | Integer | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. |
@Mask | Integer | 0..1 | Masked data. |
@Token | Integer | 0..1 | Tokenized information. |
@TokenProviderID | String | 0..1 | Provider ID. |
Voucher | Element | 0..1 | Details of a paper or electronic document indicating prepayment. |
@SeriesCode | Integer | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
DirectBill | Element | 0..1 | Details of a direct billing arrangement. |
@DirectBill_ID | Integer | 0..1 | Identifier for the organization to be billed directly for travel services. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Guarantee | Element | 0..1 | Guarantee provided with the reservation. Used if no deposit is paid for the reservation. |
@GuaranteeCode | String | 0..1 | Guarantee Code |
@GuaranteeType | String | 0..1 | An enumerated type defining the guarantee to be applied to this reservation. Value: |
GuaranteesAccepted | Element | 0..1 | Contains the details of accepted guarantees. |
GuaranteeAccepted | Element | 1..n | Specific details of the accepted guarantee. |
@PaymentTransactionTypeCode | String | 0..1 |
|
PaymentCard | Element | 0..1 | Details of the payment card used for the guarantee. |
@CardType | String | 0..1 | Must be set to 1 (Credit Card). |
@CardCode | String | 0..1 | 2-character code of the credit card issuer. Refer to Payment Card Provider Codes. |
@EffectiveDate | String | 0..1 | Indicates the starting date (format MMyy). |
@ExpireDate | String | 0..1 | Expiry date of the credit card (format MMyy). |
CardHolderName | Element | 0..1 | Name of the cardholder. |
CardNumber | Integer | 0..1 | Secure information that supports PCI tokens, data masking and other encryption methods. |
@Mask | String | 0..1 | Masked data. |
@Token | Integer | 0..1 | Tokenized information. |
@TokenProviderID | String | 0..1 | Provider ID. |
Voucher | Element | 0..1 | Details of a paper or electronic document indicating prepayment. |
@SeriesCode | Integer | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
DirectBill | Element | 0..1 | Details of a direct billing arrangement. |
@DirectBill_ID | Integer | 0..1 | Identifier for the organization to be billed directly for travel services. |
| 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. |
AcceptedPayments | Element | 0..1 | Contains the accepted payment methods. |
AcceptedPayment | Element | 1 | Specific payment method accepted. |
@PaymentTransactionTypeCode | Enumeration | 0..1 | This is used to indicate either a charge, reserve (deposit) or refund. charge: This indicates that an actual payment has been made. refund: This indicates that the payment amount of this PaymentDetail element is for a refund. reserve: This indicates that a hold for the indicated amount has been placed on a credit card or that a cash amount has been taken from the customer to guarantee final payment. |
PaymentCard | Element | 1 | Details of the payment card used for the guarantee. |
@CardType | String | 0..1 | Must be set to 1 (Credit Card). |
@CardCode | String | 0..1 | 2-character code of the credit card issuer. Refer to Payment Card Provider Codes. |
@EffectiveDate | Date | 0..1 | Indicates the starting date. |
@ExpireDate | Date | 0..1 | Indicates the ending date. |
CardHolderName | Element | 0..1 | Name of the cardholder. |
@CardNumber | String | 0..1 | Actual credit card number. |
@Mask | Integer | 0..1 | Masked data. |
@Token | Integer | 0..1 | Tokenized information. |
@TokenProviderID | String | 0..1 | Provider ID. |
Voucher | Element | 0..1 | Details of a paper or electronic document indicating prepayment. |
@SeriesCode | Integer | 0..1 | Identification of a series of coupons or vouchers identified by serial number(s). |
DirectBill | Integer | 0..1 | Details of a direct billing arrangement. |
@DirectBill_ID | Integer | 0..1 | Identifier for the organization to be billed directly for travel services. |
@AmountPercent | Integer | 0..1 | Payment expressed as a fixed amount, or a percentage of/or room nights. If the the Total.amountAfterTax is provided, it will be a percentage of this value. If only the amountBeforeTax is provided it will be the percentage of this value. At least @Amount or @Percent will be populated. |
@Percent | Integer | 0..1 | The percentage used to calculate the amount. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount taken for the deposit. |
@NmbrOfNights | Integer | 1 | The number of nights of the hotel stay that are used to calculate the fee amount. |
Taxes | Element | 0..1 | A collection of taxes relating to the deposit. |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | |
Tax | Element | 0..99 | An individual tax. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
@Code | Integer | 0..1 | Code identifying the fee (e.g.,agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT). |
@Amount | Integer | 0..1 | A monetary amount of tax. |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
Deadline | Element | 1 | Payment deadline, absolute or relative. |
@AbsoluteDeadline | DateTime | 1 | Defines the absolute deadline. Either this or the offset attributes may be used. |
@OffsetTimeUnit | String | 0..1 | The units of time, e.g.: days, hours, etc., that apply to the deadline. |
@OffsetUnitMultiplier | Integer | 0..1 | The number of units of DeadlineTimeUnit. |
@OffsetDropTime | String | 0..1 | An enumerated type indicating when the deadline drop time goes into effect. |
Description | Element | 0..1 | Text description of the Payment in a given language. |
Text | Element | 0..1 | Textual information information relating to the payment. |
Address | Element | 0..1 | The address to which a deposit may be sent. |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT). |
AddressLine | Element | 0..5 | Address including any relevent street number. |
CityName | Element | 0..1 | City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). |
PostalCode | Element | 0..1 | Postal Code |
StateProv | Element | 0..1 | State, province, or region name or code needed to identify location. |
@StateCode | String | 0..1 | The standard code or abbreviation for the state, province, or region. |
CountryName | Element | 0..1 | The name or code of a country (as used in an address). |
@Code | Integer | 0..1 | ISO 3166 code for a country. |
@Type | Integer | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). |
@ID_Context | String | 0..1 | Used to identify the source of the identifier. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Total | Element | 1 | Total amount for the reservation. This includes all RoomStays and any additional fees or charges that apply. |
@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. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
@CurrencyCode | Integer | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount of tax. |
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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Percent | Integer | 0..1 | Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value). |
TaxDescription | Element | 0..5 | Text description of the taxes. |
Text | String | 0..n | Textual description of Discount Reason. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
HotelReservationIDs | Element | 0..1 | A collection of HotelReservationID objects for a given reservation. |
HotelReservationID | Element | 0..n | The HotelReservationID object contains various unique (reservation ID) and non unique (confirmation ID, cancellation ID) identifiers that the trading partners associate with a given reservation. |
@ResID_Type | Integer | 1 |
For more information about the different |
@ResID_Value | String | 1 | This is the actual value associated with ResID_Type |
@ResID_Source | String | 0..1 | A unique identifier to indicate the source system which generated the ResID_Value. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Profiles | Element | 0..1 | Contains the profile information. |
ProfileInfo | Element | 1..n | Contains the profiles. |
UniqueID | Element | 0..9 | A unique ID for a profile. This element can repeat to accommodate multiple unique IDs for a single profile across multiple systems. |
@Type | Integer | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT). |
@ID | Integer | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
@ID_Context | String | 0..1 | Used to identify the source of the identifier. |
Profile | Element | 1 | Provides detailed information regarding either a company or a customer profile. |
@ProfileType | Integer | 1 | Code to specify a profile such as Customer, Corporation, etc. Refer to OpenTravel Code List Profile Type (PRT). |
@ShareAllOptOutInd | Boolean | 0..1 | Customer has 'opted out' of receiving marking information (Non EU). |
@ShareAllMarketInd | Boolean | 0..1 | Customer has 'opted in' to receive marking information (EU Customers). |
Customer | Element | 1 | Detailed customer information for this profile. |
@VIP_Indicator | Boolean | 0..1 | If true, indicates a very important person. |
@CustomerValue | String | 0..1 | The supplier's ranking of the customer (e.g., VIP, numerical ranking). |
@BirthDate | DateTime | 0..1 | The customer’s birthday information. |
PersonName | Element | 0..1 | Detailed name information for the customer. |
@Language | String | 0..1 | The language code for which the name data is represented. |
@NameType | Integer | 0..1 | Former, Nickname, Alternate, etc. Refer to OpenTravel Codes List - Name Type (NAM). |
NamePrefix | Element | 0..3 | Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) |
GivenName | Element | 0..5 | Given name, first name or names. |
MiddleName | Element | 0..3 | The middle name of the person name. |
Surname | Element | 1 | Family or last name. |
NameSuffix | Element | 0..3 | Name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) |
NameTitle | Element | 0..5 | Degree or honours (e.g., Ph.D., M.D.) |
Telephone | Element | 0..5 | Information on a telephone number for the customer. Max 5 per reservation. |
@PhoneLocationType | Integer | 0..1 | Describes the location of the phone, such as Home, Office, Property Reservation Office, etc. Refer to OpenTravel Code List - Phone Location Type (PLT). |
@PhoneTechType | Integer | 0..1 | Indicates the type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List - Phone Technology Type (PTT). |
@PhoneNumber | String | 1 | Telephone number assigned to a single location. |
@CountryAccessCode | Integer | 0..1 | Code assigned by telecommunications authorities for international country access identifier. |
@AreaCityCode | Integer | 0..1 | Code assigned for telephones in a specific region, city, or area. |
@FormattedInd | Boolean | 0..1 | Specifies if the associated data is formatted or not. When true, then it is formatted; when false, then not formatted. |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
@Remark | String | 0..1 | A remark associated with the telephone number. |
Email | Element | 0..5 | Information on an email address for the customer. Max 5 per reservation. |
@EmailType | Integer | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List - Email Address Type (EAT). |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
Address | Element | 0..5 | Detailed information on an address for the customer. |
@Type | Integer | 0..1 | Defines the type of address (e.g. home, business, other). Refer to OpenTravel Code List - Communication Location Type (CLT). |
AddressLine | Element | 0..5 | These lines will contain free form address details. |
CityName | Element | 0..1 | City (e.g., Dublin), town, or postal station. |
StateProv | Element | 0..1 | State, province, or region name. |
@StateCode | String | 0..1 | The standard code or abbreviation for the state, province, or region. |
PostalCode | Element | 0..1 | Post Office Code number. |
CountryName | Element | 0..1 | Country name (e.g., Ireland). |
@Code | String | 0..1 | ISO 3166 code for a country. |
Email | Element | 0..5 | Information on an email address for the contact person for the company. |
@EmailType | Integer | 0..1 | Defines the purpose of the e-mail address (e.g. personal, business, listserve). Refer to OpenTravel Code List Email Address Type (EAT). |
@DefaultInd | Boolean | 0..1 | When true, indicates a default value should be used. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
TotalCommissions | Element | 0..1 | Contains details pertaining to commissions. |
UniqueID | Element | 0..1 | Identifies the recipient of the commission. |
@Type | Integer | 1 | A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. |
@ID | String | 1 | A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List - Unique ID Type (UIT). |
CommissionPayableAmount | Element | 0..1 | The amount of commission to be paid. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
@Amount | Decimal | 0..1 | A monetary amount. |
Comment | Element | 0..1 | Holds the actual comment. |
Text | Element | 1 | The content of the comment related to the commission. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
BasicPropertyInfo | Element | 1 | Property information for the reservation. |
@ChainCode | String | 0..1 | The code that identifies a hotel chain or management group. The hotel chain code is decided between vendors. |
@BrandCode | String | 0..1 | A code that identifies the brand or flag of a hotel, often used for independently owned or franchised properties that are known by a specific brand. |
@HotelCode | String | 1 | The code that uniquely identifies a single hotel property. The hotel code is decided between vendors. |
@HotelName | String | 0..1 | A text field used to communicate the proper name of the hotel. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelResNotifRS | Element | 1 | Root element for the response. |
@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. Will be set to 1.0. |
@ResResponseType | String | 0..1 | Given that the
|
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
@RecordID | Integer | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation failed, the UniqueID of the rejected reservation should be reported here. |
Success | Element | 0..1 | Annotation that the reservation batch was received successfully. Mandatory if no Errors were sent. It can be combined with Warnings messages if some of the reservations in the batch had issues. |
Warnings | Element | 0..1 | Only can be used in conjunction with a Success message. |
Warning | Element | 0..99 | Contains details of the warning returned. |
@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). |
@RecordID | Integer | 0..1 | If the receiving system is able to identify within a batch of reservations which reservation has a warning, the UniqueID of that reservation should be reported here. |
HotelReservations | Element | 1 | Contains details of the reservation made. |
HotelReservation | Element | 1 | Individual hotel reservation information. |
@ResStatus | String | 0..1 | Indicates the current status of the reservation. Valid values are dependent on the roles:
|
UniqueID | Element | 1..2 | Unique identifier for the reservation. |
@Type | String | 1 | 14 - Reservation ID34 - SM Platform Res ID |
@ID | String | 1 | Actual confirmation number. |
Maximum Content XML
{% code overflow="wrap" %} ```xmlMinimum Recommended Content XML
{% code overflow="wrap" %} ```xml| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SM_HotelResPaymentReadRQ | 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. |
SelectionCriteria | Element | 1 | |
@HotelCode | String | 0..1 | Hotel code as recognised by SiteMinder. |
@SelectionType | String | 1 | Must be Undelivered |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SM_HotelResPaymentReadRS | 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 response was generated. TimeStamp must use ISO 8601 format. |
@Version | Decimal | 1 | Specifies the API version. Must be set to 1.0 |
HotelResPaymentList | Element | 1 | List of HotelResPayments. |
HotelResPayment | Element | 0..n | HotelResPayment data |
@HotelCode | String | 1 | Hotel code as recognised by SiteMinder. |
@TransactionID | String | 1 | Transaction Identifier. |
@CreateDateTime | DateTime | 1 | Transaction Create timestamp.CreateDateTime must follow the ISO 8601 Date and Time format. |
UniqueID | Element | 2 | |
@ID | String | 1 | Reservation Identifier. |
@Type | Integer | 1 |
|
PaymentInfo | Element | 1 | |
@PaymentTransactionTypeCode | Enumeration | 1 |
|
@PaymentType | Integer | 1 | Identifies the payment type:
|
@Remark | String | 0..1 | Card Based: Open Notes/Remarks. Non-Card Based: Will include the payment provider used. |
@PaymentRef | String | 0..1 | Payment reference (e.g. Paypal reference). |
@ChargeTypeCode | Enumeration | 1 | RM = Room FD = Food/Beverage OT = Other EX = Stay Extras |
PaymentCard | Element | 0..1 | Card Based Payment. |
@CardCode | String | 1 | 2-character code of the credit card issuer. Refer to Payment Card Provider Codes. |
@CardType | String | 1 | OTA Card Type1 - Credit2 - Debit |
@ExpireDate | String | 1 | Expiry date of the credit card (format MMyy). |
@Mask | String | 1 | Masked CC number. |
@CardHolderName | String | 1 | Name of card holder. |
PaymentAmount | Element | 1 | Payment Amount container. |
@Amount | Decimal | 1 | Transaction amount. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
@Due | Decimal | 0..1 | Amount outstanding. |
Errors | Element | 0..1 | Present if unsuccessfully processed. |
Error | Element | 1 | Mandatory if Error present. Text must contain a human readable description of the error. |
@Code | String | 1 | Any code from Error Codes (ERR) |
@Type | String | 1 | Any type from Error Warning Types (EWT) |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SM_HotelResPaymentResultRQ | 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. |
HotelResPaymentResult | Element | 0..n | |
@HotelCode | String | 1 | Hotel code as recognised by SiteMinder. |
@TransactionID | 1 | Transaction Identifier. | |
UniqueID | Element | 2..3 | |
@ID | String | 1 | Identifier. |
@Type | String | 1 |
|
Success | Element | 0..1 | Present if successfully stored and processed |
Errors | Element | 0..1 | Present if unsuccessfully processed. |
Error | Element | 1 | Mandatory if Error present. Text must contain a human readable description of the error. |
@Code | String | 1 | Any code from Error Codes (ERR) |
@Type | String | 1 | Any type from Error Warning Types (EWT) |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SM_HotelResPaymentResultRS | Element | 1 | Root element for the request. |
@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 | Decimal | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Present if successfully stored and processed |
Errors | Element | 0..1 | Present If unsuccessfully processed |
Error | Element | 1 | Mandatory if Error present. Text can contain a human readable description of the error |
@Code | String | 1 | Any code from Error Codes (ERR) |
@Type | String | 1 | Any type from Error Warning Types (EWT) |
How often should I pull payment transactions?
Pull undelivered transactions every 2-5 minutes. * Minimum frequency: Every 2 minutes (not faster) * Maximum frequency: Every 5 minutes (not slower) This ensures timely payment processing without overloading the system.Can I query for transactions for all properties at the same time?
Yes, if using PMS-level authentication. Omit the `HotelCode` parameter in `SM_HotelResPaymentReadRQ` to retrieve all undelivered transactions across all properties associated with your PMS code. For hotel-level authentication, you must query each property separately by including the `HotelCode`.Can I query for transactions for a specific reservation?
No. You can only pull all undelivered transactions per PMS (all hotels) or per hotel. Use `SM_HotelResPaymentReadRQ` with `SelectionType="Undelivered"` to retrieve all pending transactions, then filter by reservation ID (Type="14" or Type="34") in your PMS.Where does the value in UniqueID Type="40" come from?
The PMS creates this value when confirming successful payment processing.
Type="40" (Delivery Confirmation ID) only appears in the `SM_HotelResPaymentResultRQ` message after your PMS successfully stores and processes a payment transaction.
What happens when I don't acknowledge a transaction?
You have 4 attempts to pull and acknowledge a transaction. After the 4th attempt, SiteMinder marks the delivery as failed. Your PMS should be able to pull and process multiple pending transactions in each `SM_HotelResPaymentReadRQ` request.Do I need to acknowledge successful AND failed transactions?
Yes. Send separate acknowledgments for successful and failed transactions. * **Success**: Send `SM_HotelResPaymentResultRQ` with `What happens to transactions when a reservation is cancelled?
You may receive additional transactions after cancellation. Properties can create charges (for cancellation fees) or refunds (for deposit returns) via SiteMinder Pay even after a reservation is cancelled. Your PMS should continue pulling and processing all pending transactions regardless of reservation status.Would refunds always cover the entire amount, or are partial refunds possible?
Partial refunds are possible. Properties can enter any refund amount through SiteMinder Pay, so your PMS should handle both full and partial refund transactions.How long does pmsXchange integration take?
Approximately 60 days from initiation to production. This includes development, testing, certification and pilot phases. For more details review our [Integration Process](broken://pages/RAgwk1sEthWhrn360fiq) guide.What are the mandatory components to certify in pmsXchange?
**Required:** * Rooms and Rates * Availability * Reservations (PUSH or PULL) **Recommended:** * Restrictions and Rates (PDP or OBP) * Modifications and Cancellations **Optional:** * Reservation Upload, Reservation Import, Payment Transaction RecordWhat is the difference between Reservations PUSH, PULL, Upload and Import?
**PUSH (recommended)**: SiteMinder sends reservations to your PMS endpoint in real-time as bookings occur. **PULL**: Your PMS polls SiteMinder every 2-5 minutes to retrieve new reservations. **Upload**: Your PMS sends reservations (walk-ins, direct bookings, CRS) to SiteMinder. **Import**: One-time bulk retrieval of all active reservations during initial PMS setup. You must certify either PUSH or PULL. Upload and Import are optional add-ons.What is the difference between PMS-level and hotel-level authentication?
**PMS-level**: Single credentials for all properties * Required for REST endpoints (Rooms and Rates) * Recommended for all integrations * Use HotelCode to identify each property **Hotel-level**: Individual credentials per property * Only available for SOAP/XML messages * Legacy approach maintained for backward compatibilityWhat is the difference between HotelCode and Username?
**HotelCode**: Identifies the specific property in each request **Username**: Authentication credential used in both SOAP (Security Header) and REST (Basic Auth) For PMS-level authentication, use the same Username across all properties, with HotelCode identifying each property.What is a delta update?
Send only the data that changed since your last update. Delta updates are required in production for all ARI components (Availability, Restrictions, Rates). Only include changed values for specific dates and room/rate combinations - never resend unchanged data. Full flushes are only permitted during initial setup or when requested by SiteMinder support.What is the difference between InvTypeCode and RoomTypeCode?
Both identify the same room type, just used in different message types: * **InvTypeCode**: Used in inventory updates (availability, restrictions, rates) * **RoomTypeCode**: Used in reservation messages Use the `roomTypeCode` from the `room-rates` endpoint for both.Does pmsXchange support release period?
No, there is no native release-period field, so a PMS wanting the same functional outcome must send Stop Sell for the release-window dates instead of a dedicated release-period value.What is HTTP Error 405?
This error occurs when sending regular HTTP requests (e.g., from a browser) to a SOAP endpoint. Test connectivity using `OTA_PingRQ` instead of browser requests to verify the service is up and running.What is TLS Error: Authentication failed because the remote party has closed the transport stream?
Your system is using an outdated TLS protocol. Ensure you're using TLS 1.2 or higher. TLS 1.0, TLS 1.1, and all SSL versions are no longer supported due to PCI compliance requirements.If I receive an Error back from pmsXchange, will any valid parts of my message be processed?
No. All messages are atomic - either the entire message succeeds or the entire message fails. If you receive an Error response, none of the data in that message was processed. Fix the error and resend the complete message.Why can't I see my ARI changes reflected on SiteMinder Platform even though I receive a successful response?
Success confirms valid XML and authentication, not that your codes are mapped. **Common cause:** `InvTypeCode` or `RatePlanCode` not mapped in SiteMinder Platform (Distribution > Connectivities > {PMS Name} > Rooms and Rates Mapping). Verify mapped codes using the `room-rates` endpoint.Can SiteMinder sync availability, restrictions, or rates back to my PMS?
Not currently. pmsXchange uses a PUSH model where your PMS sends all ARI data to SiteMinder. **Coming soon:** Restrictions and rates will support bidirectional sync, allowing SiteMinder to push changes back to your PMS. Availability will remain PMS-managed only.| Code | Booking Agent / Channel | Network |
|---|---|---|
| ABB | Airbnb | SM |
| ABG | Abbey Group | SM |
| ABR | Abreu Online | SM |
| ACO | Acomodeo | SM |
| ACT | Action Travel Corp | SM |
| ADR | Adrez Booking Engine | SM |
| AGO | Agoda | SM |
| AGY | Argenway | SM |
| AIA | AirAsia | SM |
| ALA | ALARIC | SM |
| ALB | ALBIE | SM |
| ABT | Albatravel | SM |
| AGS | A Good Stay | SM |
| ALE | AllTours - FIT Res Download (by Eturistic) | SM |
| ALI | Alidays SpA | SM |
| ALL | Allocate | SM |
| ANA | Andalucia Autentica | SM |
| ANX | Anex Tour Spain | SM |
| ANZ | ANZCRO | SM |
| AOS | Asian Overland Services | SM |
| AOT | AOT Group | SM |
| APL | Atrapalo | SM |
| ARM | AurumTours | SM |
| ARO | AróSuite | SM |
| AST | Asian Trails | SM |
| ATE | ATEL Hotels | SM |
| ATG | AIC Travel Group | SM |
| ATI | ATI Hotel Web Service | SM |
| ATP | AlliedTPro | SM |
| ATR | Altura Destination Services | SM |
| ATT | ABC Travel Taipei | SM |
| AUR | Aura.Travel | SM |
| AVT | AltoVita | SM |
| AVV | Avvio.com | SM |
| AYO | AsiaYo | SM |
| BAB | Bed-and-Breakfast.it | SM |
| BAH | British Airways Holidays | SM |
| BAS | Basiyo Services Pvt. Ltd | PMS |
| BBN | Direct Booking | SM |
| BBP | BookingButton Plus | SM |
| BBS | BookingButton Sapphire Coast | SM |
| BCC | Bookerclub.com | SM |
| BDC | Booking.com | SM |
| BEH | Beth | SM |
| BHA | Bing Hotel Ads | SM |
| BIC | NextTrip | SM |
| BKC | BookingCore | SM |
| BKE | Bookeasy/Bookit | SM |
| BKL | Bookolo | SM |
| BKN | Bakuun / RateDock | SM |
| BKS | Bookassist | SM |
| BLC | BookLogic | PMS |
| BNB | BnBerry | SM |
| BNO | Bonotel | SM |
| BOK | BookVisit | Citybreak | Nozio | SM |
| BON | Bookonlinenow | SM |
| BRC | Busy Rooms CRS | SM |
| BTH | Booking2Hotels | SM |
| BWE | Bedswithease | SM |
| BWS | Best Western CRSConnect | SM |
| BWZ | BookingWhizz | SM |
| CAE | hotline hotel software booking system | SM |
| CAM | Vacanceselect Travel | SM |
| CCA | BookingPal | SM |
| CCK | CHECK24 | SM |
| CCT | BookingButton Cradle Coast Tourism | SM |
| CDR | centraldereservas.com | SM |
| CDV | Club de Vacaciones | SM |
| CFT | Colatour Travel | SM |
| CHC | Acomos Staybooked | SM |
| CHM | Charming Italy | SM |
| CHO | CHOICE CRSConnect | SM |
| CHP | Channels Plus | SM |
| CIS | Cisalpina Tours | SM |
| CLB | Cloudbeds | PMS |
| CLD | GuestPro | SM |
| CLO | Ctoutvert | SM |
| CLT | CultBooking | SM |
| CNC | CONNECTYCS (The Finlei & Connectycs Company) | SM |
| CNT | CNTravel | SM |
| CRC | Corporate Rates Club | SM |
| CSV | Clearing Station (Vioma) | SM |
| CTG | CNBooking.net | SM |
| CTH | CTM Sleep Space | SM |
| CTM | BookMe Maldives | SM |
| CTP | Trip.com (Old) | SM |
| CUR | Curacity | SM |
| CZB | Cityzenbooking | SM |
| DAD | Daydreams | SM |
| DAT | 1way2italy | SM |
| DBH | DayBreakHotels | SM |
| DBL | Dubai Link | SM |
| DDC | Despegar.com | SM |
| DED | D-EDGE (New) | SM |
| DER | DER Touristik | SM |
| DGB | Digibreaks | SM |
| DIC | Discover Australia Contract | SM |
| DID | DidaTravel | SM |
| DIP | Discover Australia Package | SM |
| DIS | Discover Australia | SM |
| DIT | Destination Italia | SM |
| DJO | Djoca Travel | SM |
| DMC | Top Atlantico DMC | SM |
| DOW | WebBeds - Destinations of the World | SM |
| DRM | Dorms.com | SM |
| DRS | DIRS21 | SM |
| DTE | DERTUR DTServices - FIT Res Download (Eturistic) | SM |
| DTS | Dieux Travel Services | SM |
| EBW | Easybooking by Webconnection | SM |
| ECH | EcoHotels.com | SM |
| ECL | EC Travel | SM |
| ECT | followme2AFRICA | SM |
| EDH | ED for hotels | SM |
| EDR | ODIGEO Connect | SM |
| EET | Egypt Express Travel | SM |
| EEX | Europe Express | SM |
| EHX | eHotelXml | SM |
| EJT | Easyjet Holidays | SM |
| EJE | Easyjet Holidays - FIT Res Download (by Eturistic) | SM |
| ELV | Elevate DMC | SM |
| EMA | BookingEye | SM |
| EMT | EaseMyTrip | SM |
| ESA | Estonian Spa Association | SM |
| ESB | AlphaRed GHS | SM |
| ESC | Escalabeds | SM |
| ESQ | Esquiades | SM |
| EST | Estiber | SM |
| ETL | EasyTravel | SM |
| ETO | eTourism | SM |
| ETT | Eurotours International | SM |
| ETV | EasyTravel(D2C) | SM |
| EUP | Europlayas | SM |
| EVO | evoSuite | SM |
| EXP | Expedia | SM |
| EZL | EZLINK HOTELS | SM |
| EZT | ezTravel | SM |
| FAS | FastPayHotels | SM |
| FBK | D-EDGE (Old) | SM |
| FCH | fincahotels.com | SM |
| FEL | Feelingo | SM |
| FER | feratel Deskline | SM |
| FGG | Fliggy (New) | SM |
| FHO | Fusion Holidays | SM |
| FIN | Finnair | SM |
| FLG | Fliggy (Old) | SM |
| FTR | Flow | SM |
| GBB | Goibibo & MakeMyTrip | SM |
| GBR | grabrooms | SM |
| GCC | GuestCentric Systems | SM |
| GCR | GuestCentric Rewards | SM |
| GCS | GuestCentric Channels | SM |
| GEN | SiteMinder GDS | SM |
| GFT | Go4Travel | SM |
| GHF | Google Hotel Ads (CPC) | SM |
| GIC | Guest Incoming | SM |
| GIM | BookingenGIMH | SM |
| GLA | Glamping Hub | SM |
| GLN | Guestline | PMS |
| GMH | GIMH | SM |
| GNA | GNA Hotel Solutions | SM |
| GOA | Go2Africa | SM |
| GOB | Gobooking | SM |
| GOT | Grupo Opentours | SM |
| GPO | GuestPro Revenue Booster | SM |
| GRN | GreenBooking.Engine | SM |
| GRP | Groupon Getaways | SM |
| GRT | Grosvenor Tours | SM |
| GSR | GuestBook - Boutique Hospitality Booking System | SM |
| GTT | G2 Travel | SM |
| HAB | SilverDoor | SM |
| HAF | HafH | SM |
| HAN | HanaTour | SM |
| HAW | HousingAnywhere | SM |
| HBD | Hotelbeds | SM |
| HCM | Hotelchamp | PMS |
| HDT | Hotel Direct | SM |
| HEI | HEIDI (SKIZOOM) | SM |
| HEX | HotelExchange | SM |
| HFT | House of Travel | SM |
| HGO | hutchgo.com Partner Portal | SM |
| HIK | Hikari Global | SM |
| HIS | Hotelsinone | SM |
| HJZ | Hoojoozat | SM |
| HKC | Hong Kong Convergent | SM |
| HKT | HongKong Tuyi | SM |
| HKU | HOOKUSBOOKUS.COM | SM |
| HLB | HalalBooking | SM |
| HLP | HPro Travel / GoGlobal | SM |
| HLS | Hoteliers.com | SM |
| HNS | HotelNetSolutions | SM |
| HNT | Hotelnet | SM |
| HOM | Homair Vacances | SM |
| HOP | Hopper | SM |
| HOS | HotelSpecials | SM |
| HPA | Hotelpass | SM |
| HPG | HyperGuest | SM |
| HPN | HotelPlanner | SM |
| HPO | HotelPro IBE | SM |
| HRS | HRS - Hotel Reservation Service | SM |
| HRT | Hero Travel | SM |
| HSC | HostelsClub | SM |
| HSP | HotelshopUK | SM |
| HSW | HotelSwaps | SM |
| HTA | Hotel Trader | SM |
| HTI | Holiday Travel Group | SM |
| HTN | HotelTonight | SM |
| HTP | Hoterip | SM |
| HTT | Hotetec | SM |
| HUA | Hua Min Tourism Reservation | SM |
| HUR | HURB (Hotel Urbano) | SM |
| HUS | Keytel GDS | SM |
| HWG | HostelWorld Group (NEW) | SM |
| HWL | Hostelworld Group (OLD) | SM |
| HWR | Hotwire | SM |
| HYM | HotelPartner YM | SM |
| IBK | GHS iBooking | SM |
| ICI | iCastelli.net | SM |
| IDO | Idiso | SM |
| IES | i-escape | SM |
| IHW | iHotelier | SM |
| IMP | ImperaTours | SM |
| INF | Infinite Hotel | SM |
| INS | Instant Bookings | SM |
| INZ | Open Travel | SM |
| IOS | In1 Solutions | SM |
| IPB | iperbooking | SM |
| IPK | NOL Interpark | SM |
| IRU | Event Direct Booking by Ireckonu | SM |
| ITL | AzoresGetaways.com | SM |
| ITP | Inntopia | SM |
| IVU | IVIVU.com | SM |
| IXP | IXPIRA | SM |
| JLT | JL-Tour | SM |
| JMB | Jumbonline | SM |
| JTB | JTB Hawaii | SM |
| JTG | JTB Group | SM |
| JTH | Jet2holidays | SM |
| JTP | Jet2holidays Packages | SM |
| JYH | Journey Hospitality | SM |
| KAK | Kake Travel | SM |
| KAR | Karpaten Turism | SM |
| KEY | Keytel - Phoenix | SM |
| KHS | Klook | SM |
| KHT | Kaluah Tours | SM |
| KKD | KKday | SM |
| KMW | kurz-mal-weg.de | SM |
| KNB | KliknBook | SM |
| KOE | Digitrips HDA | SM |
| KRZ | Kurzurlaub | SM |
| KTL | Keytel | SM |
| LDO | HRS Australasia | SM |
| LEA | LEAN | SM |
| LKK | LekkeSlaap | SM |
| LMT | LimaTours | SM |
| LNT | Lion Travel Hotel System | SM |
| LOV | LoveHolidays | SM |
| LTE | Travel Essence / Little Travel Europe | SM |
| LTM | Latam Travel | SM |
| LTS | YouXia | SM |
| LXE | Luxury Escapes | SM |
| LXR | LuxuryRes | SM |
| LYC | Ly.com | SM |
| MAB | Mandira Abadi | SM |
| MAL | Mister Aladin | SM |
| MAN | ManleyTravel | SM |
| MAX | OpenGDS | SM |
| MCP | Mitchell Corp Ezibed.com | SM |
| MCW | Mitchell Corp Wholesale | SM |
| MEW | Mews Booking Engine | PMS |
| MDR | Macdonald Resorts | SM |
| MGA | Magic Arabia | SM |
| MGK | MG bedbank | SM |
| MHB | MyHotelBreak.com (Classic Britain) | SM |
| MMS | Mr and Mrs Smith | SM |
| MOM | Momorooms by Lastminute | SM |
| MRI | Mirai | SM |
| MRP | MiraiPro(Agencies) | SM |
| MRS | MyERes.com | SM |
| MRT | Myrealtrip | SM |
| MTC | MTC Group SA | SM |
| MTG | Mustgo | SM |
| MTL | MIKI Travel | SM |
| MTN | Meituan | SM |
| MTS | MTS - FIT Res Download (by Eturistic) | SM |
| MYT | MyTour HMS | SM |
| MYX | Xcaliber | SM |
| NAB | Net Affinity V2 | SM |
| NAM | NamuTravel | SM |
| NAY | NetAffinity | SM |
| NBI | NB Incoming Services | SM |
| NBK | Neobookings | SM |
| NFT | Fine Tours Group | SM |
| NMO | Nomolesten.com | SM |
| NRL | Rezlive.com (NEW) | SM |
| NST | Blueground | SM |
| NTN | World 2 Meet | SM |
| NUT | Nuitee (Direct) | SM |
| NWT | New World Travel | SM |
| NXS | Nexus Tours | SM |
| OBE | ObeHotel | SM |
| ODE | Odeon Tours | SM |
| ODI | Odisseias | SM |
| ODX | ETStur | SM |
| OFH | Orchestra4Hotels | SM |
| OHR | 1HotelRez | SM |
| OLV | Olympia Europe | SM |
| OMH | OhMyHotel | SM |
| OMI | Omni Hotelier | SM |
| OMN | Omnimentum | SM |
| ONB | OnetBooking | SM |
| OND | ONDA | SM |
| ONT | On Travel Solutions | SM |
| OPL | Off Peak Luxury | SM |
| OPN | ONE | SM |
| OPR | OpenROOM | SM |
| OTB | On the Beach Beds Limited | SM |
| OTS | Open Travel Service | SM |
| OTZ | otelz.com | SM |
| OUT | One-Up Travel | SM |
| OVK | Emerging Travel Inc | SM |
| OWD | Our World | SM |
| OZA | Ozaccom+ | SM |
| OZC | OzAccom+ (NEW) | SM |
| PBB | Pacific BedBank | SM |
| PDV | Panamericana de Viajes DMC | SM |
| PKF | PKFare | SM |
| PLY | Play In One | SM |
| PMB | Pays du Mont Blanc | SM |
| PMR | Portimar | SM |
| POW | powernapp.com | SM |
| PPN | Pan Pacific Travel | SM |
| PRC | PriceTravel (New) | SM |
| PRF | Profitroom | SM |
| PRL | Perlatours | SM |
| PRT | Tidesquare | SM |
| PTB | Prime Travel / Bedsopia | SM |
| PTC | P.T.C Express Travel | SM |
| PTH | Paraty Hotels | SM |
| PTK | Pegas Touristik | SM |
| PTL | PriceTravel (Old) | SM |
| PTR | Profit Travel B2B | SM |
| PUP | Pitchup.com | SM |
| QBD | Flight Centre Travel Group | SM |
| QHH | Qantas/Jetstar Hotels & Holidays | SM |
| QRS | Quantum Reservations | SM |
| QYJ | Qiyouji | SM |
| RAC | RACV Travel and Experiences | SM |
| RAK | Rakuten - Non-Domestic (Old) | SM |
| RAT | Openhotelier | SM |
| RBS | Roibos | SM |
| RBT | Roombeast | SM |
| RCI | RCI | SM |
| RCL | Reconline AG | SM |
| REH | Rehlat | SM |
| REV | Revenatium | SM |
| RFA | Roamfree | SM |
| RGL | Regal | SM |
| RKT | Rakuten Travel Xchange | SM |
| RLB | Railbookers Group | SM |
| RLG | ResLogic | SM |
| RLT | Resort Life Travel | SM |
| RMC | RMS Cloud | PMS |
| RMS | RoomStay | SM |
| RMT | RateMatch | SM |
| ROI | Roiback | SM |
| ROM | Roomex | SM |
| ROS | RocketStay | SM |
| RPR | Riparide | SM |
| RRN | RoomRaccoon | PMS |
| RRZ | Ripe | SM |
| RSD | Tripster | SM |
| RTL | Beds4Travel | SM |
| RTS | Kognitiv | SM |
| RTX | Rakuten - Non-Domestic (NEW) | SM |
| RVC | RevChill | SM |
| RVG | Cendyn RVNG CRS | SM |
| RVH | Reserv by Tambourine | SM |
| RVP | GuestLeader | SM |
| RWD | Rewards Corp | SM |
| RYD | Goelett | SM |
| SAH | South African Hotels | SM |
| SAN | Travelstart | SM |
| SBB | Spa Breaks | SM |
| SBX | Smartbox Group | SM |
| SDB | SpeedyBooker.com | SM |
| SDT | SideTours - FIT Res Download (by Eturistic) | SM |
| SEM | Sembo | SM |
| SEN | Sentinel | SM |
| SER | Serhs Tourism | SM |
| SES | Secret Escapes | SM |
| SHE | Shenzhen Chunqiu Travel Agency | SM |
| SHJ | Shiji - WeChat | SM |
| SHR | Stash Hotel Rewards | SM |
| SIT | Sidetours | SM |
| SMA | SmartHOTEL BV | SM |
| SMP | Simple Booking | SM |
| SMR | Spar mit! Reisen | SM |
| SNH | SilverNeedle IBE | SM |
| SOL | Solferias | SM |
| SPA | Springbok Atlas | SM |
| SQR | Thesqua.re | SM |
| SRA | Almosafer | SM |
| SRV | Sirvoy | PMS |
| SST | Sun Series Travel | SM |
| STC | STC Hoteldata | SM |
| STR | Soliterra DMC | SM |
| STU | SITU | SM |
| STY | Staycation | SM |
| SUN | WebBeds - Sunhotels | SM |
| SWB | Sunweb Group | SM |
| SYN | Synergy | SM |
| SYX | SynXis | SM |
| SZA | Szallasvadasz | SM |
| SZS | Szallas.hu | Noclegi.pl | SM |
| TAD | TripADeal | SM |
| TAM | TeamAmerica | SM |
| TAN | TA Network | SM |
| TAV | Travia Marketplace | SM |
| TBH | Tablet Hotels | SM |
| TBL | TravelBullz | SM |
| TBO | TBOHolidays | SM |
| TDM | Tourvest Destination Management | SM |
| TDN | Time Design | SM |
| TDS | TDS (Travel Destination Solutions) | SM |
| TDT | TourDiez Travel | SM |
| TDZ | Tour10 | SM |
| TEA | Tourism eXchange Australia | SM |
| TEI | Tourism eXchange Saudi | SM |
| TEM | TUI Dynamic - European Markets | SM |
| TES | Tourism eXchange USA | SM |
| TEU | Tourism eXchange Great Britain | SM |
| TFA | Travel Funders Network (New) | SM |
| TFN | Travel Funders Network (Old) | SM |
| THA | Thompsons Africa | SM |
| THO | The Hotel Network | SM |
| THR | ThinkReservations | PMS |
| TIB | Tripadvisor Plus / Instant Booking | SM |
| TIP | Trip.com(New) | SM |
| TKH | Booking Direct | SM |
| TKT | Tiket.com | SM |
| TLB | Tailorbeds | SM |
| TLE | Tumlare | SM |
| TLS | Travalco USA Inc. | SM |
| TMD | Tourmind | SM |
| TMK | tripmakery | SM |
| TMP | Travel Compositor | SM |
| TMS | Holidu Smart Destination | SM |
| TNA | TourMappers North America | SM |
| TOA | CVC Brasil Operadora | SM |
| TOH | Thompsons Holidays | SM |
| TOP | Toptown Shanghai | SM |
| TPL | Tourplan | SM |
| TRA | Tripadvisor Cost-Per-Click | SM |
| TRC | Wink | SM |
| TRG | Lastminute.com (Old) | SM |
| LMS | Lastminute.com (New) | SM |
| TRI | ITRIP LLC | SM |
| TRK | Traveloka | SM |
| TRL | Travelanium | SM |
| TRP | dnata | SM |
| TSE | Travel Security | SM |
| TSY | TravelStaytion | SM |
| TTM | Taiwan Travel Map | SM |
| TTP | Cendyn CRS | SM |
| TTV | Trav Travel | SM |
| TUD | TUI-DE - FIT Res Download (by Eturistic) | SM |
| TUI | TUI Future Markets | SM |
| TUK | Travelodge UK | SM |
| TUU | TUI-UK - FIT Res Download (by Eturistic) | SM |
| TVC | Travco | SM |
| TVO | Trivago | SM |
| TVS | TravelStay Network Services | SM |
| TVT | Traveltino | SM |
| VAC | Vacatia | SM |
| VAT | Viajes Aramon | SM |
| VCS | VacayHome Connect | SM |
| VCT | VeryChic Tonight | SM |
| VCV | CanariasViaja.com | SM |
| VDE | verwoehnwochenende.de | SM |
| VEC | Viajes El Corte Ingles | SM |
| VEG | Vegas.com | SM |
| VEL | Velero Incoming | SM |
| VET | Veturis Travel | SM |
| VIA | Interrias-TG | SM |
| VIF | Villa Finder | SM |
| VOL | Viajes Olympia | SM |
| VOO | Voordeeluitjes | SM |
| VNG | Ving - FIT Res Download (by Eturistic) | SM |
| VRB | Vrbo | PMS |
| VRC | VeryChic | SM |
| VSB | VHSHUB - WeChat Booking Engine | SM |
| WAT | WHL Alba travel | SM |
| WBR | Webrooms | SM |
| WDC | Wide Discovery | SM |
| WDS | Windsurfer CRS | SM |
| WEB | WebsiteTravel | SM |
| WKD | Weekendesk | SM |
| WLL | WellBeds | SM |
| WLV | Weave Living | PMS |
| WMT | Worldmeetings.com | SM |
| WOW | Wowcher | SM |
| WOZ | Wozozo | SM |
| WTB | Witbooking | SM |
| WTE | Withinearth.com | SM |
| WTX | IOL-X | SM |
| WWW | Wilderness Window | SM |
| XDO | SSbooking | SM |
| XML | XML World | SM |
| XNI | Xenia International | SM |
| XYT | XY travel | SM |
| YGT | Your Golf Travel | SM |
| YHG | Yonda Holiday Group | SM |
| YNZ | YHA New Zealand | SM |
| ZAV | Zavia BE | SM |
| ZOO | Travelzoo | SM |
| ZOW | Zoweg | SM |
| Code | Type |
|---|---|
| 1 | Visa |
| 2 | Passport |
| 3 | Military identification |
| 4 | Drivers license |
| 5 | National identity document |
| 6 | Vaccination certificate |
| 7 | Alien registration number |
| 8 | Insurance policy number |
| 9 | Tax exemption number |
| 10 | Vehicle registration/license number |
| 11 | Border crossing card |
| 12 | Refugee travel document |
| 13 | Pilot's license |
| 14 | Permanent resident card |
| 15 | Redress number |
| 16 | Known traveler number |
| 17 | Non-standard |
| 18 | Merchant mariner |
| 19 | Air Nexus card |
| 20 | Crew member certificate |
| 21 | Passport card |
| 22 | Naturalization certificate |
| Code | Name | Description |
|---|---|---|
| 187 | System currently unavailable | EXPLAIN REASON FOR FAILURE |
| 448 | System error | Invalid Username and/or Password |
| 450 | Unable to process | EXPLAIN REASON FOR FAILURE |
| Code | Name | Description |
|---|---|---|
| 137 | Adult occupancy mismatch | Invalid included occupancy |
| 249 | Invalid rate code | Rate code not found for this hotel |
| 321 | Required field missing | EXPLAIN REASON FOR FAILURE |
| 375 | Hotel not active | EXPLAIN REASON FOR FAILURE |
| 392 | Invalid hotel code | Hotel not found for HotelCode=XXXXXX |
| 397 | Invalid number of adults | Invalid number of adults |
| 402 | Invalid room type | Room type code not found for this hotel |
| 436 | Rate does not exist | EXPLAIN REASON FOR FAILURE |
| 783 | Room or rate not found | Combination of room code and rate code not found for this hotel |
| 842 | Rate not loaded | EXPLAIN REASON FOR FAILURE |
| Code | Name | Reason |
|---|---|---|
| 1 | Unknown | Indicates an unknown error. |
| 2 | No implementation | Indicates that the target business system has no implementation for the intended request. |
| 3 | Biz rule | Indicates that the XML message has passed a low-level validation check, but that the business rules for the request message were not met. |
| 4 | Authentication | Indicates the message lacks adequate security credentials. |
| 5 | Authentication timeout | Indicates that the security credentials in the message have expired. |
| 6 | Authorization | Indicates the message lacks adequate security credentials. |
| 7 | Protocol violation | Indicates that a request was sent within a message exchange that does not align to the message. |
| 8 | Transaction model | Indicates that the target business system does not support the intended transaction-oriented operation. |
| 9 | Authentical model | Indicates the type of authentication requested is not recognized. |
| 10 | Required field missing | Indicates that an element or attribute that is required in by the schema (or required by agreement between trading partners) is missing from the message. |
| 11 | Advisory | |
| 12 | Processing exception | Indicates that during processing of the request that a not further defined exception occurred. |
| 13 | Application error | Indicates that an involved backend application returned an error or warning, which is passed back in the response message. |
| Code | Name |
|---|---|
| 1 | Bed tax |
| 2 | City hotel fee |
| 3 | City tax |
| 4 | County tax |
| 5 | Energy tax |
| 6 | Federal tax |
| 7 | Food & beverage tax |
| 8 | Lodging tax |
| 9 | Maintenance fee |
| 10 | Occupancy tax |
| 11 | Package fee |
| 12 | Resort fee |
| 13 | Sales tax |
| 14 | Service charge |
| 15 | State tax |
| 16 | Surcharge |
| 17 | Total tax |
| 18 | Tourism tax |
| 19 | VAT/GST tax |
| 20 | Surplus Lines Tax |
| 21 | Insurance Premium Tax |
| 22 | Application Fee |
| 23 | Express Handling Fee |
| 24 | Exempt |
| 25 | Standard |
| 26 | Zero-rated |
| 27 | Miscellaneous |
| 28 | Room Tax |
| 29 | Early checkout fee |
| 30 | Country tax |
| 31 | Extra person charge |
| 32 | Banquet service fee |
| 33 | Room service fee |
| 34 | Local fee |
| 35 | Goods and services tax (GST) |
| 36 | Value Added Tax (VAT) |
| 37 | Crib fee |
| 38 | Rollaway fee |
| 39 | Assessment/license tax |
| 40 | Pet sanitation fee |
| 41 | Not known |
| 42 | Child rollaway charge |
| 43 | Convention tax |
| 44 | Extra child charge |
| 45 | Standard food and beverage gratuity |
| 46 | National government tax |
| 47 | Adult rollaway fee |
| 48 | Beverage with alcohol |
| 49 | Beverage without alcohol |
| 50 | Tobacco |
| 51 | Food |
| 52 | Total surcharges |
| 53 | State cost recovery fee |
| 54 | Miscellaneous fee |
| 55 | Destination amenity fee |
Implement an Exponential Backoff strategy:
5 seconds → 10 seconds → 20 seconds → 40 seconds → then every 1 minute until a minimum timeout of 30 minutes.
If the issue persists beyond the timeout, contact our Application Operations team.
| Code | Type |
|---|---|
| 1 | All inclusive |
| 2 | American |
| 3 | Bed & breakfast |
| 4 | Buffet breakfast |
| 5 | Caribbean breakfast |
| 6 | Continental breakfast |
| 7 | English breakfast |
| 8 | European plan |
| 9 | Family plan |
| 10 | Full board |
| 11 | Full breakfast |
| 12 | Half board/modified American plan |
| 13 | As brochured |
| 14 | Room only |
| 15 | Self catering |
| 16 | Bermuda |
| 17 | Dinner bed and breakfast plan |
| 18 | Family American |
| 19 | Breakfast |
| 20 | Modified |
| 21 | Lunch |
| 22 | Dinner |
| 23 | Breakfast & lunch |
| 24 | Lunch and Dinner |
| Code Value | Code Name |
|---|---|
| 1 | Rate description |
| 2 | Property description |
| 3 | Property location |
| 4 | Room information |
| 5 | Guarantee information |
| 6 | Deposit information |
| 7 | Cancellation information |
| 8 | Check in check out information |
| 9 | Extra charge information |
| 10 | Tax information |
| 11 | Service charge information |
| 12 | Package information |
| 13 | Commission information |
| 14 | Miscellaneous information |
| 15 | Promotional information |
| 16 | Inclusion information |
| 17 | Amenity information |
| 18 | Late arrival information |
| 19 | Late departure information |
| 20 | Advanced booking information |
| 21 | Extra person information |
| 22 | Areas served |
| 23 | Onsite facilities information |
| 24 | Offsite facilities information |
| 25 | Onsite services information |
| 26 | Offsite services information |
| 27 | Extended stay information |
| 28 | Corporate booking information |
| 29 | Booking guidelines |
| 30 | Government booking policy |
| 31 | Group booking information |
| 32 | Rate disclaimer information |
| 33 | Visa/travel requirement information |
| 34 | Security information |
| 35 | Onsite recreational activities information |
| 36 | Offsite recreational activities information |
| 37 | General meeting planning information |
| 38 | Group meeting planning information |
| 39 | Contract/negotiated booking information |
| 40 | Travel industry booking information |
| 41 | Meeting room description |
| 42 | Pet policy description |
| 43 | Meal plan description |
| 44 | Family plan description |
| 45 | Children information |
| 46 | Early checkout description |
| 47 | Special offers description |
| 48 | Catering description |
| 49 | Room decor description |
| 50 | Oversold policy description |
| 51 | Last room availability description |
| 52 | Room type upgrade description |
| 53 | Driving directions |
| 54 | Driving directions from the north |
| 55 | Driving directions from the south |
| 56 | Driving directions from the east |
| 57 | Driving directions from the west |
| 58 | Surcharge information |
| 59 | Minimum stay information |
| 60 | Maximum stay information |
| 61 | Check-in policy |
| 62 | Check-out policy |
| 63 | Express check-in policy |
| 64 | Express check-out policy |
| 65 | Facility restrictions |
| 66 | Customs information for material |
| 67 | Seasons |
| 68 | Food and beverage minimums for groups |
| 69 | Deposit policy for master account |
| 70 | Deposit policy for reservations |
| 71 | Restaurant services |
| 72 | Special events |
| 73 | Cuisine description |
| Code Value | Code Name |
|---|---|
| 1 | Over 21 |
| 2 | Over 65 |
| 3 | Under 2 |
| 4 | Under 12 |
| 5 | Under 17 |
| 6 | Under 21 |
| 7 | Infant |
| 8 | Child |
| 9 | Teenager |
| 10 | Adult |
| 11 | Senior |
| 12 | Additional occupant with adult |
| 13 | Additional occupant without adult |
| 14 | Free child |
| 15 | Free adult |
| 16 | Young driver |
| 17 | Younger driver |
| 18 | Under 10 |
| 19 | Junior |
| Code Value | Code Name |
|---|---|
| 1 | Global distribution system (GDS) |
| 2 | Alternative distribution system (ADS) |
| 3 | Sales and catering system (SCS) |
| 4 | Property management system (PMS) |
| 5 | Central reservation system (CRS) |
| 6 | Tour operator system (TOS) |
| 7 | Internet |
| 8 | Kiosk |
| 9 | Agent |
| Code Value | Code Name |
|---|---|
| 1 | Home |
| 2 | Business |
| 3 | Other |
| 4 | Destination |
| Code Value | Code Name |
|---|---|
| 1 | Personal |
| 2 | Business |
| 3 | Listserve |
| 4 | Internet |
| 5 | Property |
| 6 | Sales office |
| 7 | Reservation office |
| 8 | Managing company |
| Code Value | Code Name |
|---|---|
| 1 | Bed tax |
| 2 | City hotel fee |
| 3 | City tax |
| 4 | County tax |
| 5 | Energy tax |
| 6 | Federal tax |
| 7 | Food & beverage tax |
| 8 | Lodging tax |
| 9 | Maintenance fee |
| 10 | Occupancy tax |
| 11 | Package fee |
| 12 | Resort fee |
| 13 | Sales tax |
| 14 | Service charge |
| 15 | State tax |
| 16 | Surcharge |
| 17 | Total tax |
| 18 | Tourism tax |
| 19 | VAT/GST tax |
| 20 | Surplus Lines Tax |
| 21 | Insurance Premium Tax |
| 22 | Application Fee |
| 23 | Express Handling Fee |
| 24 | Exempt |
| 25 | Standard |
| 26 | Zero-rated |
| 27 | Miscellaneous |
| 28 | Room Tax |
| 29 | Early checkout fee |
| 30 | Country tax |
| 31 | Extra person charge |
| 32 | Banquet service fee |
| 33 | Room service fee |
| 34 | Local fee |
| 35 | Goods and services tax (GST) |
| 36 | Value Added Tax (VAT) |
| 37 | Crib fee |
| 38 | Rollaway fee |
| 39 | Assessment/license tax |
| 40 | Pet sanitation fee |
| 41 | Not known |
| 42 | Child rollaway charge |
| 43 | Convention tax |
| 44 | Extra child charge |
| 45 | Standard food and beverage gratuity |
| 46 | National government tax |
| 47 | Adult rollaway fee |
| 48 | Beverage with alcohol |
| 49 | Beverage without alcohol |
| 50 | Tobacco |
| 51 | Food |
| 52 | Total surcharges |
| 53 | State cost recovery fee |
| 54 | Miscellaneous fee |
| 55 | Destination amenity fee |
| Code Value | Code Name |
|---|---|
| 1 | All inclusive |
| 2 | American/full board |
| 3 | Bed & breakfast |
| 4 | Buffet breakfast |
| 5 | Caribbean breakfast |
| 6 | Continental breakfast |
| 7 | English breakfast |
| 8 | European plan |
| 9 | Family plan |
| 10 | Full board |
| 11 | Full breakfast |
| 12 | Half board/modified American plan |
| 13 | As brochured |
| 14 | Room only/European plan |
| 15 | Self catering |
| 16 | Bermuda |
| 17 | Dinner bed and breakfast plan |
| 18 | Family American |
| 19 | Breakfast |
| 20 | Modified |
| 21 | Lunch |
| 22 | Dinner |
| 23 | Breakfast & lunch |
| Code Value | Code Name |
|---|---|
| 1 | Former |
| 2 | Nickname |
| 3 | Alternate |
| 4 | Maiden |
| Code Value | Code Name |
|---|---|
| 1 | Brand reservations office |
| 2 | Central reservations office |
| 3 | Property reservation Office |
| 4 | Property direct |
| 5 | Sales office |
| 6 | Home |
| 7 | Office |
| 8 | Other |
| 9 | Managing company |
| 10 | Mobile |
| Code Value | Code Name |
|---|---|
| 1 | Voice |
| 2 | Data |
| 3 | Fax |
| 4 | Pager |
| 5 | Mobile |
| 6 | TTY |
| 7 | Telex |
| 8 | Voice over IP |
| Code Value | Code Name |
|---|---|
| 1 | Customer |
| 2 | GDS |
| 3 | Corporation |
| 4 | Travel agent |
| 5 | Wholesaler |
| 6 | Group |
| 7 | Tour operator |
| 8 | CRO |
| 9 | Representation company |
| 10 | Internet broker |
| 11 | Airline |
| 12 | Hotel |
| 13 | Car rental |
| 14 | Cruise line |
| 15 | Employee |
| 16 | Event host |
| 17 | Supplier partner |
| 18 | Billing contact |
| 19 | Authorized signer |
| 20 | General service contractor |
| 21 | Arranger |
| 22 | Association |
| 23 | Travel agency |
| Code Value | Code Name |
|---|---|
| 1 | All suite |
| 2 | Budget |
| 3 | Corporate business transient |
| 4 | Deluxe |
| 5 | Economy |
| 6 | Extended stay |
| 7 | First class |
| 8 | Luxury |
| 9 | Meeting/Convention |
| 10 | Moderate |
| 11 | Residential apartment |
| 12 | Resort |
| 13 | Tourist |
| 14 | Upscale |
| 15 | Efficiency |
| 16 | Standard |
| 17 | Midscale |
| 18 | Moderate 2 |
| 19 | Quality |
| 20 | Quality 2 |
| 21 | Unknown |
| 22 | Midscale without F&B |
| 23 | Upper upscale |
| Code Value | Code Name |
|---|---|
| 1 | Customer |
| 2 | CRO (Customer Reservations Office) |
| 3 | Corporation representative |
| 4 | Company |
| 5 | Travel agency |
| 6 | Airline |
| 7 | Wholesaler |
| 8 | Car rental |
| 9 | Group |
| 10 | Hotel |
| 11 | Tour operator |
| 12 | Cruise line |
| 13 | Internet broker |
| 14 | Reservation |
| 15 | Cancellation |
| 16 | Reference |
| 17 | Meeting planning agency |
| 18 | Other |
| 19 | Insurance agency |
| 20 | Insurance agent |
| 21 | Profile |
| 22 | ERSP (Electronic reservation service provider) |
| 23 | Provisional reservation |
| 24 | Travel Agent PNR |
| 25 | Associated reservation |
| 26 | Associated itinerary reservation |
| 27 | Associated shared reservation |
| 28 | Alliance |
| 29 | Booking agent |
| 30 | Ticket |
| 31 | Divided reservation |
| 32 | Merchant |
| 33 | Acquirer |
| 34 | Master reference |
| 35 | Purged master reference |
| 36 | Parent reference |
| 37 | Child reference |
| 38 | Linked reference |
| 39 | Contract |
| 40 | Confirmation number |
| 41 | Fare quote |
| 42 | Reissue/refund quote |
| 43 | Ground transportation supplier |
| 44 | EMD |
| Code | Type |
|---|---|
| AX | American Express |
| BC | Bank Card |
| BL | Carte Bleu |
| CB | Carte Blanche |
| DN | Diners Club |
| DS | Discover Card |
| EC | Eurocard |
| JC | Japanese Credit Bureau Credit Card |
| LC | Local Card |
| MA | Maestro |
| MC | Master Card |
| SO | Solo |
| CU | Union Pay |
| TP | Universal Air Travel Card |
| VE | Visa Electron |
| VI | VIsa |
| Type | Description |
|---|---|
| EXTRA_PERSON | Charges related to extra people |
| EXTRA_BED | Extra bed charges |
| SURCHARGE | Surcharges, for example credit card surcharge |
| MEAL | Charges related to the meal |
| SERVICE | General hotel nominated service charges |
| TOUR | Charges for a tour |
| EVENT | Charges for an event |
| EXTRA | Un-categorised extra added to the reservation |
| OTHER | Any additional charge that does not fall under the above categories, where OTHER is specified more information will be provided in the description |
| Value | Definition |
|---|---|
| 02 or 05 | Fully Authenticated Transaction |
| 01 or 06 | Attempted Authentication Transaction |
| 00 or 07 | Non 3-D Secure Transaction |
| 02, 01, 00 | Mastercard |
| 05, 06, 07 | Visa |
| 05, 06, 07 | Amex |
| 05, 06, 07 | JCB |
| 05, 06, 07 | Diners |
| Value | Definition |
|---|---|
| Y | Successful Authentication |
| N | Failed Authentication |
| U | Unable to Complete Authentication |
| A | Successful Attempts Transaction |
| B | You can proceed to authorisation using the information received |
| R | Authentication Rejected (Merchant must not submit for authorisation) |
| Value | Definition |
|---|---|
| Y | Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. |
| N | Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted. |
| null | If not sent then null |
| Value | Definition |
|---|---|
| Y | Yes, Bank is participating in 3-D Secure protocol and will return the ACSUrl |
| N | No, Bank is not participating in 3-D Secure protocol |
| U | Unavailable, The DS or ACS is not available for authentication at the time of the request |
| B | Bypass, Merchant authentication rule is triggered to bypass authentication in this use case |
3782 8224 6310 0005
3782 0000 1111 2222
5555 5555 5555 4444
5555 1111 2222 6666
5555 6666 8888 9999
5555 5555 5555 4444
3056 9309 0259 04
3056 1111 2222 33
3056 9300 0902 0004
3056 9311 2111 3222
3852 0000 0232 37
6011 1111 1111 1117
6011 0009 9013 9424
5100 0000 1111 3333
5473 0000 0000 0007
3566 0020 2036 0505
3530 1113 3330 0000
1234 4567 7890 4222
9890 6555 7777 8888
6759 6498 2643 84536799 9901 0000 0000
5555 5555 5555 4444
5200 0078 4000 0022
5506 9274 2731 7625
5506 9208 0924 3667
6334 0000 1111 2222
6767 0000 1111 4444
6200 0000 0000 0005
6200 5555 6666 7777
1000 70000 000112
1000 70000 000155
1000 88888 000155
4917 3000 0000 0008
4917 1111 2222 3333
4242 4242 4242 4242
4000 0019 6000 0008
4035 5010 0000 0008
4000 0200 0000 0000
4111 1111 1111 1111
:circle-bolt: | Quick Start | /pages/ALxLZL6VqfAzmyft5Rmd | |
:signs-post: | Integration Requirements | /pages/cqRPfKMmxJM7XZog4O7Z | |
:code: | API Overview | /pages/r62XJhbwlkj7RcUczIPn |
| Item | Details |
|---|---|
| Inventory SOAP endpoint | Your HTTPS endpoint URL for Rooms and Rates, Availability and Restrictions, and Rates |
| Credentials | username and password forSiteMinder to authenticate against your Inventory SOAP endpoint |
| Hotel Code | HotelCode |
| Pricing Model | Whether you'll implement Per Day Pricing (PDP) or Occupancy Based Pricing (OBP). You can only certify one pricing model, which will apply across all your properties. |
| Item | Details |
|---|---|
| Reservation SOAP endpoint | https://tpi-cm-apac.preprod.siteminderlabs.com/siteconnect/services |
| Credentials | username and password |
| Identifier | RequestorID (Channel Code) |
| Hotel Test Account | Platform that includes pre-configured room types and rate plans, an inventory simulator to push availability, restrictions, and rates, and to verify pushed reservations. |
OTA\_HotelAvailRS
OTA\_HotelAvailNotifRS
OTA\_HotelRateAmountNotifRS
OTA\_HotelAvailRS
OTA\_HotelAvailNotifRS
OTA\_HotelRateAmountNotifRS
OTA\_HotelAvailNotifRS
OTA\_HotelRateAmountNotifRS
OTA\_HotelAvailNotifRS
OTA\_HotelRateAmountNotifRS
<OTA_HotelResNotifRS
xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="9a40291f-24fa-410d-b1c2-b64efab47da4" TimeStamp="2023-04-28T20:46:53+10:00" Version="1.0">
<Errors>
<Error Type="4">Invalid Username and/or Password for ABC</Error>
</Errors>
</OTA_HotelResNotifRS>
| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| IP Whitelisting | Pre-Production IP addresses:
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailRQ | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
@AvailRatesOnly | Boolean | 1 | Indicates that only availability rates should be returned. Will be set to true. |
AvailRequestSegments | Element | 1 | Container for availability request segments. |
AvailRequestSegment | Element | 1 | Single availability request segment. |
@AvailReqType | String | 1 | Specifies the type of availability request. Will be set to Room. |
HotelSearchCriteria | Element | 1 | Container for the hotel search criteria. |
Criterion | Element | 1 | Single search criterion. |
HotelRef | Element | 1 | Reference to a specific hotel. |
@HotelCode | String | 1 | Identifier for the hotel. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailRS | Element | 1 | Root element for the response. |
@xmlns | String | 1 | Defines the XML namespace for the response. Must be set to http://www.opentravel.org/OTA/2003/05 |
@EchoToken | String | 1 | Unique identifier matching the request EchoToken. |
@TimeStamp | DateTime | 1 | Time when the response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
RoomStays | Element | 0..1 | Container for room stay information. |
RoomStay | Element | 1..n | Single room stay information. |
RoomTypes | Element | 1 | Container for room types. |
RoomType | Element | 1 | Single room type information. |
@RoomTypeCode | String | 1 | Code for the room type. |
RoomDescription | Element | 1 | Description of the room. |
@Name | String | 1 | Name of the room. |
Text | String | 0..1 | Description text for the room. |
Occupancy | Element | 0..1 | Occupancy details for the room. Only for OBP. |
@AgeQualifyingCode | Integer | 1 | Age qualification code for the occupancy:
Only for OBP. |
@MaxOccupancy | Integer | 1 | Maximum occupancy for the room. Min Only for OBP. |
RatePlans | Element | 0..1 | Container for rate plans. |
RatePlan | Element | 1 | Single rate plan information. |
@RatePlanCode | String | 1 | Code for the rate plan. |
RatePlanDescription | Element | 1 | Description of the rate plan. |
@Name | String | 1 | Name of the rate plan. |
Text | String | 0..1 | Description text for the rate plan. |
AdditionalDetails | Element | 0..1 | Additional details about the rate plan. |
AdditionalDetail | Element | 1..2 | Single additional detail. |
@Code | String | 1 | Codes:
|
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
What is the purpose of the Rooms and Rates endpoint?
The Rooms and Rates endpoint allows SiteMinder to retrieve the complete list of active room types and rate plans configured in your booking channel for a specific property. **When it's called:** * During initial property setup * When the hotel needs to update their room rate mappings * When SiteMinder needs to refresh configuration data **What it enables:** * Hotels can map their SiteMinder room types to your channel's room types * Establishes the foundation for all ARI updates and reservations * Ensures accurate inventory synchronization between systemsCan I retrieve rooms and rates from SiteMinder to load into my system?
No, you cannot directly retrieve rooms and rates from SiteMinder. The workflow is: 1. **Booking channel setup:** Room types and rate plans must first be configured in your channel based on the agreement between the hotel and your booking channel 2. **SiteMinder requests:** SiteConnect sends `OTA_HotelAvailRQ` to retrieve your channel's configuration 3. **Hotel mapping:** The hotel maps your channel's rooms and rates to their SiteMinder inventory structure **Why this direction?** This ensures that the booking channel controls their own inventory structure and SiteMinder adapts to it.How often does SiteMinder call the Rooms and Rates endpoint?
SiteMinder calls this endpoint: * **On-demand** when hotels access the room rate mapping interface * **Not on a schedule** - there is no automatic polling * **During setup** when a new property is being configured **Performance expectation:** Your endpoint should respond within 1-2 seconds as hotels are actively waiting for the mapping interface to load.Why aren't all the rooms and rates I sent showing up in the mapping interface?
This occurs when **combinations are not unique**. Each room rate must have a distinct combination of: * `RoomDescription @Name` + `RatePlanDescription @Name` **Example of the problem:** ```xmlWhy can't I find the RoomDescription/Text we sent in the SiteMinder platform?
The `RoomDescription/Text` element is used **internally by SiteMinder Support** and is not displayed in the hotel-facing mapping interface.
**What hotels see:**
* `RoomDescription @Name` - Appears in dropdown menus
* `RatePlanDescription @Name` - Appears in dropdown menus
**Best practice:** Make the `@Name` attributes clear and descriptive since these are what hotels will use for mapping.
What are the NO_UPDATES, NO_AVAILABILITY, and NO_RATES flags?
These optional flags control which types of updates SiteMinder sends for specific room-rate combinations: **NO\_UPDATES:** * Blocks **all** ARI updates (availability, restrictions, and rates) * Use for room rates that are mapped **only for reservation delivery** **NO\_AVAILABILITY:** * Blocks **availability** updates only * Restrictions and rates will still be sent * **Note:** Restriction updates (stop sells, min/max stay, CTA/CTD) will still be sent in `OTA_HotelAvailNotifRQ` **NO\_RATES:** * Blocks **rate** updates only * Availability and restrictions will still be sent **Combined flags:** You can use `NO_AVAILABILITY` and `NO_RATES` together to allow only restriction updates.Does my channel need to support Occupancy Based Pricing (OBP)?
SiteConnect supports both **Per Day Pricing (PDP)** and **Occupancy Based Pricing (OBP)**. **PDP (default):** * Single rate per room per night * No occupancy variations required * No `Occupancy` element needed in response **OBP (optional):** * Different rates based on number of guests * Requires `Occupancy` element with `MaxOccupancy` attribute * More flexible pricing structure You can support either or both pricing models based on your channel's capabilities.We only supported RoomTypeCode, but now we want to add RatePlanCode. What do we need to do?
Adding `RatePlanCode` support requires completing a certification process: **Steps:** 1. **Development:** Modify your system to include `RatePlanCode` in responses 2. **Certification:** Complete testing with SiteMinder Partner Integrations team 3. **Hotel remapping:** Properties will need to remap their room rates to include the new `RatePlanCode` **Impact:** This is a significant change that affects all connected properties but provides better granularity for rate plan management.What happens if I change the room name or rate plan name?
Changing `RoomDescription @Name` or `RatePlanDescription @Name` **without changing the codes**: **Impact:** * Connection remains intact (codes unchanged) * Hotels must **re-save** their mapping in SiteMinder platform to see updated descriptions * If hotels don't re-save, they'll see old descriptions but functionality continues **Best practice:** Notify connected hotels when you change descriptions so they can update their mappings if needed.What happens if I change the RoomTypeCode or RatePlanCode?
Changing `RoomTypeCode` or `RatePlanCode` **breaks the existing mapping**: **Impact:** * SiteMinder will not recognize the old codes * All ARI updates for this room-rate combination will fail * Reservations may not be properly routed * Hotels must **complete the mapping again** from scratch **Critical:** Code changes should be avoided whenever possible. If absolutely necessary: 1. Notify SiteMinder Partner Integrations team in advance 2. Coordinate with affected hotels 3. Plan for a maintenance window 4. Provide clear migration instructionsWhat are the most common validation errors for Rooms and Rates?
**Common errors:** 1. **Multiple rate plans in single RoomStay** * Each `RoomType` + `RatePlan` combination must be in its own `RoomStay` * Invalid: Multiple `| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| IP Whitelisting | Pre-Production IP addresses:
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRQ | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
AvailStatusMessages | Element | 1 | Container for availability status messages. |
@HotelCode | String | 1 | Identifier for the hotel. |
AvailStatusMessage | Element | 1 | Single availability status message. |
@BookingLimit | Integer | 1 | Sets the number of rooms available for sale. |
StatusApplicationControl | Element | 1 | Contains date and room identification information. |
@Start | Date | 1 | The start date for which the update is being set. This date is inclusive. |
@End | Date | 1 | The end date for which the update is being set. This date is inclusive. |
@InvTypeCode | String | 1 | Identifies the room. |
@RatePlanCode | String | 1 | Identifies the rate. |
LengthsOfStay | Element | 0..2 | Used for Minimum Stay and Maximum Stay. |
LengthOfStay | Element | 1 | Single length of stay information. |
@MinMaxMessageType | String | 1 | Can be one of the following:
|
@Time | Integer | 0..1 | Specifies the number of days related to a stay. Valid range: 1 to 9999. Minimum Stay: Always included with minimum value of 1. Maximum Stay: When included: Set or update the maximum stay value. When excluded: Remove/clear any existing maximum stay restriction. |
RestrictionStatus | Element | 0..1 | Used to restrict the room for Stop Sell, Closed to Arrivals, and Closed to Departure. |
@Status | String | 1 | Values:
|
@Restriction | String | 0..1 | Values:
If no type is specified, assume a full close or open for the room date. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelAvailNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
What updates can be sent in a single message?
Each `OTA_HotelAvailNotifRQ` message is limited to: * **One hotel** (`HotelCode`) * **One room type** (`InvTypeCode`) * **Multiple rate plans** under that room type * **Multiple date ranges** Within these constraints, a single message can contain multiple `AvailStatusMessage` elements updating: * Availability counts (`BookingLimit`) * Stop Sell status * Minimum/Maximum Length of Stay * Close to Arrival (CTA) * Close to Departure (CTD) **Example:** You might receive availability, stop sell, and min stay updates for the same room type across different date ranges in one message.How often will I receive availability and restriction updates?
**Update Frequency:** * New update rounds sent every **2 minutes** * Only changed values for specific room/rate/date combinations are sent * When a change is triggered, **all** availability and restriction values for that combination are included **Update Volume:** * Maximum payload: **210 days** (30 date elements × 7-day spans) * Response speed affects update frequency - faster responses enable more frequent updates * First-time connections receive full inventory data for the configured update period **Important:** Your endpoint must respond within the 20-second timeout, with 1-2 seconds being optimal.What's the difference between Room Type level and Rate Plan level availability?
**Room Type Level (default):** * Availability is **shared across all rate plans** for a room type * Same inventory count applies to all rates (BAR, Non-Refundable, etc.) * When one rate plan is booked, availability for **all rate plans** under that room type is reduced * Your system uses `InvTypeCode` as the primary identifier **Rate Plan Level:** * **Separate availability** per rate plan under the same room type * Each rate (BAR, Non-Refundable, etc.) has its own inventory count * Booking one rate plan only affects that specific rate's availability * Hotels must configure this setting in SiteMinder Platform * Your system must use both `InvTypeCode` and `RatePlanCode` to track inventory **Implementation:** If you only support Room Type level, use `InvTypeCode` and disregard `RatePlanCode` values. If you support Rate Plan level, track inventory separately using the combination of `InvTypeCode` + `RatePlanCode`.Is there a mechanism to prevent hotels from entering excessively large availability numbers?
No, SiteConnect does not validate availability amounts. It is the **hotel's responsibility** to enter correct inventory counts. **Your system must:** * Accept any positive integer value for `BookingLimit` * Not impose arbitrary limits on availability counts * Process updates as received from SiteMinder **Why no validation?** Some properties have very large inventories (e.g., major hotels, apartment complexes), and SiteMinder cannot determine what constitutes a "reasonable" number for each property.How should I handle stop sells if my system doesn't support them as a separate feature?
If your booking channel does not support stop sells as a distinct feature, you **must interpret** `RestrictionStatus @Status="Close"` (without `@Restriction` attribute) as **equivalent to zero availability**. **Implementation:** * When you receive `What's the difference between Stay on Arrival and Stay Through?
**Stay on Arrival (SetMinLOS / SetMaxLOS):** * Restriction applies **based on the arrival date** * Guest must stay minimum/maximum nights **starting from** their check-in date * Example: Min Stay = 3 on Friday means guests arriving Friday must stay at least 3 nights **Stay Through (SetForwardMinStay / SetForwardMaxStay):** * Restriction applies **to the entire length of stay** * Guest must stay minimum/maximum nights **covering specific dates** * Example: Min Stay Through = 3 for Friday-Sunday means any stay covering those dates must be at least 3 nights **Configuration:** * Hotels choose their preferred method in SiteMinder Platform * Your channel must support **both** Stay on Arrival **and** Stay Through to enable the Through option * If you only support one method, implement Stay on Arrival **Message Type:** SiteMinder indicates which method is used via the `MinMaxMessageType` attribute.What happens if I don't support certain restriction types?
You should implement **all mandatory restriction types**, but if you cannot support optional restrictions: 1. Inform SiteMinder Partner Integrations team during certification to remove those restrictions from your configuration 2. In the meantime, return a **Success** response (do not return errors for unsupported features) 3. Simply ignore those specific `AvailStatusMessage` elements 4. Process other supported updates in the same message **Important:** Do not fail the entire message if you don't support one restriction type. Process what you can support.What are the date range limitations for updates?
**Per Message:** * Maximum payload: **210 days** of data * Structured as up to 30 date elements with maximum 7-day spans each * `Start` and `End` dates are **inclusive** **Update Period:** * SiteConnect can send updates up to **750 days** in advance * Specific update period configured during channel setup (typically 365-750 days) * New date added daily to maintain rolling window **Date Format:** * ISO 8601 date format: `YYYY-MM-DD` * Dates use hotel's local timezone as configured in SiteMinder * Example: `Start="2024-10-05"` `End="2024-10-12"` **Bundling:** Dates with identical values are bundled into ranges. Different values are sent in separate `AvailStatusMessage` elements.Why can't I reset the MinStay field back to blank in SiteMinder Platform?
This is **expected API and platform behaviour**, not a limitation: **Current Behaviour:** * Once MinStay is set, it cannot be reverted to "no restriction" * Minimum value is **1 night** * To effectively remove the restriction, set it to 1 **API Representation:** * SiteMinder will send `How do I handle MaxStay updates without a Time attribute?
When you receive a `LengthOfStay` element for Maximum Stay **without** a `Time` attribute, this means the Maximum Stay restriction has been **removed** in SiteMinder. **With Time attribute:** Set or update the maximum stay value `| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| IP Whitelisting | Pre-Production IP addresses:
|
| 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). |
| Element/Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelRateAmountNotifRS | 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. |
@TimeStamp | DateTime | 1 | Time when the request was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
RateAmountMessages | Element | 1 | Container for rate status messages. |
@HotelCode | String | 1 | Identifier for the hotel. |
RateAmountMessage | Element | 1..n | Single rate status message. |
StatusApplicationControl | Element | 1 | Contains date and room identification information. |
@Start | Date | 1 | The start date for which the update is being set. This date is inclusive. |
@End | Date | 1 | The end date for which the update is being set. This date is inclusive. |
@InvTypeCode | Integer | 1 | Identifies the room. |
@RatePlanCode | Element | 0..1 | Identifies the rate. |
Rates | String | 1 | Container for rate information. |
Rate | String | 1 | Contains individual rate information. |
BaseByGuestAmts | Element | 1 | Base charge for a given number of guests. |
BaseByGuestAmt | Element | 1..n | Contains individual rate amounts. |
@AmountAfterTax | Decimal | 1 | Positive decimal value for the rate amount after tax. |
@NumberOfGuests | Integer | 0..1 | Number of guests in the room. Mandatory for OBP. |
@AgeQualifyingCode | Element | 0..1 | Age qualification code for the rate:
Mandatory for OBP. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
AdditionalGuestAmounts | Element | 0..1 | Additional charges for extra guests based on age qualification. |
AdditionalGuestAmount | Element | 0..2 | Contains details of extra guest charges. |
@AgeQualifyingCode | String | 1 | Age qualification code for the extra guest charge:
|
@Amount | Decimal | 1 | Extra charge amount. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
RateDescription | Element | 0..1 | Description of what the rate includes. |
Text | Element | 1 | Inclusion text (maximum 255 characters). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelRateAmountNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Must be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
What is the difference between Per Day Pricing (PDP) and Occupancy Based Pricing (OBP)?
**Per Day Pricing (PDP):** * Rates set for each individual day * Base rate applies to default occupancy (configured on booking channel) * Optional Included Occupancy via `NumberOfGuests` attribute * Extra guest charges via `AdditionalGuestAmounts` (both adults and children) * Single Guest Discount shown as `NumberOfGuests="1"` **Occupancy Based Pricing (OBP):** * Rates vary based on number of guests * Separate rate for **each occupancy level** from 1 to Maximum Occupancy * `NumberOfGuests` attribute **mandatory** for all rates * Extra Adult Rate **not used** (adult rates already included for each occupancy) * Only Extra Child Rate in `AdditionalGuestAmounts` **How to identify:** * **PDP:** May have single `BaseByGuestAmt` or include `NumberOfGuests` for Included Occupancy * **OBP:** Multiple consecutive `BaseByGuestAmt` elements (1, 2, 3, 4...) up to Maximum OccupancyHow often will I receive rate updates?
**Update Frequency:** * Rate updates sent every **2 minutes** in coordination with ARI updates * Only changed values for specific room/rate/date combinations are sent * Maximum payload: **210 days** per message **Important Dependency:** Rate updates are sent **after** successful processing of availability and restrictions. If availability/restriction updates fail, rate updates will be queued until resolved. **Update Trigger:** When rates change, all rate components are included: * Base rates for all occupancy levels (OBP) or base rate with optional Included Occupancy (PDP) * Extra guest rates (if configured) * Inclusions text (if configured)Why am I receiving availability and restrictions updates but not rate updates?
This is **expected behaviour**. SiteConnect sends updates in a specific order: **Update Sequence:** 1. **First:** Availability and Restrictions updates sent 2. **Then:** Rate updates sent **only after** successful availability/restrictions response **Action:** Verify your endpoint is successfully processing and responding to availability/restrictions updates before expecting rate updates.What does Included Occupancy mean?
**Included Occupancy** is the number of guests covered by the base rate. **For PDP (Per Day Pricing):** * Indicated by `NumberOfGuests` attribute on base rate element * Example: `NumberOfGuests="2"` means base price covers 2 guests * If more guests allowed, extra charges can be added via `AdditionalGuestAmounts` * Single Guest Discount can be applied with `NumberOfGuests="1"` **For OBP (Occupancy Based Pricing):** * Every rate has `NumberOfGuests` attribute (mandatory) * Each occupancy level (1, 2, 3...) has its own complete rate * No "included occupancy" concept - each occupancy is explicitly priced **Default Behavior:** * **PDP:** If `NumberOfGuests` not present, booking channel uses its own default * **OBP:** If hotel doesn't configure Included Occupancy, SiteMinder defaults to 2 guests as the baseWhat's the difference between NumberOfGuests="1" and Included Occupancy?
This depends on whether you're receiving PDP or OBP rates: **In PDP Messages:** * `NumberOfGuests="1"` = **Single Guest Discount** (reduced rate for solo travellers) * `NumberOfGuests="2"` or higher = **Included Occupancy** (base rate for that number of guests) * If only one `BaseByGuestAmt` without `NumberOfGuests` = base rate with no occupancy specification **Example PDP with both:** ```xmlWhat happens if the Maximum Occupancy in SiteMinder doesn't match my channel's settings?
You must return an **"Invalid number of adults"** error when there's a mismatch. **Expected Behavior:** * SiteMinder sends rates for 1 to Maximum Occupancy (consecutive) * Number of `BaseByGuestAmt` elements = Maximum Occupancy value * Your channel must validate this matches your configured Maximum Occupancy **Error Response Examples:** ```xmlHow many occupancy rates can I receive in an OBP message?
You will receive **one rate for each occupancy level** from 1 to the Maximum Occupancy. **Number of Rates:** * Determined by `MaxOccupancy` value provided in your Rooms and Rates response * Valid range: 1 to 50 * Always consecutive: 1, 2, 3, 4... up to max **Examples:** * `MaxOccupancy="3"` → 3 rates (for 1, 2, and 3 guests) * `MaxOccupancy="6"` → 6 rates (for 1, 2, 3, 4, 5, and 6 guests) **Message Size Considerations:** Higher Maximum Occupancy values result in larger messages. Plan your parsing logic to handle up to 50 `BaseByGuestAmt` elements per rate update.How does SiteConnect sync Extra Adult Rate, Extra Child Rate, and Single Guest Discount in an PDP?
**Sync Behavior:** * These values are **rate plan level settings** (not date-specific) * Once configured, a **full sync is sent** for the entire rate plan * All dates for that room/rate combination receive the same extra guest rates and discount **Update Trigger:** * When hotel first configures these values * When hotel changes these values * During regular rate updates (included with base rates) **In Messages:** * **Extra Adult/Child Rates:** Sent in `AdditionalGuestAmounts` section * **Single Guest Discount:** Sent as `BaseByGuestAmt` with `NumberOfGuests="1"` * Applied across all dates in the message date range **Example:** If a hotel sets Extra Adult Rate to 50 EUR for a rate plan, all future rate updates for that rate plan will include `I added a Single Guest Discount and stopped receiving rate updates. Why?
This occurs when the Single Guest Discount results in a **negative rate**. **Example Problem:** * Base rate: 50 EUR * Single Guest Discount: 60 EUR * **Result:** 50 - 60 = **-10 EUR** (negative rate) **System Behavior:** * SiteMinder detects the negative rate * Rate updates for that room-rate combination **stop being sent** * Error prevents invalid pricing from reaching your channel **Resolution:** * Hotel must adjust the Single Guest Discount to be **less than** the base rate * Once corrected, rate updates will resume **Best practice:** Validate that Single Guest Discount ≤ Base Rate in your channel's hotel management interfaceAre rates received from SiteConnect inclusive or exclusive of taxes?
All rates are sent in the `AmountAfterTax` attribute, but the **actual tax inclusion depends on hotel configuration**. **What SiteConnect Sends:** * Attribute: `AmountAfterTax` (always used) * Value: Daily rate amount as configured by hotel * No explicit tax flag to indicate inclusive vs. exclusive **Common Practice:** * Most hotels load **all-inclusive rates** (required by major channels like Booking.com, Expedia) * Your channel can handle rates on your extranet as you see fit **Critical:** Hotel must be informed and agree on how rates are interpreted **Recommendation:** * Document your channel's rate handling policy clearly * Communicate this to hotels during onboarding * Consider adding a toggle in your extranet if you support both modelsWe only support one currency. Can we work without receiving CurrencyCode?
Yes, you can request to have `CurrencyCode` disabled. **Default Behavior:** * SiteConnect sends `CurrencyCode` attribute by default * Uses ISO 4217 currency codes (EUR, USD, GBP, etc.) * Allows properties to select currency to send **Single Currency Channels:** * Request Partner Integrations team to disable `CurrencyCode` * This is a **channel-level setting** (applies to all properties) * Rate messages will be sent without the `CurrencyCode` attribute * Your channel assumes your supported currency **Multi-Currency Support:** * If you support multiple currencies, keep `CurrencyCode` enabled * Each hotel can configure their preferred currency in SiteMinder * Only one currency per request (never mixed)Will I receive both PDP and OBP messages during migration to Occupancy Based Pricing?
Yes, your channel must support both message formats during the migration period. **Migration Switch:** * PDP to OBP migration happens **simultaneously for all properties** on your channel * The switch occurs **instantaneously** - all properties convert at once * Your endpoint must process both PDP and OBP messages to ensure continuity **Why Both Formats:** * Handle the instantaneous cutover moment * Support potential rollback to PDP if issues occur * Maintain service during the verification period **When to Disable PDP:** Only after SiteMinder Partner Integrations confirms: * All properties successfully receiving OBP updates * Verification period completed without issues * Migration is stable with no rollback required **How to Detect Format:** * **OBP:** Multiple consecutive `BaseByGuestAmt` with `NumberOfGuests="1"`, `"2"`, `"3"`... * **PDP:** Single or non-consecutive `BaseByGuestAmt` elements| Category | Requirement |
|---|---|
| Web Service Endpoint |
|
| Authentication |
|
| Message Structure |
|
| Content-Type | text/xml; charset=utf-8 |
| Version | SOAP 1.1 |
| Protocol & Security |
|
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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 | Enumeration | 1 | Specifies the booking status:
|
@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. |
| 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 | Channel code. The ID used will be agreed by trading partners and remain consistent across messages. |
BookingChannel | Element | 1 | Contains booking channel information. |
@Primary | Boolean | 1 |
|
CompanyName | Element | 1 | Name of the booking channel. |
@Code | String | 0..1 | Code of the booking channel. - Same as RequestorID ID for the primary source.- Your internal reference code for the secondary source. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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. Must be set when ResStatus is Commit, Modify and Cancel. 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. |
UniqueID | Element | 1 | Unique identifier of the reservation in the system which sent the message. |
@Type | Integer | 1 | Must be set to 14 (Reservation). |
@ID | String | 1 | Actual confirmation number. |
| 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). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RoomTypes | Element | 0..1 | Provides more information about the room type for this room stay. |
RoomType | Element | 1 | Contains specific information about the room type. |
@RoomTypeCode | String | 1 | Code of the room booked. |
RoomDescription | Element | 1 | Description of the room. |
@Name | String | 1 | Name of the room. Required for Reservation Notification Email feature. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RatePlans | Element | 0..1 | Provides more information about the rate plan for this room stay. |
RatePlan | Element | 1 | Contains details about the specific rate plan. |
@RatePlanCode | String | 1 | Code of the rate booked. |
RatePlanDescription | Element | 1 | Description of the rate plan. Required for Reservation Notification Email feature. |
Commission | Element | 0..1 | Commission amount associated with the rate plan. |
CommissionPayableAmount | Element | 1 | Amount of commission to be paid. |
@Amount | Decimal | 1 | Commission amount. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
MealsIncluded | Element | 0..n | Used to identify the types of meals included with a rate plan. |
@MealPlanCode | Integer | 0..1 | Refer to Meal Plan Type (MPT). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
RoomRates | Element | 1 | Contains details of the rates applied to the room stay. |
RoomRate | Element | 1 | One RoomRate per RoomStay. Multiple rates are listed under the RoomRate. |
@RoomTypeCode | String | 1 | Code of the room booked. |
@RatePlanCode | String | 0..1 | Code of the rate plan booked. Must be included if RoomStay / RatePlans is present. |
@NumberOfUnits | Integer | 1 | Must be set to 1. If there are multiple RoomStays for the same RoomTypeCode and RatePlanCode, multiple RoomStay elements should be sent. |
Rates | Element | 1 | Contains rate details |
Rate | Element | 0..n | 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. |
@UnitMultiplier | Integer | 1 | Must be set to 1. |
@RateTimeUnit | String | 1 | Must be set to Day. |
@EffectiveDate | Date | 1 | Starting date of the rate. This date is inclusive. Must use YYYY-MM-DD format. |
@ExpireDate | Date | 1 | Expire date is the first day after the applicable period. This date is not inclusive. Must use YYYY-MM-DD format. |
Base | Element | 1 | Base amount charged for the accommodation. |
@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. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
Tax | Element | 0..n | Contains specific tax information. |
@Type | Enumeration | 0..1 | Indicates whether the tax is:
|
@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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
Total | Element | 0..1 | Total amount charged, including additional occupants and fees. If empty, assume the Base amount equals the Total amount. |
@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. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
Tax | Element | 0..n | Contains specific tax information. |
@Type | Enumeration | 0..1 | Indicates whether the tax is:
|
@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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
ServiceRPHs | Element | 0..1 | Container for the ServiceRPH elements. |
ServiceRPH | Element | 0..n | Links a service to the Service information at the HotelReservation level (if applicable). Service at the RoomRate level. |
@RPH | Integer | 1 | Reference to the ServiceRPH at the HotelReservation level. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
GuestCounts | Element | 1 | Total guest counts, divided by age group (adult, child, infant). Adult count must always be sent. |
GuestCount | Element | 1..n | Represents the count for a specific age group. |
@AgeQualifyingCode | Integer | 1 |
|
@Count | Integer | 1 | Number of guests for this age group. Count must be greater than or equal to 1. |
@Age | Integer | 0..1 | Age of the guest, required only for children and infants. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
TimeSpan | Element | 1 | Contains the timespan for the RoomStay.Maximum 749 days |
@Start | Date | 1 | Check-in date. Must use YYYY-MM-DD format. |
@End | Date | 1 | Check-out date. Must use YYYY-MM-DD format.Must be after Start (minimum 1-night stay required). Same-day bookings will be rejected. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Total | Element | 1 | Container for the total amount elements. |
@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. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
Taxes | Element | 0..1 | Contains details of the taxes applied. |
Tax | Element | 1..n | Contains specific tax information. |
@Type | Enumeration | 0..1 | Indicates whether the tax is:
|
@Code | String | 0..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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
BasicPropertyInfo | Element | 1 | Contains basic identification details for the hotel associated with the reservation. |
@HotelCode | String | 1 | Identifier for the hotel. |
@HotelName | String | 0..1 | Name of the hotel. |
| 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). |
| 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. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Comments | Element | 0..1 | Contains comment for the RoomStay. |
Comment | Element | 1 | Holds the actual comment. |
Text | Element | 1 | The content of the comment. PCI sensitive data is prohibited. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
SpecialRequests | Element | 0 | Contains special requests for the RoomStay. |
SpecialRequest | Element | 0..n | Holds the actual special request. |
@Name | String | 1 | Special request type (e.g., bedding configuration, smoking, cot, extra bed). |
Text | Element | 0..1 | Special request text. |
| 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. Use this list as a guide to code your extras/services. You can use additional codes not on the list such as PARKING or your own service identifier codes generated in your system. |
@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 RoomRate. ServiceRPH absence indicates a HotelReservation level charge. |
@Inclusive | Boolean | 1 | Must be set to TRUE, as SiteMinder 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. |
Price | Element | 0..1 | Container for pricing details of the service. |
Base | Element | 0..1 | Base amount 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. |
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. |
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 | 1 | Contains the time span for which the service is provided. |
@Start | Date | 0..1 | Start date of service. Must use YYYY-MM-DD format. |
@End | Date | 0..1 | Last date of service. Must use YYYY-MM-DD format. |
| 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:
|
@ArrivalTime | Time | 0..1 | Arrival time of the guest. Must use hh:mm:ss format. |
Profiles | Element | 1 | Contains the guest profile information. |
ProfileInfo | Element | 1 | Contains the profile information for the guest. |
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 | Element | 0..1 | Title of the guest (e.g., Mr., Mrs., Dr.). |
GivenName | Element | 1 | First name of the guest. |
Surname | Element | 1 | Last name of the guest. |
Telephone | Element | 0..1 | Contains telephone information related to the guest. |
@PhoneNumber | String | 1 | Contains the actual number (maximum 32 characters). |
Email | Element | 0..1 | Contact email address. |
Address | Element | 0..1 | Address information of the guest. |
AddressLine | Element | 0..2 | 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 | Country name (maximum 64 characters). |
CustLoyalty | Element | 0..n | Contains loyalty information for the guest. |
@ProgramID | String | 1 | Defined membership program name or ID applicable to the program. |
@MembershipID | String | 1 | Account identification number for this particular member in this particular program. |
@ExpireDate | 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). Maximum 64 characters. |
@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. Maximum 64 characters. |
@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. Maximum 64 characters. |
@DocIssueStateProv | String | 0..1 | State or Province where the document was issued (2-8 characters). |
@DocType | String | 1 | Indicates the type of document. Refer to Document Type Code (DOC). |
@EffectiveDate | Date | 0..1 | Indicates the starting date. Must use YYYY-MM-DD format. |
@ExpireDate | Date | 0..1 | Indicates the ending date. Must use YYYY-MM-DD format. |
@Gender | String | 0..1 | Identifies the gender:
|
DocHolderName | Element | 0..1 | The name of the document holder in unformatted text (Mr. Sam Jones). If no DocHolderName is included, the guest name fields will be assumed as the holder name. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
ArrivalTransport | Element | 0..1 | Details about transport to the destination. |
TransportInfo | Element | 1 | Contains transport mode details used by the guest for arrival. |
@Type | String | 0..1 | Type of transport used for arrival, provided by the booking channel. |
@ID | String | 0..1 | Transport provider's ID for the mode of transportation (e.g., Flight Number QF123). |
@Time | DateTime | 0..1 | Arrival time at the destination. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
DepartureTransport | Element | 0..1 | Details about transport from the destination. |
TransportInfo | Element | 1 | Contains transport mode details used by the guest for departure. |
@Type | String | 0..1 | Type of transport used for departure, provided by the booking channel. |
@ID | String | 0..1 | Transport provider's ID for the mode of transportation (e.g., Flight Number QF123). |
@Time | DateTime | 0..1 | Departure time from the destination. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
ResGlobalInfo | Element | 1 | Contains global information about the reservation. |
HotelReservationIDs | Element | 0..1 | Contains the HotelReservationID. |
HotelReservationID | Element | 1 | Reference number/string or PNR as supplied by the booking channel. |
@ResID_Type | String | 1 | Must be set to 14 (Travel Agent PNR). |
@ResID_Value | String | 1 | Actual reference number/string supplied by the booking channel (maximum 64 characters). |
| 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. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
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. |
Tax | Element | 1 | Contains specific tax information. |
@Type | String | 0..1 | Indicates whether the tax is:
|
@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. |
@CurrencyCode | String | 0..1 | Use ISO 4217 currency codes. |
TPA_Extensions | Element | 0..1 | Indicates if the reservation is using the Net amount or Gross amount. Required if the booking channel uses the Commission Percentage feature. |
Total | Element | 1 | Contains the includesCommission information. |
@includesCommission | Boolean | 1 |
When |
| 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). |
@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. Length must not exceed 19 digits. Required if |
@SeriesCode | String | 0..1 | Security number of the card. Only passed through if the booking channel uses Reservation Notification Email. Not stored for PCI compliance. |
@ExpireDate | String | 0..1 | Expiry date of the credit card (format MMyy).Required if CardNumber is provided. |
CardHolderName | Element | 0..1 | Name of the cardholder. |
ThreeDomainSecurity | Element | 0..1 | Contains 3DS (Three Domain Security) transaction details. |
Results | Element | 1 | Transaction results. |
@ThreeDSVersion | String | 1 | 3DS version used for authentication. |
@XID | String | 0..1 | Transaction identifier resulting from authentication processing. When |
@DSTransactionID | String | 0..1 | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. When |
@CAVV | String | 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. |
TPA_Extensions | Element | 0..1 | Additional elements for the transaction. |
VirtualCreditCard | Element | 1 | Denotes that the payment card is a virtual credit card. |
@isVCC | Boolean | 1 | Must be set to true. |
@VCCActivationDate | Date | 0..1 | Date from when the card can be charged. Must use YYYY-MM-DD format. |
@VCCDeactivationDate | Date | 0..1 | Date from when the card is no longer chargeable. Must use YYYY-MM-DD format. |
@VCCCurrentBalance | Decimal | 0..1 | Total amount that can be charged to the card. If the reservation is modified or canceled, an updated balance should be sent indicating the new total amount that can be charged to the card. If the amount changes to 0 as a result of cancellation, the cancellation should be sent with a 0 balance. |
@VCCCurrencyCode | String | 0..1 | Must be included if there is @VCCCurrentBalance. Use ISO 4217 currency codes. |
| 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. |
AcceptedPayments | Element | 0..1 | Contains the accepted payment methods. |
AcceptedPayment | Element | 1 | Specific payment method accepted. |
PaymentCard | Element | 1 | Details of the payment card used for the guarantee. |
@CardType | String | 0..1 | Must be set to 1 (Credit 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. Length must not exceed 19 digits. |
@SeriesCode | String | 0..1 | Security number of the card. Only passed through if the booking channel uses Reservation Notification Email. Not stored for PCI compliance. |
@ExpireDate | String | 0..1 | Expiry date of the credit card (format MMyy). |
CardHolderName | Element | 0..1 | Name of the cardholder. |
ThreeDomainSecurity | Element | 0..1 | Contains 3DS (Three Domain Security) transaction details. |
Results | Element | 1 | Transaction results. |
@ThreeDSVersion | Element | 1 | 3DS version used for authentication. |
@XID | String | 0..1 | Transaction identifier resulting from authentication processing. When |
@DSTransactionID | String | 0..1 | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. When |
@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. |
TPA_Extensions | Element | 0..1 | Additional elements for the transaction. |
VirtualCreditCard | Element | 1 | Denotes that the payment card is a virtual credit card. |
@isVCC | Boolean | 1 | Must be set to true. |
@VCCActivationDate | Date | 0..1 | Date from when the card can be charged. |
@VCCDeactivationDate | Date | 0..1 | Date from when the card is no longer chargeable. |
@VCCCurrentBalance | Decimal | 0..1 | Total amount that can be charged to the card. If the reservation is modified or canceled, an updated balance should be sent indicating the new total amount that can be charged to the card. If the amount changes to 0 as a result of cancellation, the cancellation should be sent with a 0 balance. |
@VCCCurrencyCode | String | 0..1 | Must be included if there is @VCCCurrentBalance. Use ISO 4217 currency codes. |
AmountPercent | Element | 1 | Mandatory when something is passed in the DepositPayment element. |
@Amount | Decimal | 1 | Amount charged as deposit. |
@CurrencyCode | String | 1 | Use ISO 4217 currency codes. |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
Profiles | Element | 1 | Contains the profiles related to the reservation, including the customer, corporate and/or travel agent. |
ProfileInfo | Element | 1..3 | Contains information about the profile type. |
Profile | Element | 1 | Contains profile details, such as customer, company, or travel agent information. |
@ProfileType | String | 1 | Defines the type of profile:
|
UniqueID | Element | 0..1 | Only used on ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) to identify the unique ID of the agent. |
@ID | String | 1 | Identification number, such as a corporate ID or travel agent ID (e.g., IATA code). |
Customer | Element | 1 | Used for ProfileType 1 to contain customer details. |
PersonName | Element | 1 | Contains the name information for the customer. |
NamePrefix | Element | 0..1 | Title of the customer (e.g., Mr., Mrs., Dr.). |
GivenName | Element | 1 | First name of the customer. |
Surname | Element | 1 | Last name of the customer. |
CompanyInfo | Element | 1 | Used for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) to contain company information. |
CompanyName | Element | 1 | Name of the company. |
Telephone | Element | 0..1 | Contains telephone information related to the profile. |
TelephoneInfo | Element | 0..1 | Only used for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) |
@PhoneNumber | String | 1 | Contains the actual number (maximum 32 characters). |
Email | Element | 0..1 | Contact email address related to the profile. |
Address | Element | 0..1 | Address information for the profile. |
AddressInfo | Element | 0..1 | Only used for ProfileType 3 (Corporate) and ProfileType 4 (Travel Agent) |
AddressLine | Element | 0..2 | One or more address lines for the profile. |
CityName | Element | 0..1 | City of the profile's residence. |
PostalCode | Element | 0..1 | Postal code of the profile. |
StateProv | Element | 0..1 | State or province of the profile's residence. |
CountryName | Element | 0..1 | Country of the profile's residence (maximum 64 characters). |
| Element / @Attribute | Type | M | Description |
|---|---|---|---|
OTA_HotelResNotifRS | Element | 1 | Root element for the response. |
@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 response was generated. |
@Version | String | 1 | Specifies the API version. Will be set to 1.0. |
Success | Element | 0..1 | Indicates successful processing of the request. |
HotelReservations | Element | 1 | Contains details of the reservation made. |
HotelReservation | Element | 1 | Individual hotel reservation information. |
UniqueID | Element | 1 | Unique identifier for the reservation. |
@Type | String | 1 | Will be set to 14 (Reservation). |
@ID | String | 1 | Actual confirmation number. |
ResGlobalInfo | Element | 1 | Contains global information about the reservation. |
HotelReservationIDs | Element | 1 | Contains the HotelReservationID. |
HotelReservationID | Element | 1 | Reference number/string or PNR. |
@ResID_Type | String | 1 | Will be set to 14 (Travel Agent PNR). |
@ResID_Value | String | 1 | The identifier of the reservation created by SiteMinder. |
Errors | Element | 0..1 | Indicates an error occurred during the processing of the request. |
Error | Element | 1..n | Single error information containing free text. |
@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). |
Maximum Content XML
This example provides a general XML for a reservation that includes a service at the `RoomStay` level, along with a guarantee using a virtual credit card. This example is designed to demonstrate the structure and key elements for such a booking scenario. Variations of this reservation can be created based on specific requirements, as long as they adhere to the [specifications](https://developer.siteminder.com/siteminder-apis/channels/introduction/siteconnect/api-reference/reservations). The `` comments within the XML indicate areas where further elements may be added if needed for other configurations. ```xmlHow can we avoid overbooking?
While overbooking is rare, it can occur when the last available room is booked simultaneously across multiple channels. **SiteConnect Behaviour:** * Accepts all valid reservations received * Sends all bookings to the property * Does not reject reservations based on availability **Resolution:** * The property typically works directly with booking channels to resolve overbookings * Hotels may honor all reservations and arrange alternative accommodation if needed * Your channel's policy determines how overbookings are handled with guests **Prevention:** * Ensure fast response times to availability updates * Process availability changes immediately upon receiving them * Implement real-time inventory management in your systemAfter sending a cancelled reservation, why didn't availability increase?
This is **standard SiteMinder functionality**. Cancelled reservations (or modifications that reduce room bookings) do not automatically increase availability. **Standard Behavior:** * Availability is **hotel-controlled** or **PMS-controlled** * Hotels must manually update availability after cancellations * SiteMinder processes the cancellation but doesn't adjust inventory automatically **Auto-Replenishment Option:** If the hotel has enabled Auto-Replenishment in SiteMinder settings: * System automatically increases availability for cancelled rooms * You will receive updated availability via `OTA_HotelAvailNotifRQ` * This setting is property-specific and not enabled by defaultWhat happens if a hotel unmaps a room rate or disables the channel, and a reservation is received?
SiteConnect will **still accept the reservation**, but availability handling differs: **Unmapped Room Rate:** * Reservation is accepted and stored * **Availability is NOT adjusted** (booking can't be assigned to a room type) * Hotel sees the reservation but must manually manage it **Disabled Channel:** * Reservation is accepted and stored * **Availability is adjusted** in SiteMinder * Updated availability is **NOT sent back** to your channel (channel is disabled) **Best Practice:** * Validate room rate mappings exist before sending reservations * Monitor for unmapped room rate errors in your integration logsIs it possible to get the status or confirmation of a reservation after sending it?
No, SiteConnect does not provide reservation status queries or confirmations. **Reservation Flow:** 1. Booking channel sends `OTA_HotelResNotifRQ` 2. SiteMinder responds with `OTA_HotelResNotifRS` (Success or Error) 3. **Success means:** Reservation received and accepted 4. **After acceptance:** Reservation is confirmed and delivered to PMS. Also, availability is updated and distributed to all channels **No Status Changes:** * Once accepted, reservations are considered confirmed and valid * No "pending" or "processing" status exists * No query endpoint to check reservation status **Error Handling:** If you receive an Error response, the reservation was **not** accepted. Fix the issue and resend the complete reservation.In what instances can a reservation fail to be received by SiteConnect?
Reservations can fail for the following reasons: **XML/Format Issues:** * Incorrect XML structure (invalid elements or attributes) * Missing mandatory fields * Invalid data types or formats **Authentication Issues:** * Invalid username or password * Missing or malformed Security Header **Hotel Configuration:** * `HotelCode` not found in SiteMinder database * Hotel not configured for your channel **Important:** SiteConnect **will still accept** reservations even if: * Hotel lacks availability (no availability validation) * Room rates are not mapped in SiteMinder Platform * Rate plans don't match **Error Response:** Failed reservations return `OTA_HotelResNotifRS` with `What data should I include in modified or cancelled reservation messages?
Include **all data from the original reservation** plus the modification/cancellation details. **Required for Modifications (`ResStatus="Modify"`):** * Complete original reservation data * Updated values (dates, rates, guests, etc.) * `CreateDateTime` (original booking time) * `LastModifyDateTime` (when modification occurred) **Required for Cancellations (`ResStatus="Cancel"`):** * Complete original reservation data * `CreateDateTime` (original booking time) * `LastModifyDateTime` (when cancellation occurred) * Updated VCC balance (set to 0.00 or cancellation policy amount) **Why Complete Data Required:** * SiteMinder **rewrites the entire reservation** on modifications/cancellations * Missing data causes hotels to lose important information * Data flows to connected PMS/CRS systems * Incomplete data may cause PMS integration failuresAre credit card details visible to the hotel?
Yes, hotels can view credit card details in SiteMinder Platform, **except CVV/CVC**. **Visible to Hotel:** * Card number * Cardholder name * Expiry date * Card type/code * VCC details (if applicable) **Not Visible in Platform:** * CVV/CVC (Card Security Code) **CVV/CVC Delivery:** * Only available in **Reservation Notification Email** (if enabled for your channel) * Never stored in SiteMinder database (PCI compliance) * Never passed to PMS systems **PMS Integration:** If the property has a PMS connected to SiteMinder that supports credit card details, the same information (excluding CVV/CVC) is forwarded to the PMS.Is it okay to make a booking without payment details?
Yes, payment details are **optional**. Both `Guarantee` and `DepositPayments` sections can be omitted. **Use Cases for No Payment Details:** * Pay-at-property bookings * Invoiced reservations * Alternative payment methods not supported in API * Free stays or complimentary bookings **When to Include Payment Details:** * Credit card guarantee provided * Deposit collected * Virtual Credit Card (VCC) issued * Payment already processed SiteMinder accepts reservations regardless of payment information presence.What is the advantage of sending VCC instead of standard credit cards?
Virtual Credit Cards (VCC) provide significant advantages for reservation processing: **Security and Accuracy:** * **Reduced errors:** VCC details clearly displayed in SiteMinder Platform * **Direct PMS reading:** PMS systems can read VCC information automatically * **Minimized human error:** Less manual card entry required * **Controlled usage:** VCC limits and activation/deactivation dates prevent misuse **Payment Processing:** * **SiteMinder Pay integration:** Simplifies transactions for hotels using SiteMinder Pay * **Clear balance tracking:** `VCCCurrentBalance` shows exact chargeable amount * **Modification handling:** Easy to update balance for changes/cancellations **Compliance:** * **PSD2 exemption:** VCCs excluded from Strong Customer Authentication requirements * **Faster processing:** No additional authentication steps needed **Recommendation:** VCC is optional but highly recommended when available.Can the VCC CurrencyCode differ from the Reservation Total CurrencyCode?
Yes, the `VCCCurrencyCode` can differ from the reservation's `CurrencyCode`. **Common Scenario:** * Reservation made in one currency (e.g., USD) * Hotel collects in different currency (e.g., NZD) via VCC * Both currencies clearly specified in respective sections **Example:** ```xmlWhat's the difference between Guests and Customers in reservations?
**Guests (`ResGuest`):** * People **staying in the rooms** * Linked to specific RoomStays via `ResGuestRPH` * Can have multiple guests per reservation * Contains: Name, contact details, arrival time, loyalty info, ID documents **Customer (`Profile ProfileType="1"` in `ResGlobalInfo/Profiles`):** * Person who **made the booking** or is the primary contact * Only one customer per reservation * May or may not be staying at the property * Contains: Name, contact details, address **Relationship:** * Guest and Customer can be the same person * Guest and Customer can be different people (e.g., assistant booking for executive) * Customer profile is mandatory, Guest profiles are recommended **Best Practice:** Provide both complete Customer information and individual Guest details when available for better hotel service and PMS integration.The hotel received a booking after the check-in date. Why did this happen?
This can occur when the `CreateDateTime` value sent in the `OTA_HotelResNotifRQ` uses an incorrect time zone offset. SiteConnect transmits the `CreateDateTime` as provided by the channel — if the timestamp is sent as UTC (suffix `Z`) but the actual booking time was in the property's local time zone, the value will be misinterpreted. For example, if a booking was created at 20:57:41 in Jakarta (UTC+7), the correct value should be either: * `2026-04-18T20:57:41+07:00` (local time with offset), or * `2026-04-18T13:57:41Z` (converted to true UTC) Sending `2026-04-18T20:57:41Z` instead tells SiteConnect the booking was made at 20:57 UTC — which converts to 03:57 local time the following day, placing it after the check-in date. SiteConnect converts the received `CreateDateTime` to the property's local time zone without modifying the original value. Ensure your system sends the timestamp in one of the two valid formats above to avoid bookings appearing after the check-in date.How long does SiteConnect integration take?
Approximately **60 days from initiation to production**, including development, testing, certification and pilot phases. For more details, review our [Integration Process](https://developer.siteminder.com/siteminder-apis/integration-process) guide.What are the mandatory components to certify in SiteConnect?
**Mandatory:** * Rooms and Rates * Availability * Stop Sell * Rates (PDP or OBP) * Reservations (Initial Delivery) **Strongly Recommended:** * Minimum Stay on Arrival * Maximum Stay on Arrival * Minimum Stay Through * Maximum Stay Through * Close to Arrival (CTA) * Close to Departure (CTD) * Reservation Modifications and CancellationsWhat test credentials and resources will SiteMinder provide?
**SiteMinder will provide:** * Test endpoints for reservations * Username and Password for authentication * RequestorID (channel code) * Access to test Platform with pre-configured room types and rate plans * WSDL files (Standard and Inlined versions) **Booking Channel must provide:** * Endpoint URL for Rooms and Rates retrieval * Endpoint URL for receiving ARI updates (or single endpoint for both) * Username and Password for SiteMinder to authenticate * HotelCode for test propertyWhat authentication method does SiteConnect use?
SiteConnect uses **WS-Security (WSSE) UsernameToken** authentication in the SOAP Security Header. **Key Requirements:** * Partners provide a single username and password that is global for all hotels * All communication occurs over HTTPS for encryption * Plain text passwords are acceptable within the encrypted HTTPS channel * The `Password @Type` attribute must be: `http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText`Does SiteConnect require separate credentials for each hotel?
No, SiteConnect uses **global authentication** where partners provide a single username and password that applies to all hotels. **How it works:** * The same authentication credentials are used across all properties * The `HotelCode` attribute in each message identifies the specific property * This simplifies credential management while maintaining clear property identification **Example:** If you connect 100 hotels through SiteConnect, you use the same username and password for all messages, with each hotel distinguished by its unique HotelCode.We're experiencing WS-Security compatibility issues between .NET and Java. How can we resolve this?
Compatibility issues can occur with WS-Security between .NET and Java frameworks. **Solution:** Adjust .NET to accept WebRequests from Java. Refer to [WSSE Authentication for WebRequest/Response](https://www.codeproject.com/Articles/19339/WSSE-Authentication-for-WebRequest-Response) for detailed implementation guidance, including custom authentication modules.Which Java libraries and versions are recommended for SiteConnect?
SiteMinder's SiteConnect test environment uses: **Java Version:** * Java(TM) SE Runtime Environment (build 1.6.0\_21-b06) * Java HotSpot(TM) 64-Bit Server VM (build 17.0-b16, mixed mode) **Framework:** * Spring Web Services **Required Libraries:** * `spring-ws-core-1.5.9.jar` * `spring-ws-security-1.5.9.jar` **Note**: These are reference versions used in SiteMinder's environment. Newer compatible versions may also work.What is the message exchange model for SiteConnect?
SiteConnect uses a **hybrid PUSH/PULL model**: **PUSH (SiteMinder → Booking Channel):** * Availability updates * Restriction updates * Rate updates **PULL (Booking Channel → SiteMinder):** * Rooms and Rates retrieval (on-demand when mapping is accessed) **PUSH (Booking Channel → SiteMinder):** * Reservations (new bookings, modifications, cancellations)What data will be pushed during first-time connection?
When connecting to SiteConnect for the first time, the system will push **all Availability, Restrictions, and Rates data** to the booking channel. The requests will be sent back-to-back to ensure the booking channel receives all necessary data to synchronize inventory.How many days in advance can SiteConnect send updates?
SiteConnect can send updates for availability, restrictions, and rates up to **750 days in advance**. **Key Points:** * The specific update period is configured by SiteMinder during channel setup * Typical configurations range 365 to 750 days * Each morning, the system automatically adds one new date at the end of the update period to maintain a rolling windowHow does SiteConnect batch and send ARI updates?
**Update Frequency:** * New update rounds are sent every **2 minutes** * Only the most recent version of each room/rate/date combination is sent * Updates per hotel are single-threaded, but multiple hotels update concurrently **Message Structure:** * Each message contains updates for **one room/rate pair only** * Maximum payload: **210 days** (30 date elements × 7-day spans) * Date ranges are bundled based on data consistency * Only changed room/rate/date combinations are sent (delta updates) * When triggered, ALL availability, rate, and restriction values for that combination are included **Response Impact:** * Update frequency depends on how quickly the booking channel responds * Faster responses enable more frequent updatesWhy do we see spikes in ARI updates at certain times?
ARI update patterns are **customer-driven**, not controlled by SiteMinder: **Common Causes:** * Revenue Management Systems (RMS) running scheduled calculations * Hotels manually updating inventory during business hours * Bulk updates across the update period * Time zone differences creating regional activity peaks **Important:** SiteMinder only passes through actual data changes. Non-delta changes are not forwarded to connectivity partners. Updates arrive as changes are made and as quickly as your system accepts them.Does SiteConnect support release period?
No. When a property configures a release period in SiteMinder Platform, the system translates that internally into Stop Sell behaviour for the affected room rates and dates when sending to booking channels.Can we connect using SOAP 1.2?
No, SiteConnect **only supports SOAP 1.1**. If your system uses SOAP 1.2, you must adjust it to use SOAP 1.1 for SiteConnect integration. This is a mandatory requirement.What are the Content-Type requirements?
All SOAP XML requests to SiteMinder must have a Content-Type of **`text/xml; charset=utf-8`**. Other Content-Types will not be accepted.What SSL/TLS versions are supported?
SiteConnect supports **TLS 1.1 and above** (TLS 1.1, TLS 1.2, TLS 1.3). **Requirements:** * Production URI must use HTTPS * SiteMinder does not support self-signed SSL certificatesWhat are the response time expectations?
**Optimal Performance:** * Aim for **1-2 second average** response times * Sub-1-second responses are ideal **Timeout Limits:** * SiteMinder enforces a **20-second timeout** for ARI update requests * This is a failsafe - consistent timeouts or prolonged response times should not occur frequently **Scalability Requirements:** * Conduct thorough performance testing on production servers * Ensure systems can scale with the number of connected hotels * Must handle large data loads (up to 750 days) in short periods * Must accommodate multiple properties going live simultaneouslWill SiteConnect retry failed ARI update requests?
Yes, SiteConnect has an automatic retry system for availability, restrictions, and rate messages: **Retry Behavior:** * Initial timeout: **15 seconds** * Retry interval: Every **2 minutes** * New requests queue until a successful response is received * Connection may be disabled after extended outagesHow should errors be returned in SiteConnect?
Errors must be: * Returned within a **SOAP Envelope** * Use the appropriate response message container: * `OTA_HotelAvailRS` for Rooms and Rates errors * `OTA_HotelAvailNotifRS` for Availability/Restrictions errors * `OTA_HotelRateAmountNotifRS` for Rate errors * `OTA_HotelResNotifRS` for Reservation errors * Include appropriate error codes and descriptive error messages **Important:** For application-level errors, respond with SOAP error messages. Only use HTTP standard error codes (503, 504, etc.) for server-level issues.Are reservation messages processed atomically?
Yes. All messages in SiteConnect are **atomic** - either the entire message succeeds or the entire message fails. If you receive an Error response while pushing reservation messages, **none** of the data in that message was processed. You must fix the error and resend the complete message.What is the HotelCode and why is it important?
The **HotelCode** is a unique identifier for each property within your booking channel system. **Requirements:** * Must be unique for each property per booking channel * Used in every message to identify which property the message relates to * Provided by the booking channel and configured in SiteMinder during setup **Function:** While authentication credentials are global across all hotels, the HotelCode ensures each message is routed to the correct property.| Code | Type |
|---|---|
| 1 | Visa |
| 2 | Passport |
| 3 | Military identification |
| 4 | Drivers license |
| 5 | National identity document |
| 6 | Vaccination certificate |
| 7 | Alien registration number |
| 8 | Insurance policy number |
| 9 | Tax exemption number |
| 10 | Vehicle registration/license number |
| 11 | Border crossing card |
| 12 | Refugee travel document |
| 13 | Pilot's license |
| 14 | Permanent resident card |
| 15 | Redress number |
| 16 | Known traveler number |
| 17 | Non-standard |
| 18 | Merchant mariner |
| 19 | Air Nexus card |
| 20 | Crew member certificate |
| 21 | Passport card |
| 22 | Naturalization certificate |
| Code | Name | Description |
|---|---|---|
| 187 | System currently unavailable | EXPLAIN REASON FOR FAILURE |
| 448 | System error | Invalid Username and/or Password |
| 450 | Unable to process | EXPLAIN REASON FOR FAILURE |
| Code | Name | Description |
|---|---|---|
| 137 | Adult occupancy mismatch | Invalid included occupancy |
| 249 | Invalid rate code | Rate code not found for this hotel |
| 321 | Required field missing | EXPLAIN REASON FOR FAILURE |
| 375 | Hotel not active | EXPLAIN REASON FOR FAILURE |
| 392 | Invalid hotel code | Hotel not found for HotelCode=XXXXXX |
| 397 | Invalid number of adults | Invalid number of adults |
| 402 | Invalid room type | Room type code not found for this hotel |
| 436 | Rate does not exist | EXPLAIN REASON FOR FAILURE |
| 783 | Room or rate not found | Combination of room code and rate code not found for this hotel |
| 842 | Rate not loaded | EXPLAIN REASON FOR FAILURE |
| Code | Name | Reason |
|---|---|---|
| 1 | Unknown | Indicates an unknown error. |
| 2 | No implementation | Indicates that the target business system has no implementation for the intended request. |
| 3 | Biz rule | Indicates that the XML message has passed a low-level validation check, but that the business rules for the request message were not met. |
| 4 | Authentication | Indicates the message lacks adequate security credentials. |
| 5 | Authentication timeout | Indicates that the security credentials in the message have expired. |
| 6 | Authorization | Indicates the message lacks adequate security credentials. |
| 7 | Protocol violation | Indicates that a request was sent within a message exchange that does not align to the message. |
| 8 | Transaction model | Indicates that the target business system does not support the intended transaction-oriented operation. |
| 9 | Authentical model | Indicates the type of authentication requested is not recognized. |
| 10 | Required field missing | Indicates that an element or attribute that is required in by the schema (or required by agreement between trading partners) is missing from the message. |
| 11 | Advisory | |
| 12 | Processing exception | Indicates that during processing of the request that a not further defined exception occurred. |
| 13 | Application error | Indicates that an involved backend application returned an error or warning, which is passed back in the response message. |
| Code | Name |
|---|---|
| 1 | Bed tax |
| 2 | City hotel fee |
| 3 | City tax |
| 4 | County tax |
| 5 | Energy tax |
| 6 | Federal tax |
| 7 | Food & beverage tax |
| 8 | Lodging tax |
| 9 | Maintenance fee |
| 10 | Occupancy tax |
| 11 | Package fee |
| 12 | Resort fee |
| 13 | Sales tax |
| 14 | Service charge |
| 15 | State tax |
| 16 | Surcharge |
| 17 | Total tax |
| 18 | Tourism tax |
| 19 | VAT/GST tax |
| 20 | Surplus Lines Tax |
| 21 | Insurance Premium Tax |
| 22 | Application Fee |
| 23 | Express Handling Fee |
| 24 | Exempt |
| 25 | Standard |
| 26 | Zero-rated |
| 27 | Miscellaneous |
| 28 | Room Tax |
| 29 | Early checkout fee |
| 30 | Country tax |
| 31 | Extra person charge |
| 32 | Banquet service fee |
| 33 | Room service fee |
| 34 | Local fee |
| 35 | Goods and services tax (GST) |
| 36 | Value Added Tax (VAT) |
| 37 | Crib fee |
| 38 | Rollaway fee |
| 39 | Assessment/license tax |
| 40 | Pet sanitation fee |
| 41 | Not known |
| 42 | Child rollaway charge |
| 43 | Convention tax |
| 44 | Extra child charge |
| 45 | Standard food and beverage gratuity |
| 46 | National government tax |
| 47 | Adult rollaway fee |
| 48 | Beverage with alcohol |
| 49 | Beverage without alcohol |
| 50 | Tobacco |
| 51 | Food |
| 52 | Total surcharges |
| 53 | State cost recovery fee |
| 54 | Miscellaneous fee |
| 55 | Destination amenity fee |
Implement an Exponential Backoff strategy:
5 seconds → 10 seconds → 20 seconds → 40 seconds → then every 1 minute until a minimum timeout of 30 minutes.
If the issue persists beyond the timeout, contact our Application Operations team.
| Code | Type |
|---|---|
| 1 | All inclusive |
| 2 | American |
| 3 | Bed & breakfast |
| 4 | Buffet breakfast |
| 5 | Caribbean breakfast |
| 6 | Continental breakfast |
| 7 | English breakfast |
| 8 | European plan |
| 9 | Family plan |
| 10 | Full board |
| 11 | Full breakfast |
| 12 | Half board/modified American plan |
| 13 | As brochured |
| 14 | Room only |
| 15 | Self catering |
| 16 | Bermuda |
| 17 | Dinner bed and breakfast plan |
| 18 | Family American |
| 19 | Breakfast |
| 20 | Modified |
| 21 | Lunch |
| 22 | Dinner |
| 23 | Breakfast & lunch |
| 24 | Lunch and Dinner |
| Code Value | Code Name |
|---|---|
| 1 | Rate description |
| 2 | Property description |
| 3 | Property location |
| 4 | Room information |
| 5 | Guarantee information |
| 6 | Deposit information |
| 7 | Cancellation information |
| 8 | Check in check out information |
| 9 | Extra charge information |
| 10 | Tax information |
| 11 | Service charge information |
| 12 | Package information |
| 13 | Commission information |
| 14 | Miscellaneous information |
| 15 | Promotional information |
| 16 | Inclusion information |
| 17 | Amenity information |
| 18 | Late arrival information |
| 19 | Late departure information |
| 20 | Advanced booking information |
| 21 | Extra person information |
| 22 | Areas served |
| 23 | Onsite facilities information |
| 24 | Offsite facilities information |
| 25 | Onsite services information |
| 26 | Offsite services information |
| 27 | Extended stay information |
| 28 | Corporate booking information |
| 29 | Booking guidelines |
| 30 | Government booking policy |
| 31 | Group booking information |
| 32 | Rate disclaimer information |
| 33 | Visa/travel requirement information |
| 34 | Security information |
| 35 | Onsite recreational activities information |
| 36 | Offsite recreational activities information |
| 37 | General meeting planning information |
| 38 | Group meeting planning information |
| 39 | Contract/negotiated booking information |
| 40 | Travel industry booking information |
| 41 | Meeting room description |
| 42 | Pet policy description |
| 43 | Meal plan description |
| 44 | Family plan description |
| 45 | Children information |
| 46 | Early checkout description |
| 47 | Special offers description |
| 48 | Catering description |
| 49 | Room decor description |
| 50 | Oversold policy description |
| 51 | Last room availability description |
| 52 | Room type upgrade description |
| 53 | Driving directions |
| 54 | Driving directions from the north |
| 55 | Driving directions from the south |
| 56 | Driving directions from the east |
| 57 | Driving directions from the west |
| 58 | Surcharge information |
| 59 | Minimum stay information |
| 60 | Maximum stay information |
| 61 | Check-in policy |
| 62 | Check-out policy |
| 63 | Express check-in policy |
| 64 | Express check-out policy |
| 65 | Facility restrictions |
| 66 | Customs information for material |
| 67 | Seasons |
| 68 | Food and beverage minimums for groups |
| 69 | Deposit policy for master account |
| 70 | Deposit policy for reservations |
| 71 | Restaurant services |
| 72 | Special events |
| 73 | Cuisine description |
| Code Value | Code Name |
|---|---|
| 1 | Over 21 |
| 2 | Over 65 |
| 3 | Under 2 |
| 4 | Under 12 |
| 5 | Under 17 |
| 6 | Under 21 |
| 7 | Infant |
| 8 | Child |
| 9 | Teenager |
| 10 | Adult |
| 11 | Senior |
| 12 | Additional occupant with adult |
| 13 | Additional occupant without adult |
| 14 | Free child |
| 15 | Free adult |
| 16 | Young driver |
| 17 | Younger driver |
| 18 | Under 10 |
| 19 | Junior |
| Code Value | Code Name |
|---|---|
| 1 | Global distribution system (GDS) |
| 2 | Alternative distribution system (ADS) |
| 3 | Sales and catering system (SCS) |
| 4 | Property management system (PMS) |
| 5 | Central reservation system (CRS) |
| 6 | Tour operator system (TOS) |
| 7 | Internet |
| 8 | Kiosk |
| 9 | Agent |
| Code Value | Code Name |
|---|---|
| 1 | Home |
| 2 | Business |
| 3 | Other |
| 4 | Destination |
| Code Value | Code Name |
|---|---|
| 1 | Personal |
| 2 | Business |
| 3 | Listserve |
| 4 | Internet |
| 5 | Property |
| 6 | Sales office |
| 7 | Reservation office |
| 8 | Managing company |
| Code Value | Code Name |
|---|---|
| 1 | Bed tax |
| 2 | City hotel fee |
| 3 | City tax |
| 4 | County tax |
| 5 | Energy tax |
| 6 | Federal tax |
| 7 | Food & beverage tax |
| 8 | Lodging tax |
| 9 | Maintenance fee |
| 10 | Occupancy tax |
| 11 | Package fee |
| 12 | Resort fee |
| 13 | Sales tax |
| 14 | Service charge |
| 15 | State tax |
| 16 | Surcharge |
| 17 | Total tax |
| 18 | Tourism tax |
| 19 | VAT/GST tax |
| 20 | Surplus Lines Tax |
| 21 | Insurance Premium Tax |
| 22 | Application Fee |
| 23 | Express Handling Fee |
| 24 | Exempt |
| 25 | Standard |
| 26 | Zero-rated |
| 27 | Miscellaneous |
| 28 | Room Tax |
| 29 | Early checkout fee |
| 30 | Country tax |
| 31 | Extra person charge |
| 32 | Banquet service fee |
| 33 | Room service fee |
| 34 | Local fee |
| 35 | Goods and services tax (GST) |
| 36 | Value Added Tax (VAT) |
| 37 | Crib fee |
| 38 | Rollaway fee |
| 39 | Assessment/license tax |
| 40 | Pet sanitation fee |
| 41 | Not known |
| 42 | Child rollaway charge |
| 43 | Convention tax |
| 44 | Extra child charge |
| 45 | Standard food and beverage gratuity |
| 46 | National government tax |
| 47 | Adult rollaway fee |
| 48 | Beverage with alcohol |
| 49 | Beverage without alcohol |
| 50 | Tobacco |
| 51 | Food |
| 52 | Total surcharges |
| 53 | State cost recovery fee |
| 54 | Miscellaneous fee |
| 55 | Destination amenity fee |
| Code Value | Code Name |
|---|---|
| 1 | All inclusive |
| 2 | American/full board |
| 3 | Bed & breakfast |
| 4 | Buffet breakfast |
| 5 | Caribbean breakfast |
| 6 | Continental breakfast |
| 7 | English breakfast |
| 8 | European plan |
| 9 | Family plan |
| 10 | Full board |
| 11 | Full breakfast |
| 12 | Half board/modified American plan |
| 13 | As brochured |
| 14 | Room only/European plan |
| 15 | Self catering |
| 16 | Bermuda |
| 17 | Dinner bed and breakfast plan |
| 18 | Family American |
| 19 | Breakfast |
| 20 | Modified |
| 21 | Lunch |
| 22 | Dinner |
| 23 | Breakfast & lunch |
| Code Value | Code Name |
|---|---|
| 1 | Former |
| 2 | Nickname |
| 3 | Alternate |
| 4 | Maiden |
| Code Value | Code Name |
|---|---|
| 1 | Brand reservations office |
| 2 | Central reservations office |
| 3 | Property reservation Office |
| 4 | Property direct |
| 5 | Sales office |
| 6 | Home |
| 7 | Office |
| 8 | Other |
| 9 | Managing company |
| 10 | Mobile |
| Code Value | Code Name |
|---|---|
| 1 | Voice |
| 2 | Data |
| 3 | Fax |
| 4 | Pager |
| 5 | Mobile |
| 6 | TTY |
| 7 | Telex |
| 8 | Voice over IP |
| Code Value | Code Name |
|---|---|
| 1 | Customer |
| 2 | GDS |
| 3 | Corporation |
| 4 | Travel agent |
| 5 | Wholesaler |
| 6 | Group |
| 7 | Tour operator |
| 8 | CRO |
| 9 | Representation company |
| 10 | Internet broker |
| 11 | Airline |
| 12 | Hotel |
| 13 | Car rental |
| 14 | Cruise line |
| 15 | Employee |
| 16 | Event host |
| 17 | Supplier partner |
| 18 | Billing contact |
| 19 | Authorized signer |
| 20 | General service contractor |
| 21 | Arranger |
| 22 | Association |
| 23 | Travel agency |
| Code Value | Code Name |
|---|---|
| 1 | All suite |
| 2 | Budget |
| 3 | Corporate business transient |
| 4 | Deluxe |
| 5 | Economy |
| 6 | Extended stay |
| 7 | First class |
| 8 | Luxury |
| 9 | Meeting/Convention |
| 10 | Moderate |
| 11 | Residential apartment |
| 12 | Resort |
| 13 | Tourist |
| 14 | Upscale |
| 15 | Efficiency |
| 16 | Standard |
| 17 | Midscale |
| 18 | Moderate 2 |
| 19 | Quality |
| 20 | Quality 2 |
| 21 | Unknown |
| 22 | Midscale without F&B |
| 23 | Upper upscale |
| Code Value | Code Name |
|---|---|
| 1 | Customer |
| 2 | CRO (Customer Reservations Office) |
| 3 | Corporation representative |
| 4 | Company |
| 5 | Travel agency |
| 6 | Airline |
| 7 | Wholesaler |
| 8 | Car rental |
| 9 | Group |
| 10 | Hotel |
| 11 | Tour operator |
| 12 | Cruise line |
| 13 | Internet broker |
| 14 | Reservation |
| 15 | Cancellation |
| 16 | Reference |
| 17 | Meeting planning agency |
| 18 | Other |
| 19 | Insurance agency |
| 20 | Insurance agent |
| 21 | Profile |
| 22 | ERSP (Electronic reservation service provider) |
| 23 | Provisional reservation |
| 24 | Travel Agent PNR |
| 25 | Associated reservation |
| 26 | Associated itinerary reservation |
| 27 | Associated shared reservation |
| 28 | Alliance |
| 29 | Booking agent |
| 30 | Ticket |
| 31 | Divided reservation |
| 32 | Merchant |
| 33 | Acquirer |
| 34 | Master reference |
| 35 | Purged master reference |
| 36 | Parent reference |
| 37 | Child reference |
| 38 | Linked reference |
| 39 | Contract |
| 40 | Confirmation number |
| 41 | Fare quote |
| 42 | Reissue/refund quote |
| 43 | Ground transportation supplier |
| 44 | EMD |
| Code | Type |
|---|---|
| AX | American Express |
| BC | Bank Card |
| BL | Carte Bleu |
| CB | Carte Blanche |
| DN | Diners Club |
| DS | Discover Card |
| EC | Eurocard |
| JC | Japanese Credit Bureau Credit Card |
| LC | Local Card |
| MA | Maestro |
| MC | Master Card |
| SO | Solo |
| CU | Union Pay |
| TP | Universal Air Travel Card |
| VE | Visa Electron |
| VI | VIsa |
| Type | Description |
|---|---|
| EXTRA_PERSON | Charges related to extra people |
| EXTRA_BED | Extra bed charges |
| SURCHARGE | Surcharges, for example credit card surcharge |
| MEAL | Charges related to the meal |
| SERVICE | General hotel nominated service charges |
| TOUR | Charges for a tour |
| EVENT | Charges for an event |
| EXTRA | Un-categorised extra added to the reservation |
| OTHER | Any additional charge that does not fall under the above categories, where OTHER is specified more information will be provided in the description |
| Value | Definition |
|---|---|
| 02 or 05 | Fully Authenticated Transaction |
| 01 or 06 | Attempted Authentication Transaction |
| 00 or 07 | Non 3-D Secure Transaction |
| 02, 01, 00 | Mastercard |
| 05, 06, 07 | Visa |
| 05, 06, 07 | Amex |
| 05, 06, 07 | JCB |
| 05, 06, 07 | Diners |
| Value | Definition |
|---|---|
| Y | Successful Authentication |
| N | Failed Authentication |
| U | Unable to Complete Authentication |
| A | Successful Attempts Transaction |
| B | You can proceed to authorisation using the information received |
| R | Authentication Rejected (Merchant must not submit for authorisation) |
| Value | Definition |
|---|---|
| Y | Indicates that the signature of the PARes has been validated successfully and the message contents can be trusted. |
| N | Indicates that the PARes could not be validated. This result could be for a variety of reasons; tampering, certificate expiration, etc., and the result should not be trusted. |
| null | If not sent then null |
| Value | Definition |
|---|---|
| Y | Yes, Bank is participating in 3-D Secure protocol and will return the ACSUrl |
| N | No, Bank is not participating in 3-D Secure protocol |
| U | Unavailable, The DS or ACS is not available for authentication at the time of the request |
| B | Bypass, Merchant authentication rule is triggered to bypass authentication in this use case |
3782 8224 6310 0005
3782 0000 1111 2222
5555 5555 5555 4444
5555 1111 2222 6666
5555 6666 8888 9999
5555 5555 5555 4444
3056 9309 0259 04
3056 1111 2222 33
3056 9300 0902 0004
3056 9311 2111 3222
3852 0000 0232 37
6011 1111 1111 1117
6011 0009 9013 9424
5100 0000 1111 3333
5473 0000 0000 0007
3566 0020 2036 0505
3530 1113 3330 0000
1234 4567 7890 4222
9890 6555 7777 8888
6759 6498 2643 84536799 9901 0000 0000
5555 5555 5555 4444
5200 0078 4000 0022
5506 9274 2731 7625
5506 9208 0924 3667
6334 0000 1111 2222
6767 0000 1111 4444
6200 0000 0000 0005
6200 5555 6666 7777
1000 70000 000112
1000 70000 000155
1000 88888 000155
4917 3000 0000 0008
4917 1111 2222 3333
4242 4242 4242 4242
4000 0019 6000 0008
4035 5010 0000 0008
4000 0200 0000 0000
4111 1111 1111 1111
:circle-bolt: | Quick Start | /pages/iOhKCrpXrBcy2gWC3jcL | |
:signs-post: | Integration Requirements | /pages/P1hia9vBTbBEOX4dyyR5 | |
:code: | API Overview | /pages/uhPRnvUFxSZlVcjiQXPm |
| Item | Details |
|---|---|
| Channel endpoint | https://tpi-channel-api.preprod.smchannelsplus.com/ |
| Export endpoint | https://tpi-export-api.preprod.smchannelsplus.com/ |
| Partner Portal | Access to generate your API ID and API Key, and to create Deals |
| Item | Detail |
|---|---|
| Protocol | REST over HTTPS |
| Format | JSON |
| Authentication | Two-header channel-level (x-sm-api-id + x-sm-api-key) |
| API Specification | OpenAPI (YAML available for download) |
| Header | Description |
|---|---|
x-sm-api-id | Your assigned channel identifier |
x-sm-api-key | Your channel secret key |
| Response Header | Description |
|---|---|
ratelimit-policy | Requests allowed per window, e.g. 100;w=60 means 100 requests per 60 seconds |
ratelimit-limit | Total requests allowed in the current window |
ratelimit-remaining | Requests remaining in the current window |
ratelimit-reset | Seconds until the window resets |
| Policy Type | Description |
|---|---|
free-cancellation | Can be cancelled up to N days before check-in |
non-refundable | Cannot be cancelled; freeCancellationUntilDays is null |
1. Mandatory fields with 1-night room stay for total occupancy
Call the get properties endpoint with mandatory elements only to retrieve a list of properties within the default radius of a lat/long boundary for a stay of more than 1 night. For this scenario use just the total adults and children for the entire reservation.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=-33.9&longitude=151.18&checkin=2025-04-09&checkout=2025-04-11&totalRooms=1&totalAdults=2&totalChildren=1
```
**View Sample Request and Response:**
2. Mandatory fields with more than 1 night with pagination
Call the get properties endpoint with mandatory elements only to retrieve a list of properties within the default radius of a lat/long boundary for a stay of more than 1 night. For this scenario use just the total adults and children for the entire reservation. Request for the second page of this response.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=-33.9&longitude=151.18&checkin=2025-04-12&checkout=2025-04-14&totalRooms=1&totalAdults=2&totalChildren=1&perPage=10&page=1
```
**View Sample Request & Response:**
3. Mandatory fields with 2 room stay
Call the get properties endpoint with mandatory elements only to retrieve a list of properties within the default radius of a lat/long boundary for a stay of more than 1 night. For this scenario provide a breakdown of adult & child occupancy for a 2 room stay.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=-33.9&longitude=151.18&checkin=2025-04-12&checkout=2025-04-14&rooms[0][adults]=2&rooms[0][children]=1&rooms[1][adults]=2&rooms[1][children]=1
```
**View Sample Request & Response:**
4. Mandatory fields within a set radius
Call the get properties endpoint with mandatory elements only to retrieve a list of properties within a specified radius of a lat/long boundary for a stay of more than 1 night. For this scenario use just the total adults and children for the entire reservation.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=-33.9&longitude=151.18&checkin=2025-04-12&checkout=2025-04-14&totalRooms=1&totalAdults=2&totalChildren=1&radius=50
```
**View Sample Request & Response:**
5. Mandatory fields and specific deals only
Call the get properties endpoint with mandatory elements only to retrieve a list of properties within the default radius of a lat/long boundary for a stay of more than 1 night. For this scenario use just the total adults and children for the entire reservation. Additionally specify a deal code and set the deal only flag to receive rates that are part of a deal only. Skip if you will not use the Deals functionality.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=-33.9&longitude=151.18&checkin=2025-04-12&checkout=2025-04-14&totalRooms=1&totalAdults=2&totalChildren=1&dealCodes=bd06c1c5-7efb-47f8-b269-454f48b0fa0e&dealOnly=true
```
**View Sample Request & Response:**
6. Invalid latitude and longitude
Call the get properties endpoint with an invalid lat/long and receive an error.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties?latitude=33.9test&longitude=151.18test&checkin=2025-04-12&checkout=2025-04-14&totalRooms=1&totalAdults=2&totalChildren=1
```
**Error:**
```json
{"errors":[{"code":"InvalidInputError","message":"should be number","meta":{"type":"number","params":{"type":"number"},"keyword":"type","dataPath":".query.latitude","schemaPath":"#/properties/query/properties/latitude/type"}},{"code":"InvalidInputError","message":"should be number","meta":{"type":"number","params":{"type":"number"},"keyword":"type","dataPath":".query.longitude","schemaPath":"#/properties/query/properties/longitude/type"}}]}
```
**View Sample Request & Response:**
1. Mandatory fields with total occupancy set
Call the get property endpoint with mandatory elements only to retrieve a list of room rates at the property for a stay of more than 1 night. For this scenario, use the entire reservation's total number of adults and children.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b?checkin=2025-01-11&checkout=2025-01-13&totalRooms=1&totalAdults=2&totalChildren=1
```
**View Sample Request & Response:**
2. Mandatory fields with room occupancy set
Call the get property endpoint with mandatory elements only to retrieve a list of room rates at the property for a stay of more than 1 night. For this scenario, provide a breakdown of adult & child occupancy for a 2-room stay.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b?checkin=2025-03-04&checkout=2025-03-06&rooms[0][adults]=2&rooms[0][children]=0&rooms[1][adults]=2&rooms[1][children]=1
```
**View Sample Request & Response:**
3. Mandatory fields with deal only
Call the get property endpoint with mandatory elements only to retrieve a list of room rates at the property for a stay of more than 1 night. For this scenario, use the entire reservation's total number of adults and children. Additionally, specify a deal code to receive rates that are part of the deal only. Skip if you will not use the Deals functionality.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b?checkin=2025-04-19&checkout=2025-04-21&totalRooms=1&totalAdults=2&totalChildren=1&dealCode=90508fbd-2b33-44dd-9eb0-948ec4ea086e
```
**View Sample Request & Response:**
4. Invalid Property
Call the get property endpoint with an invalid property uuid and receive an error.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/invalid?checkin=2025-04-19&checkout=2025-04-21&totalRooms=1&totalAdults=2&totalChildren=1
```
**Error:**
```json
{"errors":[{"code":"PropertyNotFoundError","message":"property with spid=invalid not found"}]}
```
**View Sample Request & Response:**
1. Valid room rate
Call the lock a reservation endpoint with a valid array of room rate bookings. Do not set the deal code and deal flag.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b/reservations
```
**Sample Body:**
```json
{
"checkin": "2025-04-19",
"checkout": "2025-04-21",
"rooms": [
{
"roomRateUuid": "2298f8f6-fb91-4095-b225-9290b6d3c231",
"adults": 2,
"children": 1
}
]
}
```
**View Sample Request & Response:**
2. Valid room rate with deal code
Call the lock a reservation endpoint with a valid array of room rate bookings. Set the deal code and deal flag, if you choose to use the Deals funtionality.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b/reservations
```
**Sample Body:**
```json
{
"checkin": "2025-04-19",
"checkout": "2025-04-21",
"dealCode": "90508fbd-2b33-44dd-9eb0-948ec4ea086e",
"rooms": [
{
"roomRateUuid": "2298f8f6-fb91-4095-b225-9290b6d3c231",
"adults": 2,
"children": 1,
"applyDeal":true
}
]
}
```
**View Sample Request & Response:**
3. Invalid room rate
Call the lock a reservation endpoint with an invalid room rate UUID and receive an error.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b/reservations
```
**Sample Body:**
```
{
"checkin": "2025-04-19",
"checkout": "2025-04-21",
"rooms": [
{
"roomRateUuid": "invalid",
"adults": 2,
"children": 1
}
]
}
```
**Error:**
```json
{"errors":[{"code":"RoomRateNotFoundError","message":"Some room rates in roomRateUuids=[invalid] not found"}]}
```
**View Sample Request & Response:**
4. Valid room rate with netInvoicing
Note: This is available to partners with a Net Invoicing agreement only, not available to partners operating under a Gross Invoicing model.
Call the lock a reservation endpoint with a valid array of room rate bookings. Set the netInvoicing to true.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/properties/160efac8-7e63-43b2-a1f3-6dbe2cdcfd8b/reservations
```
**Sample Body:**
```json
{
"checkin": "2025-04-19",
"checkout": "2025-04-21",
"netInvoicing": true,
"rooms": [
{
"roomRateUuid": "2298f8f6-fb91-4095-b225-9290b6d3c231",
"adults": 2,
"children": 1
}
]
}
```
**View Sample Request & Response:**
1. Confirm reservation using credit card information
Call the confirm reservation endpoint with a credit card payment type with valid card type, card metadata and guest information.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/48609eca-3/confirmation
```
**Sample Body:**
```json
{
"paymentMethod":"CreditCard",
"cardNumber": 4444333322221111,
"cardholderName": "FirstName LastName",
"cardExpiry": "04/2027",
"cardType": "VI",
"cardCvv": "123",
"guestTitle": "Mr",
"guestFirstName": "FirstName",
"guestLastName": "LastName",
"guestEmail": "test@example.com",
"guestPhoneNumber": "708-406-5153",
"guestAddress": "612 Rusty Glens",
"guestCity": "Fayetteville",
"guestState": "Ava Orchard",
"guestPostcode": "1234",
"guestCountry": "Norfolk Island",
"guestRemarks": "This is for testing purposes",
"rooms": [
{
"roomUuid": "96b1f3bf-eb08-4f85-b059-09e1f3259bab",
"guestTitle": "Mr",
"guestFirstName": "FirstName",
"guestLastName": "LastName",
"guestRemarks": "This is a test"
}
]
}
```
**View Sample Request & Response:**
2. Confirm reservation with a Virtual Credit Card
Call the confirm reservation endpoint with a virtual credit card payment type with valid card type, card metadata and guest information.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/55bfe5bd-3/confirmation
```
**Sample Body:**
```json
{
"paymentMethod":"VirtualCreditCard",
"vccActivationDateTime": "2024-04-25T13:58:56.450Z",
"vccDeactivationDateTime": "2025-05-06T13:58:56.450Z",
"vccCurrency": "AUD",
"vccBalance": 200.2,
"cardNumber": 4444333322221111,
"cardholderName": "FirstName LastName",
"cardExpiry": "07/2025",
"cardType": "VI",
"cardCvv": "123",
"guestTitle": "Mr",
"guestFirstName": "FirstName",
"guestLastName": "LastName",
"guestEmail": "Test@Test.com",
"guestPhoneNumber": "3. Expired Reservation
Call the confirm reservation endpoint with a valid reservation UUID that has now timed out to receive error.
*Note: The timeout window is 15 minutes*
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/6c250a6a-3/confirmation
```
**Sample Body:**
```json
{
"paymentMethod":"VirtualCreditCard",
"vccActivationDateTime": "2024-06-29T19:09:56.450Z",
"vccDeactivationDateTime": "2025-05-10T19:09:56.450Z",
"vccCurrency": "AUD",
"vccBalance": 100.1,
"cardNumber": 4444333322221111,
"cardholderName": "Test Test",
"cardExpiry": "07/2025",
"cardType": "VI",
"cardCvv": "123",
"guestTitle": "Mr",
"guestFirstName": "Test",
"guestLastName": "Test",
"guestEmail": "Test@Test.com",
"guestPhoneNumber": "4. Non-existing Reservation
Call the confirm reservation endpoint with an invalid reservation UUID.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/invalidbookingRef/confirmation
```
**Sample Body:**
```json
{
"paymentMethod":"VirtualCreditCard",
"vccActivationDateTime": "2024-06-29T19:09:56.450Z",
"vccDeactivationDateTime": "2025-05-10T19:09:56.450Z",
"vccCurrency": "AUD",
"vccBalance": 100.1,
"cardNumber": 4444333322221111,
"cardholderName": "Test Test",
"cardExpiry": "07/2025",
"cardType": "VI",
"cardCvv": "123",
"guestTitle": "Mr",
"guestFirstName": "Test",
"guestLastName": "Test",
"guestEmail": "Test@Test.com",
"guestPhoneNumber": "1. Valid modify guest details
Call the modify reservation endpoint with a valid reservation UUID and valid guest details.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/48609eca-3
```
**Sample Body:**
```json
{
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestEmail": "new_test@example.com",
"guestPhoneNumber": "337-861-3753",
"guestAddress": "27314 Leann Tunnel",
"guestCity": "new_city",
"guestState": "new_state",
"guestPostcode": "new_Postcode",
"guestCountry": "new_country",
"guestRemarks": "new_guestRemarks",
"rooms": [
{
"roomUuid": "4b0e1df9-f49d-4655-92e3-eac619299c3d",
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestRemarks": "new_guestRemarks"
}
]
}
```
**View Sample Request & Response:**
2. Modify guest details whilst guest checked-in
Call the modify reservation endpoint with a valid reservation UUID for a reservation that has already been checked in.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/48609eca-3
```
**Sample Body:**
```json
{
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestEmail": "new_test@example.com",
"guestPhoneNumber": "337-861-3753",
"guestAddress": "27314 Leann Tunnel",
"guestCity": "new_city",
"guestState": "new_state",
"guestPostcode": "new_Postcode",
"guestCountry": "new_country",
"guestRemarks": "new_guestRemarks",
"rooms": [
{
"roomUuid": "4b0e1df9-f49d-4655-92e3-eac619299c3d",
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestRemarks": "new_guestRemarks"
}
]
}
```
**Error:**
```json
{
"errors": [
{
"code": "CannotModifyAfterCheckInError",
"message": "cannot modify on or after the check-in date",
"meta": {
"traceToken": "5012c8c8-0c7d-480f-9604-c30944ea548f"
}
}
]
}
```
3. Non-existing reservation
Call the modify reservation endpoint with an invalid reservation UUID.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/d05492f1-x
```
**Sample Body:**
```json
{
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestEmail": "new_test@example.com",
"guestPhoneNumber": "337-861-3753",
"guestAddress": "27314 Leann Tunnel",
"guestCity": "new_city",
"guestState": "new_state",
"guestPostcode": "new_Postcode",
"guestCountry": "new_country",
"guestRemarks": "new_guestRemarks",
"rooms": [
{
"roomUuid": "4b0e1df9-f49d-4655-92e3-eac619299c3d",
"guestTitle": "Ms",
"guestFirstName": "new_FirstName",
"guestLastName": "new_LastName",
"guestRemarks": "new_guestRemarks"
}
]
}
```
**Error:**
```json
{
"errors": [
{
"code": "ReservationNotFoundError",
"message": "reservation not found"
}
]
}
```
1. Cancelled Reservation
Call the cancel reservation endpoint with a valid reservation UUID
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/55bfe5bd-3/cancellation
```
**View Sample Request & Response:**
2. Reservation does not exist
Call the cancel a reservation endpoint with an invalid reservation UUID.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/55bfe5bd-3/cancellation
```
**Error:**
```json
{
"errors": [
{
"code": "ReservationNotFoundError",
"message": "reservation not found"
}
]
}
```
**View Sample Request & Response:**
3. Cancelling outside the cancellation period
Call the cancel a reservation endpoint with a valid reservation UUID for a reservation that is no longer in a free cancellation period.
**Sample Request:**
```
https://tpi-channel-api.preprod.smchannelsplus.com/reservations/328e88f2-3/cancellation
```
**Error:**
```json
{
"errors": [
{
"code": "OutsideCancellationPeriodError",
"message": "cannot cancel outside of cancellation period",
"meta": {
"traceToken": "aec1c423-cab9-47ed-9939-636e6e759c8d"
}
}
]
}
```
**View Sample Request & Response:**
| Parameter | Description | Default | Maximum |
|---|---|---|---|
page | Page number to retrieve | 1 | — |
pageSize | Results per page. Must be a multiple of 10. | 100 | 500 |
| Parameter | Description |
|---|---|
propertyId | UUID of the property whose content you wish to retrieve. |
language | Language(s) in which to return content. Accepts an array. Supported values: en, de, es, fr, it, id, pt, th. |
What is the channel code for Channels Plus?
The Channel code for Channels Plus is CHP. In the reservation that is passed to the property, Channels Plus will be the primary channel on the reservation and the channel that generated the reservation will be the Affiliate channel. This information is also passed to the property in the Reservation XML.How properties setup and manage Channels Plus?
Channels Plus FAQ for properties
What is the Channels Plus Commission Structure
Channel partners receive commission payments through one of two invoicing models: **1. Gross Invoicing (Current Standard Implementation)** This is the primary commission payment method currently used: **Process Flow:** 1. Guest books through partner's platform 2. Partner provides guest's credit card OR Virtual Credit Card (VCC) with 100% booking funds 3. Hotel charges the card for the full reservation amount 4. **Monthly billing cycle**: Hotel receives invoice from Channels Plus for total commission owed on all reservations that checked out in the previous month 5. Hotel pays the commission invoice to SiteMinder 6. **SiteMinder pays the channel partner their commission share** **2. Net Invoicing (Available for Approved Partners)** This involves upfront commission collection: **Process Flow:** 1. Guest books through partner's platform 2. **Partner collects 100% of booking funds upfront from guest** 3. Partner deducts total commission (their share + SiteMinder's share) 4. Partner provides VCC with **net amount** (booking total minus commissions) 5. Hotel charges the VCC for the net amount only 6. Monthly summary provided to hotel (no billing required) 7. **SiteMinder invoices partner separately for SiteMinder's commission portion** #### Commission Structure Each booking has three commission components: * **Total Commission Percentage**: Combined commission for the booking * **Channel Commission Percentage**: Partner's portion * **SiteMinder Commission Percentage**: SiteMinder's portionWhy don't I see any response when calling the Confirm Reservation endpoint?
This is expected behavior. The Channels Plus API does not return a response body for the Confirm Reservation endpoint — the response content will be empty. * If you receive an HTTP 200 OK status, it indicates that your request was successful and the reservation has been confirmed. * If you receive a response containing error details, it means the request was unsuccessful, and the reservation was not confirmed.What is freeCancellationUntilDays?
`freeCancellationUntilDays` specifies the number of days before check-in that a guest can cancel their booking without incurring a penalty. For example, if the value is set to 10, the guest can cancel for free until 10 days prior to check-in. Any cancellations made after this period will incur a penalty of 100% of the booking amount.When Using a Virtual Credit Card (VCC), What Are the Rules?
If using a Virtual Credit Card you must adhere to the following rules: * VCC Activation Date: * Must be on or before the last acceptable cancellation date * If the reservation is non refundable, must be on or before the booking date * Note: The last acceptable cancellation date is calculated by CheckinDate minus freeCancellationUntilDays * VCC Deactivation Date: * Must be at least 7 days after checkout dateWhat should be the currency of the VCC?
The Virtual Credit Card (VCC) must match the currency of the booking. For example, if the booking currency is EUR, the VCC must also be in EUR.| Code | Type |
|---|---|
| 1 | Visa |
| 2 | Passport |
| 3 | Military identification |
| 4 | Drivers license |
| 5 | National identity document |
| 6 | Vaccination certificate |
| 7 | Alien registration number |
| 8 | Insurance policy number |
| 9 | Tax exemption number |
| 10 | Vehicle registration/license number |
| 11 | Border crossing card |
| 12 | Refugee travel document |
| 13 | Pilot's license |
| 14 | Permanent resident card |
| 15 | Redress number |
| 16 | Known traveler number |
| 17 | Non-standard |
| 18 | Merchant mariner |
| 19 | Air Nexus card |
| 20 | Crew member certificate |
| 21 | Passport card |
| 22 | Naturalization certificate |
| Code | Name | Description |
|---|---|---|
| 187 | System currently unavailable | EXPLAIN REASON FOR FAILURE |
| 448 | System error | Invalid Username and/or Password |
| 450 | Unable to process | EXPLAIN REASON FOR FAILURE |
| Code | Name | Description |
|---|---|---|
| 137 | Adult occupancy mismatch | Invalid included occupancy |
| 249 | Invalid rate code | Rate code not found for this hotel |
| 321 | Required field missing | EXPLAIN REASON FOR FAILURE |
| 375 | Hotel not active | EXPLAIN REASON FOR FAILURE |
| 392 | Invalid hotel code | Hotel not found for HotelCode=XXXXXX |
| 397 | Invalid number of adults | Invalid number of adults |
| 402 | Invalid room type | Room type code not found for this hotel |
| 436 | Rate does not exist | EXPLAIN REASON FOR FAILURE |
| 783 | Room or rate not found | Combination of room code and rate code not found for this hotel |
| 842 | Rate not loaded | EXPLAIN REASON FOR FAILURE |
| Code | Name | Reason |
|---|---|---|
| 1 | Unknown | Indicates an unknown error. |
| 2 | No implementation | Indicates that the target business system has no implementation for the intended request. |
| 3 | Biz rule | Indicates that the XML message has passed a low-level validation check, but that the business rules for the request message were not met. |
| 4 | Authentication | Indicates the message lacks adequate security credentials. |
| 5 | Authentication timeout | Indicates that the security credentials in the message have expired. |
| 6 | Authorization | Indicates the message lacks adequate security credentials. |
| 7 | Protocol violation | Indicates that a request was sent within a message exchange that does not align to the message. |
| 8 | Transaction model | Indicates that the target business system does not support the intended transaction-oriented operation. |
| 9 | Authentical model | Indicates the type of authentication requested is not recognized. |
| 10 | Required field missing | Indicates that an element or attribute that is required in by the schema (or required by agreement between trading partners) is missing from the message. |
| 11 | Advisory | |
| 12 | Processing exception | Indicates that during processing of the request that a not further defined exception occurred. |
| 13 | Application error | Indicates that an involved backend application returned an error or warning, which is passed back in the response message. |