Versions Compared

Old Version 4

changes.mady.by.user Malin Atkins

Saved on

compared with

New Version Current

changes.mady.by.user Kevin Allsworth

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This example covers the case where the booking agent sends us one RoomStay with more than 1 guest. All ResGuests are linked to the single RoomStay.

NOTE: Some of the sections are left out for clarity, as they don't impact on this example. Follow on from the example in the OTA_ResRetrieveRS to fill in the missing bits

<RoomStays> <RoomStay> <!--DETAILS OMITTED --> <ResGuestRPHs> <ResGuestRPH RPH="1"/> <ResGuestRPH RPH="2"/> </ResGuestRPHs> </RoomStay> </RoomStays> <ResGuests>
Code Block
xmlxml
Note

As part of our PCI compliance, all credit cards details are removed after a grace period. Therefore, these credit card details need to be picked up before a predetermined cutoff.

Table of Contents

Credit Card Details

Reservations with guarantee credit card details.

Code Block
languagexml
<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="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
									<Total AmountAfterTax="50.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="150.00" CurrencyCode="USD"/>
					<BasicPropertyInfo HotelCode="10107"/>
					<ResGuestRPHs>
						<ResGuestRPH RPH="1"/>
					</ResGuestRPHs>
				</RoomStay>
			</RoomStays>
			<ResGuests>
				<ResGuest ResGuestRPH="1" ArrivalTime="10:30:00">
					<Profiles>
						<ProfileInfo>
							<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
							<Profile ProfileType="1">
								<Customer>
									<PersonName>
										<GivenName>James</GivenName>
										<Surname>Bond</Surname>
									</PersonName>
								</Customer>
							</Profile>
						</ProfileInfo>
					</Profiles>
				</ResGuest>
			</ResGuests>
			<ResGlobalInfo>
				<Guarantee>
					<GuaranteesAccepted>
						<GuaranteeAccepted>
							<PaymentCard CardCode="VI" CardType="1" CardNumber="4444444444444444" ExpireDate="1114">
								<CardHolderName>Bruce  <Profiles>
      <ProfileInfo>
        <Profile ProfileType="1">
          <Customer>
            <PersonName>
              <GivenName>James</GivenName>
              <Surname>Bond</Surname>
            </PersonName>
            <!--DETAILS OMITTED -->
          </Customer>
        </Profile>
      </ProfileInfo>
    </Profiles>
  </ResGuest>
  <ResGuest ResGuestRPH="2Wayne</CardHolderName>
							</PaymentCard>
						</GuaranteeAccepted>
					</GuaranteesAccepted>
				</Guarantee>
				<Total AmountAfterTax="150.00" CurrencyCode="USD"/>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</ReservationsList>
</OTA_ResRetrieveRS>

...

Deposit Payment

Reservations with deposit payment and a deposit description element.

Code Block
languagexml
<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="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
									<Total AmountAfterTax="50.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="150.00" CurrencyCode="USD"/>
					<BasicPropertyInfo HotelCode="10107"/>
					<ResGuestRPHs>
						<ResGuestRPH RPH="1"/>
					</ResGuestRPHs>
				</RoomStay>
			</RoomStays>
			<ResGuests>
				<ResGuest ResGuestRPH="1" ArrivalTime="10:30:00">
					<Profiles>
						<ProfileInfo>
							<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
							<Profile ProfileType="1">
								<Customer>
									<PersonName>
										<GivenName>James</GivenName>
										<Surname>Bond</Surname>
									</PersonName>
								</Customer>
							</Profile>
						</ProfileInfo>
					</Profiles>
				</ResGuest>
			</ResGuests>
			<ResGlobalInfo>
				<DepositPayments>
					<GuaranteePayment>
						<AmountPercent Amount="30.00" CurrencyCode="USD" Percent="20.00"/>
						<Description>
							<Text>20% Deposit</Text>
						</Description>
					</GuaranteePayment>
				</DepositPayments>
				<Total AmountAfterTax="150.00" CurrencyCode="USD"/>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</ReservationsList>
</OTA_ResRetrieveRS>

...

Credit Card Details and Deposit Payment

Reservations with guarantee credit card details and deposit payment.

Code Block
languagexml
<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="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
									<Total AmountAfterTax="50.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="150.00" CurrencyCode="USD"/>
					<BasicPropertyInfo HotelCode="10107"/>
					<ResGuestRPHs>
						<ResGuestRPH RPH="1"/>
					</ResGuestRPHs>
				</RoomStay>
			</RoomStays>
			<ResGuests>
				<ResGuest ResGuestRPH="1" ArrivalTime="10:30:00">
					<Profiles>
						<ProfileInfo>
							<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
							<Profile  <Profiles>
      <ProfileInfo>
        <Profile ProfileType="1">
          <Customer>
            <PersonName>
              <GivenName>Honey</GivenName>
              <Surname>Rider</Surname>
            </PersonName>
            <!--DETAILS OMITTED -->
          </Customer>
        </Profile>
      </ProfileInfo>
    </Profiles>
  </ResGuest>
</ResGuests>

ProfileType="1">
								<Customer>
									<PersonName>
										<GivenName>James</GivenName>
										<Surname>Bond</Surname>
									</PersonName>
								</Customer>
							</Profile>
						</ProfileInfo>
					</Profiles>
				</ResGuest>
			</ResGuests>
			<ResGlobalInfo>
				<Guarantee>
					<GuaranteesAccepted>
						<GuaranteeAccepted>
							<PaymentCard CardCode="VI" CardType="1" CardNumber="4444444444444444" ExpireDate="1114">
								<CardHolderName>Bruce Wayne</CardHolderName>
							</PaymentCard>
						</GuaranteeAccepted>
					</GuaranteesAccepted>
				</Guarantee>
				<DepositPayments>
					<GuaranteePayment>
						<AmountPercent Amount="30.00" CurrencyCode="USD" Percent="20.00"/>
						<Description>
							<Text>20% Deposit</Text>
						</Description>
					</GuaranteePayment>
				</DepositPayments>
				<Total AmountAfterTax="150.00" CurrencyCode="USD"/>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</ReservationsList>
</OTA_ResRetrieveRS>

...

Payment Gateway

Example of a reservation with a payment reference id.

Code Block
languagexml
<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="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
									<Total AmountAfterTax="50.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="150.00" CurrencyCode="USD"/>
					<BasicPropertyInfo HotelCode="10107"/>
					<ResGuestRPHs>
						<ResGuestRPH RPH="1"/>
					</ResGuestRPHs>
				</RoomStay>
			</RoomStays>
			<ResGuests>
				<ResGuest ResGuestRPH="1" ArrivalTime="10:30:00">
					<Profiles>
						<ProfileInfo>
							<UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
							<Profile ProfileType="1">
								<Customer>
									<PersonName>
										<GivenName>James</GivenName>
										<Surname>Bond</Surname>
									</PersonName>
								</Customer>
							</Profile>
						</ProfileInfo>
					</Profiles>
				</ResGuest>
			</ResGuests>
			<ResGlobalInfo>
				<Guarantee>
					<GuaranteesAccepted>
						<GuaranteeAccepted/>
					</GuaranteesAccepted>
					<Comments>
						<Comment Name="PaymentGatewayName">
							<Text>Paypal</Text>
						</Comment>
						<Comment Name="PaymentGatewayAuthCode">
							<Text>123143253467</Text>
						</Comment>
						<Comment Name="PaymentReferenceId">
							<Text>123124151616</Text>
						</Comment>
					</Comments>
					<GuaranteeDescription>
						<Text>Payment accepted up front</Text>
					</GuaranteeDescription>
				</Guarantee>
				<Total AmountAfterTax="150.00" CurrencyCode="USD"/>
				<HotelReservationIDs>
					<HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
				</HotelReservationIDs>
			</ResGlobalInfo>
		</HotelReservation>
	</ReservationsList>
</OTA_ResRetrieveRS>