| Note |
|---|
Please check this page regularly for functionality and feature updates to pmsXchange v2. |
...
The Channel Manager has added support for the Payment Card type - Local Card (LC). This card is primarily used in the South Korean market and reservations from HotelsCombined.
...
Profile / Customer / Document
OTA_ResRetrieveRS
Element | Number | Description |
|---|---|---|
Profiles / ProfileInfo | 1..n | Profile information |
ProfileInfo / UniqueID | 0..n | Contains profile ids provided by the source channel. There can 0 to many identifiers passed through here |
@Type | 1 | This will always be "16" to represent 'Reference' from the OTA code table Unique Id Type (UIT) |
@ID | 1 | The reference identifier for the profile as provided by the source channel |
@ID_Context | 1 | This can be one of 2 values: CHANNEL: To specify that this is a channel reference id |
ProfileInfo / Profile | 1 | Contains the profile information |
@ProfileType | 1 | The type of profile See OTA Profile Type (PRT) code table. Some common usages are below 1: Customer |
Profile / Customer | ||
Customer / Document | 0..1 | Detailed document information for the guest (e.g., driver license, passport, visa). |
@DocID | 1 | Unique number assigned by authorities to document. |
@DocType | 1 | Indicates the type of document (e.g. Passport, Military ID, Drivers License, national ID, Vaccination Certificate). Refer to the Document Type Code List |
@Gender | 0..1 | Identifies the gender. Possible values are "Female", "Male", or "Unknown". |
@BirthDate | 0..1 | Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format (YYYY-MM-DD). |
@BirthCountry | 0..1 | Specifies the birth country of the document holder. |
@BirthPlace | 0..1 | Specifies the birth place of the document holder (e.g., city, state, county, province), when designating a country of birth, use BirthCountry. |
@DocHolderNationality | 0..1 | The country code of the nationality of the document holder. |
@DocIssueAuthority | 0..1 | Indicates the group or association that granted the document. |
@DocIssueCountry | 0..1 | Country where the document was issued. |
@DocIssueLocation | 0..1 | Indicates the location where the document was issued. |
@DocIssueStateProvince | 0..1 | State or Province where the document was issued. |
@EffectiveDate | 0..1 | Indicates the starting date, in format YYYY-MM-DD. |
@ExpireDate | 0..1 | Indicates the ending date, in format YYYY-MM-DD. |
Document / DocumentHolderName | 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 to be the name as per passport. |
Customer / PersonName | 0..1 | Profile name details. Always present for type Customer. |
PersonName / NamePrefix | 0..1 | Name prefix |
PersonName / GivenName | 0..1 | The name of the profile. Always present for type Customer. |
PersonName / MiddleName | 0..1 | The middle name of the profile |
PersonName / Surname | 0..1 | The last name of the profile. Always present for type Customer. |
Customer / Telephone | 0..4 | Contact telephone number for the profile if available |
@PhoneNumber | 0..1 | The actual number, will be there if the Telephone element is there |
@PhoneUseType | 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 | 0..1 | The type of phone technology, if not provided it should be assumed as a landline 5: Mobile |
Customer / Email | 0..1 | The email address of the profile if available |
Customer / Address | 0..1 | Address information for the profile if available |
Address / AddressLine | 0..n | One or more address lines for the profile |
Address / CityName | 0..1 | Customer city of residence if available |
Address / PostalCode | 0..1 | Post code for profile if available |
Address / StateProv | 0..1 | State or province name |
Address / CountryName | 0..1 | Country name |
Address / CompanyName | 0..1 | Company name |
Customer / CustLoyalty | 0..1 | A list of Memberships. Memberships provides a list of reward programs. |
@MembershipID | 0..1 | The account identification number for this particular member in this particular program. |
@ProgramID | 0..1 | The defined membership program name or ID applicable to program. This will be in the form as provided by the source booking channel. |
@ExpiryDate | 0..1 | The expiry date of the program membership issued to card holder. Date format is yyyy-MM-dd |
...
| Note |
|---|
SCA functionality is opt-in. If your system is already integrated to pmsXchange, please reach out to the SiteMinder Partner Integrations team to enable this feature. |
OTA_ResRetrieveRS
Element | Number | Description |
|---|---|---|
Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard | 0..1 | Contains payment card information |
@CardCode | 0..1 | The 2 character code of the credit card issuer. Please see the OTA Payment Card Provider Codes table for reference |
| @CardType | 0..1 | The type of payment card, refer to the OTA Card Type code table for reference. Common usages are: 1: Credit |
@CardNumber | 0..1 | The number embossed on the payment card |
@ExpireDate | 0..1 | This is the expiry date of the payment card used in the format MMyy |
| @MaskedCardNumber | 0..1 | May be used to send a concealed or partial credit card number (e.g. "xxxxxxxxxxxx4444" or "4444"). |
| PaymentCard / CardHolderName | 0..1 | This is the name of the card holder. |
| PaymentCard / ThreeDomainSecurity / Results | 0..1 | Transaction results. IMPORTANT NOTE: SCA / 3DS details will only be provided if received from an SCA / 3DS compatible booking agent. Information within the 'ThreeDomainSecurity' element will not be visible in The Channel Manager. |
| @ThreeDSVersion | 1 | The 3DS version used for authentication |
| @ECI | 1 | Electronic Commerce Indicator. Please see Electronic Commerce Indicator Codes table for reference. |
| @CAVV | 0..1 | Cardholder Authentication Verification Value (CAVV); Authentication Verification Value (AVV); Universal Cardholder Authentication Field (UCAF) |
| @PAResStatus | 0..1 | Transactions status result identifier. Please see Transactions Status Result Identifier Codes table for reference. |
| @SignatureVerification | 0..1 | Transaction Signature status identifier. Please see Transaction Signature Status Codes table for reference. |
| @XID | 0..1 | Transaction identifier resulting from authentication processing |
| @Enrolled | 0..1 | Status of Authentication eligibility. Please see Status of Authentication Codes table for reference. |
| @DSTransactionID | 0..1 | Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction |
| Guarantee / Comments / Comment | 0..n | Contains extra information about the payment |
| @Name | 1 | The type of payment information, this can be one of PaymentGatewayName: The name of the payment gateway The comment Name will always be included if a Comment node is present here |
| Guarantee / Comments / Comment / Text | 1 | The actual information related to the payment |
| Guarantee / GuaranteeDescription | 0..1 | |
| Guarantee / GuaranteeDescription / Text | 1 | Information about the form of guarantee |
...
| Element | Number | Description |
|---|---|---|
| BaseByGuestAmts / BaseByGuestAmt | 1 | Contains the rate amounts per room |
@AmountAfterTax | 0..1 | One and only one of @AmountAfterTax and @AmountBeforeTax must be included if BaseByGuestAmts is present. Must be a positive decimal value. |
| @AmountBeforeTax | 0..1 | One and only one of @AmountAfterTax and @AmountBeforeTax must be included if BaseByGuestAmts is present. Must be a positive decimal value. |
Released 09-October-2014
Reservation with one room type booked, but multiple rate plans/codes contained.
Example of a reservation with the a single room type booked but different rate plans and one guest on the reservation level. Reservations like this occur most commonly on Booking.com, where a guest might make a 3 night booking for a room type "DR" - however, Booking.com allocates rate plan "RAC" to the first two nights of the booking, whereas the third night is booked on rate plan "RACX". The reason this happens is because one rate plan may be available when others aren't, allowing Booking.com to stitch together continuous stays from rate plans with different availability. An example of such a reservation is shown below.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
<Success/>
<ReservationsList>
<HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
<POS>
<Source>
<RequestorID Type="22" ID="SITEMINDER"/>
<BookingChannel Primary="true" Type="7">
<CompanyName Code="WTF">Wotif</CompanyName>
</BookingChannel>
</Source>
</POS>
<UniqueID Type="14" ID="WTF-001"/>
<UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
<RoomStays>
<RoomStay>
<RoomRates>
<RoomRate RoomTypeCode="DR" RatePlanCode="RAC" NumberOfUnits="1">
<Rates>
<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-14">
<Total AmountAfterTax="50.00" CurrencyCode="USD"/>
</Rate>
</Rates>
</RoomRate>
<RoomRate RoomTypeCode="DR" RatePlanCode="RACX" NumberOfUnits="1">
<Rates>
<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2013-03-14" ExpireDate="2013-03-15">
<Total AmountAfterTax="40.00" CurrencyCode="USD"/>
</Rate>
</Rates>
</RoomRate>
</RoomRates>
<GuestCounts>
<GuestCount AgeQualifyingCode="10" Count="1"/>
</GuestCounts>
<TimeSpan Start="2013-03-12" End="2013-03-15"/>
<Total AmountAfterTax="90.00" CurrencyCode="USD"/>
<BasicPropertyInfo HotelCode="10107"/>
</RoomStay>
</RoomStays>
<ResGuests>
<ResGuest>
<Profiles>
<ProfileInfo>
<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
<Profile ProfileType="1">
<Customer>
<PersonName>
<GivenName>James</GivenName>
<Surname>Bond</Surname>
</PersonName>
<Telephone PhoneNumber="555-1234"/>
<Email>james.bond@mi5.co.uk</Email>
</Customer>
</Profile>
</ProfileInfo>
</Profiles>
</ResGuest>
</ResGuests>
<ResGlobalInfo>
<Total AmountAfterTax="150.00" CurrencyCode="USD"/>
<HotelReservationIDs>
<HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
</HotelReservationIDs>
</ResGlobalInfo>
</HotelReservation>
</ReservationsList>
</OTA_ResRetrieveRS> |
RoomStayType
Element | Number | Description |
|---|---|---|
| RatePlans / RatePlan | 0..n | Contains information for the Rate Plan(s) used for the RoomStay. There will only ever be one RatePlanCode per RoomStay, however if there are multiple promotions or additional inclusions which span different date ranges there will be multiple RatePlan nodes |
| RoomStay / RoomRates / RoomRate | 1..n | Multiple RoomRates per RoomStay. Multiple rates are listed under each RoomRate. This can happen when there is a single room booked but more than one rate plan applies during the stay. See RoomRateType |
RoomRateType
Element | Number | Description |
|---|---|---|
| RoomStay / RoomRates / RoomRate | 1..n | Multiple RoomRates per RoomStay. Multiple rates are listed under each RoomRate. This can happen when there is a single room booked but more than one rate plan applies during the stay. |
| Code Block | ||
|---|---|---|
| ||
<RoomStay>
<RoomRates>
<RoomRate RoomTypeCode="ROOM1" RatePlanCode="RATE1" NumberOfUnits="1">
<Rates>
<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2012-03-12" ExpireDate="2012-03-13">
<Base AmountBeforeTax="252.00" AmountAfterTax="280.00" CurrencyCode="AUD"/>
</Rate>
</Rates>
</RoomRate>
<RoomRate RoomTypeCode="ROOM1" RatePlanCode="RATE2" NumberOfUnits="1">
<Rates>
<Rate UnitMultiplier="1" RateTimeUnit="Day" EffectiveDate="2012-03-13" ExpireDate="2012-03-14">
<Base AmountBeforeTax="279.00" AmountAfterTax="310.00" CurrencyCode="AUD"/>
</Rate>
</Rates>
</RoomRate>
</RoomRates>
<TimeSpan Start="2012-03-12" End="2012-03-14"/>
<Total AmountBeforeTax="531.00" AmountAfterTax="590.00" CurrencyCode="AUD">
<Taxes>
<Tax Amount="59.00" CurrencyCode="AUD"/>
</Taxes>
</Total>
</RoomStay> |
...