Data Warehouse Delivery - Reservations | SynXis Developer Portal

Enhanced to support the following functionality: Pass Through Point Redemption; Identifier for FinTech payment methods.

Pass Through Point Redemption (FEA90497)

For hotel chains using their own Custom Booking Engine (CBE), the ability to make point redemption reservations directly with their Customer Relationship Management (CRM) vendor and communicate the redemption information to the PMS is crucial for supporting the loyalty program and enhancing the overall guest experience. SynXis can receive information from the CBE that a redemption has occurred and will store it and pass information to a Data Warehouse.

Data Warehouse Reservation delivery will be enhanced to communicate the following redemption details for points redemption bookings:

ProgramName - Loyalty program
MemberNumber - Member number
ID - Award number
ID_Context - Award type
Total points redeemed
RedemptionCash - Total cost of booking not covered by points for points and cash redemptions

<RoomStay>
	...
	<Guarantee GuaranteeCode="GCC"
	           GuaranteeType="GuaranteeRequired">
		<GuaranteesAccepted>
			<GuaranteeAccepted>
				<LoyaltyRedemption MemberNumber="MEMBERSHIPNUMBER"
				                   ProgramName=" LOYALTYPROGRAMCODE"
				                   RedemptionQuantity="10000">
					<LoyaltyCertificate ID="AWARDNUMBER"
					                    ID_Context="AWARDTYPECODE"/>
				</LoyaltyRedemption>
			</GuaranteeAccepted>
		</GuaranteesAccepted>
		<GuaranteeDescription>
			<Text>Hotel requires credit card guarantee</Text>
		</GuaranteeDescription>
	</Guarantee>
	<Total CurrencyCode="USD"
	       AmountBeforeTax="100.00">
		<Taxes Amount="0.00"
		       CurrencyCode="USD"/>
		<TPA_Extensions>
			<PointsRedemptionInfo CurrencyCode="USD"
			                      RedemptionCash="100.00"/>
		</TPA_Extensions>
	</Total>
	...
</RoomStay>

Identifier for FinTech payment methods (FEA92354)

When the guest’s reservation has a Fintech Provider stored as the Fintech Payment Provider in the reservation and the CC used is for Guarantee, then the Fintech Provider code will be passed in the / HotelReservations / HotelReservation / RoomStays / RoomStay / Guarantee / GuaranteesAccepted / GuaranteeAccepted / PaymentCard / TPA_Extensions section:

TPA_Extensions/ TPA_Extensions/FintechPaymentProvider
FintechPaymentProvider/@Code - Fintech Provider code (10 characters max)

Example:

<Guarantee GuaranteeCode="GCC"
           GuaranteeType="GuaranteeRequired">
	<GuaranteesAccepted>
		<GuaranteeAccepted>
			<PaymentCard CardType="1"
			             CardCode="VI"
			             CardNumber=" XXXXXXXXXXX2111"
			             SeriesCode="123"
			             ExpireDate="1225">
				<CardHolderName>TESTBOOKER</CardHolderName>
				<TPA_Extensions>
					<FintechPaymentProvider Code="FLEXPAY"/>
				</TPA_Extensions>
			</PaymentCard>
		</GuaranteeAccepted>
	</GuaranteesAccepted>
	<GuaranteeDescription>
		<Text>Hotel requires credit card guarantee</Text>
	</GuaranteeDescription>
</Guarantee>

When the guest’s reservation has a Fintech Provider stored as the Payment Provider in the reservation and the CC used is for Deposit, then the Fintech Provider code will be passed in the / HotelReservations / HotelReservation / RoomStays / RoomStay /DepositPayment/ GuaranteePayment / AcceptedPayments / AcceptedPayment / PaymentCard / TPA_Extensions section:

TPA_Extensions/ TPA_Extensions/FintechPaymentProviderFintechPaymentProvider/@Code - Fintech Provider code (10 characters max)

Example:

<DepositPayments>
	<GuaranteePayment>
		<AcceptedPayments>
			<AcceptedPayment PaymentTransactionTypeCode="reserve">
				<PaymentCard CardType="1"
				             CardCode="VI"
				             CardNumber="XXXXXXXXXXX2111"
				             ExpireDate="XXXX">
					<CardHolderName>TestName TestSurname</CardHolderName>
					<TPA_Extensions>
						<FintechPaymentProvider Code="FLEXPAY"/>
					</TPA_Extensions>
				</PaymentCard>
			</AcceptedPayment>
		</AcceptedPayments>
		<AmountPercent Amount="636.50"
		               CurrencyCode="USD"/>
		<Deadline OffsetTimeUnit="Day"
		          OffsetUnitMultiplier="0"
		          OffsetDropTime="AfterBooking"/>
	</GuaranteePayment>
</DepositPayments>

Updated to support new functionality from the following enhancements: Include VAT Information in Reservation Delivery, Tracking an External System User’s API transactions, Loyalty Accrual Indicator, and Indicate Tax Rules On Rate Plans.

Include VAT Information in Reservation Delivery (FEA91049)

Configure in Administration > Hotel > Hotel Maintenance > Enable Billing Address Fields
(Current attribute to enable the ability to capture VAT Billing Details on reservations in SynXis CRS)

Currently, SynXis CRS hosts functionality to capture VAT Billing Detail information on reservations made on SBE and SVA. The data warehouse feed (DWH) has been enhanced to communicate this information when provided on a reservation allowing for centralized data warehousing.

By default, the hotel attribute for enabling VAT Billing details is turned off. This must be enabled to provide the opportunity for this information to be entered and captured on reservations. The information will always be included in integrating reservation messages whenever the details are present on a reservation in SynXis CRS.

Example: OTA_HotelResNotifRQ xml snippet (See full specification for official use case definitions)

<HotelReservation>
	...
	<TPA_Extensions>
		...
		<BillingInformation>
			<VAT CompanyName="VatCompanyName"
			     VATNumber="123456789">
				<Address>
					<AddressLine>VatAddress1</AddressLine>
					<AddressLine>VatAddress2</AddressLine>
					<AddressLine>VatAddress3</AddressLine>
					<CityName>VatCity</CityName>
					<PostalCode>11111</PostalCode>
					<CountryName>US</CountryName>
				</Address>
				<Telephone PhoneTechType="1"
				           PhoneNumber="1-111-111-1111"
				           FormattedInd="false"
				           DefaultInd="false"/>
				<Email>VatEmail</Email>
			</VAT>
		</BillingInformation>
		...
	</TPA_Extensions>
	...
</HotelReservation>

Tracking an External System User’s API transactions (FEA92169)

The SynXis APIs have been enhanced so customers can now provide additional user metadata that will be tracked in SynXis CRS. This metadata will allow visibility into which users from the customer’s application (external system) initiated the API transactions to SynXis CRS.

A new optional parameter (ApplicationUserMetaData) is now supported in the HTTP headers for inbound requests to SynXis CRS, as well as in the header of the token request for use with REST APIs. The ApplicationUserMetaData parameter has a maximum size of 60 characters.

If ApplicationUserMetaData was provided in any reservation transactions via API, the value will be included in reservation delivery OTA_HotelResNotifRQ message as ResID_Type="3". The following partial XML sample shows how the metadata will be communicated:

<HotelReservations>
	<HotelReservation>
		...
		<ResGlobalInfo>
			<HotelReservationIDs>
				...
				<HotelReservationID ResID_Type="3"
				                    ResID_Value="ABCD456782"
				                    ResID_Source="Corporation representative"
				                    ForGuest="false"/>
			</HotelReservationIDs>
		</ResGlobalInfo>
		...
	</HotelReservation>
</HotelReservations>

Loyalty Accrual Indicator (FEA95383)

For chains that allow guests to earn benefits such as points or free nights based on specific rates booked, the SynXis CRS now supports the ability to configure and apply such policies to rates. The SynXis CRS previously supported the ability to configure if a rate is eligible for accrual. This functionality has been expanded to allow the association of a specific accrual benefit a guest would earn.

A new configuration “Include Accrual Details in Reservation Delivery (HTNG Only)” attribute has been added in SynXis CRS to control if the accrual type will be included in the HTNG reservation message, if associated to the rate.

The following is a sample partial XML:

<HotelReservations>
	<HotelReservation>
		...
		<TPA_Extensions>
			...
			<AccrualDetails AccrualIndicator="True"
			                AccrualTypeCode="Points"
			                AccrualTypeName="Earn Points"/>
		</TPA_Extensions>
	</HotelReservation>
</HotelReservations>

Indicate Tax Rules On Rate Plans (FEA90212)

Reservation Delivery to the PMS has been enhanced to include a comment regarding any Exempt or Pre-Paid taxes.

Reservation Delivery to any secondary endpoints (non-PMS) will not include any Exempt or Pre-Paid tax comments.

The following attributes have been added to the Administration > Integration > Integration Detail > Attributes page to control whether the comments are included:

Include Exempt Taxes in Comments
Include Pre-paid Taxes in Comments

Sample partial XML for Exempt taxes:

<OTA_HotelResNotifRQ>
	...
	<HotelReservations>
		<HotelReservation>
			...
			<RoomStays>
				<RoomStay>
					...
					<Comments>
						<Comment GuestViewable="false">
							<Text>~EXEMPTTAXES RBT(0.00), RLT(0.00) EXEMPTTAXES~</Text>
						</Comment>
					</Comments>
				</RoomStay>
			</RoomStays>
			...
		</HotelReservation>
	</HotelReservations>
</OTA_HotelResNotifRQ>

Sample partial XML for Pre-Paid taxes:

<OTA_HotelResNotifRQ>
	...
	<HotelReservations>
		<HotelReservation>
			...
			<RoomStays>
				<RoomStay>
					...
					<Comments>
						<Comment GuestViewable="false">
							<Text>~PREPAIDTAXES RBT(45.00), RLT(30.00) PREPAIDTAXES~</Text>
						</Comment>
					</Comments>
				</RoomStay>
			</RoomStays>
			...
		</HotelReservation>
	</HotelReservations>
</OTA_HotelResNotifRQ>

Data Warehouse Delivery - Reservations