TicketExchange request message

Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.

NodeDescriptionValuesOccursExample
<TicketExchangeRQ>
1
@Version
Message version.
0..1 2.2
@Type
The type of exchange ot be performed, a full or partial exchange.
Possible values: 'FULL', 'PARTIAL'
[FULL] [PARTIAL] 1
@TypeOfExchange
The type of exchange that to be performed.
Possible values:
E = Even exchange
A = Add / collect exchange
R = Residual exchange
[E] [A] [R] 0..1
<RecordLocator/>
The record locator of the PNR in which the ticket exchange will be recorded. Not specified if new PNR.0..1
<Traveler>
Traveler details group1
<TravelerElementNumber/>
Element number of traveler associated to this item. 1 1
<TravelerName>
Name group1
<Surname/>
Traveler family (last) name. 1 SMITH
<GivenName/>
Traveler given (first) name. 1 JANE
<NativeGivenName/>
This field contains the given (first) name as it is returned from the GDS (free form text which contains given name, initial and title). In addition the given name as it comes from the GDS is parsed according to the GDS convention and the content is returned in sibling elments GivenName, Initial and Title. NOTE: client applications which implement their own parsing algorithm should use the content of this field! EXAMPLE: JOHN A MR0..1
</TravelerName>
</Traveler>
<OriginalTicket>
Data of the original ticket.1
<Ticket>
Data of the ticket that is to be exchanged. In case of a conjunctive ticket, all ticket numbers must be supplied with the coupon numbers that are to be refunded.
Sabre automatically exchanges all unused coupons.
1..4
@Number
The 13 digt ticket number of the ticket to be refunded.
1 0012345467891
<CouponNumber/>
The number of the coupoun to be exchanged.
1..4 1
</Ticket>
<FormOfPayment>
1
<CreditCard>
0..N
@PartialAmount
(Partial) Amount allocated to this FOP in case of a split payment. 0..1 75000
<CCCode/>
Credit card code. 1 VI
<CCNumber/>
Credit card number. 1 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX
<CCExpiration>
Credit card expiration group1
<Month/>
Credit card expiration month. 1 02 Can be returned encrypted by GDS/CRS. Example: XX
<Year/>
Last two digits of the credit card expiration year. 1 06 Can be returned encrypted by GDS/CRS. Example: XX
</CCExpiration>
</CreditCard>
<Other>
Other payment information. 0..N Check 113 or *CHECK, CASH
@PartialAmount
(Partial) Amount allocated to this FOP in case of a split payment. 0..1 75000
</Other>
</FormOfPayment>
<FareData>
Information about the fare of the original ticket.1
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<AmountPaid>
The amount paid for the original ticket group1
@Total
Total fare amount for one traveler of the specified passenger type. Total price = base fare amount + taxes amount. 1 230000
<BaseFare>
1
@Amount
Total base fare amount that includes surcharges (if any). 1 200000
<FiledIn>
This group represents fares filed in a currency different from the currency of a point of sale. The content elements represent the original currency and amount as filed.0..1
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<Amount/>
Base Fare Amount as originally filed.1
</FiledIn>
<Surcharges>
Surcharges group0..1
@Amount
Total surcharges amount. 1 2000
<Surcharge>
Surcharges break down information.1..N
@Amount
Individual surcharge amount. 1 270
<Designator/>
Surcharge designator.1
<Description/>
Surcharge descriptions as free form text.0..1
@Segment
Segment number to which the surcharge applies.

0..1 1
</Surcharge>
</Surcharges>
</BaseFare>
<Taxes>
0..1
@Amount
The total amount of taxes.1
<Tax>
0..N
@Amount
The amount that is to be collected. 1
<Designator/>
Tax or surcharge designator. 1 US
<CollectionPoint>
Mandatory for XF and ZP taxes.
Tax data break down for eac h collection point. Use NumberOfDecimals from the tax element attribute.

The sum of individual amounts entered here must me equal to the Amount entered in the Tax element.
0..N
@Amount
1
<AirportCode/>
Airport code. 1 MIA
</CollectionPoint>
</Tax>
</Taxes>
</AmountPaid>
<CorporateCode/>
0..1
<FareCalculation/>
The fare calculation line of the original ticket.
Note that this element is MANDATORY if exchange is performed based on an original ticket.
For exchanges based on MCO's this element is OPTIONAL.
0..1
<FlownSegment>
0..15
@TicketNumber
The ticket number of the coupon that has already been used.1
@CouponNumber
The coupon number that has already been used.1
<TicketDesignator>
0..1
</TicketDesignator>
<Discount>
0..1
@Type
The type of discount. Possible values: 'P' for percent, 'A' for amount.[A] [P] 1
</Discount>
<FareBasisCode/>
Fare basis code. 1 Y26
<BaseFareUsed/>
Base fare amount used for this coupon.1
</FlownSegment>
</FareData>
<TktIssueDate/>
Date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<IATA/>
The IATA number of the agency originally issuing the ticket.1
<OriginalIssuePlace/>
Three letter IATA code of the town where the ticket originally has been issued.
0..1 MIA
<SubSequentExchange>
0..1
@OriginalTicketNumber
In case that the ticket that is to be exchanged is already an exchange ticket, the ticket number of the originally issued ticket (the first one, no subsequent ones resulting from exchange) is to be specified here. In case of a conjunctive ticket, specify the first ticket number. 1
</SubSequentExchange>
<Commission>
The commission taken on the original ticket.
0..1 10
@Type
Whether the commission is in percent or an amount.
Possible values: P, A.
1 A
@NumberOfDecimals
If and only if the commission type is A, specify the number of decimals here.
0..1 2
</Commission>
</OriginalTicket>
<StoredFareReq>
The stored fare to be used for pricing the new itinerary.1
<TktStoredFare>
1
@FareNumber
FareNumber as returned in PNRViewRS.
1 2
</TktStoredFare>
</StoredFareReq>
<FlightReq>
1
<TktFlight>
Flight to be ticketed.0..16
@Element
PNR flight element number. 1 1
</TktFlight>
</FlightReq>
<TravelerReq>
1
<TktTraveler>
0..1
@Element
PNR traveler element number.1 1
@ManualPricingInd
In case of a manual fare, fare validation will not succeed and is omitted / the system response is ignored and ticket issued anyway.
Possible values: Y / N.
0..1 N.
<TktFlight>
Flight to be ticketed. If ommited, request applies to all flights for the traveler.0..16
@Element
PNR flight element number. 1 1
</TktFlight>
</TktTraveler>
</TravelerReq>
<ChangeFee>
The fee / penalty charged for the ticket exchange.
0..1 100
<Amount>
The change fee amount that is to be collected as penalty.

1 5000
@NumberOfDecimals
The number of decimals for the amount.1
</Amount>
<Commission>
The commission taken on the ChangeFee.
0..1 10
@Type
Whether the commission is in percent or an amount.
Possible values: P, A.
1 A
@NumberOfDecimals
If and only if the commission type is A, specify the number of decimals here.
0..1 2
</Commission>
</ChangeFee>
<Commission>
The commission taken on the new ticket.
0..1 10
@Type
Whether the commission is in percent or an amount.
Possible values: P, A.
1 A
@NumberOfDecimals
If and only if the commission type is A, specify the number of decimals here.
0..1 2
</Commission>
<FormOfPayment>
Form of Payment Group. To specify how additional collection is to be paid.0..1
<CreditCard>
1
<CCCode/>
Credit card code. 1 VI
<CCNumber/>
Credit card number. 1 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX
<CCExpiration>
Credit card expiration group1
<Month/>
Credit card expiration month. 1 02 Can be returned encrypted by GDS/CRS. Example: XX
<Year/>
Last two digits of the credit card expiration year. 1 06 Can be returned encrypted by GDS/CRS. Example: XX
</CCExpiration>
<SecurityID/>
Credit card security number for online transactions (referred to also as CVV2, CVC2, CSC or CID). This is a 3-digit (Visa, Master, Discover) or 4-digit (Amex) number.

0..1 493
<Authorization>
Credit card authorization. Values are:
Y = Obtain credit card authorization and approval code
S = Obtain credit card authorization and approval code and store approval code in the PNR
N = Do not obtain credit card authorization
0..1 N
@Amount
Amount approved for this credit card.
0..1 1200
@AirlineCode
Airline Code.
0..1 AA
</Authorization>
<ApprovalCode/>
Credit card approval code. 0..1 996456
<ExtendedPayment>
Credit card extended payment. Values are:
Y = Add extended payment
N = Do not add extended payment
0..1 N
@NumberOfMonths
If and only if the value of the ExtendedPayment is set to Y.
Identifies the period of extended payment in months. Usually credit card systems (or the travel agency) allows a payment to be extended over a certain number of months. The actual timeframe will vary depending on the credit card system.
0..1 5
@Code
Code necessary for a special form of payment (if ExtendedPayment=Y).
For Amadeus:
A credit card is used for an initial amount and uniform subsequent monthly installment amounts.
The total of the installment amounts is expected in the PartialAmount attribute of the Other element, which has content INSTALLMENT in this case.
The currency given in the same FormOfPayment element is used.
0..1 CM5
</ExtendedPayment>
</CreditCard>
<Other/>
Other payment information. 1 Check 113 or *CHECK, CASH
</FormOfPayment>
<ResidualValues>
This group represent unused values of the ticket that is to be exchanged. Contains unused fare portion and unused taxes.

IMPORTANT: this structure is not applicable for BSP markets. However, still MANDATORY for ARC.
0..1
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<UnusedBaseFareAmount>
1
</UnusedBaseFareAmount>
<UnusedTaxes>
1
@Amount
The total amount of taxes.1
<Tax>
1..N
@Amount
The amount that is to be collected. 1
<Designator/>
Tax or surcharge designator. 1 US
<CollectionPoint>
Mandatory for XF and ZP taxes.
Tax data break down for eac h collection point. Use NumberOfDecimals from the tax element attribute.

The sum of individual amounts entered here must me equal to the Amount entered in the Tax element.
0..N
@Amount
1
<AirportCode/>
Airport code. 1 MIA
</CollectionPoint>
</Tax>
</UnusedTaxes>
</ResidualValues>
<AdditionalCollection>
Additional collection group. To be used to specify additional base amount and taxes.

Mandatory if fare plus taxes of the new ticket is higher than the amount of the ticket to be exchanged.
1
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<BaseFareDifference>
The additional base amount to be collected. Mandatory for uneven exchange.
BaseFareDifference = NewTicketBaseFare minus UnusedBaseFareAmount (from Residual Values)
0..1
</BaseFareDifference>
<Taxes>
Taxes to be collected or refunded. Note that the value of the Amount attribute of this note could have a positive or a negatve value. If positive - this is the amount to be collected. If negative - this is the amount to be refunded. 0..1 much higher base fare and lower taxes. In that case (assuming that the fare difference is so high that in overall we have an additional collection) we still would have some of the unused taxes to be refunded - identified here as negative amount.
@Amount
The total amount of taxes.1
<Tax>
0..N
@Amount
The amount that is to be collected. 1
<Designator/>
Tax or surcharge designator. 1 US
<CollectionPoint>
Mandatory for XF and ZP taxes.
Tax data break down for eac h collection point. Use NumberOfDecimals from the tax element attribute.

The sum of individual amounts entered here must me equal to the Amount entered in the Tax element.
0..N
@Amount
1
<AirportCode/>
Airport code. 1 MIA
</CollectionPoint>
</Tax>
</Taxes>
</AdditionalCollection>
<Refund>
Refund group. To be used to specify refunds to be made.

Mandatory if fare plus taxes of the new ticket is less than the amount of the ticket to be exchanged.
1
<CurrencyCode>
Currency code. 1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<BaseFareDifference>
The base amount to be refunded. Mandatory for uneven exchange.
The amount is calculated as the difference betw. the unused fare amount of the original ticket(see UnusedBaseFareAmount element) and the fare of the new ticket.
0..1
</BaseFareDifference>
<Taxes>
Taxes to be collected or refunded. Note that the value of the Amount attribute of this note could have a positive or a negatve value. If positive - this is the amount to be refunded. If negative - this is the amount to be collected. An example could be a total amount of the new ticket where a refund should take place. However, the taxes could be higher than in the original ticket - thus need to be collected. In that case the Amount attribute will have a negative value. 0..1
@Amount
The total amount of taxes.1
<Tax>
0..N
@Amount
The amount that is to be collected. 1
<Designator/>
Tax or surcharge designator. 1 US
<CollectionPoint>
Mandatory for XF and ZP taxes.
Tax data break down for eac h collection point. Use NumberOfDecimals from the tax element attribute.

The sum of individual amounts entered here must me equal to the Amount entered in the Tax element.
0..N
@Amount
1
<AirportCode/>
Airport code. 1 MIA
</CollectionPoint>
</Tax>
</Taxes>
</Refund>
<ValidatingCarrier/>
0..1
<PrinterGroup>
The PrinterGroup specifies the printer(s) to print to.

NOTE: The PrinterGroup is mandatory for all GDS, although it may not be required on other CRS!
0..1
<PrinterDestination>
Documents are printed on this destination. If not given, the default printer is used.
1..4
@Type
The type of printer. Can be boarding pass (B), invoice / itinerary (I), mini itinerary (M), ticket (T) printer or hardcopy (H) printer.
1 T.
@CountryCode
The ticket printer country code. Needed by Sabre.
0..1 AB
</PrinterDestination>
</PrinterGroup>
<EndTransaction>
End of transaction. If not included in the request the changes will not be end-transacted.0..1
@TransactionType
End of transaction type. Values are:
ET = End transaction
ER = End transaction and retrieve PNR
IG = Ignore transaction
IR = Ignore transaction and retrieve PNR
RD = Redisplay

[ET] [ER] [IG] [IR] [RD] 1 ET
</EndTransaction>
<ReportingTo/>
Whether the agency reports to ARC or BSP.[ARC] [BSP] 0..1
</TicketExchangeRQ>

Legend

ColumnDescription
NodeName of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples:
0..3 Node is optional and may occur up to 3 times.
1..N Node must occur at least one (mandatory) and may occur any number of times.
2 Node must occur exactly twice.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server