PaxFaB – Reference

Reference: API change management

Mon, 01 Jan 0001 00:00:00 +0000

PaxFaB is not a versioned API. Instead API changes are classified as either Minor, Major Optional, or Major Mandatory; and the corresponding policy followed.

Minor

For minor changes no development work should be required by you as long as your integration adheres to Paxport’s guidance and gracefully accepts minor changes (see later “Minor vs Major” section for definition). Though you may wish to make changes to take advantage of the new features included in the minor change.

Major - optional

Optional major changes will almost certainly require you to make development changes if the new functionality is enabled for you.

These changes are referred to as optional because they will be feature gated/switched on the PaxFaB backend then either:

disabled by default for pre-existing API users
or enabled by default but you will be notified of the option to disable pre-release

Major - mandatory

Mandatory major changes will almost certainly require you to make development changes by a deadline. If you fail to make any necessary changes you will be unable to continue using PaxFab once the deadline is reached.

Mandatory major changes are rare on the PaxFab API and deadlines are devised through customer consultation. The typical deadline would be 12 months.

Notifications

Emails will be sent out for all “Major Mandatory” release events and for most “Major Optional” release events. It is therefore important that you keep your release contacts up to date with Paxport Customer Services.

Minor vs Major

We consider the following Paxport initiated changes to be minor:

Adding new API endpoints/messages
- As long as they don’t result in a mandatory change to an existing flow.
Adding new response fields
Adding new optional request fields
Making an optional response field mandatory
Making a mandatory request field optional
Reordering of response fields for XML elements and attributes
- Unless an order has previously been explicitly defined in written documentation
Changing the contents of any field as long as it stays within the limits of the API specification.

Note

Paxport retains the right to break the change management policy in case of extraordinary circumstances. For example security, legal, or regulatory issues.

Reference: XSDs

Mon, 01 Jan 0001 00:00:00 +0000

FAB XSD files

FAB_SimpleTypes.xsd

FAB_CommonTypes.xsd

FAB_FormattedContent.xsd

Reference: FABRequestResponse

Mon, 01 Jan 0001 00:00:00 +0000

Each request message or response message from FAB is an example of a FABRequestResponse object and as such has the following structure:

Attribute or element	Mandatory?	Definition	Note
`@Target`	Yes	`test` or `production`	Controls which FAB system is used. Bookings against “test” are not real.
`@Version`	Yes	Must be set to `2002A`	-
`SyndicatorInfo@SyndicatorId`	Yes	String of syndicatorId	Used for authN/authZ
`SyndicatorInfo@SyndicatorPassword`	Yes	String of syndicator password	Used for authN/authZ
`SessionInfo@CreateNewSession`	Yes	`true` or `false`	Controls whether to create a new FAB session, see API concepts section on sessions.
`SessionInfo@FABSessionId`	Yes for all responses. Yes for requests if continuing a session.	String	See API concepts section on sessions
`ConsumersContext@Reference`	No	consisting of any string that the syndicator wishes to attach to this request/response.	-
`ConsumersContext/Parameter[*]@Name`	No	Key pair value variation of Reference	Element can be repeated up to a total of 10
`ConsumersContext/Parameter[*]@Value`	No	Key pair value variation of Reference	Element can be repeated up to a total of 10
`Warnings`	No	List of `Warning` that are relevant to current request or response	Note that for FAB_BasketRS warnings may also be set a level down so check both locations, see FAB__BasketRS
`Warnings/Warning[*]`	No	Warning text	-
`Errors`	No	List of `Error` that are relevant to current request or response	Note that for FAB_BasketRS errors may also be set a level down so check both locations, see FAB_BasketRS
`Errors/Error[*]@ErrorText`	Yes if `Error` element is being set	a generic human readable description of the error	Likely not appropriate to expose to consumers
`Errors/Error[*]@ErrorCode`	Yes if `Error` element is being set	string error code	see Error Codes
`ConfigOverride@NormalisationCurrency`	No	ISO 4217 alphabetic currency that response prices should be normalised (converted) to	Should be used consistently throughout all stages of a journey
`CurrencyConversionRates`	No	Contains a list of `Rate` that can be used for currency conversion in place of spot rate	-
`CurrencyConversionRates/Rate[*]@FromCurrency`	Yes if `Rate` element is being set	ISO 4217 alphabetic currency. From currency for rate	-
`CurrencyConversionRates/Rate[*]@ToCurrency`	Yes if `Rate` element is being set	ISO 4217 alphabetic currency. To currency for rate	-
`CurrencyConversionRates/Rate[*]@Rate`	Yes if `Rate` element is being set	Float greater than zero. Rate	-
`Languages`	No	List of Language codes in priority order descending. Indicates preferred content language. If unset or none of the listed languages are supported by the supplier then English (`EN`) will be used.	Also see example page for this feature
`Languages/Language[*]`	Yes if `Languages` element is being set	ISO 639-1 two letter language code, e.g `EN`	-

Reference: FABSearchRequest

Mon, 01 Jan 0001 00:00:00 +0000

FAB_PkgAvailRQ is an example of a FABSearchRequest type.

Attribute or element	Mandatory?	Definition	Note
`ResultSetPreferences`	Yes	Limit and sort the result set	-
`ResultSetPreferences@SortCode`	No, default `cost`	`none` or `cost`. Sort result set	-
`ResultSetPreferences@SortAscending`	No, default true	Boolean, if true then sort ascending	-
`ResultSetPreferences@MaxItems`	No, default 300	Integer limit of max number of results to return	-
`InitialViewInfo`	Yes	-	-
`InitialViewInfo@Offset`	No	-	Advisable to leave unset
`InitialViewInfo@Length`	No, default 50	-	Advisable to always set equal to `ResultSetPreferences@MaxItems`
`@ResponseTimeoutSecs`	No, has default of 30	Non negative integer	FAB will attempt to abort and return early if this timeout is reached. Advisable to set no lower than 3 seconds. Generally set to the maximum time your consumer or operator is willing to wait for a response (with some margin for your own processing).
`@ExcludeNonBookableSuppliers`	No, default false	boolean, if true exclude results that are not bookable in FAB	-

Reference: FABSearchResponse

Mon, 01 Jan 0001 00:00:00 +0000

FAB_PkgAvailRS is an example of a FABSearchResponse type.

Any FABSearchRequest type will result in a FABSearchResponse.

Attribute or element	Mandatory?	Definition	Note
`@Success`	Yes	Boolean indicating if search was successful	-
`ResultSetInfo@SortCode`	Yes	Indicates how result set was sorted	-
`ResultSetInfo@SortAscending`	Yes	-	-
`ResultSetInfo@MaxItems`	Yes	-	-
`ResultSetInfo@NumItems`	Yes	How many results have been returned	-
`ViewInfo@Offset`	No	-	-
`ViewInfo@Length`	Yes	-	-

Reference: FAB_PkgAvailRQ

Mon, 01 Jan 0001 00:00:00 +0000

A FAB_PkgAvailRQ message will result in a FAB_PkgAvailRS response message that will show holiday availability information. Each FAB_PkgAvailRQ must contain a HolidaySearchRequest.

HolidaySearchRequest

HolidaySearchRequest is an example of a FABSearchRequest

It has the following additional structure:

Attribute or element	Mandatory?	Definition	Note
`SearchCriteria@FlightOnly`	No, default false	boolean, if true then search is for flights, if false then search is for packages	Always set this to true
`SearchCriteria@OneWayOnly`	No, default false	boolean, if true then search is for one way flights, if false then search is for return flights	-
`SearchCriteria@NumberOfAdults`	No, default 1	Number of adults in party	An adult is aged 16 years or older at datetime of final flight.
`SearchCriteria@NumberOfYouths`	No, default 0	Number of youths in party	A youth is aged 12 years or older but less than 16 years old at datetime of final flight.
`SearchCriteria@NumberOfChildren`	No, default 0	Number of children in party	A child is aged 2 years or older but less than 12 years old at datetime of final flight.
`SearchCriteria@NumberOfInfants`	No, default 0	Number of infants in party	An infant is less than 2 years old at datetime of final flight.
`SearchCriteria@IncludeITFares`	No, default false	boolean if true FAB will attempt to include IT Fares in the result set	-
`SearchCriteria/DepartureDateRange@StartDate`	Yes	yyyyMMdd start date of departure date range	For a range greater than 7 contact your Account Manager about our PaxCache product
`SearchCriteria/DepartureDateRange@EndDate`	Yes	yyyyMMdd end date of departure date range	For a range greater than 7 contact your Account Manager about our PaxCache product
`SearchCriteria/HolidayDuration@MinNumberOfNights`	Yes for a return search	Integer greater than zero	Must equal `MaxNumberOfNights`. For duration ranged searches talk to your Paxport Account Manager about our PaxCache product. Simple calculation between departure date and return departure date, no consideration of time.
`SearchCriteria/HolidayDuration@MaxNumberOfNights`	Yes for a return search	Integer greater than zero	Must equal `MinNumberOfNights`. For duration ranged searches talk to your Paxport Account Manager about our PaxCache product. Simple calculation between departure date and return departure date, no consideration of time.
`SearchCriteria/TimePreferences`	No	Optionally limit results based on departure/arrival times	Default leeway applied to each of +/- 60 minutes, this can be adjusted by Paxport Customer Service Team.
`SearchCriteria/TimePreferences@OutboundDepartureTime`	No	`HHmm`	In local time of airport
`SearchCriteria/TimePreferences@OutboundArrivalTime`	No	`HHmm`	In local time of airport
`SearchCriteria/TimePreferences@HomeboundDepartureTime`	No	`HHmm`	In local time of airport
`SearchCriteria/TimePreferences@HomeboundArrivalTime`	No	`HHmm`	In local time of airport
`SearchCriteria/FlightPreferences@DirectFlightsOnly`	No, default false	boolean, if true then limit results to direct flights only	A direct flight can include technical landings, this behaviour can be changed by Paxport Customer Service Team
`SearchCriteria/FlightPreferences@CabinClass`	No	Limit results to one of the following cabin classes: `economy` `premium` `business` `first`	If unset FAB will attempt to return all cabin classes. Note that for some suppliers only one cabin class can be searched at a time, with `economy` being the default.
`SearchCriteria/FlightPreferences@Carrier`	No, default no limit	Limit results to flights that are marketed and operated by this carrier (code)	ICAO or IATA code, depending on supplier’s preference
`SearchCriteria/DepartureAirports`	Yes, unless search uses `SpecificRouteFlightSearchList`	List of `Airport` to depart from	-
`SearchCriteria/DepartureAirports/Airport[*]`	Yes	IATA airport code	IATA city codes are supported as long as they are unique; city codes that also refer to a specific airport are not supported
`SearchCriteria/DestinationChoice/DestinationAirports`	Yes, unless search uses `SpecificRouteFlightSearchList`	List of `Airport` to arrive at	-
`SearchCriteria/DestinationChoice/DestinationAirports/Airport[*]`	Yes	IATA airport code	IATA city codes are supported as long as they are unique; city codes that also refer to a specific airport are not supported
`SearchCriteria/Suppliers`	No	Contains one or `Supplier` elements	-
`SearchCriteria/Suppliers/Supplier[*]`	No	Contains FAB supplier code	Limiting your search to specific suppliers may improve performance
`SearchCriteria/ExcludeSuppliers`	No	Contains one or `Supplier` elements	-
`SearchCriteria/ExcludeSuppliers/Supplier[*]`	No	Contains FAB supplier code	Limiting your search to exclude specific suppliers may improve performance
`SearchCriteria/AdultAge[*]`	No	Integer age in years of adult at datetime of final flight, element can be repeated as a list	Set if known as this may improve price accuracy
`SearchCriteria/YouthAge[*]`	No	Integer age in years of youth at datetime of final flight, element can be repeated as a list	Set if known as this may improve price accuracy
`SearchCriteria/ChildAge[*]`	No	Integer age in years of child at datetime of final flight, element can be repeated as a list	Set if known as this may improve price accuracy
`SearchCriteria/CostConstraints`	No	Limit results to a cost range	-
`SearchCriteria/CostConstraints@MaxPerPersonCost`	Yes	Max cost per person	-
`SearchCriteria/CostConstraints@MinPerPersonCost`	Yes	Min cost per person	-
`SearchCriteria/CostConstraints@Currency`	Yes	ISO 4217 alphabetic currency	-
`SearchCriteria/SpecificRouteFlightSearchList`	Yes, unless search uses `DepartureAirports` and `DestinationAirports`	List of SpecificRouteFlightSearch, for making Open Jaw searches	-
`SearchCriteria/SpecificRouteFlightSearchList/SpecificRouteFlightSearch[*]`	Yes	Contains exactly two `TravelPointPair` to describe one Open Jaw trip	-
`SearchCriteria/SpecificRouteFlightSearchList/SpecificRouteFlightSearch[]/TravelPointPair[]`	Yes	Exactly two per `SpecificRouteFlightSearch`, one per segment of a trip	-
`SearchCriteria/SpecificRouteFlightSearchList/SpecificRouteFlightSearch[]/TravelPointPair[]@DeparturePoint`	Yes	Departure point of segment	-
`SearchCriteria/SpecificRouteFlightSearchList/SpecificRouteFlightSearch[]/TravelPointPair[]@ArrivalPoint`	Yes	Arrival point of segment	-

Reference: FAB_PkgAvailRS

Mon, 01 Jan 0001 00:00:00 +0000

FAB_PkgAvailRS is an example of a FABRequestResponse. Additionally it contains the HolidaySearchResponse element, which is an example of a FABSearchResponse. The HolidaySearchResponse also includes:

Attribute or element	Mandatory?	Definition	Note
`/PackageHolidays`	Yes if results are present	List of `PackageHolidays`	-
`/PackageHolidays/PackageHoliday@ItineraryId`	Yes	String	Required for later basket request. Contains encoded ampersand. Length and structure is not fixed.
`/PackageHolidays/PackageHoliday@Supplier`	Yes	FAB supplier code	-
`/PackageHolidays/PackageHoliday@Country`	No	ISO 3166-1 alpha-2 code of destination country	Due to limited coverage it is advisable to not rely on this attribute
`/PackageHolidays/PackageHoliday@NumberOfNights`	Yes for a return trip	Non negative integer.	Simple calculation between departure date and return departure date, no consideration of time.
`/PackageHolidays/PackageHoliday@LeadInPricePerPassenger`	Yes	Adult lead in price	-
`/PackageHolidays/PackageHoliday@YouthPrice`	No	Youth lead in price	Enabled via backend config; contact support. Attribute will be missing if no youths were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search.
`/PackageHolidays/PackageHoliday@ChildPrice`	No	Child lead in price	Enabled via backend config; contact support. Attribute will be missing if no children were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search.
`/PackageHolidays/PackageHoliday@InfantPrice`	No	Infant lead in price	Enabled via backend config; contact support. Attribute will be missing if no infants were searched for. Attribute may be missing if value is unknown; e.g if supplier does not provide it at search.
`/PackageHolidays/PackageHoliday@FlightOnly`	Yes	`true` indicates trip is a flight. `false` indicates package.	-
`/PackageHolidays/PackageHoliday@OneWayOnly`	Yes	boolean that indicates if trip is oneway or return	-
`/PackageHolidays/PackageHoliday@BookableByFAB`	Yes	boolean that indicates if FAB can book this trip	-
`/PackageHolidays/PackageHoliday@Currency`	Yes	ISO 4217 alphabetic currency of provided prices	-
`/PackageHolidays/PackageHoliday@BookingChannel`	No	-	Advised to ignore
`/PackageHolidays/PackageHoliday@PassengerIdRequired`	No, default false	boolean, if true then ID information must be provided to the supplier before departure	-
`/PackageHolidays/PackageHoliday@PassengerIdMandatory`	No, default false	boolean, if true then ID information must be provided to the supplier before booking	-
`/PackageHolidays/PackageHoliday@NationalityRequired`	No, default false	`true` or `false`, if true then nationality information must be provided to the supplier before departure	-
`/PackageHolidays/PackageHoliday@NationalityMandatory`	No, default false	`true` or `false`, if true then `Nationality` attribute must be set for each passenger before booking	-
`/PackageHolidays/PackageHoliday@LastTicketTimestamp`	No	`yyyyMMdd HHmm` UTC timestamp for deadline to ticket fare by	-
`/PackageHolidays/PackageHoliday[*]/Flight@OriginAirport`	Yes	IATA code	-
`/PackageHolidays/PackageHoliday[*]/Flight@DestinationAirport`	Yes	IATA code	-
`/PackageHolidays/PackageHoliday[*]/Flight@HomeboundDeparturePoint`	No	IATA code	Only set for Open Jaw trips
`/PackageHolidays/PackageHoliday[*]/Flight@HomeboundArrivalPoint`	No	IATA code	Only set for Open Jaw trips
`/PackageHolidays/PackageHoliday[*]/Flight@DepartureDate`	Yes	yyyyMMdd	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@DepartureTime`	Yes	HHmm	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDate`	Yes for a return trip	yyyyMMdd	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeTime`	Yes for a return trip	HHmm	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDepartDate`	Yes for a return trip	yyyyMMdd	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnHomeDepartTime`	Yes for a return trip	HHmm	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ArrivalDate`	Yes	yyyyMMdd	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@ArrivalTime`	Yes	HHmm	In local time of airport
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightNumber`	Yes	Outbound flight number, prefixed with marketing carrier code	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightNumber`	Yes for a return trip	Return flight number, prefixed with marketing carrier code	-
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightBasePrice`	Yes	Outbound adult price for fare + taxes	For some older supplier integrations this may exclude tax, contact Customer Service for more information
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightBasePrice`	Yes for a return trip	Return adult price for fare + taxes	For some older supplier integrations this may exclude tax, contact Customer Service for more information
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundCarrier`	No	Outbound operating carrier code of first leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnCarrier`	No	Return operating carrier code of first leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[*]/Flight@MarketingCarrier`	Yes	Outbound marketing carrier code of first leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundMarketingCarrier`	No	Marketing outbound carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[*]/Flight@InboundMarketingCarrier`	No	Marketing indbound carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[*]/Flight@FareClass`	No	Indicates the fare class of the first outbound leg	Generally a single letter, e.g “Y”
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundFlightClass`	No	Indicates the fare class of the first outbound leg	Generally a single letter, e.g “Y”
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnFlightClass`	No	Indicates the fare class of the first inbound leg	Generally a single letter, e.g “Y”
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundStopPoints`	No	IATA code of any technical stops that are part of the outbound flight	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnStopPoints`	No	IATA code of any technical stops that are part of the return flight	-
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundAirlineName`	No	Outbound operating carrier name	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnAirlineName`	No	Return operating carrier name	-
`/PackageHolidays/PackageHoliday[*]/Flight@OriginAirportName`	No	Origin airport name	-
`/PackageHolidays/PackageHoliday[*]/Flight@DestinationAirportName`	No	Destination airport name	-
`/PackageHolidays/PackageHoliday[*]/Flight@FareType`	Yes	`Published` `Private` `NoFrills` `NegoCorporate`	-
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundCabinClass`	Yes	`ECONOMY` `PREMIUM` `BUSINESS` `FIRST`	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnCabinClass`	Yes	`ECONOMY` `PREMIUM` `BUSINESS` `FIRST`	-
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundJourneyMins`	No	total outbound journey duration in minutes	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnJourneyMins`	No	total return journey duration in minutes	-
`/PackageHolidays/PackageHoliday[*]/Flight@OutboundNumStops`	No, default zero	the total number of stops on the outbound journey	-
`/PackageHolidays/PackageHoliday[*]/Flight@ReturnNumStops`	No, default zero	the total number of stops on the return journey	-
`/PackageHolidays/PackageHoliday[*]/Flight@ITFare`	No, default false	boolean indicating if this flight result is an IT (Inclusive Tour) fare and therefore should only be used when using the flight as part of an “inclusive package”.	-
`/PackageHolidays/PackageHoliday[*]/Flight@CAT35Fare`	No, default false	boolean indicating if this flight result is a CAT35 fare	-
`/PackageHolidays/PackageHoliday[*]/Flight@MultiLegOutboundFlight`	No, default false	boolean indicating if the outbound flight consists of multiple legs	-
`/PackageHolidays/PackageHoliday[*]/Flight@MultiLegReturnFlight`	No, default false	boolean indicating if the return flight consists of multiple legs	-
`/PackageHolidays/PackageHoliday[*]/Flight@DisconnectedFlights`	No, default false	boolean, if true then trip is Open Jaw	-
`/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance`	No	Indicates included baggage allowance	Only supported by select suppliers
`/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Per`	Yes	`Passenger` or `Adult` or `Youth` or `Child` or `Infant`	-
`/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Unit`	Yes	`Piece` or `kg` or `lb` or `Unknown`	-
`/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Quantity`	Yes	Integer	-
`/PackageHolidays/PackageHoliday[*]/Flight/OutboundBaggageAllowance@Type`	Yes	`Hold` or `Hand`	-
`/PackageHolidays/PackageHoliday[*]/Flight/HomeboundBaggageAllowance`	No	Same structure as `OutboundBaggageAllowance`	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]`	No	If segment is multileg/indirect one or more subsegments/legs will be listed	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@DeparturePoint`	Yes	IATA code	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@DepartureDate`	Yes	yyyyMMdd	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@DepartureTime`	Yes	HHmm	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@ArrivalPoint`	Yes	IATA code	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@ArrivalDate`	Yes	yyyyMMdd	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@ArrivalTime`	Yes	HHmm	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@OperatingCarrier`	No	Operating carrier code of leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@MarketingCarrier`	No	Marketing carrier code of leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@OperatedBy`	No	Operating carrier name	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@FlightNumber`	Yes	Flight number, prefixed with marketing carrier code	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@OriginAirportName`	No	-	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@DestinationAirportName`	No	-	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@FlightClass`	No	Indicates the fare class of the leg	Generally a single letter, e.g “Y”
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]@JourneyMins`	No	journey duration in minutes of the leg	-
`/PackageHolidays/PackageHoliday[]/Flight/OutboundSubSegments[]/BaggageAllowance`	No	Same structure as `OutboundBaggageAllowance`	-
`/PackageHolidays/PackageHoliday[]/Flight/HomeboundSubSegments[]`	No	Same structure as `OutboundSubSegments`, only set if inbound segment is a multileg	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]`	No	Contains additional flight details	Generally only populated for MIX trips.
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@Direction`	Yes	`outbound` or `inbound`	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@Supplier`	Yes	FAB Supplier Code	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@MarketingCarrier`	No	Marketing carrier code of first leg	Can be IATA or ICAO, depending on the supplier’s preference
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@FareType`	No	`Published` `Private` `NoFrills`	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@FareClass`	No	Generally a single letter indicating the fare class	Sometimes delimited with a `
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@ITFare`	No, default false	boolean indicating if this flight is an IT (Inclusive Tour) fare and therefore should only be used when using the flight as part of an “inclusive package”.	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]@CAT35Fare`	No, default false	boolean indicating if this flight is a CAT35 fare	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails`	No, only populated where enabled and supported	Contains a richer breakdown of the flight costs	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails/Charge[*]`	No	A charge or cost detail	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails/Charge[*]@Amount`	Yes	The charge amount i.e cost	Will be per passenger
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails/Charge[*]@Currency`	Yes	ISO 4217 alphabetic currency of `Amount`	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails/Charge[*]@PaxType`	No	Indicates which passenger type the charge/cost applies to; `Adult` or `Youth` or `Child` or `Infant`.	-
`/PackageHolidays/PackageHoliday[]/Flight/FlightJourneyDetails[]/CostDetails/Charge[*]@Type`	Yes	Type of charge; `Fare` or `SuppsTaxes` or `Baggage` or `EstimatedPaymentCardCharge` or `SupplierBookingFee`	`Fare` may include tax/discounts/fees if discrete values are not known
`/PackageHolidays/PackageHoliday[*]/Flight/BookingCharges`	No, only populated where enabled and supported	Contains a richer breakdown of the booking costs	Similar to `CostDetails` but for `Charges` that apply to the whole flight booking
`/PackageHolidays/PackageHoliday[]/Flight/BookingCharges/Charge[]`	No	A charge or cost detail	-
`/PackageHolidays/PackageHoliday[]/Flight/BookingCharges/Charge[]@Amount`	Yes	The charge amount i.e cost	Will be per booking
`/PackageHolidays/PackageHoliday[]/Flight/BookingCharges/Charge[]@Currency`	Yes	ISO 4217 alphabetic currency of `Amount`	-
`/PackageHolidays/PackageHoliday[]/Flight/BookingCharges/Charge[]@Type`	Yes	Type of charge; `Fare` or `SuppsTaxes` or `Baggage` or `EstimatedPaymentCardCharge` or `SupplierBookingFee`	`Fare` may include tax/discounts/fees if discrete values are not known

Reference: FAB_BasketRQ

Mon, 01 Jan 0001 00:00:00 +0000

Once an itinerary has been chosen by the end user, it can be booked by creating a FAB Basket. The FAB_BasketRQ is an example of a FABRequestResponse but also requires one of the following:

CreateBasketRequest

In order to start the booking process a CreateBasketRequest is required. It must contain the Itinerary that will eventually be booked. A CreateBasketRequest will return with a response only once the TargetBookingStage has been reached except if more information is required to reach the target stage or if the ResponseTimeoutSecs has been reached.

CreateBasketRequest structure:

Attribute or element	Mandatory?	Definition	Note
`@ResponseTimeoutSecs`	No, has default of 0	Non negative integer. If timeout is reached FAB will return the basket even if processing is not complete (so basket is still “active”).	FAB will continue to process in the background. Advisable to set no lower than 5 seconds. Generally set to the maximum time your consumer or operator is willing to wait for a response (with some margin for your own processing).
`@TargetBookingStage`	No, default `confirmed_costing`	`passenger_details` or `confirmed_costing`	Can generally be left unset. If set to `confirmed_costing` (default) but `PassengerDetails` have not been provided then FAB will automatically stop at `passenger_details` stage instead.
`@ReplaceExistingBasket`	No, default false	must be set to true if a Basket already exists in the current user session.	-
`Itinerary`	Yes	List of `ComponentIdentity` to basket	-
`Itinerary/ComponentIdentity@Identity`	Yes	String of component identity taken from search response. For flights this is the `ItineraryId`	Ampersand must be correctly encoded
`Itinerary/OptionalExtras`	No	List of OptionalExtras to add/remove to the basket	-
`Itinerary/OptionalExtras/OptionalExtra[*]`	No	An OptionalExtra to add/remove to the basket	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Code`	Yes	From `OptionalExtra@Code` FAB_BasketRS	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Supplier`	Yes	FAB supplier code of OptionalExtra	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Quantity`	Yes	Less than or equal to `OptionalExtra@QuantityAvailable`	Sometimes set to zero to remove an automatically selected optional extra.
`Itinerary/OptionalExtras/OptionalExtra[*]@Direction`	Yes, if set on the respective extra in FAB_BasketRS	From `OptionalExtra@Direction` FAB_BasketRS	-
`PartyInfo@NumberOfAdults`	Yes	Number of adults in party	Aged 16 years or older at datetime of itinerary, or for a return flight trip; at datetime of final flight. Note that this differs from `FAB_PkgAvailRQ`, hence YoungPersonAge is mandatory.
`PartyInfo@NumberOfInfants`	Yes if infants are present	Number of infants in party	An infant is less than 2 years at datetime of itinerary, or for a return flight trip; at datetime of final flight.
`PartyInfo/YoungPersonAge[*]`	Yes if young person is present	List of ages of every young person in the party	A young person is aged 2 years or older but less than 16 years old at datetime of itinerary or, for a return flight trip, at datetime of final flight. Excludes party members that have been counted by `NumberOfAdults` or `NumberOfInfants`. Can be approximate but this may cause price changes if it deviates greatly from later `@DOB`.
`PassengerDetails`	No, but must be provided before booking	List containing exactly one `LeadCustomer` and zero or more `Customer`	-
`PassengerDetails/Customer[*]@Gender`	No unless Title is non-gendered (Inf/Dr/Prof/Rev), but highly advised to always set.	`Male` or `Female`	If gender is set but does not match the title (e.g Male Miss) then unexpected behaviour may occur.
`PassengerDetails/Customer[*]@Nationality`	Yes if `NationalityMandatory="true"` or `PassengerIdMandatory="true"`	ISO 3166-1 alpha-2	-
`PassengerDetails/Customer[*]@Firstname`	Yes	String	-
`PassengerDetails/Customer[*]@Surname`	Yes	String	-
`PassengerDetails/Customer[*]@DOB`	Yes	Date of birth, yyyyMMdd	-
`PassengerDetails/Customer[*]@Title`	Yes	`Inf` `Master` `Miss` `Ms` `Mrs` `Mr` `Dr` `Prof` `Rev`	Non-gendered titles (Inf/Dr/Prof/Rev) can only be used if the Gender attribute is set
`PassengerDetails/Customer[*]@MiddleInitials`	Yes, if passenger has middle name(s)	Middle name(s) of passenger	Note attribute’s reference to “Initials” is misleading/incorrect. Also note best to always set this attribute if passenger has middle name(s), regardless of `PassengerFullMiddleNameMandatory`.
`PassengerDetails/Customer[*]@PassengerID`	Yes if `PassengerIdMandatory="true"`	String	Normally passport number
`PassengerDetails/Customer[*]@IDExpireDate`	Yes if `PassengerIdMandatory="true"`	yyyyMMdd ID expiration date	-
`PassengerDetails/Customer[*]@IDIssueDate`	Yes if `PassengerIdMandatory="true"`	yyyyMMdd ID issue date	-
`PassengerDetails/Customer[*]@FOID`	Yes if `PassengerIdMandatory="true"`	See FOID table	Normally `PP` for passport
`PassengerDetails/Customer[*]@IDIssueCountry`	Yes if `PassengerIdMandatory="true"`	ISO 3166-1 alpha-2 of issuing country	-
`PassengerDetails/Customer[*]@CountryOfResidence`	Yes if `PassengerIdMandatory="true"`	ISO 3166-1 alpha-2 for country of residence	-
`PassengerDetails/Customer[]/SeatOptions[]`	No	Element for selecting a seat per pax per flight	Can be repeated once per pax per flight. Populate based on FAB_BasketRS SeatOptions
`PassengerDetails/Customer[]/SeatOptions[]@FlightNumber`	Yes if SeatOptions is desired	Flight number from FAB_BasketRS `SeatOptions@FlightNumber`	-
`PassengerDetails/Customer[]/SeatOptions[]@Supplier`	Yes if set on FAB_BasketRS `SeatOptions@Supplier`	Supplier from FAB_BasketRS `SeatOptions@Supplier`	-
`PassengerDetails/Customer[]/SeatOptions[]@DeparturePoint`	Yes if set on FAB_BasketRS `SeatOptions@DeparturePoint`	Supplier from FAB_BasketRS `SeatOptions@DeparturePoint`	-
`PassengerDetails/Customer[]/SeatOptions[]/Seat@Num`	Yes if SeatOptions is desired	Num from FAB_BasketRS `SeatOptions/Seat@Num`	-
`PassengerDetails/Customer[]/SeatOptions[]/Seat@MeetsRestriction`	no, default false	boolean, must be set to true if selected seat is `Access="Restricted"` and this customer meets that restriction	-
`PassengerDetails/Customer[*]/OptionalExtras`	No	List of OptionalExtra to select for this specific passenger/customer	Cannot be used if the passenger is an infant. When used in `FAB_BasketRS` indicates what has been selected for this specific passenger/customer.
`PassengerDetails/Customer[]/OptionalExtras/OptionalExtra[]`	No	See `Itinerary/OptionalExtras/OptionalExtra[*]` for structure	-
`PassengerDetails/LeadCustomer`	Yes	Same structure as `Customer`	-
`PassengerDetails/LeadCustomer/ContactDetails`	No	Contains contact details	How and when FAB uses this information will vary by supplier. By default FAB will avoid using it where possible. Contact Customer Services to find out more.
`PassengerDetails/LeadCustomer/ContactDetails@EmailAddress`	No, unless basket contains Norse or Ryanair flight.	Contact email address	-
`PassengerDetails/LeadCustomer/ContactDetails@Telephone`	No, unless basket contains a Norse, Ryanair, Wizzair or Jet2 flight.	E.164 formatted contact telephone number	E.g `+441174960999`
`PassengerDetails/LeadCustomer/ContactDetails@MobilePhone`	No, unless basket contains a Norse, Ryanair, Wizzair or Jet2 flight.	E.164 formatted contact mobile telephone number	E.g `+441174960999`. Only supported for select suppliers so generally advisable to set `Telephone` in addition.
`PassengerDetails/LeadCustomer/ContactDetails/Address`	No, unless basket contains a Ryanair or Wizzair flight.	See Address. Contact address.	-
`Remarks`	No	See Remarks.	See example
`@ConsumersReference`	No	String	Allows syndicator to attach a reference that will be stored within the basket.

Address

Attribute or element	Mandatory?	Definition	Note
Address@Address1	Yes	First line of the address	-
Address@Address2	No	Second line of the address	-
Address@Address3	No	Third line of the address	-
Address@Address4	No	Fourth line of the address	-
Address@CityOrTown	Yes	Name of city or town	-
Address@PostCode	Yes	Post code or equivalent	-
Address@Country	Yes	ISO 3166-1 alpha-2 country code	-

FOID

Tip

Passport (PP) is the most common Form Of ID required for FAB bookings.

FOID	Description
CC	Credit Card
FF	Frequent Flight number
NI	National Identity card
ID	Staff Id card
PP	Passport
GP	Group Passport
RD	Refugee Document
DL	Driving license

Remarks

Attribute or element	Mandatory?	Definition	Note
Remarks@Supplier	Yes	FAB supplier code of Remarks	-
Remarks@ComponentId	Mandatory for multi-component basket	Identifies component	Unique per basket. Used for multi-component flight baskets.
Remarks/Remark	No	Remark text	Not blank

AmendBasketRequest

Once a basket has been created, it can only be changed through the use of an AmendBasketRequest.

Attribute or element	Mandatory?	Definition	Note
`Itinerary/AmendOptionalExtras`	No	List of OptionalExtras to add/remove to the basket	If used then you must list all optional extras that you wish to keep from the current basket, unlisted selected extras are removed.
`Itinerary/AmendOptionalExtras/OptionalExtra[*]`	No	An OptionalExtra to add/remove to the basket	-
`Itinerary/AmendOptionalExtras/OptionalExtra[*]@Code`	Yes	From `OptionalExtra@Code` FAB_BasketRS	-
`Itinerary/AmendOptionalExtras/OptionalExtra[*]@Supplier`	Yes	FAB supplier code of OptionalExtra	-
`Itinerary/AmendOptionalExtras/OptionalExtra[*]@Quantity`	Yes	Less than or equal to `OptionalExtra@QuantityAvailable`	Set to zero to remove an already selected optional extra.
`Itinerary/AmendOptionalExtras/OptionalExtra[*]@Direction`	Yes, if set on the respective extra in FAB_BasketRS	From `OptionalExtra@Direction` FAB_BasketRS	-
`@ConsumersReference`	No	String	Allows syndicator to attach a reference that will be stored within the basket.
`@BasketId`	Yes	ID of basket to amend	-
`@TargetBookingStage`	No, default `confirmed_costing`	`passenger_details` or `confirmed_costing`	Can generally be left unset unless you intend to amend the basket multiple times in which case set to to `passenger_details` and only change to `confirmed_costing` once you are ready to book as a `confirmed_costing` basket cannot be further amended. If set to `confirmed_costing` (default) but `PassengerDetails` have not been provided then FAB will automatically stop at `passenger_details` stage instead.
`@ResponseTimeoutSecs`	No, default 30	Non negative integer. If timeout is reached FAB will return the basket even if processing is not complete (so basket is still “active”).	FAB will continue to process in the background. Advisable to set no lower than 5 seconds. Generally set to the maximum time your consumer or operator is willing to wait for a response (with some margin for your own processing).
`Itinerary/PassengerDetails`	No, but must be provided before booking	See PassengerDetails in CreateBasketRequest	-
`Remarks`	No	See Remarks.	See example

CheckBasketRequest

Used to poll an active basket until it becomes inactive.

Attribute or element	Mandatory?	Definition	Note
`@BasketId`	Yes	String of Basket ID you wish to check	-
`@ResponseTimeoutSecs`	No, default 5	Non negative integer. If timeout is reached FAB will return the basket even if processing is not complete (so basket is still “active”).	FAB will continue to process in the background. Advisable to set no lower than 5 seconds. Generally set to the maximum time your consumer or operator is willing to wait for a response (with some margin for your own processing).

BookBasketRequest

In order to actually do the booking, the basket must be inactive at the confirmed_costing booking stage, at which point you can send a BookBasketRequest message. A Basket can only be booked once.

Attribute or element	Mandatory?	Definition	Note
`@BasketId`	Yes	String of Basket ID you wish to book	-
`@TotalCost`	Yes	Expected total cost of booking	This is used to validate that you, fab, and the supplier(s) are agreed on the booking cost
`@ConsumersReference`	No	String	Allows syndicator to attach a reference that will be stored within the basket.
`@ResponseTimeoutSecs`	No, default 290	Non negative integer. If timeout is reached FAB will return the basket even if processing is not complete, with success status of pending.	Generally set to the maximum time your consumer or operator is willing to wait for a response (with some margin for your own processing).
`Payment@PaymentMode`	Yes	Enum indicating how you wish to pay the supplier	See PaymentMode section
`Payment@PayOnlyDeposit`	No, default false	boolean	Deprecated
`Payment/PaymentCard`	Yes if `PaymentMode="card_payment_override_lodged"`	-	-
`Payment/PaymentCard@CardNumber`	Yes	The card number	-
`Payment/PaymentCard@ExpiryDate`	Yes	MMyy	-
`Payment/PaymentCard@Authorisation`	Yes	Describes how the card payment should be authorised	Should be set to `cv2_only`
`Payment/PaymentCard@CardType`	Yes	See CardType	-
`Payment/PaymentCard@CardHoldersName`	Yes	the full name of the card holder as it appears on the card	-
`Payment/PaymentCard@IssueDate`	No	MMyy	-
`Payment/PaymentCard@Cv2SecurityNumber`	Yes	3 or 4 digit cv2	-
`Payment/PaymentCard@CardHoldersTelephoneNumber`	No	E.164 formatted telephone number	E.g `+441174960999`. How and when FAB uses this information will vary by supplier. Contact Customer Services to find out more.
`Payment/PaymentCard@CardHoldersEmailAddress`	No	-	How and when FAB uses this information will vary by supplier. Contact Customer Services to find out more.
`Payment/PaymentCard/CardHoldersAddress`	Yes	See Address	How and when FAB uses this information will vary by supplier. Contact Customer Services to find out more.
`Component`	No	Provides additional controls over the booking, e.g to make a held booking	Must list all components or none.
`Component[*]@ComponentId`	Yes	Identifies component	Unique per basket
`Component[*]@CurrentBookingStage`	No	`confirmed_costing`	-
`Component[*]@Supplier`	Yes	Supplier code of component	-
`Component[*]@TargetTicketingStatus`	No	`confirmed` or `held`. If supported allows control over ticket status	See example
`Remarks`	No	See Remarks.	See example

Note

If passing in a card, only cards exempt from SCA (Strong Customer Authentication) are supported.

PaymentMode

PaymentMode	Description
syndicator_deferred	Indicates that FAB should handle any required supplier payments. This could by generating Pax2Pay virtual cards or by sending account details (e.g BSP Cash).
card_payment_override_lodged	Indicates that any required card payments to supplier should be made with the passed in card.

FAB Payment Card Type

CardType	Note
American_Express	-
American_Express_Corporate	-
Debit_Mastercard	-
Laser	-
Maestro	-
Mastercard	-
Mastercard_Credit_Corporate	-
Mastercard_Debit_Corporate	-
Pre_Paid_Mastercard	-
Solo	-
Switch	-
Visa_Credit	-
Visa_Credit_Corporate	-
Visa_Debit	-
Visa_Debit_Corporate	-
Visa_Delta	-
Visa_Electron	-
Diners_Club	-
JCB	-
UATP	-
IATA_Easy_Pay	-

FAB Card Authorisation Modes

Mode	Description
card_only	Neither CV2 nor AVS are carried out, only the card number and expiry dates are checked
cv2_only	Only card number, dates, and CV2 number is checked
address_only	Only card number, dates, address is checked
postcode_only	Only card number, dates, and postcode is checked
cv2_and_address	Only card number, dates, CV2 number, and address is checked
cv2_and_postcode	Only card number, dates, CV2 number, and postcode is checked
address_and_postcode	Only card number, dates, postcode, and address is checked
all	All checks are performed and must all pass

Reference: FAB_BasketRS

Mon, 01 Jan 0001 00:00:00 +0000

The FAB_BasketRS will be the result of any FAB_BasketRQ and is an example of a FABRequestResponse. It will additionally contain a element of CurrentBasket.

CurrentBasket

CurrentBasket has the following structure:

Attribute or element	Mandatory?	Definition	Note
`@CurrentlyActive`	Yes	`true` or `false`, if true then FAB is still attempting to process the basket (e.g waiting for a supplier response)	An active basket is not ready to book or to display to consumers, instead you must check the basket until it becomes inactive. See section check basket
`@BasketId`	Yes	String identifying current basket	Used for subsequent basket actions
`@Status`	No	Text indicating the basket’s current status.	-
`@TargetBookingStage`	Yes	`passenger_details` or `confirmed_costing` or `booked`	May differ from `CurrentBookingStage` if you didn’t provide `PassengerDetails` resulting in FAB only reaching `passenger_details` not your target of `confirmed_costing`.
`@CurrentBookingStage`	Yes	`passenger_details` or `confirmed_costing` or `booked`	`PassengerDetails` must be provided to proceed from `passenger_details` to `confirmed_costing`. Only a basket at `confirmed_costing` can proceed to book.
`@ConsumersReference`	No	Reference set from request	-
`PartyInfo`	Yes	See FAB_BasketRQ	-
`Itinerary`	Yes	Details the requested itinerary	-
`PassengerDetails`	No	See `PassengerDetails` in BasketRQ for structure	-
`Itinerary@PassengerIdRequired`	No, default false	boolean, if true then ID information must be provided to the supplier before departure	-
`Itinerary@PassengerIdMandatory`	No, default false	boolean, if true then ID information must be provided to the supplier before booking	-
`Itinerary@NationalityRequired`	No, default false	boolean, if true then nationality information must be provided to the supplier before departure	-
`Itinerary@NationalityMandatory`	No, default false	boolean, if true then `Nationality` attribute must be set for each passenger before booking	-
`Itinerary@PassengerFullMiddleNameMandatory`	No, default false	boolean, if true then passengers must have `MiddleInitials` set to their full middle name(s) if they have one	Note this attribute is not widely supported, it is best to always set `MiddleInitials` to the passenger’s middle name(s) if they have one.
`Itinerary@ItineraryId`	Yes	the id associated with the Itinerary	-
`Itinerary@StartDate`	Yes	yyyyMMdd the start date for this Itinerary	-
`Itinerary@EndDate`	Yes	yyyyMMdd the end date for this Itinerary	-
`Itinerary@NumNights`	No	the duration in number of nights of this Itinerary	-
`Itinerary@Availability`	Yes	`available` or `unavailable` or `unknown` Indicates whether or not a particular itinerary is available	-
`Itinerary@BookableByFab`	Yes	boolean, if true then FAB is capable of booking this itinerary	-
`Itinerary@Currency`	Yes	ISO 4217 alphabetic currency of PerPassengerCost	-
`Itinerary@PerPassengerCost`	No	The cost per passenger of this itinerary	-
`Itinerary/ItineraryCost`	Yes	Contains details of the itinerary costs, including both totals and a breakdown	-
`Itinerary/ItineraryCost@TotalCost`	Yes	Total cost of itinerary	-
`Itinerary/ItineraryCost@Currency`	Yes	ISO 4217 alphabetic currency of `TotalCost` and `DepositRequiredAtBooking`	-
`Itinerary/ItineraryCost@CostingStage`	Yes	`estimate` or `quick` or `confirmed` or `booked`	See “FAB Costing Stages” table
`Itinerary/ItineraryCost@CostingAccuracy`	Yes	indicates the accuracy, as a percentage, of the associated cost structure	Deprecated
`Itinerary/ItineraryCost@BasedOn`	No	Human readable description of the itinerary
`Itinerary/ItineraryCost@PartyInfoCheck`	Yes	Human readable description of the party	-
`Itinerary/ItineraryCost@DepositRequiredAtBooking`	No	Indicates booking deposit cost	Not widely supported
`Itinerary/ItineraryCost@CostingValid`	Yes	boolean, if true then the costing is valid	Deprecated
`Itinerary/Component[*]`	Yes	Contains some info in relation to the suppliers of the itinerary	-
`Itinerary/Component[*]@Supplier`	Yes	Supplier code of component	-
`Itinerary/Component[*]@BookingChannel`	No	-	Advised to ignore
`Itinerary/Component[*]@BookingChannelName`	No	String indicating the supplier integration of hte component	Should not be mapped as it is not stable
`Itinerary/FOIDAllowed[*]`	No	Lists acceptable forms of identification	Useful if you need/want to set FOID request attribute
`Itinerary/FOIDAllowed[]/FOID[]`	Yes	See FAB_BasketRQ FOID	-
`Itinerary/ItineraryCost/Component[*]@Supplier`	Yes	Supplier (code) of component	-
`Itinerary/ItineraryCost/Component[*]@TotalCost`	Yes	Total cost of component	-
`Itinerary/ItineraryCost/Component[*]@Currency`	Yes	ISO 4217 alphabetic currency of `TotalCost` and `DepositRequiredAtBooking`	-
`Itinerary/ItineraryCost/Component[*]@CostingStage`	Yes	`estimate` or `quick` or `confirmed` or `booked`	See “FAB Costing Stages” table
`Itinerary/ItineraryCost/Component[*]@DepositRequiredAtBooking`	No	Indicates booking deposit cost	Not widely supported
`Itinerary/ItineraryCost/Component[*]@UpdatedTime`	Yes	`yyyyMMdd HHmm` indicates when costing was produced	UK local time
`Itinerary/ItineraryCost/Component[*]@HostSystemRequiresPaymentCard`	No, default false	`true` or `false`. If true then this component must be paid by card	-
`Itinerary/ItineraryCost/Component[]/Detail[]`	Yes	A Component’s cost is broken down into one or more cost details	Note that the list of details is dynamic so care must be taken to not hard-code an expectation that a certain Detail will always be present.
`Itinerary/ItineraryCost/Component[]/Detail[]@Description`	Yes	A description of the Detail	-
`Itinerary/ItineraryCost/Component[]/Detail[]@UnitCost`	Yes	Unit cost	Following any currency conversion and/or syndicator markup
`Itinerary/ItineraryCost/Component[]/Detail[]@Quantity`	Yes	quantity of this cost item	-
`Itinerary/ItineraryCost/Component[]/Detail[]@ExtendedCost`	Yes	Unit cost multiplied by quantity	-
`Itinerary/ItineraryCost/Component[]/Detail[]@Currency`	Yes	ISO 4217 alphabetic currency of `UnitCost` and `ExtendedCost`	-
`Itinerary/ItineraryCost/Component[]/Detail[]@PriceDescription`	No	Additional description of Detail	-
`Itinerary/ItineraryCost/Component[]/Detail[]@PriceCode`	No	Categorises the cost line item	Derived from the fab price code.
`Itinerary/ItineraryCost/Component[]/Detail[]@FPC`	Yes	FAB Price Code categorises the cost line item	see fpcs
`Itinerary/ItineraryCost/Component[]/Detail[]@ExtraCode`	No	Code of related optional extra	-
`Itinerary/ItineraryCost/Component[]/Detail[]/SourceCostDetail`	No	Contains information about costs before any markup/discounts or currency conversion had been applied.	Can generally be ignored
`Itinerary/ItineraryCost/Component[]/Detail[]/SourceCostDetail@SourceUnitCost`	Yes	Unit cost before any currency conversion or syndicator markup	-
`Itinerary/ItineraryCost/Component[]/Detail[]/SourceCostDetail@SourceCurrency`	Yes	ISO 4217 alphabetic currency of `SourceUnitCost`	-
`Itinerary/ItineraryCost/Component[]/Detail[]/SourceCostDetail@UnitCost`	Yes	Unit cost after any currency conversion	In currency of `Detail`
`Itinerary/ItineraryCost/Component[]/Detail[]/SourceCostDetail@UnitMarkup`	Yes	Unit syndicator markup, if any	In currency of `Detail`
`Itinerary/ItineraryCost/Component[]/PaymentCardCharge[]`	No	Info about what card types are accepted by the supplier of this component and the charge for each	Never currency normalised
`Itinerary/ItineraryCost/Component[]/PaymentCardCharge[]@CardType`	Yes	Card type, see FAB_BasketRQ	-
`Itinerary/ItineraryCost/Component[]/PaymentCardCharge[]@Amount`	Yes	Card charge amount	-
`Itinerary/ItineraryCost/Component[]/PaymentCardCharge[]@Currency`	Yes	ISO 4217 alphabetic currency of `Amount`	-
`Itinerary/ItineraryCost/Component[]/PaymentCardCharge[]/AcceptableAuthMode[*]`	Yes	What auth modes are accepted	See FAB_BasketRQ “FAB Card Authorisation Modes”
`Itinerary/ItineraryCost/PaymentCardCharge[*]`	No	Intersection of PaymentCardCharges from each Component, with Amount summed	i.e lists cards and charges that can be used to pay for all relevant components. May have been currency normalised.
`Itinerary/ItineraryCost/PaymentCardCharge[*]@CardType`	Yes	Card type, see FAB_BasketRQ	-
`Itinerary/ItineraryCost/PaymentCardCharge[*]@Amount`	Yes	Card charge amount	-
`Itinerary/ItineraryCost/PaymentCardCharge[*]@Currency`	Yes	ISO 4217 alphabetic currency of `Amount`	-
`Itinerary/ItineraryCost/PaymentCardCharge[]/AcceptableAuthMode[]`	Yes	What auth modes are accepted	See FAB_BasketRQ “FAB Card Authorisation Modes”
`ImportantInformation/Errata[*]@Text`	No	Freetext information about an itinerary component.	Can include information like fare rules or bag dimensions. This information is usually set by the supplier so Paxport does not guarantee that the information is appropriate to expose to the consumer.
`ImportantInformation/Errata[*]@Code`	No	Code identifying the errata	-
`ImportantInformation/Errata[*]@Supplier`	Yes	Supplier code that Errata applies to	-
`Itinerary/TravelSegments/TravelSegment[*]`	No	A travel segment of the itinerary	e.g an inbound flight
`Itinerary/TravelSegments/TravelSegment[*]@DeparturePoint`	Yes	Departure airport IATA code	-
`Itinerary/TravelSegments/TravelSegment[*]@ArrivalPoint`	Yes	Arrival airport IATA code	-
`Itinerary/TravelSegments/TravelSegment[*]@Type`	Yes	`outbound` `homebound` `transfer`	-
`Itinerary/TravelSegments/TravelSegment[*]@DepartureDate`	Yes	yyyyMMdd	-
`Itinerary/TravelSegments/TravelSegment[*]@DepartureTime`	Yes	HHmm	-
`Itinerary/TravelSegments/TravelSegment[*]@ArrivalDate`	Yes	yyyyMMdd	-
`Itinerary/TravelSegments/TravelSegment[*]@ArrivalTime`	Yes	HHmm	-
`Itinerary/TravelSegments/TravelSegment[*]@Supplier`	Yes	Supplier code of segment	-
`Itinerary/TravelSegments/TravelSegment[*]@ItineraryId`	Yes	ItineraryId of segment	-
`Itinerary/TravelSegments/TravelSegment[*]@Currency`	Yes	ISO 4217 alphabetic currency of segment	-
`Itinerary/TravelSegments/TravelSegment[*]@ITFare`	No, default false	boolean indicating if this flight result is an IT (Inclusive Tour) fare and therefore should only be used when using the flight as part of an “inclusive package”.	-
`Itinerary/TravelSegments/TravelSegment[*]@CAT35Fare`	No, default false	boolean indicating if this flight result is a CAT35 fare
`Itinerary/TravelSegments/TravelSegment[*]@FareType`	Yes	`Published` `Private` `NoFrills` `NegoCorporate`	-
`Itinerary/TravelSegments/TravelSegment[*]@OperatedBy`	No	Operating carrier name	-
`Itinerary/TravelSegments/TravelSegment[*]@MarketedBy`	No	Marketing carrier name	-
`Itinerary/TravelSegments/TravelSegment[*]@OperatingCarrier`	No	Operating carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`Itinerary/TravelSegments/TravelSegment[*]@MarketingCarrier`	Yes	Marketing carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`Itinerary/TravelSegments/TravelSegment[*]@JourneyMins`	No	Duration of journey in minutes	Includes any layover time
`Itinerary/TravelSegments/TravelSegment[*]@FareClass`	No	Indicates the fare class of the first leg	Generally a single letter, e.g “Y”
`Itinerary/TravelSegments/TravelSegment[*]@FlightClass`	No	Indicates the fare class of the first leg	Generally a single letter, e.g “Y”
`Itinerary/TravelSegments/TravelSegment[*]@NumStops`	No, default zero	Number of stops	-
`Itinerary/TravelSegments/TravelSegment[*]@DeparturePointName`	No	Departure airport name	-
`Itinerary/TravelSegments/TravelSegment[*]@ArrivalPointName`	No	Arrival airport name	-
`Itinerary/TravelSegments/TravelSegment[*]@SupplierName`	No	Supplier name	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo`	No	Contains information about ticket collection, check-in, and the suchlike	This is rarely populated beyond FlightNumber for lowcost carriers
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@CheckInDate`	No	yyyyMMdd	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@CheckInTime`	No	HHmm	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@CheckInDetails`	No	details of where/how to check in	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@CollectionDetails`	No	details of where/how to pick up ticket	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@FlightNumber`	No	Flight number for ticket info	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@TicketOnDeparture`	No	boolean, if true then the ticket is supposed to be collected on at the airport just before departure	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@DepartureTerminal`	No	details about the departure airport terminal	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@ArrivalTerminal`	No	details about the arrival airport terminal	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@LastTicketDate`	No	yyyyMMdd last date at which this fare can be ticketed	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@LastTicketTime`	No	HHmm last time at which this fare can be ticketed	-
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@DefaultTicketingStatus`	No	Indicates default ticketing status for the booking. Set to `held` for held booking or `confirmed` for a standard booking	The default status can be overridden using `TargetTicketingStatus` parameter in BasketRQ if `SupportsTargetTicketingStatus` is set to `true`
`Itinerary/TravelSegments/TravelSegment[*]/TicketInfo@SupportsTargetTicketingStatus`	No	boolean indicating if the handler supports the `TargetTicketingStatus` attribute in BasketRQ	If set to `false` then the handler can ignore the `TargetTicketingStatus` parameter set during booking.
`Itinerary/TravelSegments/TravelSegment[*]/BaggageAllowance`	No	Indicates included baggage allowance	Only supported by select suppliers
`Itinerary/TravelSegments/TravelSegment[*]/BaggageAllowance@Per`	Yes	`Passenger` or `Adult` or `Youth` or `Child` or `Infant`	-
`Itinerary/TravelSegments/TravelSegment[*]/BaggageAllowance@Unit`	Yes	`Piece` or `kg` or `lb` or `Unknown`	-
`Itinerary/TravelSegments/TravelSegment[*]/BaggageAllowance@Quantity`	Yes	Integer	-
`Itinerary/TravelSegments/TravelSegment[*]/BaggageAllowance@Type`	Yes	`Hold` or `Hand`	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]`	No	If segment is multileg/indirect one or more subsegments/legs will be listed	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]/BaggageAllowance`	No	Same structure as `TravelSegment[*]/BaggageAllowance`. Indicates included baggage allowance for the leg/subsegment	Only supported by select suppliers
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@DeparturePoint`	Yes	Departure airport IATA code	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@ArrivalPoint`	Yes	Arrival airport IATA code	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@DepartureDate`	Yes	yyyyMMdd	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@DepartureTime`	Yes	HHmm	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@ArrivalDate`	Yes	yyyyMMdd	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@ArrivalTime`	Yes	HHmm	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@OperatedBy`	No	Operating carrier name	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@OperatingCarrier`	No	Operating carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@MarketingCarrier`	No	Marketing carrier code	Can be IATA or ICAO, depending on the supplier’s preference
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@JourneyMins`	No	Duration of journey in minutes	Includes any layover time
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@FlightClass`	No	Fare class	Generally a single letter, e.g “Y”
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@NumStops`	No, default zero	Number of stops	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@OriginAirportName`	No	Departure airport name	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@DestinationAirportName`	No	Arrival airport name	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@FlightNumber`	Yes	Flight number	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@DepartureTerminal`	No	Departure terminal	-
`Itinerary/TravelSegments/TravelSegment[]/SubSegment[]@ArrivalTerminal`	No	Arrival terminal	-
`Itinerary/SeatOptions[*]`	No	Seat selection options	Only supported by select flight suppliers.
`Itinerary/SeatOptions[*]@FlightNumber`	Yes	Flight number (designator) of flight relevant to this SeatOption	-
`Itinerary/SeatOptions[*]@AircraftType`	No	Indicates aircraft type	-
`Itinerary/SeatOptions[*]@NumberOfBlocks`	Yes	Indicates the number of divisions within a row of seats. For example, an aircraft with a single aisle seat configuration will have two ‘blocks’.	-
`Itinerary/SeatOptions[*]@Currency`	Yes	ISO 4217 alphabetic currency of `Price`	-
`Itinerary/SeatOptions[*]@Supplier`	No	Supplier code of this SeatOption	-
`Itinerary/SeatOptions[*]@DeparturePoint`	No	Departure airport IATA code of flight relevant to this SeatOption	-
`Itinerary/SeatOptions[]/SeatBand[]`	Yes	Contains pricing information and description. Seat selection can be broken down into different categories of seats with different prices associated with each. The SeatBand element describes one of these categories.	-
`Itinerary/SeatOptions[]/SeatBand[]@Id`	Yes	ID used to correlate between SeatBand and Seat	-
`Itinerary/SeatOptions[]/SeatBand[]@Description`	Yes	Text description of seat band	-
`Itinerary/SeatOptions[]/SeatBand[]@Price`	Yes	Price of a seat in this band	-
`Itinerary/SeatOptions[]/Seat[]`	Yes	-	-
`Itinerary/SeatOptions[]/Seat[]@Num`	Yes	Seat identifier, includes row number. E.g 1A	-
`Itinerary/SeatOptions[]/Seat[]@Availabile`	Yes	Boolean, indicates if seat is available for selection	Attribute has typo
`Itinerary/SeatOptions[]/Seat[]@BandId`	Yes	ID used to correlate between SeatBand and Seat	-
`Itinerary/SeatOptions[]/Seat[]@Block`	Yes	Block number	See `NumberOfBlocks`
`Itinerary/SeatOptions[]/Seat[]@Row`	Yes	Row number	-
`Itinerary/SeatOptions[]/Seat[]@AllowInfant`	Yes	boolean, if false then adult with infant cannot sit here	-
`Itinerary/SeatOptions[]/Seat[]@AllowChild`	Yes	boolean, if false then child cannot sit here	-
`Itinerary/SeatOptions[]/Seat[]@ExitRow`	Yes	boolean, if true then seat is on an exit row	-
`Itinerary/SeatOptions[]/Seat[]@Position`	Yes	`Aisle` `Middle` `Window`	-
`Itinerary/SeatOptions[]/Seat[]@Access`	Yes	`Regular` `Special` `Restricted`	`Restricted` - additional restrictions apply to what passengers can sit here beyond those restrictions already indicated by AllowInfant/AllowChild. These additional restrictions will be described by the `Text` of `Errata@Code="Seat Selection - Restricted"`.
`Itinerary/SeatOptions[]/Seat[]@UpperDeck`	No, default false	boolean. If true then seat is on the upper deck of the aircraft	-
`Itinerary/OptionalExtras`	Yes	Contains selected optional extras, if any	Used for itinerary extras, per pax selected extras are shown under `PassengerDetails`
`Itinerary/OptionalExtras/OptionalExtra[*]`	No	An optional extra	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Code`	Yes	Code of extra	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Supplier`	Yes	Supplier (code) of extra	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Quantity`	Yes	The number of units of the extra that have been selected	-
`Itinerary/OptionalExtras/OptionalExtra[*]@Direction`	No	`outbound` or `homebound`. If set then the extra only applies to that specific direction	-
`Itinerary/ItineraryOptions`	No	Describes a set of options (e.g bags) available for the associated Itinerary	-
`Itinerary/ItineraryOptions/OptionalExtra[*]`	No	An optional extra	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@Direction`	No	`outbound` or `homebound`. If set then the extra only applies to that specific direction	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@Description`	Yes	Text description of the extra	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@Code`	Yes	String identifying the extra, used for selection	The value is generally based on data from the supplier (e.g an airline SSR code) so it may change over time. You are therefore advised to make any mapping of Code in your integration configurable.
`Itinerary/ItineraryOptions/OptionalExtra[*]@ID`	Yes	String identifying the extra	Rarely used.
`Itinerary/ItineraryOptions/OptionalExtra[*]@Supplier`	Yes	Supplier (code) of the extra	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@FPC`	Yes	FAB Price Code categorises the extra	see fpcs
`Itinerary/ItineraryOptions/OptionalExtra[*]@Type`	Yes	See FABOptionalExtraType	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@QuantityAvailable`	Yes	The number of units of this extra that are available	Does not account for units that are already selected
`Itinerary/ItineraryOptions/OptionalExtra[*]@UnitCost`	Yes	Unit cost	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@CurrencyCode`	Yes	ISO 4217 alphabetic currency of `UnitCost`	-
`Itinerary/ItineraryOptions/OptionalExtra[*]@ApplyTo`	Yes	Indicates how the extra applies to the passengers, see FABApplyToType	-
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[*]`	No	Rules indicate how OptionalExtras can be combined	-
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[*]@RuleCode`	Yes	Code indicating rule	See later FABGroupRuleCode section
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[*]@Supplier`	Yes	Supplier code rule applies to	-
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[*]@QuantityPerBooking`	Yes if `RuleCode="PerBookingLimit"`	See later FABGroupRuleCode section for PerBookingLimit	-
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[]/ID[]`	Yes	List of IDs in the group	Used to ID relevant OptionalExtras
`Itinerary/ItineraryOptions/OptionalExtraGroupRule[]/ID[]@Direction`	No	`outbound` or `homebound`. If set then ID applies to an extra of a specific direction	-
`Remarks`	No	See `Remarks` in BasketRQ for structure	-
`Warnings`	No	List of `Warning` that are relevant to the `CurrentBasket`	Note that warnings may also be set a level up so check both locations, see FABRequestResponse
`Warnings/Warning[*]`	No	Warning text	-
`Errors`	No	List of `Error` that are relevant to the `CurrentBasket`	Note that errors may also be set a level up so check both locations, see FABRequestResponse
`Errors/Error[*]@ErrorText`	Yes if `Error` element is being set	a generic human readable description of the error	Likely not appropriate to expose to consumers
`Errors/Error[*]@ErrorCode`	Yes if `Error` element is being set	string error code	see Error Codes

BookingInfo

Responses to a BookBasketRequest have an additional element of BookingInfo within CurrentBasket

Attribute or element	Mandatory?	Definition	Note
`BookingInfo`	Yes for response to `BookBasketRequest`	Contains details about the booking attempt	-
`BookingInfo@Success`	Yes	`true` `false` `pending` indicates booking success of itinerary	See later section
`BookingInfo@PaymentMode`	Yes	Indicates requested PaymentMode	See FAB_BasketRQ
`BookingInfo@PaidOnlyDeposit`	Yes	boolean	Deprecated
`BookingInfo@PaymentTakenAtBooking`	Yes	indicates the amount that has been/should be taken from the end user.	-
`BookingInfo@PaymentTakenByFABAtBooking`	No	total amount debited by payment systems directly invoked by FAB with a provided payment card	-
`BookingInfo@Currency`	Yes	ISO 4217 alphabetic currency of `PaymentTakenAtBooking` and `PaymentTakenByFABAtBooking`	-
`BookingInfo@ThirdPartyHandoffBookingId`	No	Reference to the information registered on a third-party system by a handoff handler	-
`BookingInfo/BookingComponent[*]`	Yes	A booking component	-
`BookingInfo/BookingComponent[*]@Supplier`	Yes	Supplier code of booking component	-
`BookingInfo/BookingComponent[*]@Success`	Yes	`true` `false` `pending` indicates booking success of component	See later section
`BookingInfo/BookingComponent[*]@BookingReference`	No	If successful, this will contain the suppliers booking reference for this component. Unset if failed. Set to “PENDING” if pending	-
`BookingInfo/BookingComponent[*]@Deposit`	Yes	Amount of deposit (taken at booking).	-
`BookingInfo/BookingComponent[*]@TotalCost`	Yes	Total cost of component	-
`BookingInfo/BookingComponent[*]@ExpectedTotalCost`	No	May be used to indicate a price change that was within tolerance	Not widely supported
`BookingInfo/BookingComponent[*]@BookingChannel`	No	-	Advised to ignore
`BookingInfo/BookingComponent[*]@BookingUsername`	No	A username relevant to the booking	Not widely supported.
`BookingInfo/BookingComponent[*]@BookingPassword`	No	A password relevant to the booking	Not widely supported.
`BookingInfo/BookingComponent[*]@Currency`	Yes	ISO 4217 alphabetic currency of `TotalCost` and `Deposit`	-
`BookingInfo/BookingComponent[*]/PaymentAuth`	No	Contains information about payment made with a passed in card	-
`BookingInfo/BookingComponent[*]/PaymentAuth@Amount`	Yes	Amount authorised from card	-
`BookingInfo/BookingComponent[*]/PaymentAuth@Currency`	Yes	ISO 4217 alphabetic currency of Amount	-
`BookingInfo/BookingComponent[*]/PaymentAuth@Last4DigitsOfCardNumberUsed`	No	Last 4 digits of card used for payment	-
`BookingInfo/BookingComponent[*]/PaymentAuth@CardNameUsed`	Yes	Card holder name used	-
`BookingInfo/BookingComponent[*]/PaymentAuth@SupplierCode`	Yes	Supplier (code) who took the payment	-
`BookingInfo/BookingComponent[*]/LodgedCardPaymentAuth`	No	Same structure as `PaymentAuth` but contains information about payment made with Pax2Pay virtual card	-
`BookingInfo/BookingComponent[]/Reference[]`	No	Contains additional references relevant to the booking.	Only supported by select suppliers
`BookingInfo/BookingComponent[]/Reference[]@Type`	Yes	String identifier for reference	E.g `PNR`
`BookingInfo/BookingComponent[]/Reference[]@Value`	Yes	Value of reference	-
`BookingInfo/BookingComponent[]/Reference[]@Source`	No	String indicating source of reference	Optionally used to further clarify source of the reference. E.g could be the IATA code for the airline that issued the reference.
`BookingInfo/BookingComponent[*]/@CurrentTicketingStatus`	No	`held` or `confirmed`. Indicates ticket status if `TargetTicketingStatus` was used in the request.	See example
`BookingInfo/BookingComponent[]/ETicket[]`	No	Contains ticket documents	An ETicket can represent a ticket, EMD, etc
`BookingInfo/BookingComponent[]/ETicket[]@ETicketNumber`	No	The full ticket number	-
`BookingInfo/BookingComponent[]/ETicket[]@PassengerName`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]@DateOfIssue`	Yes	`yyyyMMdd`	-
`BookingInfo/BookingComponent[]/ETicket[]@FormOfPayment`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@IssuingAgency`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@PlaceOfIssue1`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@PlaceOfIssue2`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@IssuingAgent`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@Endorsements`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@LegalNotices`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@Type`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]@NumberOfBooklets`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@Airline`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@FlightNumber`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@DepartureDate`	Yes	`yyyyMMdd`	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@DepartureTime`	Yes	`HHmm`	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@Origin`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@OriginName`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@OriginTerminal`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@Destination`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@DestinationName`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@DestinationTerminal`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@FlightClass`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@BaggageAllowance`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@FareBasis`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@ReservationStatus`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@NotValidBeforeAfter`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@NumericAirlineCode`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@OperatedBy`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Flight[*]@Ref`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost@FareCalculation`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost@BaseFare`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost@Total`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost@Currency`	Yes	ISO 4217 alphabetic currency	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost/TaxComponent[*]`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost/TaxComponent[*]@Amount`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost/TaxComponent[*]@Code`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Cost/TaxComponent[*]@Currency`	Yes	ISO 4217 alphabetic currency	-
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]`	No	A coupon within the ticket	-
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]@Number`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/InConnectionWith`	No	Allows a coupon to link to another ETicket	E.g link a seat EMD to the main fare ticket.
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/InConnectionWith@ETicketNumber`	Yes	-	Link to `ETicket@ETicketNumber`
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/InConnectionWith@FlightRef`	Yes	-	Link to `Flight@Ref`
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/ReasonForIssuance`	No	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/ReasonForIssuance@Code`	Yes	-	-
`BookingInfo/BookingComponent[]/ETicket[]/Coupons/Coupon[*]/ReasonForIssuance@SubCode`	Yes	-	-

FAB Group Rule Codes - FABGroupRuleCode

FABGroupRuleCode	Description	Note
OneOf	Must choose one of the group	-
MandatoryOneOfPerPax	Must choose one of the group, per Passenger	Like OneOf but per passenger.
OneOrNone	Can choose Only One of the group, or None	-
OneOfPerPax	Can choose Only One of the group, or None, per Passenger	Note that type name is misleading due to historic reasons. You should think of it as if it were named OneOrNoneOfPerPax.
AllOrNone	Must choose all of the group, or None	-
PerBookingLimit	Total (summed) selected quantity of these extras must not exceed QuantityPerBooking

FAB Optional Extra Types - FABOptionalExtraType

FABOptionalExtraType	Note
Meal	-
Transfer	-
Flight	-
Room	-
Sports	-
Insurance	-
CarHire	-
Baggage	-
Excursion	-
Donation	-
Theatre	-
Other	-
BaggageTracking	-
SeatOptions	-
CheckIn	-
Priority	-
Lounge	-
BaggageInsurance	-
DutyFree	-
FastTrack	-
Unrecognised	Can be raised with Customer Services team to fix

FAB Apply To Types - FABApplyToType

FABApplyToType	Description
NoPax	Not related to passengers.
AllPax	Applies to all passengers.
SelectedPax	Individual passengers must select this extra.

FAB Costing Stages - FABCostingStage

FABCostingStage	Description
estimate	Estimated party price based on pricing information stored within the FAB system
quick	Live quick cost produced by accessing a suppliers reservation system
confirmed	Live confirmed cost produced by accessing a suppliers reservation system. One step away from booking, this represents the actual cost that will be incurred by booking this itinerary with the given party
booked	Indicates that this Itinerary has been booked

Booking success status

Further info on determining booking success status

true - component (BookingComponent[*]@Success) or itinerary (BookingInfo@Success) booked
false - component (BookingComponent[*]@Success) or itinerary (BookingInfo@Success) failed to book
pending
- In the case of a component (BookingComponent[*]@Success) this indicates that FAB is unsure whether the component has booked or not. You would generally need to contact the supplier to investigate. You can also raise the issue with Paxport support team.
- In the case of the itinerary (BookingInfo@Success) this indicates at least one component was not Success="true".

Note

Note that FAB has no automated mechanism to change Success="pending" to Success="true" or Success="false". Manual investigation/intervention will be required. Consequently Paxport aims for Success="pending" to be a rare event.

Note

If FAB fails to respond (or responds without BookingInfo) to your BookBasketRequest you should follow these steps:

Retry the exact same FAB_BasketRQ (BookBasketRequest) request
If BookingInfo is returned then check it as per “Booking success status” above.
If no response (or BookingInfo) then assume that BookingInfo@Success="pending" and act as per “Booking success status” above

Reference: FAB Error Codes

Mon, 01 Jan 0001 00:00:00 +0000

A non exhaustive list of FAB ErrorCode values

Code	Meaning	Suggested action
800	Session error - FAB session is expired or broken	Start a new session
900	Generic error	-
F4400	Generic user input validation error	Check error text and amend request as required
F4401	Generic authorization error	Raise a support ticket
F4422	Passenger details are invalid	Check error text and syndicator details
F5000	Generic internal error	Raise a support ticket
F5200	Generic availability error	Retry your request or request availability for different dates.
F5400	Generic internal validation error	Raise a support ticket
F6100	The supplier or related party declined the payment card	Check card details and funding. Generate a new basket and retry.
F6451	The supplier blocked the request	Generate a new basket and retry.

Reference: FAB Price Codes

Mon, 01 Jan 0001 00:00:00 +0000

FAB Price Codes (FPCs) can be used to categorise various parts of the FAB_BasketRS.

They are strings of 1-4 parts, delimited with a .

E.g:

basic.adult.flight
basic.infant.flight.1

Tip

Also see Parsing ItineraryCost.

Note

It is advisable to have your integration gracefully handle cost details that have missing/unrecognised/unparsable FPCs; e.g by displaying them as a generic cost.

FPCs

Below is a non exhaustive list of the most common FPCs.

Note

This table only lists the first three parts, any FPC may be further appended with a 1 or a 2 to indicate outbound / inbound respectively.

Type	Sub-Type 1	Sub-Type 2	Description
unrecognised	-	-	Indicates a mapping error, can be raised with Paxport Customer Services
basic	adult/child/infant/pax/party	flight	Flight fare (may include tax/discounts/fees if discrete values are not known)
basic	unit	room	-
extra	adult/child/infant/pax/party	flightmeal	Inflight meal
extra	adult/child/infant/pax/party	insurance	Insurance
extra	adult/child/infant/pax/party	seatupgrade	-
extra	adult/child/infant/pax/party	seat	Seat selection
extra	adult/child/infant/pax/party	transfer	Resort transfer
extra	adult/child/infant/pax/party	any	Generic FPC for extras
extra	adult/child/infant/pax/party	charity	Charity donation
extra	adult/child/infant/pax/party	checkin	Check-in fee
extra	unit	baggage	Bag cost.
extra	unit	baggagetracking	-
extra	unit	carhire	-
extra	unit	taxi_transfer	-
extra	carparking	-
supplement	adult/child/infant/pax/party	board	-
supplement	adult/child/infant/pax/party	eticket	-
supplement	adult/child/infant/pax/party	flight	Generic flight fee
supplement	adult/child/infant/pax/party	fuel	Fuel supplement
supplement	adult/child/infant/pax/party	room	-
supplement	adult/child/infant/pax/party	paperticket	-
supplement	adult/child/infant/pax/party	tod	-
supplement	adult/child/infant/pax/party	handling	Generic booking fee or card charge.
supplement	adult/child/infant/pax/party	afp	-
supplement	adult/child/infant/pax/party	agent	Agent fee or commission
supplement	pax	baggage	Bag cost, generally for the recommended bag option.
supplement	adult/child/infant/pax/party	charity	-
supplement	adult/child/infant/pax/party	checkin	Check-in fee
supplement	adult/child/infant/pax/party	bookingfee	Booking fee
supplement	adult/child/infant/pax/party	service	Service fee
supplement	adult/child/infant/pax/party	discount	Discount
supplement	adult/child/infant/pax/party	earlybooking	-
supplement	adult/child/infant/pax/party	latebooking	-
supplement	pax	flightmeal	-
supplement	pax	noflightmeal	-
supplement	adult/child/infant/pax/party	special	-
supplement	adult/child/infant/pax/party	seat	Fee for a mandatory or automatic seat selection
supplement	room	occupancy	-
supplement	unit	room	-
tax	adult/child/infant/pax/party	flight	Flight tax

Type

The type part helps with high level categorisation.

Type	Description
basic	A core cost component, e.g the fare
extra	An extra e.g a meal
supplement	A fee or discount
tax	A tax

Sub-Type 1

The sub-type 1 part helps identify how the cost is applied.

Tip

The passenger definitions (i.e age ranges) for FPCs are from the supplier. E.g a 14 year old passenger would have tax.adult.flight for Corendon but tax.child.flight for easyJet.

The only exception is for youths which lack an FPC Sub-Type 1 at present; these are mapped to child FPCs.

Type	Description
adult	Applies to one or more adults in the party
child	Applies to one or more children in the party
infant	Applies to one or more infants in the party
pax	Applies to one or more passengers in the party
party	Applies to the party
unit	A generic unit, e.g a bag or a room

Sub-Type 2

The sub-type 2 helps identify the specific cost category. E.g “flightmeal”