AirPriceReq (AirReqRsp.xsd)

Name Type Enumeration Values R/O Default Description
AirPriceReq element Request to price an itinerary in one to many ways. Pricing commands can be specified globally, or specifically per command.
CheckFlightDetails boolean simple type Optional false To Include FlightDetails in Response set to “true” the Default value is “false”.
CheckOBFees string simple type Optional A flag to return fees for ticketing and for various forms of payment. The default is “TicketingOnly” and will return only ticketing fees. The value “All” will return ticketing fees and the applicable form of payment fees for the form of payment information specified in the request. “FOPOnly” will return the applicable form of payment fees for the form of payment information specified in the request. Form of payment fees are never included in the total unless specific card details are in the request.Provider notes:ACH - CheckOBFees is valid only for LowFareSearch. The valid values are “All”, “TicketingOnly” and “None” and the default value is “None”. 1P -The valid values are “All”, “None” and “TicketingOnly”.1G – All four values are supported.1V/RCH – CheckOBFees are not supported.”
FareRuleType string simple type none , short , long Optional none Provider: 1G,1V,1P,ACH.
FareRuleValidation boolean simple type Optional false A boolean flag used to request host to return the lowest fare which matches the specified fare basis code and passes rule validation
MostRestrictivePenalties boolean simple type Optional false Boolean flag used to request the MostRestrictivePenalties in the response
NSCC string simple type Optional 1 to 3 numeric that defines a Search Control Console filter.This attribute is used to override that filter.
PricingPreference string simple type Optional An attribute to return the Lowest Price/Ignore availability for a booked itinerary with the valid preferences "PriceIgnoreAvailability" and "PriceWithAvailability"
ReturnMM boolean simple type Optional false If this attribute is set to “true”, Fare Control Manager processing will be invoked.
SplitPricing boolean simple type Optional false Indicates whether the AirSegments should be priced together or separately. Set ‘true’ for split pricing. Set ‘false’ for pricing together.SplitPricing is not supported with post book re-pricing.
SupplierCode string simple type Optional Specifies the supplier/ vendor for vendor specific price requests
TicketDate date simple type Optional YYYY-MM-DD Using a date in the past is a request for an historical fare
AuthorizedBy string simple type Optional Used in showing who authorized the request. Use is optional.
LanguageCode token simple type Optional ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P.
OverrideLogging string simple type TRACE , DEBUG , INFO , WARN , ERROR , FATAL Optional Use to override the default logging level
TargetBranch string simple type Optional Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified.
TokenId string simple type Optional Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional.
TraceId string simple type Optional Unique identifier for this atomic transaction traced by the user. Use is optional.
BillingPointOfSaleInfo element Point of Sale information for Billing
CIDBNumber integer simple type Optional A 10 Digit customer number generated by CIDB system.
OriginApplication string simple type Required Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user.
AgentIDOverride element Vendor specific agent identifier overrides to be used to access vendor systems.
AgentID string simple type Required The Agent ID for the applicable supplier/vendor
ProviderCode string simple type Required Provider code to route the AgentId to proper provider.
SupplierCode string simple type Optional Supplier code to determine which vendor this AgentId belongs to.
TerminalSessionInfo string simple type Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user
AirItinerary element A container for an Air only travel itinerary.
AirSegment typeBaseAirSegment complex type An Air marketable travel segment.
Key string simple type Required
Passive boolean simple type Optional
ProviderSegmentOrder integer simple type Optional To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation.
Status string simple type Optional Status of this segment.
TravelOrder decimal simple type Optional To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
APISRequirementsRef string simple type Optional Reference to the APIS Requirements for this AirSegment.
AvailabilitySource string simple type Optional Indicates Availability source of AirSegment.
BlackListed boolean simple type Optional Indicates blacklisted carriers which are banned from servicing points to, from and within the European Community.
BookingDate date simple type Optional Used for rapid reprice. The date the booking was made. Providers: 1G/1V/1P/1S/1A
BrandIndicator string simple type Optional Value “B” specifies that the carrier supports Rich Content and Branding. The Brand Indicator is only returned in the availability search response. Provider: 1G, 1V, 1P, ACH
CabinClass string simple type Optional Specifies Cabin class for a group of class of services. Cabin class is not identified if it is not present.
Carrier string simple type Optional The carrier that is marketing this segment
ChangeOfPlane boolean simple type Optional false Indicates the traveler must change planes between flights.
ClassOfService string simple type Optional
ETicketability string simple type Yes , No , Required , Ticketless Optional Identifies if this particular segment is E-Ticketable
Equipment string simple type Optional Identifies the equipment that this segment is operating under.
FlightNumber string simple type Optional The flight number under which the marketing carrier is marketing this flight
FlownSegment boolean simple type Optional false Used for rapid reprice. Tells whether or not the air segment has been flown. Providers: 1G/1V/1P/1S/1A
Group long simple type Required The Origin Destination Grouping of this segment.
GuaranteedPaymentCarrier string simple type Optional Identifies that this segment has Guaranteed Payment Carrier.
HostTokenRef string simple type Optional Identifies that this segment has Guaranteed Payment Carrier.
MarriageGroup long simple type Optional Identifies this segment as being a married segment. It is paired with other segments of the same value.
NumberInParty positiveInteger simple type Optional Number of person traveling in this air segment excluding the number of infants on lap.
NumberOfStops long simple type Optional Identifies the number of stops for each within the segment.
OpenSegment boolean simple type Optional Indicates OpenSegment when True
OperationalStatus string simple type Optional Refers to the flight operational status for the segment. This attribute will only be returned in the AvailabilitySearchRsp and not used/returned in any other request/responses. If this attribute is not returned back in the response, it means the flight is operational and not past scheduled departure.
OptionalServicesIndicator boolean simple type Optional Indicates true if flight provides optional services.
PassiveProviderReservationInfoRef string simple type Optional Provider reservation reference key.
ProviderReservationInfoRef string simple type Optional Provider reservation reference key.
RailCoachNumber string simple type Optional Coach number for which rail seatmap/coachmap is returned.
ScheduleChange boolean simple type Optional false Used for rapid reprice. Tells whether or not the air segment had a schedule change by the carrier. This tells rapid reprice that the change in the air segment was involuntary and because of a schedule change, not because the user is changing the segment. Providers: 1G/1V/1P/1S/1A
Seamless boolean simple type Optional Identifies that this segment was sold via a direct access channel to the marketing carrier.
Distance decimal simple type Optional The distance traveled. Units are specified in the parent response element.
FlightTime decimal simple type Optional Time spent (minutes) traveling in flight, including airport taxi time.
TravelTime decimal simple type Optional Total time spent (minutes) traveling including flight time and ground time.
AvailabilityDisplayType string simple type Optional The type of availability from which the segment is sold.Possible Values (List): G - General S - Flight Specific L - Carrier Specific/Direct Access M - Manual Sell F - Fare Shop/Optimal Shop Q - Fare Specific Fare Quote unbooked R - Redemption Availability used to complete the sell. Supported Providers: 1G,1V.
LinkAvailability boolean simple type Optional Indicates if carrier has link (carrier specific) display option.
ParticipantLevel string simple type Optional Type of sell agreement between host and link carrier.
PolledAvailabilityOption string simple type Optional Indicates if carrier has Inside (polled)Availability option.
ArrivalTime string simple type Optional The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included.
DepartureTime string simple type Optional The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included.
Destination string simple type Required The IATA location code for this destination of this entity.
Origin string simple type Required The IATA location code for this origination of this entity.
ProviderCode string simple type Optional
SupplierCode string simple type Optional
SegmentRemark element A textual remark container to hold any printable text. (max 512 chars)
Key string simple type Required
SponsoredFltInfo element This describes whether the segment is determined to be a sponsored flight. The SponsoredFltInfo node will only come back for Travelport UIs and not for other customers.
FltKey string simple type Required The unique identifying key for the sponsored flight.
NeutralLNB integer simple type Required The neutral line number for the flight item.
SponsoredLNB integer simple type Required The line number of the sponsored flight item
CodeshareInfo element Describes the codeshare disclosure (simple text string) or the specific operating flight information (as attributes).
OperatingCarrier string simple type Optional The actual carrier that is operating the flight.
OperatingFlightNumber string simple type Optional The actual flight number of the carrier that is operating the flight.
AirAvailInfo element Matches class of service information with availability counts. Only provided on search results.
HostTokenRef string simple type Optional
ProviderCode string simple type Optional
BookingCodeInfo element Details Cabin class info and class of service information with availability counts. Only provided on search results and grouped by Cabin class
BookingCounts string simple type Optional Lists class of service and their counts for specific cabin class
CabinClass string simple type Optional Specifies Cabin class for a group of class of services. Cabin class is not identified if it is not present.
FareTokenInfo element Associates Fare with HostToken
FareInfoRef string simple type Required
HostTokenRef string simple type Required
FlightDetails element Specific details within a flight segment.
AutomatedCheckin boolean simple type Optional false “True” indicates that the flight allows automated check-in. The default is “False”.
DestinationTerminal string simple type Optional
Equipment string simple type Optional
GroundTime decimal simple type Optional
Key string simple type Required
OnTimePerformance decimal simple type Optional Represents flight on time performance as a percentage from 0 to 100
OriginTerminal string simple type Optional
ArrivalTime string simple type Optional The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included.
DepartureTime string simple type Optional The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included.
Destination string simple type Required The IATA location code for this destination of this entity.
Origin string simple type Required The IATA location code for this origination of this entity.
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
Distance decimal simple type Optional The distance traveled. Units are specified in the parent response element.
FlightTime decimal simple type Optional Time spent (minutes) traveling in flight, including airport taxi time.
TravelTime decimal simple type Optional Total time spent (minutes) traveling including flight time and ground time.
Connection element Flight Connection Information
ChangeOfAirport boolean simple type Optional false Indicates the traveler must change airports between flights.
ChangeOfPlane boolean simple type Optional false Indicates the traveler must change planes between flights.
ChangeOfTerminal boolean simple type Optional false Indicates the traveler must change terminals between flights.
Duration long simple type Optional The actual duration (in minutes) between flights.
FlightDetailsIndex long simple type Optional The sequential FlightDetails number that this connection information applies to.
IncludeStopOverToFareQuote string simple type NoStopOver , StopOver , IgnoreSegment Optional The field determines to quote fares with or without stop overs,the values can be NoStopOver,StopOver and IgnoreSegment.
MinConnectionTime long simple type Optional The minimum time needed to connect between the two different destinations.
SegmentIndex long simple type Optional The sequential AirSegment number that this connection information applies to.
StopOver boolean simple type Optional false Indicates that there is a significant delay between flights (usually 12 hours or more)
FareNote element A simple textual fare note. Used within several other objects.
FareInfoMessageRef string simple type Optional
Key string simple type Required
NoteName string simple type Optional
Precedence decimal simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
Meals typeMealService simple type Available Meal Service.
InFlightServices string simple type Available InFlight Services. They are: 'Movie', 'Telephone', 'Telex', 'AudioProgramming', 'Television' ,'ResvBookingService' ,'DutyFreeSales' ,'Smoking' ,'NonSmoking' ,'ShortFeatureVideo' ,'NoDutyFree' ,'InSeatPowerSource' ,'InternetAccess' ,'Email' ,'Library' ,'LieFlatSeat' ,'Additional service(s) exists' ,'WiFi' ,'Lie-Flat seat first' ,'Lie-Flat seat business' ,'Lie-Flat seat premium economy' ,'Amenities subject to change' etc.. These follow the IATA standard. Please see the IATA standards for a more complete list.
FlightDetailsRef element Reference to a complete FlightDetails from a shared list
Key string simple type Required
AlternateLocationDistanceRef element Reference to a AlternateLocationDistance
Key string simple type Required
Connection element Flight Connection Information
ChangeOfAirport boolean simple type Optional false Indicates the traveler must change airports between flights.
ChangeOfPlane boolean simple type Optional false Indicates the traveler must change planes between flights.
ChangeOfTerminal boolean simple type Optional false Indicates the traveler must change terminals between flights.
Duration long simple type Optional The actual duration (in minutes) between flights.
FlightDetailsIndex long simple type Optional The sequential FlightDetails number that this connection information applies to.
IncludeStopOverToFareQuote string simple type NoStopOver , StopOver , IgnoreSegment Optional The field determines to quote fares with or without stop overs,the values can be NoStopOver,StopOver and IgnoreSegment.
MinConnectionTime long simple type Optional The minimum time needed to connect between the two different destinations.
SegmentIndex long simple type Optional The sequential AirSegment number that this connection information applies to.
StopOver boolean simple type Optional false Indicates that there is a significant delay between flights (usually 12 hours or more)
FareNote element A simple textual fare note. Used within several other objects.
FareInfoMessageRef string simple type Optional
Key string simple type Required
NoteName string simple type Optional
Precedence decimal simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
SellMessage string simple type Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored.
RailCoachDetails element Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored.
AvailableRailSeats string simple type Optional Number of available seats present in this rail coach.
RailCoachNumber string simple type Optional Rail coach number for the returned coach details.
RailSeatMapAvailability boolean simple type Optional Indicates if seats are available in this rail coach which can be mapped.
HostToken element This is a host token. It contains some kind of payload we got from a hostthat must be passed in on successive calls they know who you are as our systemdoes not maintain state. The format of this string isn't important as long as itis not altered in any way between calls. Since a host token is only valid onthe host it is assocated with, there is also an attribute called Host so we knowhow to route the command(s). You can have multiple active sessions betweenone or more hosts
Host string simple type Optional The host associated with this token
Key anySimpleType simple type Optional Unique identifier for this token - use this key when a single HostToken is shared by multiple elements.
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
APISRequirements element Specific details for APIS Requirements.
DateOfBirthRequired boolean simple type Optional
GenderRequired boolean simple type Optional
Key anySimpleType simple type Optional Unique identifier for this APIS Requirements - use this key when a single APIS Requirements is shared by multiple elements.
Level string simple type Optional Applicability level of the Document. Required, Supported, API_Supported or Unknown
NationalityRequired boolean simple type Optional Nationality of the traveler is required for booking for some suppliers.
RequiredDocuments string simple type Optional What are required documents for the APIS Requirement. One, FirstAndOneOther or All
Document element APIS Document Details.
Level string simple type Optional Applicability level of the Document. Required, Supported, API_Supported or Unknown.
Sequence nonNegativeInteger simple type Optional Sequence number for the document.
Type string simple type Optional Type of the Document. Visa, Passport, DriverLicense etc.
AirPricingModifiers element Controls and switches for a Air Search request that contains Pricing Information
AccountCodeFaresOnly boolean simple type Optional Indicates whether or not the private fares returned should be restricted to only those specific to the input account code and contract code.
ChannelId string simple type Optional A Channel ID is 2 to 4 alpha-numeric characters used to activate the Search Control Console filter for a specific group of travelers being served by the agency credential.
CurrencyType string simple type Optional
ETicketability string simple type Yes , No , Required , Ticketless Optional Request a search based on whether only E-ticketable fares are required.
FaresIndicator string simple type PublicFaresOnly , PrivateFaresOnly , AgencyPrivateFaresOnly , AirlinePrivateFaresOnly , PublicAndPrivateFares , NetFaresOnly , AllFares Optional Indicates whether only public fares should be returned or specific type of private fares
FiledCurrency string simple type Optional Currency in which Fares/Prices will be filed if supported by the supplier else approximated to.
ForceSegmentSelect boolean simple type Optional false This indicator allows agent to force segment select option in host while selecting all air segments to store price on a PNR. This is relevent only when agent selects all air segmnets to price. if agent selects specific segments to price then this attribute will be ignored by the system. This is currently used by Worldspan only.
InventoryRequestType string simple type Seamless , DirectAccess , Basic Optional This allows user to make request for a particular source of inventory for pricing modifier purposes.
Key string simple type Optional
OneWayShop boolean simple type Optional false Via this attribute one way shop can be requested. Applicable provider is 1G
OverrideCarrier string simple type Optional The Plating Carrier for this journey.
PlatingCarrier string simple type Optional The Plating Carrier for this journey.
ProhibitAdvancePurchaseFares boolean simple type Optional false
ProhibitMaxStayFares boolean simple type Optional false
ProhibitMinStayFares boolean simple type Optional false
ProhibitNonExchangeableFares boolean simple type Optional false
ProhibitNonRefundableFares boolean simple type Optional false
ProhibitRestrictedFares boolean simple type Optional false
ProhibitUnbundledFareTypes boolean simple type Optional A "True" value wiill remove fares with EOU and ERU fare types from consideration. A "False" value is the same as no value. Default is no value. Applicable providers: 1P/1G/1V
ReturnFailedSegments boolean simple type Optional false If "true", returns failed segments information.
ReturnFareAttributes boolean simple type Optional false Returns attributes that are associated to a fare
ReturnServices boolean simple type Optional false When set to false, ATPCO filed Optional Services will not be returned. Default is false. Provider: 1G, 1V, 1P
SellCheck boolean simple type Optional false Checks if the segment is bookable before pricing
SellCity string simple type Optional City Code identifying where the ticket is to be sold.
TicketingCity string simple type Optional City Code identifying where the ticket will be issued.
ProhibitedRuleCategories element City Code identifying where the ticket will be issued.
FareRuleCategory element Rule Categories to filter on.
Category integer simple type Required
AccountCodes element
AccountCode element Account Code is used to get Private Fares.If ProviderCode or SupplierCode is not specified,it will be considered a default AccounCode to be sent to all the Providers or Suppliers.
Code string simple type Optional
Type string simple type Optional An identifier to categorize this account code. For example, FlightPass for AC Flight Pass or RFB for AC corporate Rewards for Business.
ProviderCode string simple type Optional
SupplierCode string simple type Optional
PermittedCabins element
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
ContractCodes element
ContractCode element Some private fares (non-ATPCO) are secured to a contract code.
Code string simple type Required The 1-64 character string which uniquely identifies a Contract.
CompanyName string simple type Optional Providers supported : ACH
ProviderCode string simple type Optional
SupplierCode string simple type Optional
ExemptTaxes element Request tax exemption for specific tax category and/or all taxes of a specific country
AllTaxes boolean simple type Optional Request exemption of all taxes.
CompanyName string simple type Optional The federal government body name must be provided in this element. This field is required by AC
TaxTerritory string simple type Optional exemption is achieved by sending in the TaxTerritory in the tax exempt price request.
CountryCode typeCountry simple type Specify ISO country code for which tax exemption is requested.
TaxCategory string simple type Specify tax category for which tax exemption is requested.
PenaltyFareInformation element Specify tax category for which tax exemption is requested.
ProhibitPenaltyFares boolean simple type Required Indicates whether user wants penalty fares to be returned.
PenaltyInfo typeFarePenalty complex type Penalty Limit if requested.
NoShow boolean simple type Optional The No Show penalty (if any) to change/cancel the fare.
PenaltyApplies string simple type Anytime , Before Departure , After Departure Optional
Amount typeMoney simple type The penalty (if any) - expressed as the actual amount of money. Both Amount and Percentage can be present.
Percentage typePercentageWithDecimal simple type The penalty (if any) - expressed in percentage. Both Amount and Percentage can be present.
DiscountCard element Rail Discount Card Information
Code string simple type Required
Description string simple type Optional
Key string simple type Optional
Number string simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
PromoCodes element If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
PromoCode element A container to specify Promotional code with Provider code and Supplier code.
Code string simple type Required To be used to specify Promotional Code.
ProviderCode string simple type Required To be used to specify Provider Code.
SupplierCode string simple type Required To be used to specify Supplier Code.
ManualFareAdjustment element To be used to specify Supplier Code.
AdjustmentType string simple type Amount , Percentage Required Represents process used for applying manual discount/increment. Presently supported values are Flat, Percentage.
AppliedOn string simple type Base , Total , Other Required Represents pricing component upon which manual increment/discount to be applied. Presently supported values are Base and Total. Other is present as a future place holder but presently no request processing logic is available for value Other
FareType string simple type Optional Providers: 1p
PassengerRef string simple type Optional Represents passenger association.
TicketDesignator string simple type Optional Providers: 1p
Value decimal simple type Required Represents value of increment/discount applied. Negative value is considered as discount whereas positive value represents increment
PointOfSale element User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale.
IATA string simple type Optional Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V
Key string simple type Optional
ProviderCode string simple type Required The provider in which the PCC is defined.
PseudoCityCode string simple type Required The PCC in the host system.
BrandModifiers element Used to specify the level of branding requested.
FareFamilyDisplay element Used to request a fare family display.
ModifierType string simple type Required "FareFamily" returns the lowest branded fares in a fare family. "MaintainBookingCode" attempts to return the lowest branded fare in a fare family display based on the permitted booking code. Any brand that does not have a fare for the permitted booking code will then have the lowest fare returned. "LowestFareInBrand" returns the lowest fare within each branded fare in a fare family display.
BasicDetailsOnly element Used to request basic details of the brand.
ReturnBasicDetails boolean simple type Required
MultiGDSSearchIndicator element Indicates whether public fares and/or private fares should be returned.
DefaultProvider boolean simple type Optional Use the value “true” if the provider is the default (primary) provider. Use the value “false” if the provider is the alternate (secondary). Use of this attribute requires specifically provisioned credentials.
PrivateFareCode string simple type Optional The code of the corporate private fare. This is the same as an account code. Use of this attribute requires specifically provisioned credentials.
PrivateFareCodeOnly boolean simple type Optional : Indicates whether or not the private fares returned should be restricted to only those specific to the PrivateFareCode in the previous attribute. This has the same validation as the AccountCodeFaresOnly attribute. Use of this attribute requires specifically provisioned credentials.
ProviderCode string simple type Optional
Type string simple type Optional Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly.
PreferredCabins element Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly.
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
SearchPassenger element Passenger type with code and optional age information
AccompaniedPassenger boolean simple type Optional false Container to identify accompanied passenger. Set true means this passenger is accompanied
Age decimal simple type Optional
BookingTravelerRef string simple type Optional This value should be set for Multiple Passengers in the request.
Code string simple type Required The 3-char IATA passenger type code
DOB date simple type Optional Passenger Date of Birth
Gender string simple type Optional The passenger gender type
PricePTCOnly boolean simple type Optional
ResidencyType string simple type Employee , National , Resident Optional The passenger residence type.
Key string simple type Optional
Name element Complete name fields
First string simple type Required First Name. Size can be up to 256 characters
Last string simple type Required Last Name. Size can be up to 256 characters
Middle string simple type Optional Midle name. Size can be up to 256 characters
Prefix string simple type Optional Name prefix. Size can be up to 20 characters
Suffix string simple type Optional Name suffix. Size can be up to 256 characters
TravelerProfileId integer simple type Optional Traveler Applied Profile ID.
LoyaltyCard element Provider loyalty card information
CardNumber string simple type Required
FreeText string simple type Optional
Level string simple type Optional
MembershipStatus string simple type Optional
PriorityCode string simple type Optional
Status string simple type Optional
SupplierType string simple type Air , Vehicle , Hotel , Rail , Cruise , Other Optional
VendorLocationRef string simple type Optional
AllianceLevel string simple type Optional
Key string simple type Optional
MembershipProgram string simple type Optional Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards
SupplierCode string simple type Required The code used to identify the Loyalty supplier, e.g. AA, ZE, MC
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
ProviderReservationSpecificInfo typeProviderReservationSpecificInfo complex type If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
ProviderReservationLevel boolean simple type Optional If true means Loyalty card is applied at ProviderReservation level.
ReservationLevel boolean simple type Optional If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc.
OperatedBy element This is the carrier code to support Cross Accrual
ProviderReservationInfoRef element Container for Provider reservation reference key.
Key string simple type Required
DiscountCard element Rail Discount Card Information
Code string simple type Required
Description string simple type Optional
Key string simple type Optional
Number string simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
PersonalGeography element Personal geography details of the associated passenger.
CountryCode typeCountry simple type Passenger country code.
StateProvinceCode typeState simple type Passenger state/province code.
CityCode typeCity simple type Passenger city code.
AirPricingCommand element A containter to identify individual pricing events. A pricing result will be returned for each pricing command according to its parameters.
CabinClass string simple type Optional Specify the cabin type to price the entire itinerary in. If segment level cabin selection is required, this attribute should not be used.
CommandKey string simple type Optional An identifier to link the pricing responses to the pricing commands. The value passed here will be returned in the resulting AirPricingInfo(s) from this command.
AirPricingModifiers element Controls and switches for a Air Search request that contains Pricing Information
AccountCodeFaresOnly boolean simple type Optional Indicates whether or not the private fares returned should be restricted to only those specific to the input account code and contract code.
ChannelId string simple type Optional A Channel ID is 2 to 4 alpha-numeric characters used to activate the Search Control Console filter for a specific group of travelers being served by the agency credential.
CurrencyType string simple type Optional
ETicketability string simple type Yes , No , Required , Ticketless Optional Request a search based on whether only E-ticketable fares are required.
FaresIndicator string simple type PublicFaresOnly , PrivateFaresOnly , AgencyPrivateFaresOnly , AirlinePrivateFaresOnly , PublicAndPrivateFares , NetFaresOnly , AllFares Optional Indicates whether only public fares should be returned or specific type of private fares
FiledCurrency string simple type Optional Currency in which Fares/Prices will be filed if supported by the supplier else approximated to.
ForceSegmentSelect boolean simple type Optional false This indicator allows agent to force segment select option in host while selecting all air segments to store price on a PNR. This is relevent only when agent selects all air segmnets to price. if agent selects specific segments to price then this attribute will be ignored by the system. This is currently used by Worldspan only.
InventoryRequestType string simple type Seamless , DirectAccess , Basic Optional This allows user to make request for a particular source of inventory for pricing modifier purposes.
Key string simple type Optional
OneWayShop boolean simple type Optional false Via this attribute one way shop can be requested. Applicable provider is 1G
OverrideCarrier string simple type Optional The Plating Carrier for this journey.
PlatingCarrier string simple type Optional The Plating Carrier for this journey.
ProhibitAdvancePurchaseFares boolean simple type Optional false
ProhibitMaxStayFares boolean simple type Optional false
ProhibitMinStayFares boolean simple type Optional false
ProhibitNonExchangeableFares boolean simple type Optional false
ProhibitNonRefundableFares boolean simple type Optional false
ProhibitRestrictedFares boolean simple type Optional false
ProhibitUnbundledFareTypes boolean simple type Optional A "True" value wiill remove fares with EOU and ERU fare types from consideration. A "False" value is the same as no value. Default is no value. Applicable providers: 1P/1G/1V
ReturnFailedSegments boolean simple type Optional false If "true", returns failed segments information.
ReturnFareAttributes boolean simple type Optional false Returns attributes that are associated to a fare
ReturnServices boolean simple type Optional false When set to false, ATPCO filed Optional Services will not be returned. Default is false. Provider: 1G, 1V, 1P
SellCheck boolean simple type Optional false Checks if the segment is bookable before pricing
SellCity string simple type Optional City Code identifying where the ticket is to be sold.
TicketingCity string simple type Optional City Code identifying where the ticket will be issued.
ProhibitedRuleCategories element City Code identifying where the ticket will be issued.
FareRuleCategory element Rule Categories to filter on.
Category integer simple type Required
AccountCodes element
AccountCode element Account Code is used to get Private Fares.If ProviderCode or SupplierCode is not specified,it will be considered a default AccounCode to be sent to all the Providers or Suppliers.
Code string simple type Optional
Type string simple type Optional An identifier to categorize this account code. For example, FlightPass for AC Flight Pass or RFB for AC corporate Rewards for Business.
ProviderCode string simple type Optional
SupplierCode string simple type Optional
PermittedCabins element
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
ContractCodes element
ContractCode element Some private fares (non-ATPCO) are secured to a contract code.
Code string simple type Required The 1-64 character string which uniquely identifies a Contract.
CompanyName string simple type Optional Providers supported : ACH
ProviderCode string simple type Optional
SupplierCode string simple type Optional
ExemptTaxes element Request tax exemption for specific tax category and/or all taxes of a specific country
AllTaxes boolean simple type Optional Request exemption of all taxes.
CompanyName string simple type Optional The federal government body name must be provided in this element. This field is required by AC
TaxTerritory string simple type Optional exemption is achieved by sending in the TaxTerritory in the tax exempt price request.
CountryCode typeCountry simple type Specify ISO country code for which tax exemption is requested.
TaxCategory string simple type Specify tax category for which tax exemption is requested.
PenaltyFareInformation element Specify tax category for which tax exemption is requested.
ProhibitPenaltyFares boolean simple type Required Indicates whether user wants penalty fares to be returned.
PenaltyInfo typeFarePenalty complex type Penalty Limit if requested.
NoShow boolean simple type Optional The No Show penalty (if any) to change/cancel the fare.
PenaltyApplies string simple type Anytime , Before Departure , After Departure Optional
Amount typeMoney simple type The penalty (if any) - expressed as the actual amount of money. Both Amount and Percentage can be present.
Percentage typePercentageWithDecimal simple type The penalty (if any) - expressed in percentage. Both Amount and Percentage can be present.
DiscountCard element Rail Discount Card Information
Code string simple type Required
Description string simple type Optional
Key string simple type Optional
Number string simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
PromoCodes element If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
PromoCode element A container to specify Promotional code with Provider code and Supplier code.
Code string simple type Required To be used to specify Promotional Code.
ProviderCode string simple type Required To be used to specify Provider Code.
SupplierCode string simple type Required To be used to specify Supplier Code.
ManualFareAdjustment element To be used to specify Supplier Code.
AdjustmentType string simple type Amount , Percentage Required Represents process used for applying manual discount/increment. Presently supported values are Flat, Percentage.
AppliedOn string simple type Base , Total , Other Required Represents pricing component upon which manual increment/discount to be applied. Presently supported values are Base and Total. Other is present as a future place holder but presently no request processing logic is available for value Other
FareType string simple type Optional Providers: 1p
PassengerRef string simple type Optional Represents passenger association.
TicketDesignator string simple type Optional Providers: 1p
Value decimal simple type Required Represents value of increment/discount applied. Negative value is considered as discount whereas positive value represents increment
PointOfSale element User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale.
IATA string simple type Optional Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V
Key string simple type Optional
ProviderCode string simple type Required The provider in which the PCC is defined.
PseudoCityCode string simple type Required The PCC in the host system.
BrandModifiers element Used to specify the level of branding requested.
FareFamilyDisplay element Used to request a fare family display.
ModifierType string simple type Required "FareFamily" returns the lowest branded fares in a fare family. "MaintainBookingCode" attempts to return the lowest branded fare in a fare family display based on the permitted booking code. Any brand that does not have a fare for the permitted booking code will then have the lowest fare returned. "LowestFareInBrand" returns the lowest fare within each branded fare in a fare family display.
BasicDetailsOnly element Used to request basic details of the brand.
ReturnBasicDetails boolean simple type Required
MultiGDSSearchIndicator element Indicates whether public fares and/or private fares should be returned.
DefaultProvider boolean simple type Optional Use the value “true” if the provider is the default (primary) provider. Use the value “false” if the provider is the alternate (secondary). Use of this attribute requires specifically provisioned credentials.
PrivateFareCode string simple type Optional The code of the corporate private fare. This is the same as an account code. Use of this attribute requires specifically provisioned credentials.
PrivateFareCodeOnly boolean simple type Optional : Indicates whether or not the private fares returned should be restricted to only those specific to the PrivateFareCode in the previous attribute. This has the same validation as the AccountCodeFaresOnly attribute. Use of this attribute requires specifically provisioned credentials.
ProviderCode string simple type Optional
Type string simple type Optional Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly.
PreferredCabins element Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly.
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
AirSegmentPricingModifiers element Specifies modifiers that a particular segment should be priced in. If this is used, then there must be one for each AirSegment in the AirItinerary.
AccountCode string simple type Optional
AirSegmentRef string simple type Optional
BrandTier string simple type Optional Modifier to price by specific brand tier number.
CabinClass string simple type Optional
ConnectionIndicator string simple type AvailabilityAndPricing , TurnAround , Stopover Optional ConnectionIndicator attribute will be used to map connection indicators AvailabilityAndPricing, TurnAround and Stopover. This attribute is for Wordspan/1P only.
FareBasisCode string simple type Optional The fare basis code to be used for pricing.
FareBreak string simple type MustBreak , MustOnlyBreak , MustNotBreak Optional Fare break point modifier to instruct Fares where it should or should not break the fare.
ProhibitAdvancePurchaseFares boolean simple type Optional false
ProhibitNonRefundableFares boolean simple type Optional false
ProhibitPenaltyFares boolean simple type Optional false
PermittedBookingCodes element
BookingCode element The Booking Code (Class of Service) for a segment
Code string simple type Required
AirReservationLocatorCode element Identifies the AirReservation LocatorCode within the Universal Record
OptionalServices element A wrapper for all the information regarding each of the Optional services
OptionalServicesTotal element The total fares, fees and taxes associated with the Optional Services
ApproximateBasePrice string simple type Optional The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges.
ApproximateFees string simple type Optional The Converted fee amount in Default Currency.
ApproximateTaxes string simple type Optional The Converted tax amount in Default Currency.
ApproximateTotalPrice string simple type Optional The Converted total price in Default Currency for this entity including base price and all taxes.
BasePrice string simple type Optional Represents the base price for this entity. This does not include any taxes or surcharges.
EquivalentBasePrice string simple type Optional Represents the base price in the related currency for this entity. This does not include any taxes or surcharges.
Fees string simple type Optional The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees.
Services string simple type Optional The total cost for all optional services.
Taxes string simple type Optional The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes.
TotalPrice string simple type Optional The total price for this entity including base price and all taxes.
TaxInfo typeTaxInfo complex type The tax information for a
CarrierDefinedCategory string simple type Optional Optional category, where a carrier has used a non-standard IATA tax category. The tax category will be set to "DU"
Category string simple type Required The tax category represents a valid IATA tax code.
CouponRef string simple type Optional The coupon to which that tax is relative (if applicable)
FlightDetailsRef string simple type Optional The flight details that this tax is relative to (if applicable)
Key string simple type Optional The tax key represents a valid key of tax
ProviderCode string simple type Optional Code of the provider returning this TaxInfo.
SegmentRef string simple type Optional The segment to which that tax is relative (if applicable)
SupplierCode string simple type Optional Code of the supplier returning this TaxInfo.
TaxExempted boolean simple type Optional This indicates whether the tax specified by tax category is exempted.
Text string simple type Optional Additional Information returned from Supplier.(ACH only)
Amount string simple type Required
CountryCode string simple type Optional
DestinationAirport string simple type Optional
FareInfoRef string simple type Optional
OriginAirport string simple type Optional
TaxDetail element The tax idetail nformation for a fare quote tax.
Amount string simple type Required
CountryCode string simple type Optional
DestinationAirport string simple type Optional
FareInfoRef string simple type Optional
OriginAirport string simple type Optional
IncludedInBase element Shows the taxes and fees included in the base fare. (ACH only)
Amount string simple type Optional this attribute shows the amount included in the base fare for the specific fee or tax
FeeInfo typeFeeInfo complex type A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets
Amount string simple type Required
BaseAmount string simple type Optional
BookingTravelerRef string simple type Optional Reference to booking traveler
Code string simple type Required
Description string simple type Optional
FeeToken string simple type Optional
Key string simple type Required
PassengerTypeCode string simple type Optional
PaymentRef string simple type Optional The reference to the one of the air reservation payments if fee included in charge
SubCode string simple type Optional
Text string simple type Optional Additional Information returned from Supplier.(ACH only)
ProviderCode string simple type Optional
SupplierCode string simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
TaxInfoRef element This reference elements will associate relevant taxes to this fee
Key string simple type Required
IncludedInBase element Shows the taxes and fees included in the base fare. (ACH only)
Amount string simple type Optional this attribute shows the amount included in the base fare for the specific fee or tax
OptionalService element this attribute shows the amount included in the base fare for the specific fee or tax
ApplicableFFLevel integer simple type Optional Numerical value of the loyalty card level for which this service is available.
AssessIndicator string simple type MileageAndCurrency , MileageOrCurrency Optional Indicates whether price is assessed by mileage or currency or both
Available boolean simple type Optional Boolean to describe whether the Service is available for sale or not
BaggageUnitPrice string simple type Optional The per unit price of baggage. Providers: 1G, 1V, 1P
BookedQuantity string simple type Optional Indicates the Optional Service quantity already booked. Provider: 1G, 1V, 1P
Chargeable string simple type Optional Indicates if the optional service is not offered, is available for a charge, or is included in the brand
Confirmation string simple type Optional Confirmation number provided by the supplier
CreateDate dateTime simple type Optional Timestamp when this service/offer got created.
DisplayOrder integer simple type Optional Optional service group display order.
DisplayText string simple type Optional Title of the Optional Service. Provider: ACH
Entitled boolean simple type Optional Boolean to describe whether the passenger is entitled for the service without charge or not
ExcessWeightRate string simple type Optional The cost of the bag per unit weight.
FirstPiece long simple type Optional Indicates the minimum occurrence of excess baggage.Provider: 1G, 1V, 1P.
GeographySpecification string simple type Optional Sector, Portion, Journey.
Group string simple type Optional Associates Optional Services with the same ServiceSub Code, Air Segment, Passenger, and EMD Associated Item. Provider:1G, 1V, 1P
InclusiveOfTax boolean simple type Optional Identifies if the service was filed with a fee that is inclusive of tax.
InterlineSettlementAllowed boolean simple type Optional Identifies if the interline settlement is allowed in service .
IsPricingApproximate boolean simple type Optional When set to True indicates that the pricing returned is approximate. Supported providers are MCH/ACH
IsRepriceRequired boolean simple type Optional false When set to “true”, the Optional Service must be re-priced. Provider: 1G, 1V, 1P
IssuanceReason string simple type Optional A one-letter code specifying the reason for issuance of the OptionalService
Key string simple type Optional
LastPiece long simple type Optional Indicates the maximum occurrence of excess baggage. Provider: 1G, 1V, 1P.
Mileage decimal simple type Optional Indicates mileage fee/amount
OptionalServicesRuleRef string simple type Optional UniqueID to associate a rule to the Optional Service
PaymentRef string simple type Optional Reference to a payment for merchandising services.
PerTraveler boolean simple type Optional true Boolean to describe whether the Amount on the Service is charged per traveler.
Priority decimal simple type Optional Numeric value that represents the priority order of the Service
Private boolean simple type Optional Describes if service is private or not.
ProviderDefinedType string simple type Optional Original Type as sent by the provider
PseudoCityCode string simple type Optional The PCC or SID that booked the Optional Service.
PurchaseWindow string simple type BookingOnly , TicketingOnly , CheckInOnly , Anytime , PostTicketing Optional Describes when the Service is available for confirmation or purchase (e.g. Booking Only, Check-in Only, Anytime, etc.)
Quantity decimal simple type Optional The number of units availed for each optional service (e.g. 2 baggage availed will be specified as 2 in quantity for optional service BAGGAGE)
Restricted boolean simple type Optional false When set to “true”, the Optional Service is restricted by an embargo. Provider: 1G, 1V, 1P
SSRCode string simple type Optional The SSR Code associated with the OptionalService
SSRFreeText string simple type Optional Certain SSR types sent in OptionalService SSRCode require a free text message. For example, PETC Pet in Cabin.
SecondaryType string simple type Optional The secondary option code type required for certain options
SequenceNumber decimal simple type Optional The sequence number associated with the OptionalService
ServiceStatus string simple type Optional Specify the service status (e.g. active, canceled, etc.)
ServiceSubCode string simple type Optional The service subcode associated with the OptionalService
Source string simple type Optional The Source of the optional service. The source can be ACH, MCE, or MCH.
Tag string simple type Optional Optional service group name.
TotalWeight string simple type Optional The total weight of a bag. Providers: 1G, 1V, 1P
Type string simple type Required Specify the type of service offered (e.g. seats, baggage, etc.)
ViewableOnly boolean simple type Optional Describes if the OptionalService is viewable only or not. If viewable only then the service cannot be sold.
WeightInExcess string simple type Optional The excess weight of a bag. Providers: 1G, 1V, 1P
ProviderCode string simple type Optional
SupplierCode string simple type Optional
ApproximateBasePrice string simple type Optional The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges.
ApproximateFees string simple type Optional The Converted fee amount in Default Currency.
ApproximateTaxes string simple type Optional The Converted tax amount in Default Currency.
ApproximateTotalPrice string simple type Optional The Converted total price in Default Currency for this entity including base price and all taxes.
BasePrice string simple type Optional Represents the base price for this entity. This does not include any taxes or surcharges.
EquivalentBasePrice string simple type Optional Represents the base price in the related currency for this entity. This does not include any taxes or surcharges.
Fees string simple type Optional The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees.
Services string simple type Optional The total cost for all optional services.
Taxes string simple type Optional The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes.
TotalPrice string simple type Optional The total price for this entity including base price and all taxes.
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
ServiceData element If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
AirSegmentRef string simple type Optional Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary.
BookingTravelerRef string simple type Optional Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers.
Data string simple type Optional Data that specifies the details of the merchandising offering (e.g. seat number for seat service)
EMDCouponRef string simple type Optional Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P
EMDSummaryRef string simple type Optional Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P
StopOver boolean simple type Optional false Indicates that there is a significant delay between flights (usually 12 hours or more)
TravelerType string simple type Optional Passenger Type Code.
SeatAttributes element Identifies the seat attribute of the service.
SeatAttribute element Identifies the seat attribute of the service.
Value string simple type Required
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
SSRRef typeKeyBasedReference complex type References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P
Key string simple type Required
ServiceInfo element
Description string simple type Description of the Service. Usually used in tandem with one or more media items.
MediaItem element Photos and other media urls for the property referenced above.
caption string simple type Optional
height integer simple type Optional
icon anyURI simple type Optional
sizeCode string simple type Optional
type string simple type Optional
url anyURI simple type Optional
width integer simple type Optional
Remark element A textual remark container to hold any printable text. (max 512 chars)
Key string simple type Optional
TaxInfo typeTaxInfo complex type The tax information for a
CarrierDefinedCategory string simple type Optional Optional category, where a carrier has used a non-standard IATA tax category. The tax category will be set to "DU"
Category string simple type Required The tax category represents a valid IATA tax code.
CouponRef string simple type Optional The coupon to which that tax is relative (if applicable)
FlightDetailsRef string simple type Optional The flight details that this tax is relative to (if applicable)
Key string simple type Optional The tax key represents a valid key of tax
ProviderCode string simple type Optional Code of the provider returning this TaxInfo.
SegmentRef string simple type Optional The segment to which that tax is relative (if applicable)
SupplierCode string simple type Optional Code of the supplier returning this TaxInfo.
TaxExempted boolean simple type Optional This indicates whether the tax specified by tax category is exempted.
Text string simple type Optional Additional Information returned from Supplier.(ACH only)
Amount string simple type Required
CountryCode string simple type Optional
DestinationAirport string simple type Optional
FareInfoRef string simple type Optional
OriginAirport string simple type Optional
TaxDetail element The tax idetail nformation for a fare quote tax.
Amount string simple type Required
CountryCode string simple type Optional
DestinationAirport string simple type Optional
FareInfoRef string simple type Optional
OriginAirport string simple type Optional
IncludedInBase element Shows the taxes and fees included in the base fare. (ACH only)
Amount string simple type Optional this attribute shows the amount included in the base fare for the specific fee or tax
FeeInfo typeFeeInfo complex type A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets
Amount string simple type Required
BaseAmount string simple type Optional
BookingTravelerRef string simple type Optional Reference to booking traveler
Code string simple type Required
Description string simple type Optional
FeeToken string simple type Optional
Key string simple type Required
PassengerTypeCode string simple type Optional
PaymentRef string simple type Optional The reference to the one of the air reservation payments if fee included in charge
SubCode string simple type Optional
Text string simple type Optional Additional Information returned from Supplier.(ACH only)
ProviderCode string simple type Optional
SupplierCode string simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
TaxInfoRef element This reference elements will associate relevant taxes to this fee
Key string simple type Required
IncludedInBase element Shows the taxes and fees included in the base fare. (ACH only)
Amount string simple type Optional this attribute shows the amount included in the base fare for the specific fee or tax
EMD element this attribute shows the amount included in the base fare for the specific fee or tax
AssociatedItem string simple type Optional The type of Optional Service. The choices are Flight, Ticket, Merchandising, Rule Buster, Allowance, Chargeable Baggage, Carry On Baggage Allowance, Prepaid Baggage. Provider: 1G, 1V, 1P
AvailabilityChargeIndicator string simple type X , E , F , G , H Optional A one-letter code specifying whether the service is available or if there is a charge associated with it. X = Service not available F = No charge for service (free) and an EMD is not issued to reflect free service E = No charge for service (free) and an EMD is issued to reflect the free service. G = No charge for service (free), booking is not required and an EMD is not issued to reflect free service H = No charge for service (free), booking is not required, and an EMD is issued to reflect the free service. Blank = No application. Charges apply according to the data in the Service Fee fields.
Booking typeBooking simple type Optional Holds the booking description for the service, e.g., SSR.
Commissionable boolean simple type Optional True/False value to whether or not the service is comissionable.
Date dateTime simple type Optional The date at which the service will be used.
DisplayCategory typeDisplayCategory simple type Optional Describes when the service should be displayed.
FulfillmentType integer simple type Optional A one digit code specifying how the service must be fulfilled. See FulfillmentTypeDescription for the description of this value.
FulfillmentTypeDescription string simple type Optional EMD description.
Location typeIATACode simple type Optional 3 letter location code where the service will be availed.
MileageIndicator boolean simple type Optional True/False value to whether or not the service has miles.
RefundReissueIndicator string simple type Refundable , NonRefundable , Reuse Optional An attribute specifying whether the service is refundable or reissuable.
Reusable boolean simple type Optional Identifies if the service can be re-used towards a future purchase.
BundledServices element Identifies if the service can be re-used towards a future purchase.
BundledService element Displays the services bundled together
Booking typeBooking simple type Optional Booking method for the bundled service, e..g SSR.
Carrier string simple type Optional Carrier the service is applicable.
CarrierSubCode boolean simple type Optional Carrier sub code. True means the carrier used their own sub code. False means the carrier used an ATPCO sub code
Name string simple type Optional Name of the bundled service.
Occurrence nonNegativeInteger simple type Optional How many of the service are included in the bundled service.
ServiceSubCode string simple type Optional The sub code of the service, e.g. OAA for Pre paid baggage
ServiceType string simple type Optional The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight
AdditionalInfo element The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight
Category string simple type Required The category code is the code the AdditionalInfo text came from, e.g. S5 or S7.
FeeApplication element The category code is the code the AdditionalInfo text came from, e.g. S5 or S7.
Code string simple type Optional The code associated to the fee application. The choices are: 1, 2, 3, 4, 5, K, F
Text typeTextElement complex type Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'.
LanguageCode token simple type Optional ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P.
Type string simple type Required
PriceRange element
DefaultCurrency boolean simple type Optional Indicates if the currency code of StartPrice / EndPrice is the default currency code
EndPrice string simple type Optional Price range end value
StartPrice string simple type Optional Price range start value
TourCode element Tour Code Fare Basis
Value string simple type Required
BrandingInfo element Branding information for the Ancillary Service. Returned in Seat Map only. Providers: 1G, 1V, 1P, ACH
Chargeable string simple type Optional Indicates if the optional service is not offered, is available for a charge, or is included in the brand. Providers: 1G, 1V, 1P, ACH
CommercialName string simple type Required The commercial name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
ExternalServiceName string simple type Optional The external name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
Key string simple type Optional
ServiceSubCode string simple type Optional The Service Sub Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
ServiceType string simple type Optional The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH
PriceRange element The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH
DefaultCurrency boolean simple type Optional Indicates if the currency code of StartPrice / EndPrice is the default currency code
EndPrice string simple type Optional Price range end value
StartPrice string simple type Optional Price range start value
Text typeTextElement complex type Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'.
LanguageCode token simple type Optional ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P.
Type string simple type Required
Title typeTextElement complex type The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P.
LanguageCode token simple type Optional ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P.
Type string simple type Required
ImageLocation element
ImageHeight integer simple type Required The height of the image
ImageWidth integer simple type Required The width of the image
Type string simple type Required Type of Image Location. E.g., "Agent", "Consumer".
ServiceGroup element The Service Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
Code string simple type Required The Service Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
ServiceSubGroup element The Service Sub Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
Code string simple type Optional The Service Sub Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH
AirSegmentRef typeSegmentRef complex type Specifies the AirSegment the branding information is for. Providers: ACH, 1G, 1V, 1P
Key string simple type Required
Title typeTextElement complex type The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P.
LanguageCode token simple type Optional ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P.
Type string simple type Required
GroupedOptionInfo element
GroupedOption element
OptionalServiceRef string simple type Required Reference to a optionalService which is paired with other optional services in the parent PairedOptions element.
OptionalServiceRules ServiceRuleType complex type Holds the rules for selecting the optional service in the itinerary
Key string simple type Required Unique ID to identify an optional service rule
ApplicationRules element The rules to apply the rule to the itinerary
RequiredForAllSegments boolean simple type Optional Indicates if the option needs to be applied to all segments in the itinerary if selected
RequiredForAllSegmentsInOD boolean simple type Optional Indicates if the option needs to be applied to all segments in a origin / destination (connection flights) if selected for one segment in the OD
RequiredForAllTravelers boolean simple type Optional Indicates if the option needs to be applied to all travelers in the itinerary if selected
SecondaryOptionCodeRequired boolean simple type Optional If set to true, the secondary option code is required for this option
UnselectedOptionRequired boolean simple type Optional If an UnselectedOption is present in the option, then the Unselected option needs to be selected even if the option is not selected when this flag is set to true
ApplicationLevel element Lists the levels where the option is applied in the itinerary. Some options are applied for the entire itinerary, some for entire segments, etc.
ApplicableLevels anonymous simple type Optional Indicates the level in the itinerary when the option is applied.
ProviderDefinedApplicableLevels string simple type Optional Indicates the actual provider defined ApplicableLevels which is mapped to Other
ApplicationLimits element Adds the limits on the number of options that can be selected for a particular type
ApplicationLimit OptionalServiceApplicationLimitType complex type The application limits for a particular level
ApplicableLevel string simple type Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other Required Indicates the applicable level for the option
MaximumQuantity nonNegativeInteger simple type Required The maximum quantity allowed for the type
MinimumQuantity nonNegativeInteger simple type Optional Indicates the minimum number of the option that can be selected.
ProviderDefinedApplicableLevels string simple type Optional Indicates the actual provider defined ApplicableLevels which is mapped to Other
ServiceData element Indicates the actual provider defined ApplicableLevels which is mapped to Other
AirSegmentRef string simple type Optional Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary.
BookingTravelerRef string simple type Optional Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers.
Data string simple type Optional Data that specifies the details of the merchandising offering (e.g. seat number for seat service)
EMDCouponRef string simple type Optional Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P
EMDSummaryRef string simple type Optional Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P
StopOver boolean simple type Optional false Indicates that there is a significant delay between flights (usually 12 hours or more)
TravelerType string simple type Optional Passenger Type Code.
SeatAttributes element Identifies the seat attribute of the service.
SeatAttribute element Identifies the seat attribute of the service.
Value string simple type Required
CabinClass element Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier.
Type string simple type Required
SSRRef typeKeyBasedReference complex type References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P
Key string simple type Required
ModifyRules element Groups the modification rules for the Option
ProviderDefinedModificationType string simple type Optional Indicates the actual provider defined modification type which is mapped to Other
SupportedModifications anonymous simple type Optional Lists the supported modifications for the itinerary.
ModifyRule element Indicates modification rules for the particular modification type.
AutomaticallyAppliedOnAdd boolean simple type Optional false Indicates if the option will be automatically added to new segments / passengers in the itinerary.
CanAdd boolean simple type Optional Indicates if the option can be added to the itinerary without segment or passenger modification
CanDelete boolean simple type Optional Indicates if the option can be deleted from the itinerary without segment or passenger modifications
Modification NMTOKEN simple type AddSegment , RemoveSegment , ReplaceSegment , AddPassenger , RemovePassenger , OptionsOnly , Other Required The modificaiton for which this rule group applies.
ProviderDefinedModificationType string simple type Optional Indicates the actual provider defined modification type which is mapped to Other
Refundable boolean simple type Optional Indicates if the price of the option is refundable.
SecondaryTypeRules element Lists the supported Secondary Codes for the optional / additional service.
SecondaryTypeRule element Lists a single secondary code for the optional / additional service.
SecondaryType string simple type Required The unique type to associate a secondary type in an optional service
ApplicationLimit OptionalServiceApplicationLimitType complex type The unique type to associate a secondary type in an optional service
ApplicableLevel string simple type Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other Required Indicates the applicable level for the option
MaximumQuantity nonNegativeInteger simple type Required The maximum quantity allowed for the type
MinimumQuantity nonNegativeInteger simple type Optional Indicates the minimum number of the option that can be selected.
ProviderDefinedApplicableLevels string simple type Optional Indicates the actual provider defined ApplicableLevels which is mapped to Other
Remarks FormattedTextTextType complex type Adds text remarks / rules for the optional / additional service
Formatted boolean simple type Optional Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text.
TextFormat NMTOKEN simple type PlainText , HTML Optional Indicates the format of text used in the description e.g. unformatted or html.
Language token simple type Optional Language identification.
FormOfPayment element A Form of Payment used to purchase all or part of a booking.
AgentText string simple type Optional This is only relevent when IsAgentType is specified as true. Otherwise this will be ignored.
ExternalReference string simple type Optional
FulfillmentIDNumber string simple type Optional Identification number, e.g. card number, to define how the customer will identify himself when collecting the ticket
FulfillmentIDType string simple type Bahn Card , Credit Card , Euro Cheque Card , Collection Reference Optional Identification type, e.g. credit card, to define how the customer will identify himself when collecting the ticket
FulfillmentLocation string simple type Optional Information about the location of the printer.
FulfillmentType string simple type Optional Defines how the client wishes to receive travel documents. Type does not define where or how payment is made. The supported values are "Ticket on Departure", "Travel Agency", "Courier", "Standard Mail", "Ticketless", "Ticket Office", "Express Mail", "Corporate Kiosk", "Train Station Service Desk", "Direct Printing of Ticket", "Ticket by Email", "Digital Printing of Ticket at Home", "Retrieve Ticket at Eurostar in London" Collect booking ticket at a Kiosk, print in agency.
IsAgentType boolean simple type Optional false If this is true then FormOfPayment mention in Type is anAgent type FormOfPayment.
Key string simple type Optional
ProfileID string simple type Optional The unique ID of the profile that contains the payment details to use.
ProfileKey string simple type Optional The Key assigned to the payment details value from the specified profile.
Reusable boolean simple type Optional false Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment
ReuseFOP string simple type Optional Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse.
Type string simple type Required
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
CreditCard element Container for all credit card information.
AcceptanceOverride boolean simple type Optional Override airline restriction on the credit card.
BankCountryCode string simple type Optional ISO Country code associated with the issuing bank
BankName string simple type Optional Issuing bank name for this credit card
BankStateCode string simple type Optional State code associated with the issuing bank.
CustomerReference string simple type Optional Agencies use this to pass the traveler information to the credit card company.
Enett boolean simple type Optional false Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false.
ExtendedPayment string simple type Optional Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule.
ThirdPartyPayment boolean simple type Optional false If true, this indicates that the credit card holder is not one of the passengers.
ApprovalCode string simple type Optional This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions.
CVV string simple type Optional Card Verification Code
ExpDate gYearMonth simple type Optional The Expiration date of this card in YYYY-MM format.
Name string simple type Optional The name as it appears on the card.
Number string simple type Optional
Type string simple type Optional The 2 letter credit/ debit card type.
Key string simple type Optional The Key assigned to the payment details value from the specified profile.
ProfileID string simple type Optional The unique ID of the profile that contains the payment details to use.
PhoneNumber element Consists of type (office, home, fax), location (city code), the country code, the number, and an extension.
AreaCode string simple type Optional
CountryCode string simple type Optional Hosts/providers will expect this to be international dialing digits
Extension string simple type Optional
Key string simple type Optional
Location string simple type Optional IATA code for airport or city
Number string simple type Required The local phone number
Text string simple type Optional
Type string simple type Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
ProviderReservationInfoRef element Container for Provider reservation reference key.
Key string simple type Required
BillingAddress typeStructuredAddress complex type The address to where the billing statements for this card are sent. Used for address verification purposes.
Key string simple type Optional Key for update/delete of the element
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
AddressName anonymous simple type If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
Street anonymous simple type The Address street and number, e.g. 105 Main St.
City anonymous simple type The city name for the requested address, e.g. Atlanta.
State element Container to house the state code for an address
PostalCode anonymous simple type The 5-15 alphanumeric postal Code for the requested address, e.g. 90210.
Country anonymous simple type The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches.
ProviderReservationInfoRef element Container for Provider reservation reference key.
Key string simple type Required
DebitCard element Container for all debit card information.
ApprovalCode string simple type Optional This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions.
CVV string simple type Optional Card Verification Code
ExpDate gYearMonth simple type Optional The Expiration date of this card in YYYY-MM format.
Name string simple type Optional The name as it appears on the card.
Number string simple type Optional
Type string simple type Optional The 2 letter credit/ debit card type.
IssueNumber string simple type Optional Verification number for Debit Cards
Key string simple type Optional The Key assigned to the payment details value from the specified profile.
ProfileID string simple type Optional The unique ID of the profile that contains the payment details to use.
PhoneNumber element Consists of type (office, home, fax), location (city code), the country code, the number, and an extension.
AreaCode string simple type Optional
CountryCode string simple type Optional Hosts/providers will expect this to be international dialing digits
Extension string simple type Optional
Key string simple type Optional
Location string simple type Optional IATA code for airport or city
Number string simple type Required The local phone number
Text string simple type Optional
Type string simple type Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
ProviderReservationInfoRef element Container for Provider reservation reference key.
Key string simple type Required
BillingAddress typeStructuredAddress complex type The address to where the billing statements for this card are sent. Used for address verification purposes.
Key string simple type Optional Key for update/delete of the element
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
AddressName anonymous simple type If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.
Street anonymous simple type The Address street and number, e.g. 105 Main St.
City anonymous simple type The city name for the requested address, e.g. Atlanta.
State element Container to house the state code for an address
PostalCode anonymous simple type The 5-15 alphanumeric postal Code for the requested address, e.g. 90210.
Country anonymous simple type The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches.
ProviderReservationInfoRef element Container for Provider reservation reference key.
Key string simple type Required
EnettVan element Container for all eNett Van information.
ExpiryDays duration simple type Optional The number of days from the VAN generation date that the VAN will be active for, after which the VAN cannot be used.
MaxPercentage nonNegativeInteger simple type Optional The maximum percentage that will be applied on the Total price and sent to enett, which will denote the maximum authorized amount as approved by eNett. This value will be ignored and not used for Multi-Use VAN’s.
MinPercentage nonNegativeInteger simple type Optional The minimum percentage that will be applied on the Total price and sent to enett,which will denote the minimum authorized amount approved by eNett.uApi will default this to zero for multi-use Van's.
MultiUse boolean simple type Optional true Acceptable values are true or false. If set to true it will denote that the VAN being requested is multi-use else it will indicate a single -use VAN.A Single use VAN can only be debited once while the multiple use VAN's can be debited multiple times subjected to the maximum value it has been authorized for. The default value will be TRUE to indicate a multi-use VAN is being issued.
Certificate element Certificate Form of Payment
Amount string simple type Optional The monetary value of the certificate.
DiscountAmount string simple type Optional The monetary discount amount of this certificate.
DiscountPercentage decimal simple type Optional The percentage discount value of this certificate.
NotValidAfter date simple type Optional The date that this certificate expires.
NotValidBefore date simple type Optional The date that this certificate becomes valid.
Number string simple type Required The Certificate number
TicketNumber StringLength1to13 simple type The identifying number for the actual ticket
Check element Check Form of Payment
AccountNumber string simple type Optional The account number of the check
CheckNumber string simple type Optional The sequential check number of the check.
MICRNumber string simple type Optional Magnetic Ink Character Reader Number of check.
RoutingNumber string simple type Optional The bank routing number of the check.
Requisition element Requisition Form of Payment
Category string simple type Government , Other Optional Classification Category for the requisition payment
Number string simple type Optional Requisition number used for accounting
Type string simple type Cash , Credit Optional Type can be Cash or Credit for category as Government
MiscFormOfPayment element Miscellaneous Form of Payments
AcceptanceOverride boolean simple type Optional Override airline restriction on the credit card.
Category string simple type Required Indicates what Category the Miscellaneous Form Of Payment is being used for payment - The category may vary by GDS.Allowable values are "Text" "Credit" "CreditCard" "FreeFormCreditCard" "Invoice" "NonRefundable" "MultipleReceivables" "Exchange" "Cash"
CreditCardNumber string simple type Optional
CreditCardType string simple type Optional The 2 letter credit/ debit card type or code which may not have been issued using the standard bank card types - i.e. an airline issued card
ExpDate gYearMonth simple type Optional The Expiration date of this card in YYYY-MM format.
Text string simple type Optional Any free form text which may be associated with the Miscellaneous Form of Payment. This text may be provider or GDS specific
AgencyPayment typeAgencyPayment complex type Container for Agency Payment
AgencyBillingIdentifier string simple type Required Value of the billing id
AgencyBillingNumber string simple type Optional Value of billing number
AgencyBillingPassword string simple type Optional Value of billing password
UnitedNations element United Nations Form of Payments
Number string simple type Required
DirectPayment element Direct Payment Form of Payments
Text string simple type Optional
AgentVoucher element Agent Voucher Form of Payments
Number string simple type Required
PaymentAdvice element Contains other form of payment for Cruise Reservations
DocumentNumber string simple type Required Payment Document Number Examples: 1234567890, R7777
IssueCity string simple type Required City code of document issuance
IssueDate date simple type Required Document Issuance date
OriginalFOP string simple type Optional Original form of payment Examples: CHECK 3500
Type string simple type Required Other Payment Yype. Possible Values: AGC - Agency Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash Equivalent, DBC - Denied Boarding Compensation, MCO - Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher
ProviderReservationInfoRef typeFormOfPaymentPNRReference complex type Other Payment Yype. Possible Values: AGC - Agency Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash Equivalent, DBC - Denied Boarding Compensation, MCO - Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher
Key string simple type Optional Unique ID to identify a ProviderReservationInfo
ProviderReservationLevel boolean simple type Optional true It means that the form of payment is applied at ProviderReservation level.
SegmentRef typeGeneralReference complex type It means that the form of payment is applied at ProviderReservation level.
Key string simple type Required
BSPPayment element BSP form of payment.ACH Only
BSPIdentifier string simple type Required Value of the BSP Direct Bill id
BSPPassword string simple type Optional Value of the BSP Direct Bill id password
ARCPayment element ARC form of payment.ACH Only
ARCIdentifier string simple type Required Value of the ARC Direct Bill id
ARCPassword string simple type Optional Value of the ARC Direct Bill id password
PCC element Specify pseudo City
OverridePCC element Used to emulate to another PCC or SID. Providers: 1G, 1V, 1P.
ProviderCode string simple type Required The code of the provider (e.g. 1G, 1S)
PseudoCityCode string simple type Required The PCC in the host system.
PointOfSale element User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale.
IATA string simple type Optional Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V
Key string simple type Optional
ProviderCode string simple type Required The provider in which the PCC is defined.
PseudoCityCode string simple type Required The PCC in the host system.
TicketAgency element This modifier will override the pseudo of the ticketing agency found in the AAT (TKAG). Used for all plating carrier validation.
ProviderCode anySimpleType simple type Required The code of the Provider (e.g. 1G, 1P)
PseudoCityCode anySimpleType simple type Required The PCC of the host system.
SSR element Special serivces like wheel chair, or pet carrier.
Carrier string simple type Optional
CarrierSpecificText string simple type Optional Carrier specific information which are not captured in the FreeText field(not present in IATA's standard SSR DOCO format). An example is VISA Expiration Date.
Description string simple type Optional
FreeText string simple type Optional Certain SSR types will require a free text message. For example MAAS (Meet and assist).
Key string simple type Optional
PassiveSegmentRef string simple type Optional Reference to the passive segment.
ProfileID string simple type Optional Key assigned for Secure Flight Document value from the specified profile
ProfileSecureFlightDocKey string simple type Optional Unique ID of Booking Traveler's Profile that contains the Secure flight Detail
ProviderDefinedType string simple type Optional Original Type as sent by the provider
ProviderReservationInfoRef string simple type Optional Provider reservation reference key.
SSRRuleRef string simple type Optional UniqueID to associate a rule to the SSR
SegmentRef string simple type Optional Reference to the air segment. May be required for some Types.
Status string simple type Optional
Type string simple type Required Programmatic SSRs use codes recognized by the provider/supplier (example, VGML=vegetarian meal code). Manual SSRs do not have an associated programmatic code.
URL anyURI simple type Optional
ElStat string simple type A , M , C Optional This attribute is used to show the action results of an element. Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only.
KeyOverride boolean simple type Optional If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true.