Rates

Message Exchange Workflow

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

• OTA_HotelRateAmountNotifRS - response sent by pmsXchange to acknowledge receipt.

Request

Examples

Each OTA_HotelRateAmountNotifRQ message must contain a single RateAmountMessages element. The hotel to update is identified using the RateAmountMessages/@HotelCode attribute.

Within RateAmountMessages, the RateAmountMessage elements will contain the specific rate updates to process for a given date range. While multiple RateAmountMessage updates can be included in one request, the request should only target one hotel per message.

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 pmsXchange. Therefore, ensure that the specified rate is in the correct currency as no conversion will be performed.

Rates (PDP)

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-02-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMS1"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="ABC">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-01" End="2025-03-14" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
					<BaseByGuestAmts>
						<BaseByGuestAmt AmountAfterTax="123.00"/>
					</BaseByGuestAmts>
				</Rate>
			</Rates>
		</RateAmountMessage>
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-15" End="2025-03-31" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
					<BaseByGuestAmts>
						<BaseByGuestAmt AmountAfterTax="175.00"/>
					</BaseByGuestAmts>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Rates (OBP)

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

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-02-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMS1"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="ABC">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-01" End="2025-03-10" Mon="1" Tue="1" Weds="1" Thur="1" Fri="1" Sat="1" Sun="1">
					<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"/>
						<AdditionalGuestAmount AgeQualifyingCode="8" Amount="10"/>
					</AdditionalGuestAmounts>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Room Inclusions

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-02-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMS1"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="ABC">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
			<Rates>
				<Rate Start="2025-03-01" End="2025-03-14" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
					<RateDescription>
						<Text>Room Inclusions Text - Ex: Breakfast Included</Text>
					</RateDescription>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Rates + Inclusions

<OTA_HotelRateAmountNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" TimeStamp="2025-02-01T09:30:47-05:00" Version="1.0" EchoToken="echo-abc123">
	<POS>
		<Source>
			<RequestorID Type="22" ID="PMS1"/>
		</Source>
	</POS>
	<RateAmountMessages HotelCode="ABC">
		<RateAmountMessage>
			<StatusApplicationControl InvTypeCode="A1K" RatePlanCode="BAR"/>
			<Rates>
				<Rate CurrencyCode="AUD" Start="2025-03-01" End="2025-03-14" Mon="0" Tue="0" Weds="0" Thur="0" Fri="1" Sat="1" Sun="1">
					<BaseByGuestAmts>
						<BaseByGuestAmt AmountAfterTax="123.00"/>
					</BaseByGuestAmts>
					<RateDescription>
						<Text>Room Inclusion Text (Free WI-FI and Breakfast)</Text>
					</RateDescription>
				</Rate>
			</Rates>
		</RateAmountMessage>
	</RateAmountMessages>
</OTA_HotelRateAmountNotifRQ>

Specification

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.
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 for the rate: 10 Adult 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 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.
RateDescription	Element	0..1	Description of what the rate includes.
Text	Element	1	Inclusion text (maximum 255 characters).

Response

Examples

Success

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

Error

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

Error

Rates OBP Error

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

Specification

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

Testing and Certification

Error Handling

Glossary