SiteMinder APIs
Help CentrePartner ContactsTest Extranet LoginBecome a SiteMinder Partner
  • Hub
  • Quickstart
  • Integration Process
  • CHANNELS
    • Introduction
      • SiteConnect
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservation XML Sample
        • Testing and Certification
        • Changelog
        • FAQ
      • Channels Plus
        • Getting Started
        • Developer Guide
          • Partner Portal
          • Deals
          • Invoicing: Gross vs. Net
        • API Reference
          • Properties
          • Property
          • Lock Reservation
          • Confirm Reservation
          • Modify Reservation
          • Cancel Reservation
        • Testing and Certification
        • Swagger
        • Changelog
        • FAQ
  • PMS / RMS
    • Introduction
      • pmsXchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Rooms and Rates
          • Availability and Restrictions
          • Rates
          • Reservations
            • Reservations PULL
            • Reservations Import
            • Reservations Upload
              • Reservation Types
            • Payment Transaction Record
            • Credit Card Tokenization
            • Reservations XML Samples
              • Reservations PULL Samples
              • Reservations Upload Samples
        • Testing and Certification
        • Changelog
        • FAQ
  • APPS
    • Introduction
      • SiteMinder Exchange
        • Getting Started
        • Developer Guide
          • Integration Requirements
          • Message Structure
          • Error Handling
        • API Reference
          • Availability and Rates
            • Publishers
            • Hotels
            • RoomTypes
            • RatePlans
            • Availability
            • Rates
            • Models
            • Response Samples
              • Publishers Sample
              • Hotels Sample
              • RoomTypes Samples
              • RatePlans Samples
              • Availability Samples
              • Rates Sample
            • ARI 1-Way Guidelines
          • Reservations
            • Maximum Content Sample
            • Minimum Content Sample
        • Testing and Certification
        • Activation & Deactivation Process for Hotels
          • Activation Process for Hotels
          • Activation Form Parameterisation
          • Deactivation Process for Hotels
        • Changelog
          • Reservations API Changelog
          • ARI API Changelog
        • FAQ
  • Additional Resources
    • Reference Tables
      • Booking Agent Codes
      • Document Type Code (DOC)
      • Error Codes (ERR)
      • Error Warning Types (EWT)
      • Fee Tax Type (FTT)
      • Handling HTTP 500
      • Meal Plan Type (MPT)
      • OpenTravel Codes List
      • Payment Card Provider Codes
      • Service and Extra Charge
      • Strong Customer Authentication Codes
      • Test Credit Cards
    • Glossary
    • FAQ
Powered by GitBook
On this page

Was this helpful?

Last updated 2 months ago

Was this helpful?

Message Exchange Workflow

  • OTA_HotelRateAmountNotifRQ - request sent by PMS/RMS to update room rates.

  • OTA_HotelRateAmountNotifRS - response sent by SiteMinder to acknowledge receipt.

Request

Examples

To set Rates, it is mandatory to include the @CurrencyCode attribute in the RateAmountMessage. The rate value provided will be applied directly to SiteMinder without any currency conversion by SiteMinder. Therefore, ensure that the specified rate is in the correct currency as no conversion will be performed.

  • Only adult occupancy rates are supported, indicated by @AgeQualifyingCode="10". Child occupancy rates are not supported.

  • The @NumberOfGuests attribute must specify the adult occupancy as a positive integer between 1 and 5. Sending a value greater than 5 will result in an error.

  • If certain occupancy levels are missing in the request, the Channel Manager will automatically backfill those levels with the provided rate. For example, if only @NumberOfGuests="3" is received, the same rate will apply to occupancies of 1 and 2 guests.

  • While child occupancy rates are not directly supported in the primary rate setup, the AdditionalGuestAmounts element provides a way to include specific charges for extra adults and children as needed.

Specification

Response

Examples

Rates OBP Error

Specification

Element/Attribute
Type
M
Description
Element / @Attribute
Type
M
Description
  1. PMS / RMS
  2. Introduction
  3. pmsXchange
  4. API Reference

Rates

<OTA_HotelRateAmountNotifRQ
	xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMSCODE"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="HOTEL">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="SUP" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-01" End="2025-03-14">
					<BaseByGuestAmts>
						<BaseByGuestAmt AgeQualifyingCode="10" NumberOfGuests="1" AmountAfterTax="100.00"/>
						<BaseByGuestAmt AgeQualifyingCode="10" NumberOfGuests="2" AmountAfterTax="200.00"/>
						<BaseByGuestAmt AgeQualifyingCode="10" NumberOfGuests="3" AmountAfterTax="250.00"/>
						<BaseByGuestAmt AgeQualifyingCode="10" NumberOfGuests="4" AmountAfterTax="300.00"/>
						<BaseByGuestAmt AgeQualifyingCode="10" NumberOfGuests="5" AmountAfterTax="350.00"/>
					</BaseByGuestAmts>
					<AdditionalGuestAmounts>
						<AdditionalGuestAmount AgeQualifyingCode="10" Amount="50"/> <!-- Extra Adult Rate -->
						<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10"/> <!-- Extra Child Rate -->
					</AdditionalGuestAmounts>
				</Rate>
			</Rates>
		</RateAmountMessage>
		<!-- Additional RateAmountMessage elements -->
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>
<OTA_HotelRateAmountNotifRQ
	xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMSCODE"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="HOTEL">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="SUP" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-01" End="2025-03-14">
					<BaseByGuestAmts>
						<BaseByGuestAmt AmountAfterTax="123.00"/>
					</BaseByGuestAmts>
				</Rate>
			</Rates>
		</RateAmountMessage>
		<!-- Additional RateAmountMessage elements -->
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

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.

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

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

@Sun, Mon, Tue, Weds, Thur, Fri, Sat

0..1

The day-of-week indicators are used to specify which days a rate update applies to. These indicators accept values of "0" or "1", where:

  • "1" indicates the update applies to that day.

  • "0" indicates the update does not apply to that day.

BaseByGuestAmts

Element

1

Base charge for a given number of guests.

BaseByGuestAmt

Element

1

Contains individual rate amounts.

@AmountAfterTax

Decimal

0..1

Either @AmountAfterTax or @AmountBeforeTax must be included.

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:

10 Adult

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:

10 Adult (only for PDP)

8 Child

@Amount

Decimal

1

Extra charge amount.

@CurrencyCode

String

0..1

Use ISO 4217 currency codes.

<OTA_HotelRateAmountNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
	<Success/>
</OTA_HotelRateAmountNotifRS>
<OTA_HotelRateAmountNotifRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1.0">
    <Errors>
	<Error Type="6" Code="392">Hotel not found for HotelCode=HOTELCODE</Error>
    </Errors>
</OTA_HotelRateAmountNotifRS>
<OTA_HotelRateAmountNotifRS Version="1.0" TimeStamp="2025-11-01T19:05:22+00:00" EchoToken="echo-abc1234" xmlns="http://www.opentravel.org/OTA/2003/05">
    <Errors>
        <Error Type="3">NumberOfGuests must be equal or between 1 to 5</Error>
    </Errors>
</OTA_HotelRateAmountNotifRS>
  • Request
  • Examples
  • Specification
  • Response
  • Examples
  • Specification
Testing and Certification
Error Handling
Glossary

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

@Code

Integer

0..1

Type of error. Refer to .

Code representing the error. Refer to .

Error Warning Types (EWT)
Error Codes (ERR)