Quick Start

Everything you need to begin building with pmsXchange API.

pmsXchange connects your Property Management System (PMS) or Revenue Management System (RMS) with SiteMinder's distribution platform. Through pmsXchange, your PMS can sync availability, restrictions, and rates, and manage reservations, modifications, and cancellations. RMS integrations support pushing rates and restrictions only.

API Components:

• Configuration: Rooms and Rates

• Inventory: Availability, Restrictions, Rates (PDP or OBP)

• Reservations: Push, Pull, Upload, Import

• Payments: Payment Transaction Record

Explore all components in the API Overview.

---

Before You Begin

Partnership Required

Access to pmsXchange requires an active partnership agreement with SiteMinder. Once your agreement is in place, you will receive your test environment details.

Become a SiteMinder Partner

You don't need to wait for your test environment to start development. You can begin building and testing immediately. See Make Your First Call below or explore requests directly in the Postman collection.

What You'll Provide to SiteMinder

Before SiteMinder can set up your test environment, provide the following:

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 and Rates (SM -> PMS)
Credentials	username and password for SiteMinder to authenticate against your Inventory REST endpoint

What You'll Receive from SiteMinder

Once SiteMinder has received your details, we will provide:

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.

---

Set Up Your Environment

Authentication

pmsXchange uses PMS-level authentication — one set of credentials covers all properties. Credentials are passed via wsse:UsernameToken for SOAP requests and HTTP Basic Auth for REST.

SOAP

<SOAP-ENV:Header>
	<wsse:Security SOAP-ENV:mustUnderstand="1"
		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 Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">PASSWORD</wsse:Password>
		</wsse:UsernameToken>
	</wsse:Security>
</SOAP-ENV:Header>

REST

--header 'Authorization: Basic username:password'

PMS-level vs. Hotel-level authentication

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.

API Specification Files

SOAP (WSDL)

• Standard: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange.wsdl

• Inlined (recommended for .NET): hhttps://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_flat.wsdl

• Payment Transaction Record — Standard: https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_pms_payments.wsdl

• Payment Transaction Record — Inlined (recommended for .NET): https://tpi-pmsx.preprod.siteminderlabs.com/webservices/{RequestorID}/pmsxchange_pms_payments_flat.wsdl

Use the inlined WSDL for .NET clients — the standard version may cause issues with wsdl.exe or svcutil.exe due to OTA specifications.

REST (OpenAPI)

• pmsx-core-api — download YAML

• pmsxultrasync — download YAML

---

Make Your First Call

The first call every pmsXchange integration must implement is Rooms and Rates (SM -> PMS) — your system retrieves the room type and rate plan mapping configured in SiteMinder for a given property. This mapping is the foundation for all subsequent inventory and reservation operations.

1

Authenticate

Pass your username and password on every REST request.

Header: 'Authorization: Basic username:password'

Use SiteMinder's shared test credentials to make this call:

• PMS code: PMSXTEST

• Hotel codes: PMSXTEST1, PMSXTEST2, PMSXTEST3

• Credentials are pre-filled in the Postman collection below.

2

Make the call

Retrieve the room type and rate plan mappings for a test property:

curl -L \
  --url 'https://tpi-pmsx.preprod.siteminderlabs.com/core-api/pmses/{pmsCode}/hotels/{hotelCode}/room-rates' \
  --header 'Authorization: Basic username:password' \
  --header 'X-SM-TRACE-TOKEN: text' \
  --header 'Accept: */*'

3

Handle the response

A successful response returns an array of room type and rate plan combinations configured for the property:

[
  {
    "ratePlanName": "Non-Refundable",
    "ratePlanCode": "NonRef1",
    "roomTypeName": "Dormitory Room",
    "roomTypeCode": "DORM",
    "includedAdultOccupancy": 2
  },
  {
    "ratePlanName": "Best Available Rate",
    "ratePlanCode": "BAR",
    "roomTypeName": "Family Room",
    "roomTypeCode": "FAM",
    "includedAdultOccupancy": 2
  },
  {
    "ratePlanName": "Non-Refundable",
    "ratePlanCode": "NonRef1",
    "roomTypeName": "Family Room",
    "roomTypeCode": "FAM",
    "includedAdultOccupancy": 2
  },
  {
    "ratePlanName": "Best Available Rate",
    "ratePlanCode": "BAR1",
    "roomTypeName": "Dormitory Room",
    "roomTypeCode": "DORM",
    "includedAdultOccupancy": 2
  }

4

Handle errors

If your username or password is incorrect:

{
    "errors": [
        {
            "message": "Unauthorized access",
            "code": "UnauthorizedError",
            "meta": {
                "message": "Authentication failed - received request with invalid Username/Password",
                "code": "UnauthorizedError"
            }
        }
    ]
}

401 - Check your username and password are correct and passed via Basic Auth.

If your HotelCode is incorrect:

{
    "errors": [
        {
            "message": "Not Found",
            "code": "NotFoundError"
        }
    ]
}

404 Not Found - Check your PMS code and hotel code are correct.

---

Explore with Postman

SiteMinder's pmsXchange Postman workspace contains collections and environments to help you build, test, and validate your integration for certification. Fork the collections and environments to your own Postman account to get started.

→ pmsXchange Postman Workspace

Shared Test Credentials

The pmsXchange - Rooms and Rates TEST environment is pre-filled with shared test credentials (PMSXTEST / PMSXTEST1–3). You can use these immediately — no dedicated test account required — to test:

• Rooms and Rates mapping retrieval

• Pushing availability, restrictions, and rates

• Pulling reservations (no reservations will be returned on shared test accounts)

Update the environment variables with your credentials once your test environment is set up.

For full certification scenario coverage, see Testing and Certification.

Still have questions?

Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.

If you need more support, visit Integration Support.