SM_HotelResPaymentReadRQ/RS

1 Sample XML
2 General Guidelines for Payment Transaction Retrieval
3 SM_HotelResPaymentReadRQ
4 SM_HotelResPaymentReadRS
- 4.1 PaymentInfo Detail
5 Payment Charge Type Mapping Definition

Sample XML

<SM_HotelResPaymentReadRQ EchoToken="123e4567-e89b-12d3-a456-426614174000" TimeStamp="2021-08-01T09:30:47+08:00" Version="1.0">
    <POS>
        <Source>
			<RequestorID Type="22" ID="PMS1"/>
		</Source>
    </POS>
    <SelectionCriteria HotelCode="ABCD13245" SelectionType="Undelivered"/>
</SM_HotelResPaymentReadRQ>

<SM_HotelResPaymentReadRS EchoToken="123e4567-e89b-12d3-a456-426614174000"  TimeStamp="2021-08-01T09:30:47+08:00" Version="1.0">
	<HotelResPaymentList>
		<HotelResPayment TransactionID="200098" HotelCode="ABCD13245">
			<UniqueID ID="BDC-79860526" Type="14" />
			<UniqueID ID="7223a92-d988-46b8-8476-3319285af8a2" Type="34" />
			<PaymentInfo PaymentTransactionTypeCode="charge" PaymentType="5" Remark="" ChargeTypeCode="RM">
				<PaymentCard CardCode="VI" CardType="1" ExpireDate="1020" Mask="xxxxxxxx2257" CardHolderName="Visa Card HolderName" />
				<PaymentAmount Amount="200.20" CurrencyCode="AUD" />
			</PaymentInfo>
		</HotelResPayment>
		<!-- Additional Payment Transactions -->
		<HotelResPayment TransactionID="200099" CreateDateTime="2021-08-01T08:49:34.000+0000" HotelCode="ABCD13245">
			<!-- Payment Transaction Details-->
		</HotelResPayment>
	</HotelResPaymentList>
</SM_HotelResPaymentReadRS>

<SM_HotelResPaymentReadRS EchoToken="123e4567-e89b-12d3-a456-426614174000"  TimeStamp="2021-08-01T09:30:47+08:00" Version="1.0">
	<HotelResPaymentList>
		<HotelResPayment TransactionID="200098" HotelCode="ABCD13245">
			<UniqueID ID="BDC-79860526" Type="14" />
			<UniqueID ID="7223a92-d988-46b8-8476-3319285af8a2" Type="34" />
			<PaymentInfo PaymentTransactionTypeCode="charge" PaymentType="46" Remark="alipay" ChargeTypeCode="RM">
				<PaymentAmount Amount="200.20" CurrencyCode="AUD" />
			</PaymentInfo>
		</HotelResPayment>
		<!-- Additional Payment Transactions -->
		<HotelResPayment TransactionID="200099" CreateDateTime="2021-08-01T08:49:34.000+0000" HotelCode="ABCD13245">
			<!-- Payment Transaction Details-->
		</HotelResPayment>
	</HotelResPaymentList>
</SM_HotelResPaymentReadRS>

General Guidelines for Payment Transaction Retrieval

The PMS should pull payment transactions every 2-5 minutes per Hotel. You can pull less frequently if you wish.

SM_HotelResPaymentReadRQ

Element	Number	Description
SM_HotelResPaymentReadRQ	1	Root element
@Version	1	Current Version 1.0
@EchoToken	1	Globally unique identifier for the request, value will be returned as an EchoToken in the response.
@TimeStamp	1	Time of the transaction in xml schema dateTime format
SM_HotelResPaymentReadRQ / POS / Source / RequestorID	1	This identifies the system which is sending the reservation. This element must appear in the first Source element.
@Type	1	Fixed at 22 (ESRP)
@ID	1	The ID used will be agreed by the trading partners and remain the same throughout the messages.
SM_HotelResPaymentReadRQ / SelectionCriteria	1
@HotelCode	0..1	Hotel code as recognised by pmsXchange. Please note if you are using PMS level authentication you can omit the HotelCode to pull all pending transactions for you hotels with a single message.
@SelectionType	1	Must be "Undelivered"

SM_HotelResPaymentReadRS

Element	Number	Description
SM_HotelResPaymentReadRS	1	Root element
@Version	1	Current Version 1.0
@EchoToken	1	Globally unique identifier for the request, value will be returned as an EchoToken in the response.
@TimeStamp	1	Time of the transaction in xml schema dateTime format
SM_HotelResPaymentReadRS/HotelResPaymentList	1	List of HotelResPayments
SM_HotelResPaymentReadRS/HotelResPaymentList/HotelResPayment	0..n	HotelResPayment data
@HotelCode	1	Hotel code as recognised by pmsXchange
@TransactionID	1	Transaction Identifier
@CreateDateTime	1	Create timestamp
SM_HotelResPaymentReadRS/HotelResPaymentList/HotelResPayment/UniqueID	2	Container for the Reservation Identifier. See Unique ID
@ID	1	Reservation Identifier
@Type	1	14 and 34 - See UniqueId@Type
SM_HotelResPaymentReadRS/HotelResPaymentList/HotelResPayment/PaymentInfo	1	See PaymentInfo Detail

PaymentInfo Detail

Element	Number	Description
PaymentInfo	1	Top Level Payment information XML container
@PaymentTransactionTypeCode	1	Transaction type OTA_Def
@PaymentType	1	Identifies the payment type `5` - Credit Card `6` - Debit Card `46` - Online Payment
@Remark	0..1	Open Remarks Will include the payment provider used if the transaction was a non-card payment.
@PaymentRef	0..1	Payment reference (ie Paypal reference)
@ChargeTypeCode	1	Charge type code - See Charge Type Mapping Definition
PaymentInfo\PaymentCard	0..1
@CardCode	1	Credit card issuer code. See the OTA Payment Card Provider Codes
@CardType	1	Credit/Debit OTA_Card_Type Def
@ExpireDate	1	MMYY format card expire date
@Mask	1	Masked CC number
@CardHolderName	1	Name of card holder
PaymentInfo\PaymentAmount	1	Payment Amount container
@Amount	1	Transaction amount
@CurrencyCode	1	Currency Code
@Due	0..1	Amount outstanding

Payment Charge Type Mapping Definition

Code	Description
RM	Room
FD	Food/Beverage
OT	Other
EX	Stay Extras