Message Description

protel I/O uses a request and response message pair to redeem loyalty points at an external system. In the request message include transaction info with currency and agent information. 

Image Added

Message Attributes

IO_LoyaltyAccountChargeRQ

Element | @Attribute	Type	Num	Description outbound

Content

Comments + Contents outbound	pAir	OnPrem
IO_LoyaltyAccountChargeRQ		1	Root element of the message.
@EchoToken	string	0..1	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
@CorrelationID	string	1	Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.
@TimeStamp	dateTime

0..

1	Time of the transaction.	"2019-06-05T09:12:14Z"
@Version	string	0..1	Message version.	Version="3.001"
@PrimaryLangID	string	0..1	The primary language preference for the message encoded as ISO 639-3.
IO_LoyaltyAccountChargeRQ | LoyaltyChargeRequest		1	Information of the Redemption
@TransactionAccount	IOCodeString	0..1	Describes the action of the points	ACCRUAL
@HotelCode	string	0..1	Full name of the property which the transferred stay information belongs to.
@HotelID	string	0..1	The ID will transfer the HotelID and needs to be agreed by the trading partners and remain the same throughout the messages.
@HotelName	string	0..1	Full name of the property which the transferred stay information belongs to.
@ChainCode	string	0..1	Full name of the property which the transferred stay information belongs to.
@MemberCode	IOCodeString	1	The MemberCode attribute will indicate the actual member number.
@ProgramCode	string	1	The ProgramCode attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent

Traveller

Traveler and Company ID.
@LevelCode	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1	The account status. Refer to Open Travel Code List Profile Status (PST).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>
@PrimaryInd	boolean	0..1	When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.	true false

LoyaltyChargeRequest

@TransactionReference	IOCodeString	0..1	external Reference ID for the Cancellation
@TransactionVoidInd	boolean	0..1	Displays if it is a Redemption or a Cancellation	true false
IO_LoyaltyAccountChargeRQ | LoyaltyChargeRequest | TransactionAmount		0..1	Information of the Amount of the Redemption
@Amount	decimal	1	The Amount of the points
@Type	string	1	Code for Points

TransactionAmount

IO_LoyaltyAccountChargeRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount		0..1	Information of the Amount of the Redemption in the Hotel Currency
@CurrencyCode	decimal	1	The Currency Code which is used by the Amount

CurrencyAmount

@ExchangeRate	string	0..1	Exchange Rate	decimal
IO_LoyaltyAccountChargeRQ | LoyaltyChargeRequest | TransactionAmount | CurrencyAmount | Amount	decimal	1	The amount which will be paid with the Point Redemption

LoyaltyChargeRequest

IO_LoyaltyAccountChargeRQ | LoyaltyChargeRequest | StayInfo		0..1	Reservation Information
@ReservationID	string	0..1	Reservation ID
@ArrivalDate	dateTime	0..1	Arrival Date
@DepartureDate	dateTime	0...1	Departure Date
@CRSNumber	string	0...1	CRS ID
IO_LoyaltyAccountChargeRQ | User		1	Information of the logged-in user
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the User belongs to
@Department	string	0..1	Name of the Department from the User
IO_LoyaltyAccountChargeRQ | User | Email	string	0..1	This field would be used to pass the guest’s Email.
IO_LoyaltyAccountChargeRQ | User | UserID		0..1	This field would be used to pass the guest’s UserID

Sample Message

code

@Type

language

IOCodeString

xmlcollapsetrue

<p:IO_LoyaltyAccountChargeRQ xmlns:p="http://protel.io/soap" CorrelationID="TRIGGER#000104#UPDATE#000776#1614091094240#DB8A" Version="1.0" TimeStamp="2021-02-23T14:38:14Z" EchoToken="TRIGGER#000104#UPDATE#000776#1614091094240#DB8A" PrimaryLangID="en" Target="Test" TargetName="Test">
	<p:LoyaltyChargeRequest TransactionTime="2021-02-23T14:38:14Z" TransactionAccount="ACCRUAL" HotelCode="2987" HotelID="104" HotelName="DEV 2280" ChainCode="MRHCH" MemberCode="2345754635123" ProgramCode="Lounge Coders Club" LevelCode="HighRoller" AccountStatus="4" PrimaryInd="true">
		<p:TransactionAmount Amount="100" Type="L$C">
			<p:CurrencyAmount CurrencyCode="CHF">
				<p:Amount>30.00</p:Amount>
			</p:CurrencyAmount>
		</p:TransactionAmount>
		<p:StayInfo ReservationID="20013" ArrivalDate="2019-09-26T12:00:00+02:00" DepartureDate="2019-09-30T12:00:00+02:00" CRSNumber=""/>
	</p:LoyaltyChargeRequest>
	<p:User UserName="johnD" Organisation="Hotel 2535" Department="dev.protel.net" Occupation="">
		<p:FirstName>John</p:FirstName>
		<p:LastName>Dev</p:LastName>
		<p:Email>jdev@protel.net</p:Email>
	</p:User>
</p:IO_LoyaltyAccountChargeRQ>

1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>
@ID	string	1	The unique profile ID from the PMS.
@ID_Context	string	1	Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"

IO_LoyaltyAccountChargeRS

IO_LoyaltyAccountChargeRS - Attributes

Element | @AttributeNumDescription outboundContent outbound

	pAir	OnPrem
IO_LoyaltyAccountChargeRS	string	1	Root element of the message.
@EchoToken	string	0..1	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.
@CorrelationID	dateTime	1	Used to match result messages (*RS) to request messages (*RQ) in asynchronous communication patterns. Therefore mandatory.	"2019-06-05T09:12:14Z"
@TimeStamp	string

0..

1	Time of the transaction.

"2019-06-05T09:12:14Z"

Version="3.001"
@Version	string

@Version

0..1

Message version.

Version="3.001"

@PrimaryLangID	boolean	0..1	The primary language preference for the message encoded as ISO 639-3.	true false
IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS | Success		0..1	Returning an empty element of this type indicates the successful processing of the message. It could be combined with warning message/s if the message had issue/s.
IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS | Errors | Error	string	0..1	Indicates an error occurred during the processing of an OpenTravel message. If the message successfully processes, but there are business errors, those errors should be passed in the warning element.

Errors | Error0..1

An error that occurred during the processing of a message.

@ShortText	OTA_CodeType EWT

@ShortText

0..1

An abbreviated version of the error in textual format.

	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>
@Type	OTA_CodeType ERR

@Code

0..1

If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer

Mandatory. Refers to the OTA Code List:

Error Codes (ERR).

Error Warning Type (EWT).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>
@Code	string

@Type

0..

1

1

Mandatory. Refer to OTA Code

Refers to the OTA Code List: Error

Warning Type

Codes (

EWT

ERR).
IO_LoyaltyAccountInquiryRS | Errors | Error | Message		0...1

Message Text

	Description of the issue
IO_

LoyaltyAccountInfoRS

LoyaltyAccountInquiryRS | Warnings | Warning	string	0..1	Used in conjunction with the Success element to define one or more business errors.

Warnings | Warning0..1Used when a message has been successfully processed to report any warnings or business errors that occurred.

@ShortText	OTA_CodeType EWT

@ShortText

0..1

An abbreviated version of the error in textual format.

@Code

HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810188" target="_blank">Error Warning Type (EWT)</a>
@Type	OTA_CodeType ERR	0..1

If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer

Mandatory. Refers to the OTA Code List

: Error Codes (ERR).

: Error Warning Type (EWT).	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810191" target="_blank">Error Codes (ERR)</a>
@Code	string

@Type

0..

1

1

Mandatory. Refer to OTA Code

Refers to the OTA Code List: Error

Warning Type

Codes (

EWT

ERR).
IO_LoyaltyAccountInquiryRS | Warnings | Warning |  Message		0...1	Description of the issue
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult		0..1
@TransactionReference	IOCodeString	0..1	external Reference ID for the Cancellation
@TransactionVoidInd	boolean	0..1	Displays if it is a Redemption or a Cancellation	true false
IO_LoyaltyAccountChargeRS

| LoyaltyAccount

| LoyaltyChargeResult | LoyaltyAccount		0..1
@MemberCode	IOCodeString	1	The MemberCode attribute will indicate the actual number.
@ProgramCode	string	1	The ProgramCode attribute can be used to indicate the program that is being passed. For instance, we could use it to pass: Frequent Guest, Frequent

Traveller

Traveler and Company ID.
@LevelCode	IOCodeString	0..1	Indicates special privileges in program assigned to individual.
@AccountStatus	IOCodeString	0..1

The account status. Refer to Open Travel Code List Profile Status (PST).

• 4 = Active
• 5 = Inactive

	OTA Code list PST	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117818434" target="_blank">Profile Status (PST)</a>
@PrimaryInd	boolean

@PrimaryInd

	0..1	When true, indicates this is the primary customer loyalty program and when false, indicates this is not the primary customer loyalty program.	true false
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | CardHolderName	string	0..1	Name of the Membership card
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountBalance		1	Actual amount available, which can be used for redeeming the points
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program

AccountBalance

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountBalance | CurrencyAmount		0..1	Amount in the default Currency
@ExchangeRate	decimal	0..1	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1	Currency Code, from the RQ

CurrencyAmount

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountBalance | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountAccrued		0..1	Total amount, the collected points
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountAccrued | CurrencyAmount		0..1	Amount in the default Currency
@ExchangeRate	decimal	0..1	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1	Currency Code, from the RQ
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountAccrued | CurrencyAmount | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountRedeemed		0..1	Total amount of points redeemed
@Amount	decimal	1	Amount in Points
@Type	string	1	Shortname of the Loyalty Program

AccountAccrued

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount		0..1	Amount in the default Currency
@ExchangeRate	decimal	0..1	Exchange Rate for the Loyalty Points
@CurrencyCode	string	0..1	Currency Code, from the RQ

CurrencyAmount

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | AccountRedeemed | CurrencyAmount  | Amount	decimal	1	Amount in the Currency Code, from the RQ
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated		0..1	Information of the logged-in user
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the user belongs to
@Department	string	0..1	Name of the Department from the User

UserCreated

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated | Email		0..1	This field would be used to pass the guest’s Email.

UserCreated 

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserCreated | UserID		0..1	This field would be used to pass the guest’s UserID
@Type	IOCodeString	1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>
@ID	string	1	The unique profile ID from the PMS.
@ID_Context	string	1	Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"
IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserModified		0..1	Information of the logged-in user
@UserName	IOCodeString	0..1	Name of the User
@Organisation	string	0..1	Name of the Group the user belongs to
@Department	string	0..1	Name of the Department from the User

UserModified 

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserModified | Email		0..1	This field would be used to pass the guest’s Email.

IO_LoyaltyAccountChargeRS | LoyaltyChargeResult | LoyaltyAccount | UserModified

UserModified

| UserID		0..1	This field would be used to pass the guest’s UserID

1	A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)	HTML <a href="https://confluence.protel.net/pages/viewpage.action?pageId=117810178" target="_blank">Unique ID Type (UIT)</a>
@ID	string	1	The unique profile ID from the PMS.
@ID_Context	string	1	Used to identify the source of the ID. For inbound (to protelIO) requests, this will carry a string value identifying the protel I/O Integration Partner.	“protelIO"