Structured Fare Rules Definitions and Examples
AirReqRsp.xsd
Air Pricing > Air Fare Rules (recommended) OR
Low Fare Shop > Air Fare Rules (recommended)
The FareRulesFilterCategory returns air fare rules in a structured format.
Use the structured format to customize how you want rules displayed to your own customers (for example, in a different language). You can request all categories or specific categories (multiple CategoryCode elements can be sent in a request): To return air fare rules in a structured format, send AirFareRulesReq/FareRulesFilterCategory. If FareRulesFilterCategory is blank, all categories with structured fare rules are returned.
- ADV returns advanced reservation and ticketing rules (Cat 5)
- MIN returns minimum stay rules (Cat 6)
- MAX returns maximum stay rules (Cat 7)
- STP returns stopover information (Cat 8)
- CHG returns penalty information (Cat 16)
- VOL returns voluntary changes rules (Cat 31)
- VOR returns voluntary refunds information (Cat 33)
- Blank returns all categories with structured fare rules.
Only categories for which structured fare rules exist are returned.
- Fare rules return in CategoryDetails and VariableCategoryDetails AirFareRulesRsp/FareRule/StructuredFareRulesType .
- If both text and structured fare rules are requested at the same time, only structured fare rules are returned.
Download .CSV and .XLS of Category Rule Values
Click to download a .zip archive of spreadsheets for the category type, name, description, and values (Updated April 2023):
- Excel (.XLS) - All categories in different tabs.
- Comma Seperated Value (.CSV) - All values for all categories in single spreadsheet.
Category 5 – Advance Reservations and Ticketing
CAT5 Example
AirFareRules with provider code 1V - CAT5 (ADV)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX"> <com:BillingPointOfSaleInfo OriginApplication="UAPI"/> <air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey> <air:FareRulesFilterCategory> <air:CategoryCode>ADV</air:CategoryCode> </air:FareRulesFilterCategory> </air:AirFareRulesReq> </soapenv:Body> </soapenv:Envelope>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="2090" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="ADV">
<air:CategoryDetails Name="ConfirmedSector" Value="X"/>
<air:CategoryDetails Name="TimeBeforeDept" Value="0"/>
<air:CategoryDetails Name="ExceptionTime" Value="0"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
First
The earliest time reservations are permitted
- Time of Day
- Time of day when reservations are first permitted
- Period
- Indicates either a period of elapsed time or day of week occurrence
Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- Nb = Minutes
- Hb = Hours
- Db = Days
- Mb = Months
- If the PERIOD field is alpha:
- 01 = 1st occurrence (day of week)
- 02-52 = occurrence
- Last
- The latest time by which reservations are required
- Time of Day
- Time of day when reservations are first permitted
- Period
- Indicates either a period of elapsed time or day of week occurrence
Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- Nb = Minutes
- Hb = Hours
- Db = Days
- Mb = Months
- If the PERIOD field is alpha:
- 01 = 1st occurrence (day of week)
- 02-52 = occurrence
TSI
An indicator which specifies further restrictions for advance reservations
Permitted
Indicates that advanced reservations are not permitted
- X = Not permitted
Ticketed
Indicates that reservations must be made, and tickets must be issued at the same time
- X = Permitted only when ticket is issued
- Blank – No application
Standby
Indicates standby and wait-listing conditions
- A = Waitlist & Standby Not Permitted
- B = Waitlist Not Permitted
- C = Waitlist & Standby Not Permitted on Originating Flight
- D = Standby Not Permitted on Originating Flight
- E = Waitlist Not Permitted on Originating Flight
- F = Waitlist Not Permitted on Originating Flight/Standby Not Permitted
- G = Standby Not Permitted on Originating Flight/Waitlist Not Permitted
- H = Standby Permitted for Earlier/Later Same Day Flights, otherwise Waitlist and Standby Not Permitted
- I = Standby Permitted - Earlier/Later Same Day Flights, otherwise Standby Not Permitted
- J = Standby Permitted for Earlier/Later Same Day Flights, otherwise Waitlist and Standby Not Permitted on Originating Flight
- K = Waitlist Permitted for Earlier/Later Same Day Flights, otherwise Waitlist & Standby Not Permitted on Originating Flight
- L = Standby Permitted for Same Date as Originally Ticketed Provided Any Flight/Time Specific Provisions are Met
- X = Standby Not Permitted
- Blank = System Assumption. Waitlist and Standby permitted.
Confirmed Sectors of Transportation
Sector
Indicates the fare component (sector) that must hold a confirmed status code
- X = All sectors must be confirmed
- N = Open returns are not permitted
- Y = First sector must be confirmed
Each
Indicates that the originating flight of each fare component (sector) within the pricing unit must satisfy the reservation provisions
- X = Each sector must satisfy the reservation provision
Advance Ticketing
Indicates point in time when tickets must be issued
- Time of Day
- Time of day when reservations are first permitted
- Period
- Indicates either a period of elapsed time or day of week occurrence
Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- Nb = Minutes
- Hb = Hours
- Db = Days
- Mb = Months
- If the PERIOD field is alpha:
- 01 = 1st occurrence (day of week)
- 02-52 = occurrence
Option
Option identifying the time which follows.
- P = Earliest time ticketing is permitted
- R = Amount of time prior to travel that ticketing is required
Departure
Amount of time before departure
Unit of Time
Unit in which the time of departure is expressed
Note: Departure field with a value of ‘000’ with a unit of ‘D’ = Same Day
- Departure field with a value of ‘000’ with a unit of ‘Blank’ = No application
- N = Minutes
- H = Hours
- D = Days
- M = Months
TSI
An indicator which specifies further restrictions for advance reservations
BOTH
Indicates that amounts of time after reservations are made and prior to departure must both be taken as factors in determining the point in time at which tickets must be issued
- E = Earlier time of the two
- L = Later time of the two
Exception Time
Indicates the shortest amount of time prior to the departure to which an exception to advance ticketing requirements applies
Unit of Time
Unit in which exception time is expressed
Note: Exception time with a value of ‘000’ with a unit of ‘D’ = Same Day
- N = Minutes
- H = Hours
- D = Days
- M = Months
Waiver
Used to override the advanced reservations and/or ticketing requirements through a specific date
Reservation Date
Last date when waiver applies to advance reservations
Ticketed Date
Last date when waiver applies to advance ticketing requirement
Category 6 – Minimum Stay
CAT6 Example
AirFareRules with provider 1G – CAT6 (MIN)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/> <air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1G">XXXXXX</air:FareRuleKey> <air:FareRulesFilterCategory FareInfoRef="AmMeZcBAAA/B5OrBAAAAAA==">
<air:CategoryCode>MIN</air:CategoryCode> </air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="xxxxxx" ResponseTime="1363" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="xxxxxx" RuleNumber="AE10" Source="ATPCO" TariffNumber="001" ProviderCode="1G">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="MIN">
<air:CategoryDetails Name="MinimumStay" Value="3"/>
<air:CategoryDetails Name="UnitOfTime" Value="D"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
Origin Day of the Week
Indicator when the minimum stay is dependent on the day travel commences
- 1 = Monday
- 2 = Tuesday
- 3 = Wednesday
- 4 = Thursday
- 5 = Friday
- 6 = Saturday
- 7 = Sunday
Time of Day
The time of day when return travel may commence
Minimum Stay
Indicates either a period of elapsed time or day of week occurrence
Unit of Time
Further clarifies minimum stay requirement
- If the minimum stay field is numeric:
- Nb = Minutes
- Hb = Hours
- Db = Days
- Mb = Months
- If the minimum stay field is alpha:
- 01 = 1st occurrence (day of week)
- 02-52 = occurrence
Waiver
Indicates the minimum stay restriction may be shortened to the prior day or a specified date/time when service (scheduled flights) is provided
- 1 = May be shortened to the prior day on which service is provided
- 2 = May be shortened to the specified date or amount of time as indicated, as long as service is not provided on the last day of the minimum stay.
Minimum Stay Date
Indicates the specific date for the minimum stay requirement
Minimum Stay - Earlier/Later
Indicates that the earlier or later of the minimum stay calculated versus minimum stay date must be used
- E = Earlier minimum stay
- L = Later minimum stay
Waiver Date
Indicates the minimum stay may be waived to a specific date
Waiver – Earlier/Later
Indicates that the earlier or later of the waiver date versus the calculated waiver must be used
- E = Earlier waiver day
- L = Later waiver day
Waiver Period
Indicates a period of elapsed time
Waiver Unit of Time
Unit in which the waiver period field is expressed
- D = Days
- M = Months
Category 7 – Maximum Stay
CAT7 Example
AirFareRules with provider 1V – CAT7 (MAX)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX" FareRuleType="long">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory FareInfoRef="XXXXXX">
<air:CategoryCode>MAX</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="2142" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="E651" Source="ATPCO" TariffNumber="001" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="MAX">
<air:CategoryDetails Name="ReturnTravelCode" Value="C"/>
<air:CategoryDetails Name="MaximumStay" Value="12"/>
<air:CategoryDetails Name="UnitOfTime" Value="M"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
Return Travel Code
This field indicates whether return travel Must Commence or Must Be Completed by
- C = Must Commence
- P = Must be Completed
Time of Day
The time of day when travel must either commence or be completed by
Maximum Stay
A field indicating whether the maximum stay is expressed in the amount of elapsed time or a specified day of week
Unit of Time
Further definition of maximum stay, describing either the unit of elapsed time or the occurrence of the day of week.
NOTE: Maximum stay of ‘000’ with unit of ‘D’ = Same Day
- If the maximum stay field is numeric:
- Nb = Minutes
- Hb = Hours
- Db = Days
- Mb = Months
- If the maximum stay field is alpha:
- 01 = 1st occurrence (day of week)
- 02-52 = occurrence
Ticket Issuance Indicator
This field indicates if the maximum stay is from the day of ticket issuance
- X = Calculate from date of ticket issuance
Waiver
Indicates that the maximum stay restriction may be shortened to the prior day or a specified date/time when service (scheduled flights) is provided
- 1 = May be extended to the next day on which service is provided
- 2 = May be extended to the specified date or time as indicated as long as the service is not provided on the last day of the maximum stay.
Maximum Stay Date
This field indicates a specified maximum stay date
Maximum Stay Earlier/Later
This field indicates to apply the earlier or later of the calculated maximum stay versus the specified maximum stay date
- E = Earlier maximum stay
- L = Later maximum stay
Waiver Date
Indicates the maximum stay may be waived to the specified date
Waiver Earlier/Later
Indicates that the earlier or later of the waiver date versus the calculated waiver must be used
- E = Earlier waiver day
- L = Later waiver day
Waiver Period
Indicates a period of elapsed time
Waiver Unit
Unit in which the preceding Waiver Period field is expressed
- D = Days
- M = Months
Category 8 – Stopovers
CAT8 Example
AirFareRules with provider 1V – CAT8 (STP)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory>
<air:CategoryCode>STP</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="1721" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="STP">
<air:CategoryDetails Name="MaxStopsPermitted" Value="XX"/>
<air:CategoryDetails Name="Charges1" Value="0020000"/>
<air:CategoryDetails Name="AddtlAmt1" Value="0000000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Charges2" Value="0000000"/>
<air:CategoryDetails Name="AddtlAmt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="SegCount" Value="002"/>
<air:VariableCategoryDetails Value="Recurring Segment">
<air:CategoryDetails Name="Application" Value="N"/>
<air:CategoryDetails Name="LocType" Value="N"/>
<air:CategoryDetails Name="Loc1" Value="AU"/>
<air:CategoryDetails Name="Loc2" Value="**"/>
</air:VariableCategoryDetails>
<air:VariableCategoryDetails Value="Recurring Segment">
<air:CategoryDetails Name="LocType" Value="N"/>
<air:CategoryDetails Name="Loc1" Value="TW"/>
<air:CategoryDetails Name="Loc2" Value="**"/>
<air:CategoryDetails Name="ChangeApplies" Value="1"/>
</air:VariableCategoryDetails>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
Minimum Stops Required
Minimum number of stops required to qualify for the fare
Maximum Stops Permitted
Maximum number of stops permitted at the fare
- 00 = No stopovers permitted
- XX = Unlimited
Outbound Stops Permitted
Number of stops permitted on the outbound portion of travel
- XX = Unlimited
Inbound Stops Permitted
Number of stops permitted on the inbound portion of travel
- XX = Unlimited
Outbound or Inbound
A code indicating that the maximum number of stops are permitted on the outbound or the return portion of travel, but not both
- X = Permitted on Outbound or Return but not both
Open Jaw Stopover
- X = Applicable for Open Jaw travel
Circle Trip (2 Component) Stopover
- X = Applicable for 2 component circle trip travel
Circle Trip (More than 2 Components) Stopover
- X = Applicable for more than 2 component circle trip travel
Gateway Stopover
Indicates conditions under which a gateway stopover is permitted
- N = Not permitted
- P = Permitted only at the gateway
- Y = Permitted
Minimum Time
Indicates the minimum amount of time required at an intermediate point to be considered a stopover
Minimum Unit of Time
Unit in which contents of Minimum Time field is represented
- N = Minutes
- H = Hours
- D = Days
- M = Months
Maximum Time
Maximum amount of time allowed at an intermediate point to qualify as a stopover
Maximum Unit of Time
Unit in which contents of Maximum Time field is represented
Amount of time:
- Maximum Time of ‘000’ with a Unit of ‘D’ = Same Day
- Maximum Time of ‘001’ with a Unit of ‘D’ = Next Day
- N = Minutes
- H = Hours
- D = Days
- M = Months
Same Point Stopovers
Indicates the number of times the passenger may stop at the same point
Transfers
Indicates the number of times the same point may be transitted
Connections
Indicates the number of times connections can be made at the same point
Charge Application
Identifies the stopover charge that may apply
- Blank = Any Passenger
- 1 = Child stopover charge
- 2 = Both Adult and Child
- 3 = Both Adult and Child, but Child is discounted
- 4 = Adult stopover charge
- 5 = Adult, child, and infant, but child and infant are discounted
- 6 = Adult, child, and infant, but infant is free
- 7 = Adult, child, and infant, but child is discounted and infant is free
- 8 = Infant charge
Number of (First) Stopovers at First Charge Amount
Indicates the number of stopover charged at the first amount
First Charge Amount
The charge amount for the first stopovers permitted in the preceding field
- 000999
Additional Stopovers
Indicates the number of stopovers charged at the Additional Amount
Additional Charge Amount
The charge amount for the additional permitted stopovers
- 000999
Currency
Currency code in which the previously identified amounts are represented
- Three – letter alpha currency code
Decimal
Number of decimal places for the preceding amount
Stopover Charge Amount #2
These fields are used to specify the First and Additional stopover amounts filed in a second currency
- 000999
Additional Charge Amount #2
The charge amount for the additional permitted stopovers filed in a second currency
- 000999
Currency #2
Currency code in which the previously identified amounts are represented
- Three – letter alpha currency code
Decimal #2
Number of decimal places for the preceding amount
Number of Segments
Indicates the number of recurring segment items in the record 3
Recurring Segment Carrier Application Indicator
Indicates that transportation arriving and departing the point of stopover must be or may not be on the same carrier
- Y = Must be same carrier
- N = May not be same carrier
Recurring Segment Number of Stopovers
Indicates the number of stopovers
- XX = Unlimited
Recurring Segment Inbound Carrier
Indicates that transportation arriving at the point of stopover must be on this specific carrier
- The Standard Industry alphanumeric code of the airline
Recurring Segment Application of Geographic Carrier Information
Designates the application of carrier and geographic information
- N = Not Permitted
- R = Required
- Blank = Permitted
Recurring Segment Location Type
A code indicating the type of geographic specification that will be found in the following field
- Blank = No Application
- A = Area
- Z = Zone
- N = Country
- S = State/Province
- C = City
- P = Airport
Recurring Segment Location #1
Multiple location formats for this field.
- See ATPCO Appendix C for descriptions and details.
Recurring Segment Location #2
Multiple location formats for this field.
- See ATPCO Appendix C for descriptions and details.
Recurring Segment Outbound Carrier
Indicates that transportation departing the point of stopover must be on this specific carrier
- The Standard Industry alphanumeric code of the airline
Recurring Segment Inbound/Outbound Indicator
Indicates the portion in which the stopover must occur
- O = Outbound
- I = Inbound
- E = Either inbound or outbound but not both
Recurring Segment Stopover Charges
Indicates which stopover charge applies to the locale
- 1 = First Charge
- 2 = Additional Charge
Category 16 – Penalties
See Air Pricing with Most Restrictive Penalties topic for further information.
CAT16 Example
AirFareRules with provider 1V – CAT16 (CHG)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory>
<air:CategoryCode>CHG</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="1132" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="CHG">
<air:CategoryDetails Name="CancellationsRefunds" Value="X"/>
<air:CategoryDetails Name="TktNonRef" Value="X"/>
<air:CategoryDetails Name="Amt1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Amt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="Percent" Value="0000000"/>
<air:CategoryDetails Name="PaxDeathWaiver" Value="X"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="CHG">
<air:CategoryDetails Name="Voluntary" Value="X"/>
<air:CategoryDetails Name="ChangeItinPenalty" Value="X"/>
<air:CategoryDetails Name="ChangeNoReissuePenalty" Value="X"/>
<air:CategoryDetails Name="Amt1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Amt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="Percent" Value="0000000"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
Voluntary Change Application Tag
- X = Applies
Involuntary Change Application Tag
- X = Applies
Cancellations and Refunds Tag
- X = Applies
Ticket/Reservation Restriction Tag
- X = Non refundable
- N = Reservation cannot be changed
- B = Both
Penalty Conditions
- CANX
- Cancellation
- X = Applies
- Fail
- Failure to use confirmed space
- X = Applies
- CHRG
- Change of itinerary requiring reissue of a ticket
- X = Applies
- REP
- Replacement of last ticket/exchange order
- X = Applies
- CHGN
- Change not requiring reissue
- X = Applies
- TKT
- Ticket refund penalty
- X = Applies
- PTA
- Unticketed PTA
- X = Applies
Charges
APPL
Indicates when amount specified is applicable and whether a child's discount applies
- 1 = Penalty Anytime
- 2 = Penalty before departure
- 3 = Penalty after departure
- 4 = Penalty any time. Child’s charge can be discounted**
- 5 = Penalty before departure. Child’s charge can be discounted**
- 6 = Penalty after departure. Child’s charge can be discounted**
- **The same fare rules will apply to both adult and child passenger types. Infants without a seat are exempted from any charges involved in change/cancellation of tickets.
Portion of Ticket
Indicates portion of an itinerary/ticket on which the penalty is assessed
- 1 = One-way
- 2 = Round-trip
- 3 = Per ticket
- 4 = Per Coupon
- 5 = Per Direction
AMT
Penalty when stated as flat amount
1st CUR
Currency in which the previous amount field was represented
- 3 letter Alpha currency code
DEC
Number of decimals assumed in amount fields
AMT
Amount of penalty when penalty is expressed in more than one currency
2nd CUR
Currency in which the previous amount field was represented
- 3 letter Alpha currency code
DEC
Number of decimals assumed in previous amount field
PERCENT
Percentage of fare assessed as penalty
H/L
Indicates that when both amount and percent are specified, use the higher or lower of the two amounts.
- H = higher
- L = lower
Waivers
Death of a Passenger
- X = Penalty waived
- Blank = Penalty applied
Illness of a Passenger
- X = Penalty waived
- Blank = Penalty applied
Death of an immediate family member
- X = Penalty waived
- Blank = Penalty applied
Illness of an immediate family member
- X = Penalty waived
- Blank = Penalty applied
Schedule Change
- X = Penalty waived
- Blank = Penalty applied
Ticket Upgrade
- X = Penalty waived
- Blank = Penalty applied
Category 31 – Voluntary Changes
Example
AirFareRules with provider 1V – CAT31 (VOL)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory>
<air:CategoryCode>VOL</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="1621" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="B"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="B"/>
<air:CategoryDetails Name="Amount1" Value="0020000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="A"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="A"/>
<air:CategoryDetails Name="Amount1" Value="0020000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
PTC – Passenger Type Code
- Valid PTC codes listed in ATPCO Appendix A
- Blank = Applies to all passengers
Ticket Validity
Indicates if the change is to be made within the ticket validity
- X = within ticket validity
- Blank = anytime
Departure of Journey
Indicates the change is before or after the origin of the original ticketed journey
- B = Before
- A = After
- Blank = Anytime
Pricing Unit
Indicates the change is before or after the origin of the original pricing unit.
- B = Before
- A = After
- Blank = Anytime
Fare Component
Indicates the change is before or after the origin of the original Fare Component
- B = Before
- A = After
- Blank = Anytime
Advance Reservation – From Point
The beginning point to measure advance reservation requirements
- O = Based on the Old/Original Ticketing Date
- R = Based on the Ticket Re-issue Date
- Blank = No Application
Advance Reservation – To Point
The ending point to measure advance reservation requirements
- J = Use departure of the first travel of the Journey
- P = Use departure of the first travel of the Pricing Unit
- F = Use departure of the first travel of the Fare Component
- Blank = No Application
Advance Reservation – Period
Indicates either a period of elapsed time or day of week occurrence
- 000-999 or 3-character alpha representation of day of week (MON, TUE, WED, THU, FRI, SAT, SUN)
- Blank = No Application
Advance Reservation – Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- N = Minutes (left justified, followed by a blank)
- H = Hours (left justified, followed by a blank)
- D = Days (left justified, followed by a blank)
- M = Months (left justified, followed by a blank)
- If the PERIOD field is alpha:
- 1 = 1st occurrence (day of week)
- 02-52 = occurrence
- Blank = No Application
Advance Reservation – Change Indicator
Indicator that the changes are not permitted or the number of times the ticket may be re-issued
- N = Changes to Fare Component not permitted
- P = Changes to Pricing Unit not permitted
- J = Changes to Journey not permitted
- 1-9 = Number of times the ticket may be reissued
- Blank - No Application - continue to validate the table
Passenger Occurrence – First
The first occurrence of the passengers flying together, which are to be re-issued per this penalty amount
- 01-99
- Blank = Unlimited number of passengers
Passenger Occurrence – Last
The last occurrence of the passengers flying together, which are to be re-issued per this penalty amount
- 01-99
- Blank = Unlimited number of passengers
Penalty Calculations – Charge 1 – Amount 1
- A penalty amount stated as a flat amount
- 0000000-9999999
Penalty Calculations – Charge 1 – Currency 1
A code in which the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Penalty Calculations – Charge 1 – Decimal 1
Number of decimal placements assumed in the preceding amount field.
- 0-9
- Blank = No Application
Penalty Calculations – Charge 1 – Percentage
Percentage of the base fare assessed as the penalty
- NNN.NNNN format
- Decimal assumed – 009.5000 = 9.5%
Penalty Calculations – Charge 2 – Amount 2
A penalty amount stated as a flat amount
- 0000000-9999999
Penalty Calculations – Charge 2 – Currency 2
A code in which the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Penalty Calculations – Charge 2 – Decimal 2
Number of decimal placements assumed in the preceding amount field.
- 0-9
- Blank = No Application
Penalty Calculations – High Low
Indicates that when both amount and percentage are specified, use the higher or the lower of the two amounts
- H = Use Higher of the amount and the calculated percentage
- L = Use Lower of the amount and the calculated percentage
- Blank - No Application
Minimum Amount
The minimum amount of the additional collection that must be made
- 0000000 - 9999999
Minimum Amount Currency
A code in which the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Minimum Amount Decimal
Number of decimal placements assumed in the preceding amount field.
- 0-9
- Blank = No Application
Journey, Pricing Unit, or Fare Component
Indicates if the re-issue fee is assessed on a Journey, Pricing Unit, or Fare Component basis
NOTE: All Category 31 Record 3 tables with an effective date equal to or later than July 11, 2010 will contain only value Blank in byte 104.
- J = Journey
- P = Pricing Unit
- Blank = Fare Component
Fee Application
The Fee Application of the preceding field. Specifies how to assess the change fees.
- Byte 104 = Blank & Byte 105 = 1: From among all changed fare components, apply the highest change fee
- Byte 104 = Blank & Byte 105 = 2: From among all fare components, changed and unchanged, apply the highest change fee
- Byte 104 = Blank & Byte 105 = 3: Apply the sum of the change fees of all changed Fare Components
- Byte 104 = Blank & Byte 105 = 4: From among all fare components within changed pricing units, apply the highest change fee.
- Byte 104 = Blank & Byte 105 = 5: From among all fare components with 1) changed pricing units and 2) pricing units to which a fare component has been added, apply the highest change fees
- Byte 104 = J & Byte 105 = 1: From among all changed fare components, apply the highest change fee
- Byte 104 = J & Byte 105 = 2: From among all fare components, changed and unchanged, apply the highest change fee
- Byte 104 = P & Byte 105 = 2: From among all fare components within changed pricing units, apply the highest change fee.
Ticket Type
Indicates whether the ticket must be reissued or revalidated.
- A = Reissue
- B = Revalidation
- Blank = Either type of transaction
Discounts
Indicates whether to apply discounts. Up to 4 may be coded.
-
1 = Infant (discount any infant PTC)
-
2 = PTC = INS discount, no penalty for PTC=INF
-
3 = Child discount
-
4 = Youth discount
-
5 = Senior discount
-
6 = Category 19 discounts
-
7 = Category 22 discounts
-
8 = PTC=INF discount
-
9 = no penalty for PTC = INF
-
0 = PTC=INS discount
-
Blank = Penalty Discounts are not permitted
Residual vs. Penalty
- If a residual amount, then satisfy the residual versus the penalty by:
- I = Ignoring residual and add collect penalty
- R = Refunding residual to script and add collect penalty
- S = Subtracting
- If residual is > penalty, subtract penalty from residual and refund residual to the original form of payment or as defined in the next byte.
- If penalty is > residual, subtract residual from penalty and add/collect the difference in the penalty
- N = Subtract for Non-Refundable. If non-refundable fare is used in an itinerary with refundable fares:
- If residual is > than penalty then subtract the penalty from the residual and ignore the difference.
- If penalty is > than residual then subtract the residual from the penalty and add/collect the difference in penalty
- Blank = No Application
Form of Refund
Indicates the method in which any applicable refund amount will be returned to the passenger
- S = Script
- M =Electronic Miscellaneous Document (EMD)
- V = Voucher
- Blank - Original Form of Payment (OFOP)
Endorsement
Indicates the endorsement requirements for the reissue
- X = Include the higher non-refundable amount from either the old or new ticket in the endorsement box of the reissued ticket in lieu of the new Category 18 provisions
- W = Include the non-refundable amount of the new ticket in the endorsement box of the reissued ticket in lieu of the new Category 18 provisions.
- Y = Include on Category 18 endorsement provisions from the new ticket.
- Blank = Same as X but in addition to the new Category 18 provisions
Domestic / International Combinations
Indicates whether a domestic carrier on the itinerary gives permission for an international carrier to apply specific international reissue rules to the domestic portion of travel
- Y = International carrier on the itinerary may apply international rules to the domestic carrier's portion of travel
- N = No carrier may override the domestic carrier's rules
- Blank = Domestic carrier may override itself
Restrictive Penalty Hierarchy
Indicates which restrictive penalty hierarchy to be used
- X = Apply the least restrictive hierarchy
- Blank = Apply the most restrictive hierarchy
Category 33 – Voluntary Refunds
Example
AirFareRules with provider 1V – CAT33 (VOR)
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory>
<air:CategoryCode>VOR</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP:Body>
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="1379" xmlns:air="http://www.travelport.com/schema/air_v48_0">
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="VOR">
<air:CategoryDetails Name="TicketValidity" Value="A"/>
<air:CategoryDetails Name="TicketPeriod" Value="24"/>
<air:CategoryDetails Name="TicketUnit" Value="M"/>
<air:CategoryDetails Name="DepartureOfJourney" Value="B"/>
<air:CategoryDetails Name="CancellationIndicator" Value="X"/>
<air:CategoryDetails Name="TariffNum" Value="000"/>
<air:CategoryDetails Name="BookingCode" Value="E"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="Pufc" Value="P"/>
<air:CategoryDetails Name="CalculationOption" Value="A"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>
</SOAP:Body>
</SOAP:Envelope>
PTC – Passenger Type Code
- Valid PTC codes listed in ATPCO Appendix A
- Blank = Applies to all passengers
Ticket Validity
Indicates if the refund is to be made within the ticket validity
- Value A: Within one year after ticket issue
- Value B: Within one year after travel has commenced
- Blank: Anytime
Ticket Validation - Period
Indicates either a period of elapsed time or day of week occurrence
- 000-999
- Blank = No Application
Ticket Validation - Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- N = Minutes (left justified, followed by a blank)
- H = Hours (left justified, followed by a blank)
- D = Days (left justified, followed by a blank)
- M = Months (left justified, followed by a blank)
- Blank = No Application
Departure of Journey
Indicates the refund is before or after the origin of the original ticketed journey
- B = Before
- A = After
- Blank = Anytime
Pricing Unit
Indicates the refund is before or after the origin of the original pricing unit.
- B = Before
- A = After
- Blank = Anytime
Fare Component
Indicates the refund is before or after the origin of the original Fare Component
- B = Before
- A = After
- Blank = Anytime
Advance Cancellation – From / To Point
The beginning and ending point to measure advance cancellation requirements.
- The FROM POINT is always based on the ticket refund date.
- The TO POINT is variable
- J = Use departure of the first travel of the Journey
- P = Use departure of the first travel of the Pricing Unit
- F = Use departure of the first travel of the Fare Component
- Blank = No Application
Advance Cancellation – Last Time of Day
Time of day by which the refund request is required
- 0001 – 2400
- Blank = No Application
Advance Cancellation – Period
Indicates either a period of elapsed time or day of week occurrence
- 000-999
Or - 3-character alpha representation of day of week (MON, TUE, WED, THU, FRI, SAT, SUN)
- Blank = No Application
Advance Cancellation – Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- N = Minutes (left justified, followed by a blank)
- H = Hours (left justified, followed by a blank)
- D = Days (left justified, followed by a blank)
- M = Months (left justified, followed by a blank)
- If the PERIOD field is alpha:
- 1 = 1st occurrence (day of week)
- 02-52 = occurrence
- Blank = No Application
Advance Cancellation – Ticket Time Limit
Indicates if the refund request is permitted before or after the ticketing time limit (of the Journey or PU)
- B = Before Journey
- A = After Journey
- D = Before PU
- E = After PU
- Blank = Anytime
Advance Reservation Validation
Indicates how advance reservation data in Category 5 should be validated when processing byte 41
- I = Ignore Advance Reservation in Category 5
- A = Attempt to completely validate all Category 5 data, including reservations and advance purchase; pass or fail accordingly
- Blank = Process as according to Data Application
Fully Flown
Indicates that data in this table applies to partially or fully flown fare components only
- A = Applies to fully flown fare components
- B = Applies to partially flown fare components
- Blank = No Application
Originally Scheduled Flight
Indicates when the refund request for any unused flights being refunded must be made
- B = Before the originally scheduled flight
- D = One day before the originally scheduled flight
- X = On/Before the day of departure of the originally scheduled flight
- Blank = May be made before or after the originally scheduled flight
- A = Any time after originally scheduled flight
- O = Day of originally scheduled flight and later
- L = Day after originally scheduled flight and later
Originally Scheduled Period
Indicates either a period of elapsed time or day of week occurrence
- 000-999
Or - 3-character alpha representation of day of week (MON, TUE, WED, THU, FRI, SAT, SUN)
- Blank = No Application
Originally Scheduled – Unit of Time
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- N = Minutes (left justified, followed by a blank)
- H = Hours (left justified, followed by a blank)
- D = Days (left justified, followed by a blank)
- M = Months (left justified, followed by a blank)
- If the PERIOD field is alpha:
- 1 = 1st occurrence (day of week)
- 02-52 = occurrence
- Blank = No Application
Cancellation Indicator
- Indicates if refunds are permitted
- X = Refunds are not permitted
- Blank = Automated refunds permitted
Fare Break Points
Indicates that when repricing the fully flown portion of the itinerary, the fare break points may or may not be changed in order to calculate the value of the flown portion
- X = Fare Breaks may be changed
- Blank = Fare Break changes not permitted for fully flown fare components. For partially flown fare components, may change the destination point, but the cannot change the origin point
Re-Price Indicator
Indicates that when a partially used ticket is submitted for refund, in order to determine the value of the portion used, re-price using historical travel commencement or historical ticket fares
- A = Historical Ticket Based fares
- B = Historical Travel Commencement Based fares
- Blank = No Application
Re-Pricing Rules – Tariff Number
- 001-999 = specified tariff.
- Specified Tariff defined as:
- Public Tariff = same tariff & specified tariff
- Private Tariff = same tariff & specified tariff
- 000 = Any Tariff. Defined as:
- For Public Tariff = any public tariff
- For Private Tarff = any qualified private tariff, any public tariff
Re-Pricing Rules – Indicator
Indicates that private tariffs should be considered along with public tariffs when 000 is coded in a public rules tariff Category 33
- Blank = No Application
Re-Pricing Rules – Rule Number
The specified rule number where reprice fares must reside
- Four alpha numeric rule numbers.
- Blank = Any rule number
Re-Pricing Rules – Indicator
Indicator for how the following field is defined
- F = Fare Class code
- M = ATP Fare Family (e.g. -E70)
- S = Fare Class code starting with the 2nd position
- Blank = Any Fare Class code may be used
Re-Pricing Rules – Fare Class Code
- Characters 2-8 of a Fare Class Code or ATPCO Fare Family
- 1-8 digit alpha numeric fare class code
- 1-7 alpha numeric fare class code (excluding the first position of the fare class code).
- Generic fare family: e.g., B-E70 which refers to all BE70 fares.
- Blank = Any fare Class Code
Re-Pricing Rules – Same Indicator
Indicates that when re-pricing, select fare that are the same fare type or fare class code as the original fare
- T = Same ATPCO Fare Type Code
- C = Same Fare Class Code
- Blank = Any Fare Class Code or Fare Type
Re-Pricing Rules – Normal/Special
Indicate when repricing, select fares that are Normal or Special as indicated in the Record 1
- N = Normal
- S = Special
- Blank = Normal or Special
Re-Pricing Rules – One Way / Round Trip
Indicates when re-pricing, select fares that are One Way (Tag 1 or Tag 3) or Round Trip (Tag 2) as indicated in the Fare Record or Record 1
- 1 = One Way
- 2 = Round Trip
- Blank = Any One Way or Round-Trip fare
Re-Pricing Rules – Fare Amount
Indicates that when re-pricing fully flown fare components, to select fare that are equal to or greater in amount than the original fare.
- X = Higher than the original fare
- Blank = Equal to or Higher than the original fare
Re-Pricing Rules – Booking Code
Indicates that when re-pricing whether to select fares that are booked in the same booking code as the originally ticketed fare components
- S = Same Booking Code
- E = Equal or Higher Booking code
- Blank = Any booking code
Amount 1
A penalty amount stated as a flat amount
- 0000000-9999999
Currency 1
A code in the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Decimal 1
Number of decimal placements assumed in the preceding amount field
- 0-9
- Blank = No Application
Percentage
Percentage of the base fare assessed as the penalty
- NNN.NNNN format
Amount 2
A penalty amount stated as a flat amount
- 0000000-9999999
Currency 2
A code in the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Decimal 2
Number of decimal placements assumed in the preceding amount field
- 0-9
- Blank = No Application
Higher or Lower
Indicates that when both amount and percentage are specified, use the higher or the lower of the two amounts
- H = Use Higher of the amount and the calculated percentage
- L = Use Lower of the amount and the calculated percentage
- Blank - No Application
Minimum Amount
The minimum amount of the additional collection that must be made
- 0000000 - 9999999
Minimum Amount Currency
A code in which the preceding amount field is represented
- Three alpha currency code
- Blank = No Application
Minimum Amount Decimal
Number of decimal placements assumed in the preceding amount field.
- 0-9
- Blank = No Application
Pricing Unit / Fare Component
Indicates if the refund fee is assessed on a Pricing Unit or Fare Component basis
- F = Fare Component
- P = Pricing Unit
Calculation Options
Indicates that the refund should be calculated using one of the two defined methods
- A = When calculating the refund use Method A (Pricing Unit), as described in the Category 33 Data Applications
- B = When calculating the refund use Method B (Higher of FC & PU), as described in the Category 33 Data Applications
Discounts
Indicates whether to apply discounts. Up to 4 may be coded.
-
1 = Infant (discount any infant PTC)
-
2 = PTC = INS discount, no penalty for PTC=INF
-
3 = Child discount
-
4 = Youth discount
-
5 = Senior discount
-
6 = Category 19 discounts
-
7 = Category 22 discounts
-
8 = PTC=INF discount
-
9 = no penalty for PTC = INF
-
0 = PTC=INS discount
-
Blank = Penalty Discounts are not permitted
Form of Refund
Indicate the form of refund to apply
- S = Script
- M = MCO/EMD
- V = Voucher
- Blank - Original Form of Payment
Tax is Non-Refundable
Indicates the refundability of taxes on non-refundable and refundable type fares. For non-refundable fare types this field only applies to 100% non-refundable fares
- X = For Non-Refundable fares, taxes are non-refundable. For refundable fares, taxes are refundable.
- Blank = No Application
Customer First
The Customer First fields are used to indicate that a penalty fare is fully refundable within a specified period of time after reservations/ticketing. Data in these field are match conditions.
- If the refund request is on/before the specified period/unit after reservations/ticketing for the fare component being validated on the ticket being presented for refund, then processing will match the table (provided a match is also made to all other match fields).
- If the refund request is not on/before the specified period/unit after reservations/ticketing for the fare component being validated on the ticket being presented for refund, then processing will not match the table.
Customer First - Period of Time
Indicates either a period of elapsed time or day of week occurrence
- 000-999
Or - 3-character alpha representation of day of week (MON, TUE, WED, THU, FRI, SAT, SUN)
- Blank = No Application
Customer First – Unit of Time
Specifies that the refund request must be on/before a specific number of minutes, hours, days, or months after reservations/ticketing
Unit in which the preceding ‘period’ field is expressed
Note: Period field with a value of ‘000’ with a unit of ‘D’ = Same Day
- If the PERIOD field is numeric:
- N = Minutes (left justified, followed by a blank)
- H = Hours (left justified, followed by a blank)
- D = Days (left justified, followed by a blank)
- M = Months (left justified, followed by a blank)
- If the PERIOD field is alpha:
- 1 = 1st occurrence (day of week)
- 02-52 = occurrence
- Blank = No Application
Reservation / Ticket
Indicates if change is measured from after reservations are made, or after reservations and ticketing are made
- R = After Reservations are made
- T = After Reservations and Ticketing are made (Reservations/Ticket was performed on the same day)
- Blank = No Application
Blank
Blank returns all categories with structured fare rules.
AirFareRules with provider 1V – ALL CATEGORIES
Request
<air:AirFareRulesReq TargetBranch="XXXXXX">
<com:BillingPointOfSaleInfo OriginApplication="UAPI"/>
<air:FareRuleKey FareInfoRef="XXXXXX" ProviderCode="1V">XXXXXX</air:FareRuleKey>
<air:FareRulesFilterCategory>
<air:CategoryCode>ADV</air:CategoryCode>
<air:CategoryCode>MIN</air:CategoryCode>
<air:CategoryCode>MAX</air:CategoryCode>
<air:CategoryCode>STP</air:CategoryCode>
<air:CategoryCode>CHG</air:CategoryCode>
<air:CategoryCode>VOL</air:CategoryCode>
<air:CategoryCode>VOR</air:CategoryCode>
</air:FareRulesFilterCategory>
</air:AirFareRulesReq>
Response
<air:AirFareRulesRsp TransactionId="XXXXXX" ResponseTime="1201" xmlns:air="http://www.travelport.com/schema/air_v48_0" xmlns:common_v48_0="http://www.travelport.com/schema/common_v48_0">
<common_v48_0:ResponseMessage Code="0" Type="Warning">Fare rules for MIN,MAX - rule categories does not exist</common_v48_0:ResponseMessage>
<air:FareRule FareInfoRef="XXXXXX" RuleNumber="AU02" Source="ATPCO" TariffNumber="003" ProviderCode="1V">
<air:StructuredFareRules>
<air:FareRuleCategoryType Value="CHG">
<air:CategoryDetails Name="CancellationsRefunds" Value="X"/>
<air:CategoryDetails Name="TktNonRef" Value="X"/>
<air:CategoryDetails Name="Amt1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Amt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="Percent" Value="0000000"/>
<air:CategoryDetails Name="PaxDeathWaiver" Value="X"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="CHG">
<air:CategoryDetails Name="Voluntary" Value="X"/>
<air:CategoryDetails Name="ChangeItinPenalty" Value="X"/>
<air:CategoryDetails Name="ChangeNoReissuePenalty" Value="X"/>
<air:CategoryDetails Name="Amt1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Amt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="Percent" Value="0000000"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="ADV">
<air:CategoryDetails Name="ConfirmedSector" Value="X"/>
<air:CategoryDetails Name="TimeBeforeDept" Value="0"/>
<air:CategoryDetails Name="ExceptionTime" Value="0"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="STP">
<air:CategoryDetails Name="MaxStopsPermitted" Value="XX"/>
<air:CategoryDetails Name="Charges1" Value="0020000"/>
<air:CategoryDetails Name="AddtlAmt1" Value="0000000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Charges2" Value="0000000"/>
<air:CategoryDetails Name="AddtlAmt2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="SegCount" Value="002"/>
<air:VariableCategoryDetails Value="Recurring Segment">
<air:CategoryDetails Name="Application" Value="N"/>
<air:CategoryDetails Name="LocType" Value="N"/>
<air:CategoryDetails Name="Loc1" Value="AU"/>
<air:CategoryDetails Name="Loc2" Value="**"/>
</air:VariableCategoryDetails>
<air:VariableCategoryDetails Value="Recurring Segment">
<air:CategoryDetails Name="LocType" Value="N"/>
<air:CategoryDetails Name="Loc1" Value="TW"/>
<air:CategoryDetails Name="Loc2" Value="**"/>
<air:CategoryDetails Name="ChangeApplies" Value="1"/>
</air:VariableCategoryDetails>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOR">
<air:CategoryDetails Name="TicketValidity" Value="A"/>
<air:CategoryDetails Name="TicketPeriod" Value="24"/>
<air:CategoryDetails Name="TicketUnit" Value="M"/>
<air:CategoryDetails Name="DepartureOfJourney" Value="B"/>
<air:CategoryDetails Name="CancellationIndicator" Value="X"/>
<air:CategoryDetails Name="TariffNum" Value="000"/>
<air:CategoryDetails Name="BookingCode" Value="E"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="Pufc" Value="P"/>
<air:CategoryDetails Name="CalculationOption" Value="A"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="B"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="B"/>
<air:CategoryDetails Name="Amount1" Value="0020000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="A"/>
<air:CategoryDetails Name="Amount1" Value="0000000"/>
<air:CategoryDetails Name="Decimal1" Value="0"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
<air:FareRuleCategoryType Value="VOL">
<air:CategoryDetails Name="TicketValidity" Value="X"/>
<air:CategoryDetails Name="Journey" Value="A"/>
<air:CategoryDetails Name="Amount1" Value="0020000"/>
<air:CategoryDetails Name="Currency1" Value="AUD"/>
<air:CategoryDetails Name="Decimal1" Value="2"/>
<air:CategoryDetails Name="Percentage" Value="0000000"/>
<air:CategoryDetails Name="Amount2" Value="0000000"/>
<air:CategoryDetails Name="Decimal2" Value="0"/>
<air:CategoryDetails Name="MinAmount" Value="0000000"/>
<air:CategoryDetails Name="Dec" Value="0"/>
<air:CategoryDetails Name="FeeApplication" Value="2"/>
<air:CategoryDetails Name="TypTikt" Value="A"/>
<air:CategoryDetails Name="End" Value="Y"/>
</air:FareRuleCategoryType>
</air:StructuredFareRules>
</air:FareRule>
</air:AirFareRulesRsp>