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.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<TicketRefundRQ> | Ticket Refund Request Root Element. | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Type | Possible values are: ARC and BSP markets: Full .. full refund Partial .. partial refund BSP markets only: FullTax .. full tax only refund PartialTax .. partial tax only refund | [Full] [Partial] [FullTax] [PartialTax] | 1 | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
<RecordLocator/> | PNR record locator. | 1 | R1A3SK | |
<Traveler> | Traveler details group | 1 | ||
<TravelerElementNumber/> | Element number of traveler associated to this item. | 1 | 1 | |
<TravelerName> | Name group | 1 | ||
<Surname/> | Traveler family (last) name. | 1 | SMITH | |
<GivenName/> | Traveler given (first) name. | 1 | JANE | |
</TravelerName> | ||||
</Traveler> | ||||
<OriginalIssueData> | 1 | |||
<TktIssueDate/> | Date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<TktIssueTime/> | Time in ISO 8601 format (hh:mm). | 0..1 | 14:00 | |
<IATA/> | IATA number of the agency originating the request. | 1 | 123456 | |
<PseudoCityCode> | Pseudo City Code of the agency requesting the void/cancel. Used to verify if it has the authority for this request. | 1 | LNJ2 | |
</PseudoCityCode> | ||||
<Commission> | The commision that was originally collected (if any) | 0..1 | 200 | |
@Type | The type of commission: Percentage (P) or Amount (A). | 1 | A | |
@NumberOfDecimals | The number of decimals if the commission type is A. | 0..1 | 2 | |
</Commission> | ||||
</OriginalIssueData> | ||||
<TicketData> | Contains the breakdown of the REFUNDABLE ticket values (Base fare, Taxes). This applies to full as well as partial refunds. | 1 | ||
<Ticket> | Data of the coupons to be refunded. In case of a conjunctive ticket, all ticket numbers must be supplied with the coupon numbers that are to be refunded. NOTE: Sabre and WorldspanDIR do automatically refund all unused segments. | 1..4 | ||
@Number | The 13 digt ticket number of the ticket to be refunded. | 1 | 0012345467891 | |
<CouponNumber/> | The number of the coupoun to be refunded. | 1..4 | 1 | |
</Ticket> | ||||
<FormOfPayment> | Form of payment group | 1 | ||
<CreditCard> | Credit card group | 0..N | ||
@InhibitPrint | Option to print on invoice. Values are: Y = Inhibit remark print on invoice N = Print remark on invoice | [Y] [N] | 0..1 | Y Note that this indicator is only supprted by Sabre GDS currently. In general this means that absence of this attribute means that CC FOP will be printed on invoice unless changed during ticketing override commands. |
@PartialAmount | (Partial) amount allocated to this form of payment. Used for so called split payment. Not to be confused w/ amount entered for authorization in PNRCreateRQ. | 0..1 | ||
@ActualAmount | Actual Amount is mandatory if refunding to one single FOP. This represents the amount to be refunded | 0..1 | ||
<CCCode/> | Credit card code. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 1 | 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX | |
<CCExpiration> | Credit card expiration group | 1 | ||
<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> | ||||
<CardholderFirstName/> | Credit card holder's first name. | 0..1 | JOHN | |
<CardholderLastName/> | Credit card holder's last name. This is only required for Sabre. | 1 | SMITH | |
</CreditCard> | ||||
<Other> | Other payment information. | 0..N | CHECK 113 | |
@PartialAmount | (Partial) Amount allocated to this FOP in case of a split payment. This is not to be confused with the amount requested for authorization - see ...CreditCard/ Authorization/Amount. | 0..1 | 75000 | |
@ActualAmount | Actual Amount is mandatory if refunding to one single FOP. This represents the amount to be refunded | 0..1 | ||
</Other> | ||||
<NativeElementText/> | 1 | |||
</FormOfPayment> | ||||
<FareData> | Base Fare, Taxes, and Total Fare data to be refunded | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Price> | Price group | 1 | ||
@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 group | 0..1 | ||
@Amount | Total surcharges amount. | 1 | 2000 | |
<Surcharge> | Surcharges break down information. | 0..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> | Tax break down information group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 30000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Price> | ||||
<FareRules> | Fare rules information | 0..1 | ||
<TourCode/> | Tour code identifier. | 0..1 | ITGF12 (Galileo / Apollo) | |
</FareRules> | ||||
</FareData> | ||||
<TicketRemark> | Ticket remark group | 0..N | ||
<Text/> | Information text. | 1..N | Free flow text | |
</TicketRemark> | ||||
<ValidatingCarrier/> | Validating carrier is mandatory for BSP markets. | 0..1 | EK | |
<RefundType> | Defines the refund type depending on the reporting area Values are: D .. Domestic - Journey takes place whollywithin the reporting area T .. Transborder - Journey takes place partially outside of reporting area I .. International - Journey takes place wholly outside of the reporting area | 0..1 | Agency Location MAD: BCN-MAD is domestic BCN-PAR is transborder PAR-NCE is international | |
@DomesticJourneyType | BSP France only. Applicable only when RefundType = 'D' Values are: B .. From MRS, NCE, TLN to Corsica only F .. France metropolitan M .. France metropolitan to Corsica, except locations specified in B | [B] [F] [M] | 0..1 | |
</RefundType> | ||||
</TicketData> | ||||
<RefundData> | Data specific to the monetary refund | 1 | ||
<CurrencyCode> | Currency code. | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<FeesAndPenalties> | Fees, penalties or commission taken on the refund. Breakdown of refundable Taxes. | 0..1 | ||
@Amount | Total fees and penalties amount. | 1 | 30000 | |
<Tax> | Breakdown of taxes to be refunded. Tax break-down needed for some settlement authorities such as BSP | 0..N | ||
@Amount | Individual tax amount. | 1 | 2500 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax free form text descriptions. | 0..1 | US DOMESTIC SEGMENT TAX | |
<CollectionPoint> | For XF and ZP taxes. Tax data break down for each collection point. The sum of individual amounts entered here must be equal to the Amount entered in the Tax element. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<AirportAmount/> | The amount actually filed by the airport in the currency applicable to the geographical location of the airport. | 0..1 | ||
<AirportCode/> | IATA standard airport code . | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
<CancellationCommission> | The amount of commission taken on the cancellation penalty. Raised by the agency processing the refund. | 0..1 | 100 | |
@Type | The type of commission: Percentage (P) or Amount (A). | [A] [P] | 1 | A |
</CancellationCommission> | ||||
<CancellationPenalty> | The amount that is to be paid as cancellation penalty. Raised by the agency processing the refund. | 0..1 | 100 | |
</CancellationPenalty> | ||||
<CommFee/> | Non-refundable commission fee amount charged (if any). Raised by the agency processing the refund. | 0..1 | 1000 | |
<PenaltyFee/> | penalty fee amount charged based on the original fare rules (if any). | 0..1 | 1000 | |
<AdminFee/> | Administrative fee amount charged for the processing of the refund transaction (if any). Raised by the agency processing the refund. | 0..1 | 1000 | |
</FeesAndPenalties> | ||||
<TotalRefund> | The total refund. | 1 | ||
@Amount | Total amount that is to be refunded: Refundable base fare + refundable taxes. (Disregarding any commission, penalties or fees taken for processing the refund). | 1 | 30000 | |
</TotalRefund> | ||||
<RefundAuthNumber/> | Refund Authorization Number. Alphanumeric. | 0..1 | XYZ999 | |
<WaiverCode/> | Refund Waiver Code. Mandatory in some BSP countries such as Japan. | 0..1 | XYZ123 | |
</RefundData> | ||||
<FlownSegment> | Information about coupons that have already been used. To be specified for a partial refund. | 0..15 | ||
@CouponNumber | The coupon number of the segment flown. | 1 | ||
@TicketNumber | The ticket number of the segment flown. In case of a conjunctive ticket, give the exact ticket number, not the first one of the conjunctive set. | 1 | ||
<BaseFareUsed> | Base fare amount used for this coupon. | 1 | ||
@NumberOfDecimals | 1 | |||
</BaseFareUsed> | ||||
<FareBasisCode/> | Fare basis code of the fare on flown segment. | 1 | ||
<TicketDesignator/> | The ticket designator of the segment flown. | 1 | ||
<SurchargesUsed> | The surcharges used by this coupon | 0..1 | ||
@NumberOfDecimals | 1 | |||
</SurchargesUsed> | ||||
</FlownSegment> | ||||
<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..5 | ||
@Type | The type of printer. Values: B .. boarding pass I .. invoice / itinerary M .. mini itinerary T .. ticket printer H .. hardcopy / accounting printer PP .. PrinterProfile (Sabre only) | [B] [I] [M] [T] [H] [PP] | 1 | T |
@CountryCode | The ticket printer country code. Needed by Sabre. | 0..1 | AB | |
</PrinterDestination> | ||||
<STPDestination> | Documents are printed on this STP (Satellite Ticket Printer, means printer located in a different office location) destination. If not given, then default printer is used. | 0..1 | ||
@Type | The type of printer. Values: B .. boarding pass I .. invoice / itinerary M .. mini itinerary T .. ticket printer H .. hardcopy / accounting printer | 1 | T | |
<AccountID/> | Needed for Sabre | 1 | ||
<PseudoCityCode/> | Agency's pseudo city code. | 1 | LNJ2 | |
<STPID/> | The printer desination ID (LNIATA in Apollo / Galileo) | 1 | ||
</STPDestination> | ||||
</PrinterGroup> | ||||
<ReportingTo/> | Whether the agency reports to ARC to BSP. | [ARC] [BSP] | 0..1 | |
</TicketRefundRQ> |
| Column | Description |
|---|---|
| Node | Name 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. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum 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. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server