Getting Started

Get started with the pmsXchange API and begin your integration with SiteMinder.

Before You Start

What is pmsXchange?

pmsXchange API connects your Property Management System (PMS) with SiteMinder's distribution platform. Through pmsXchange, you can:

Retrieve room type and rate plan mapping configuration
Push availability, restrictions and rates for channel distribution
Receive reservations, modifications and cancellations
Retrieve payment transactions details

API Components:

Configuration: Rooms and Rates
Inventory: Availability and Restrictions, Rates (supports PDP and OBP)
Reservations: PULL or PUSH (delivery method), Upload, Import
Payments: Payment Transaction Record

Explore all components in the API Reference.

Partnership Required

Access to pmsXchange requires an active partnership agreement with SiteMinder. Once your partnership agreement is complete, the Partner Integrations team will contact you with test credentials and setup instructions.

Not a Partner Yet?

Become a SiteMinder Partner

Set Up Your Test Environment

What You'll Receive

SiteMinder will provide:

Test Endpoints and Credentials:

SOAP endpoint: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}
REST endpoint: https://pmsx-core-api.dev.siteminderlabs.com/pmses/{pmsCode}
Username and Password
RequestorID / pmsCode
HotelCode (test property)

Test Platform Access:

Pre-configured room types and rate plans
Reservation simulator to create test bookings
Platform to verify pushed inventory updates

What You'll Provide

If you choose to receive reservations via Reservations PUSH (recommended):

Test endpoint URL (HTTPS)
Authentication credentials (username and password) for SiteMinder
Endpoint must accept OTA_HotelResNotifRQ SOAP messages

Why PUSH? Real-time reservation delivery as soon as bookings are made.

Alternative: PULL - Poll for reservations every 2-5 minutes.

Authentication Models

Choose PMS-level authentication for full API access.

Model

Credentials

SOAP/XML

REST/JSON

PMS-Level (Recommended)

One set for all properties

✅

Hotel-Level (Legacy)

Per-property credentials

✅

❌

Hotel-level authentication is maintained for backward compatibility only. New integrations should use PMS-level to ensure access to all current and future functionality.

WSDL Files

Test Web Service

We provide multiple WSDL variations to accommodate different technology stacks:

Standard WSDL: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange.wsdl
Inlined WSDL (Recommended for .NET): https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_flat.wsdl

Payment Transaction Record

Standard WSDL: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_pms_payments.wsdl
Inlined WSDL (Recommended for .NET): https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_pms_payments_flat.wsdl

For .NET clients, we recommend using the inlined WSDL, as the standard version may cause issues with .NET proxy generators (e.g., wsdl.exe or svcutil.exe) due to OTA specifications.

Test Your Connection

Your PMS can send an OTA_PingRQ request to verify that the test web service is operational and that a connection can be established successfully. The Ping request only validates the endpoint’s availability; it does not verify credentials.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header>
		<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
			<wsse:UsernameToken>
				<wsse:Username>USERNAME</wsse:Username>
				<wsse:Password>PASSWORD</wsse:Password>
			</wsse:UsernameToken>
		</wsse:Security>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<OTA_PingRQ xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="ed8835ff-6198-4f38-b589-3058397f677c" TimeStamp="2024-07-06T15:27:41+00:00" Version="1">
			<EchoData>Hello World</EchoData>
		</OTA_PingRQ>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<SOAP-ENV:Envelope
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<OTA_PingRS
			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/>
			<EchoData>Hello World</EchoData>
		</OTA_PingRS>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Success: You received <Success/> element Failed: Check endpoint URL, network connectivity, and TLS 1.2+ support

Postman Collection

To assist with automating your testing, please fork SiteMinder's PMS Postman Collection, where you will see various request scenarios, as well as the detailed breakdown of the Reservation Certification Scenarios.

Step 1 - Fork SiteMinder's PMS Postman Collection and pmsx-api environment.

Step 2 - Update the PMS environment with your specific details.

Step 3 - Select Run Collections.

Step 4 - After running the collection, a summary will display showing which scenarios passed or failed.

Step 5 - Click View Results to see more details on each test, including the Request sent and the Response received.

For more details on using Postman, see the article Test your API using the Collection Runner.

Build and Certify Your Integration

Start Building

Now that your test environment is ready:

Review component specifications → API Reference
Begin with Rooms and Rates → Retrieve your test hotel configuration
Implement inventory management → Push availability, restrictions, and rates
Set up reservations → Receive bookings via PUSH or PULL
Test additional components → Upload, Import, Payment Transactions

Testing and Certification

Use the Testing and Certification guide to validate your integration:

✅ Required test scenarios (rooms/rates, inventory updates, reservations) ✅ Certification requirements (mandatory vs optional components) ✅ Final submission process

The guide serves as your testing checklist throughout development and final certification validation.

Help Centre

Last updated 2 days ago

Was this helpful?