The monetary amount of the tax applied to the fare.
Example
123.00
OptionalticketNumber?: string
Description
The number of the electronic document.
Example
2200011234567
OptionaltravelerIndices?: number[]
Description
Lists the indices of travelers in the travelers array to whom the particular accounting item is assigned. Returned only if fareApplication is set to Single Traveler.
The two-letter status code used by vendors. It indicates the booking status.
Example
HD
OptionalstatusName?: |"Confirmed" |"Confirmed with EMD issued" |"On Request" |"Pending" |"Cancelled" |"Unconfirmed" |"Confirmed with pending payment" |"Schedule change"
Optionalsubcode?: string
Description
The issuance subcode (RFISC) is an industry-defined or airline-defined code identifying a specific type of service. Industry-defined subcodes are available for all airlines to use, have standard definitions, and are maintained by ATPCO. Airline-defined subcodes are available for specific airlines only, and are defined and maintained by the airline utilizing the code.
Contains restrictions applied on number of baggage pieces and optional fee applicable.
Optionalfee?: {amount:string;currencyCode:string}
amount: string
Description
The monetary amount.
Example
100.00
currencyCode: string
Description
The three-letter ISO 4217 currency code.
Example
USD
OptionalisCheckInOnly?: boolean
Description
If true, the baggage restrictions are for informational purposes only. Baggage is available for purchase during check-in at the airport.
Example
true
OptionalmaximumSizeInCentimeters?: number
Format: int32
Description
Maximum allowed size of the baggage piece measured in centimeters [cm]. If null, no size limit is specified for this type of baggage.
Example
118
OptionalmaximumSizeInInches?: number
Format: int32
Description
Maximum allowed size of the baggage piece measured in inches [in]. If null, no size limit is specified for this type of baggage.
Example
46
OptionalmaximumWeightInKilograms?: number
Format: int32
Description
Maximum allowed weight of the baggage piece measured in kilograms [kg]. If null, no weight limit is specified for this type of baggage.
Example
23
OptionalmaximumWeightInPounds?: number
Format: int32
Description
Maximum allowed weight of the baggage piece measured in pounds [lb]. If null, no weight limit is specified for this type of baggage.
Example
50
numberOfPieces: number
Format: int32
Description
The number of pieces allowed within the baggage policy.
Example
1
OptionalspecialItemDescription?: string
Description
The description of the special baggage items allowed, if the baggage policy provides information about special baggage items such as musical instruments, fishing or sporting equipment, mobility device, etc.
The first travel date in the ISO 8601 format applicable for the selected ancillary, obtained from ATPCO. Together with the last travel date, this determines the period of travel application.
The two-letter type of ancillary service as per IATA standard. Please refer to the ATPCO resources for information about available industry-defined group codes.
Example
BG
OptionallastTravelDate?: string
Format: date
Description
The last travel date in the ISO 8601 format permitted for the selected ancillary, obtained from ATPCO. Together with the first travel date, this determines the period of travel application.
Example
9999-12-31
numberOfItems: number
Format: int32
Description
The quantity of ancillary items to book.
Default
1
Example
1
OptionalpurchaseDateTime?: string
Format: date-time
Description
The latest date in the ISO 8601 format before which the selected ancillary can be purchased.
The item number of a special service in the specialServices array. Defines the category of the special service associated with the selected ancillary service. Required when booking ancillaries from low-cost carriers, such as U2 or FR.
Example
1
subcode: string
Description
The issuance subcode (RFISC) is an industry-defined or airline-defined code identifying a specific type of service. Industry-defined subcodes are available for all airlines to use, have standard definitions, and are maintained by ATPCO. Airline-defined subcodes are available for specific airlines only, and are defined and maintained by the airline utilizing the code.
Example
05Z
OptionaltotalPrice?: string
Description
Contains the total price of the ancillary service after taxation.
Example
150.00
OptionalvendorCode?: string
Description
The two-letter IATA designator code of the airline providing the service. Mutually exclusive with the source property.
The ISO 3166 country code where the document is valid. Used with the 'VISA' document type.
Example
US
OptionalisLapChildDocument?: boolean
Description
If true, the identity document applies to a lap child. Can only be combined with the following document types: VISA, KNOWN_TRAVELER_NUMBER, REDRESS_NUMBER, RESIDENCE_ADDRESS, and DESTINATION_ADDRESS.
Example
true
OptionalisPrimaryDocumentHolder?: boolean
Description
If true, indicates the primary passport holder of a document issued for multiple travelers.
Example
true
OptionalissueDate?: string
Format: date
Description
The date the identity document was issued in YYYY-MM-DD format. This is mainly used for the visa document type.
Example
2024-07-09
OptionalissuingCountryCode?: string
Description
The country issuing the passenger document provided as a two- or three-letter ISO 3166 code. Not applicable to the 'VISA' document type.
Example
US
OptionalmiddleName?: string
Description
The traveler's middle name (NDC not supported).
Example
Jack
OptionalplaceOfBirth?: string
Description
The passenger's place of birth. Mainly used with the VISA document type.
Example
LYONFR
OptionalplaceOfIssue?: string
Description
The ISO 3166 code of the country the VISA document was issued in. Used with the VISA document type.
Example
FR
OptionalresidenceCountryCode?: string
Description
The country the passenger resides in or their nationality country provided as a two- or three-letter ISO 3166 code. For NDC bookings, only two-letter codes are allowed.
Lists all segments of the booking which overlaps with contextual booking elements such as flights, hotels, cars, trains and so on. This list also contains non-product related segments which exist in an underlying booking system.
OptionalbookingId?: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator or NDC orderId value, depending on content type.
Lists all the journeys associated with the booking.
* For one-way, this is a single element list.
* For round-trip, the list contains two journeys.
* For multi-destinations, the list contains more than two journeys.
Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.
Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Contains the original booking details (within the before property) or the target booking details used after a finalized modification (within the after property). Based on the difference between the before and after properties, appropriate add, update, or delete operations are performed on the booking.
OptionalagencyCustomerNumber?: string
Description
The customer identifier used by their travel agency, also known as the customer number or the DK number. Can be a six, seven, or 10-character string.
Lists payment methods associated with the booking.
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists all special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
Contains a remark to add to the booking. Please note that the PRINT_ON_TICKET, FILLER_STRIP, INTERFACE, and FORM_OF_PAYMENT remark types are currently not supported. The FORM_OF_PAYMENT remark type is automatically added to a booking upon populating the formsOfPayment array.
Identifies area preference. Cannot be combined with number. You can combine a maximum of three non-conflicting values such as FRONT and LEFT_SIDE, etc.
Optionalnumber?: string
Description
The seat number to be assigned. Cannot be combined with areaPreference.
Example
13A
travelerIndex: number
Format: int32
Description
The traveler index that is matched with the particular seat number.
Contains the special service request (SSR) message sent to an airline. The message may contain traveler preferences or mandatory/optional information directed to the airline.
code: string
Description
Defines the category of the special service request sent to the airline. Visit the official IATA website for the list of currently supported SSR code references. Some airline-specific codes may be missing within these IATA resources.
Example
XBAG
OptionalflightIndices?: number[]
Description
Lists the indices of flights within a booking.
Optionalmessage?: string
Description
The text of the special service. Some of the special service types require additional description, which is mandatory to distinguish product characteristics on the airline's side.
Contains traveler information. Multiple travelers are supported when you book by passing flight details.
Optionalage?: number
Format: int32
Description
The age of the traveler/guest. Applies only to hotel bookings. It is mandatory to pass the age of the child travelers/guests when booking a hotel room.
Lists the details of an ancillary services to be booked.
OptionalbirthDate?: string
Format: date
Description
The traveler's birthday in YYYY-MM-DD format. If you make a booking that includes infant travelers, you must provide their date of birth as it is used to send infant notification to the airline (INFT SSR).
Example
2024-01-23
Optionalemails?: string[]
Description
Lists all email addresses associated with the traveler.
OptionalformOfPaymentIndices?: number[]
Description
Lists the indices of forms of payment associated with the traveler.
Contains details of the passenger's loyalty program, such as a frequent flyer card.
OptionalnameReferenceCode?: string
Description
An additional code associated with the traveler (the so-called MAN number or statement information) used for accounting or identification purposes.
Example
C05
OptionalpassengerCode?: string
Description
Identifies the type (age) of the traveler. To book a flight that includes infant travelers, pass INF. Pass INY to indicate an infant without an assigned seat, or pass INS to indicate an infant with a seat. Used for flights and hotel bookings respectively.
Example
ADT
Optionalphones?: {label?:string;number:string}[]
Description
Lists all phone numbers associated with the traveler.
Contains special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
Contains required and optional elements to cancel a booking.
OptionalbookingSource?: "SABRE"|"SABRE_ORDER"
cancelAll: boolean
Description
If true, segments of all kinds will be cancelled from the reservation. Flights, Hotels, Cars, Trains, Cruises and all other segments included in the response are ignored.
Default
false
Example
false
Optionalcars?: {itemId:string}[]
Description
Lists the cars which should be cancelled.
confirmationId: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator value.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Lists the specifiec queue (up to three) to place the PNR into for the operation.
OptionalofferItemId?: string
Description
Contains Id for a void or refund offer available based on checkFlightTicketsResponse for the tickets belonging to the requested confirmationId. Applicable only for NDC orders.
Example
cb7778589bcbklg7tkkp8sdo50
OptionalreceivedFrom?: string
Description
The entity that authorizes the changes in a Passenger Name Record.
Example
BookingManagementAPItesting
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Example
2024-01-30
OptionalretentionLabel?: string
Description
The label associated with the retention date.
Example
RETENTIONDATE
retrieveBooking: boolean
Description
If true, the response includes the current state of the booking.
Lists all segments of the booking which overlaps with contextual booking elements such as flights, hotels, cars, trains and so on. This list also contains non-product related segments which exist in an underlying booking system.
OptionalbookingId?: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator or NDC orderId value, depending on content type.
Lists all the journeys associated with the booking.
* For one-way, this is a single element list.
* For round-trip, the list contains two journeys.
* For multi-destinations, the list contains more than two journeys.
Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.
Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
If true, segments of all kinds will be cancelled from the reservation. Flights, Hotels, Cars, Trains, Cruises and all other segments included in the response are ignored.
Default
false
Example
false
Optionalcars?: {itemId:string}[]
Description
Lists the cars which should be cancelled.
confirmationId: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator value.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Lists the specifiec queue (up to three) to place the PNR into for the operation.
OptionalofferItemId?: string
Description
Contains Id for a void or refund offer available based on checkFlightTicketsResponse for the tickets belonging to the requested confirmationId. Applicable only for NDC orders.
Example
cb7778589bcbklg7tkkp8sdo50
OptionalreceivedFrom?: string
Description
The entity that authorizes the changes in a Passenger Name Record.
Example
BookingManagementAPItesting
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Example
2024-01-30
OptionalretentionLabel?: string
Description
The label associated with the retention date.
Example
RETENTIONDATE
retrieveBooking: boolean
Description
If true, the response includes the current state of the booking.
The ID of the car rental location. Cannot be combined with other address-related qualifiers.
Example
ABC123
Optionalname?: string
Description
The name of the car rental location.
Example
TESTLOCATION
Optionalphone?: string
Description
The phone number of the car rental location involved in vehicle collection or delivery.
Example
8175551212
OptionalemailIndex?: number
Format: int32
Description
The index of the traveler's email (travelers.emails) shared with the car vendor. If the traveler's email is not specified, the index will point to the traveler's contact information instead (contactInfo.emails).
Example
1
OptionalflightIndex?: number
Format: int32
Description
Index of the flight in the reservation. Corresponding flight details (airline code and flight number) are provided to the car vendor.
Example
1
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to car booking are - PAYMENT_CARD, VOUCHER.
Example
1
OptionalpaymentPolicy?: "DEPOSIT"|"GUARANTEE"
quantity: number
Format: int32
Description
The number of cars to book. Defaults to 1.
Default
1
Example
1
OptionalspecialInstructions?: string
Description
Text-based special instructions provided to the vendor.
Example
Wantsabluecar.
OptionaltravelerIndex?: number
Format: int32
Description
The traveler index that is associated with the car booking.
Contains a set of additional features whose usage requires explicit indication to maintain backward compatibility. These functionalities will be seamlessly incorporated into a future major version of this API.
returnFiscalId: boolean
Description
If true, the additional identity document FISCAL_ID is supported.
Default
false
returnFrequentRenter: boolean
Description
If true, the additional loyalty program type FREQUENT_RENTER is supported.
Default
false
returnWalletFormsOfPayment: boolean
Description
If true, returns the following additional forms of payment - DOCKET, GOVERNMENT_TRAVEL_REQUEST, and INVOICE.
The two-letter IATA designator code of the marketing airline.
Example
AA
OptionalticketingDate?: string
Format: date
Description
The ticketing date.
Example
2024-07-09
OptionalticketingTime?: string
Description
The ticketing time in HH:MM format.
Example
11:00
asynchronousUpdateWaitTime: number
Format: int32
Description
The maximum wait time in milliseconds applied to asynchronous updates related to booking creation. Mainly used for the redisplay operation of NDC bookings.
The ID of the car rental location. Cannot be combined with other address-related qualifiers.
Example
ABC123
Optionalname?: string
Description
The name of the car rental location.
Example
TESTLOCATION
Optionalphone?: string
Description
The phone number of the car rental location involved in vehicle collection or delivery.
Example
8175551212
OptionalemailIndex?: number
Format: int32
Description
The index of the traveler's email (travelers.emails) shared with the car vendor. If the traveler's email is not specified, the index will point to the traveler's contact information instead (contactInfo.emails).
Example
1
OptionalflightIndex?: number
Format: int32
Description
Index of the flight in the reservation. Corresponding flight details (airline code and flight number) are provided to the car vendor.
Example
1
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to car booking are - PAYMENT_CARD, VOUCHER.
Example
1
OptionalpaymentPolicy?: "DEPOSIT"|"GUARANTEE"
quantity: number
Format: int32
Description
The number of cars to book. Defaults to 1.
Default
1
Example
1
OptionalspecialInstructions?: string
Description
Text-based special instructions provided to the vendor.
Example
Wantsabluecar.
OptionaltravelerIndex?: number
Format: int32
Description
The traveler index that is associated with the car booking.
Contains pricing qualifiers. If you wish to assign different mark-ups or commissions per specific passenger type, you can send separate pricing instructions per each type.
Lists optional flight status codes considered unacceptable. The system will stop processing upon encountering an unacceptable status code within a booked flight. If no status codes are provided, the system will automatically stop processing when encountering NO, UC, US, UN, UU, LL, or HL.
OptionalretryBookingUnconfirmedFlights?: boolean
Description
If true, the system will attempt to rebook unconfirmed flights. If any of the booked flights returns an unacceptable status code (as defined by HaltOnFlightStatusCodeEnum), the system will cancel them and rebook them in the lowest available fare. If the status codes remain unacceptable after the process has completed, the system will stop processing and return an error message. retryBookingUnconfirmedFlights may result in a price increase.
The two-letter IATA designator code of the marketing airline for the arrival flight.
Example
AA
OptionalarrivalFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the arrival flight.
Example
123
OptionalarrivalTime?: string
Description
The scheduled time of arrival in HH:MM format.
Example
12:28
OptionaldepartureAirlineCode?: string
Description
The two-letter IATA designator code of the marketing airline for the departure flight.
Example
AA
OptionaldepartureFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the departure flight.
Example
123
OptionaldepartureTime?: string
Description
The scheduled time of departure in HH:MM format.
Example
09:15
bookingKey: string
Description
The booking key is returned in the Hotel Price Check API response and is a mandatory value to perform the hotel booking.
Example
d9e73f0d-5f90-4b43-9c86-2d88a732604f
OptionalcorporateDiscountCode?: number
Format: int32
Description
A code that a company may give to an agency to use for a discount. It is quite often tied to a negotiated rate code. Applies to GDS hotels only.
Example
6878700
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to hotel booking are - PAYMENT_CARD, AGENCY_NAME, AGENCY_IATA, CORPORATE, COMPANY_NAME, VIRTUAL_CARD.
Contains details of the hotel rooms that will be booked. Multiple room bookings are currently not supported by GDS hotels.
OptionalspecialInstruction?: string
Description
The special instruction provided to the property.
Example
Needawi-fiintheroom.
useCsl: boolean
Description
If true, the hotel originally sourced from the GDS will be booked using the Content Services for Lodging (CSL) booking path instead of the legacy path (low level services).
Contains other service information (OSI) sent to an airline. Please note that is not possible to send other service request to a hotel chain and/or car rental vendor.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Example
2024-01-30
OptionalretentionLabel?: string
Description
The label associated with the retention date.
Example
RETENTIONDATE
OptionaltargetPcc?: string
Description
Specifies the desired pseudo city code value. The API does not revert context after completing the booking.
Lists all segments of the booking which overlaps with contextual booking elements such as flights, hotels, cars, trains and so on. This list also contains non-product related segments which exist in an underlying booking system.
OptionalbookingId?: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator or NDC orderId value, depending on content type.
Lists all the journeys associated with the booking.
* For one-way, this is a single element list.
* For round-trip, the list contains two journeys.
* For multi-destinations, the list contains more than two journeys.
Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.
Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
The two-letter IATA designator code of the marketing airline.
Example
AA
OptionalticketingDate?: string
Format: date
Description
The ticketing date.
Example
2024-07-09
OptionalticketingTime?: string
Description
The ticketing time in HH:MM format.
Example
11:00
asynchronousUpdateWaitTime: number
Format: int32
Description
The maximum wait time in milliseconds applied to asynchronous updates related to booking creation. Mainly used for the redisplay operation of NDC bookings.
The ID of the car rental location. Cannot be combined with other address-related qualifiers.
Example
ABC123
Optionalname?: string
Description
The name of the car rental location.
Example
TESTLOCATION
Optionalphone?: string
Description
The phone number of the car rental location involved in vehicle collection or delivery.
Example
8175551212
OptionalemailIndex?: number
Format: int32
Description
The index of the traveler's email (travelers.emails) shared with the car vendor. If the traveler's email is not specified, the index will point to the traveler's contact information instead (contactInfo.emails).
Example
1
OptionalflightIndex?: number
Format: int32
Description
Index of the flight in the reservation. Corresponding flight details (airline code and flight number) are provided to the car vendor.
Example
1
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to car booking are - PAYMENT_CARD, VOUCHER.
Example
1
OptionalpaymentPolicy?: "DEPOSIT"|"GUARANTEE"
quantity: number
Format: int32
Description
The number of cars to book. Defaults to 1.
Default
1
Example
1
OptionalspecialInstructions?: string
Description
Text-based special instructions provided to the vendor.
Example
Wantsabluecar.
OptionaltravelerIndex?: number
Format: int32
Description
The traveler index that is associated with the car booking.
Contains pricing qualifiers. If you wish to assign different mark-ups or commissions per specific passenger type, you can send separate pricing instructions per each type.
Lists optional flight status codes considered unacceptable. The system will stop processing upon encountering an unacceptable status code within a booked flight. If no status codes are provided, the system will automatically stop processing when encountering NO, UC, US, UN, UU, LL, or HL.
OptionalretryBookingUnconfirmedFlights?: boolean
Description
If true, the system will attempt to rebook unconfirmed flights. If any of the booked flights returns an unacceptable status code (as defined by HaltOnFlightStatusCodeEnum), the system will cancel them and rebook them in the lowest available fare. If the status codes remain unacceptable after the process has completed, the system will stop processing and return an error message. retryBookingUnconfirmedFlights may result in a price increase.
The two-letter IATA designator code of the marketing airline for the arrival flight.
Example
AA
OptionalarrivalFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the arrival flight.
Example
123
OptionalarrivalTime?: string
Description
The scheduled time of arrival in HH:MM format.
Example
12:28
OptionaldepartureAirlineCode?: string
Description
The two-letter IATA designator code of the marketing airline for the departure flight.
Example
AA
OptionaldepartureFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the departure flight.
Example
123
OptionaldepartureTime?: string
Description
The scheduled time of departure in HH:MM format.
Example
09:15
bookingKey: string
Description
The booking key is returned in the Hotel Price Check API response and is a mandatory value to perform the hotel booking.
Example
d9e73f0d-5f90-4b43-9c86-2d88a732604f
OptionalcorporateDiscountCode?: number
Format: int32
Description
A code that a company may give to an agency to use for a discount. It is quite often tied to a negotiated rate code. Applies to GDS hotels only.
Example
6878700
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to hotel booking are - PAYMENT_CARD, AGENCY_NAME, AGENCY_IATA, CORPORATE, COMPANY_NAME, VIRTUAL_CARD.
Contains details of the hotel rooms that will be booked. Multiple room bookings are currently not supported by GDS hotels.
OptionalspecialInstruction?: string
Description
The special instruction provided to the property.
Example
Needawi-fiintheroom.
useCsl: boolean
Description
If true, the hotel originally sourced from the GDS will be booked using the Content Services for Lodging (CSL) booking path instead of the legacy path (low level services).
Contains other service information (OSI) sent to an airline. Please note that is not possible to send other service request to a hotel chain and/or car rental vendor.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Example
2024-01-30
OptionalretentionLabel?: string
Description
The label associated with the retention date.
Example
RETENTIONDATE
OptionaltargetPcc?: string
Description
Specifies the desired pseudo city code value. The API does not revert context after completing the booking.
Identifies an error handling policy. Can be:
HALT_ON_ERROR - stop processing upon encountering any error from a downline service.
DO_NOT_HALT_ON_FLIGHT_PRICING_ERROR - continue upon encountering a pricing error (only ATPCO/traditional bookings).
DO_NOT_HALT_ON_HOTEL_BOOKING_ERROR - continue upon encountering a hotel booking error.
DO_NOT_HALT_ON_CAR_BOOKING_ERROR - continue upon encountering a car booking error.
DO_NOT_HALT_ON_ANCILLARY_BOOKING_ERROR - continue upon encountering an ancillary booking error.
DO_NOT_HALT_ON_SEAT_BOOKING_ERROR - continue upon encountering a seat booking error.
HALT_ON_INVALID_MINIMUM_CONNECTING_TIME_ERROR - stop if the minimum connecting time between flights is not met (only ATPCO/traditional bookings).
Contains the date range up to which a penalty is applicable, including the total cost of the penalty.
OptionalapplicableFromDate?: string
Format: date-time
Description
The date from when the penalty becomes applicable, in ISO 8601 format.
Example
2024-07-07T16:00:00Z
OptionalapplicableToDate?: string
Format: date-time
Description
The date when the penalty applicability ends, in ISO 8601 format.
Example
2024-07-09T16:00:00Z
penalty: {amount:string;currencyCode:string}
amount: string
Description
The monetary amount.
Example
100.00
currencyCode: string
Description
The three-letter ISO 4217 currency code.
Example
USD
DocumentSubTypeEnum: "RUC"|"CUIT/CUIL"|"NIT"
Description
Identifies the passenger document subtype for documentType set to FISCAL_ID. Can be RUC (Taxpayer's Unique Registry in Ecuador), CUIT/CUIL (Argentina Unique Tax Identification Key), or NIT (Tax Identification Number in Bolivia).
Contains a set of additional features whose usage requires explicit indication to maintain backward compatibility. These functionalities will be seamlessly incorporated into a future major version of this API.
Identifies the association type of the accounting item, which indicates to whom the fare is applied. Can be Single Traveler (fare amount applied to a singular passenger whose details are provided in FormOfPayment), All Travelers (fare amount applied to all passengers together as a group), or Each Traveler (fare amount applied to individual passengers).
Lists baggage allowance policies for each type of baggage.
OptionalmaximumPieces?: number
Format: int32
Description
Maximum number of allowed baggage pieces.
Example
1
OptionaltotalWeightInKilograms?: number
Format: int32
Description
Maximum summary weight of all allowed baggage measured in kilograms [kg].
Example
23
OptionaltotalWeightInPounds?: number
Format: int32
Description
Maximum summary weight of all allowed baggage measured in pounds [lb].
Example
50
OptionalfareBasisCode?: string
Description
The fare basis code used for fare construction.
Example
ABCDE10
OptionalflightIndices?: number[]
Description
Lists the indices of flights within the current itinerary. If the fare component is associated with all flights, this list is not provided. This property will be deprecated in the future major version of this API. If you wish to check flight association, use the flights property within the FareComponent object.
Optionalflights?: {itemId:string}[]
Description
Lists flights referenced by flight itemId. Multiple flight IDs can be returned for a single fare component. If the fare component is associated with all flights or a different flight itinerary was used to create this fare component (verify isCurrentItinerary property), this list is not provided.
OptionalisCurrentItinerary?: boolean
Description
If true, the fare component was created for a flight present in the current itinerary. If false, the fare component is related to a flight which is no longer a part of the current itinerary. This may be the case, for example, after a schedule change.
Contains ancillary offer for selected flights identified by itemId flight references and for selected travelers identified by indices in travelers list.
Lists flights referenced by flight itemId. If the offer is valid for all flights, this list is not provided.
OptionaltravelerIndices?: number[]
Description
Indicates to which travelers from the travelers list the ancillary offer belongs to. If the offer is valid for all travelers, this list is not provided.
Identifies the applicability of the ancillary item to the flights in the booking. Can be Single (an ancillary item applies to a single flight/sector of the booking), Multiple (an ancillary item applies to the portion of flights in the booking), or Unknown (applicability of the ancillary cannot be determined). This information is required when electronicMiscellaneousDocumentType has the value OTHER_THAN_EMD.
Contains pricing qualifiers. If you wish to assign different mark-ups or commissions per specific passenger type, you can send separate pricing instructions per each type.
Lists optional flight status codes considered unacceptable. The system will stop processing upon encountering an unacceptable status code within a booked flight. If no status codes are provided, the system will automatically stop processing when encountering NO, UC, US, UN, UU, LL, or HL.
OptionalretryBookingUnconfirmedFlights?: boolean
Description
If true, the system will attempt to rebook unconfirmed flights. If any of the booked flights returns an unacceptable status code (as defined by HaltOnFlightStatusCodeEnum), the system will cancel them and rebook them in the lowest available fare. If the status codes remain unacceptable after the process has completed, the system will stop processing and return an error message. retryBookingUnconfirmedFlights may result in a price increase.
The three-letter IATA airport code of the origin airport.
Example
DFW
OptionalhiddenStopAircraftTypeCode?: string
Description
The IATA code of the aircraft. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
E90
OptionalhiddenStopAircraftTypeName?: string
Description
The name of the aircraft model. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
EMBRAEREMBE90
OptionalhiddenStopAirportCode?: string
Description
The three-letter IATA airport code of the hidden stop airport. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
HAV
OptionalhiddenStopArrivalDate?: string
Format: date
Description
The arrival date to the hidden stop airport in the YYYY-MM-DD format in the airport's time zone. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
2024-07-09
OptionalhiddenStopArrivalTime?: string
Description
The time of arrival to the hidden stop airport in the HH:MM format. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
09:15
OptionalhiddenStopDepartureDate?: string
Format: date
Description
The departure date from the hidden stop airport in the YYYY-MM-DD format in the airport's time zone. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Example
2024-07-09
OptionalhiddenStopDepartureTime?: string
Description
The time of departure from the hidden stop airport in the HH:MM format. This property is not returned when the aircraft type is unchanged. This property will be deprecated in the future major version of this API. If you wish to check hidden stop information, use the hiddenStops list instead.
Lists seats assigned to the travelers by matching the indices in the travelers array. Refer to the travelerIndices array to verify traveler association. An empty Seat object means that there is no seat assigned to the corresponding traveler.
OptionalsourceType?: "NDC"|"LCC"|"ATPCO"
toAirportCode: string
Description
The three-letter IATA airport code of the destination airport.
Example
HNL
OptionaltravelerIndices?: number[]
Description
Lists the travelers within the travelers list. Indicates which travelers are associated with a particular flight.
OptionalupdatedArrivalDate?: string
Format: date
Description
The estimated (before arrival) or actual arrival date in YYYY-MM-DD format in the airport's time zone.
Example
2024-07-09
OptionalupdatedArrivalTime?: string
Description
The estimated (before arrival) or actual arrival time in HH:MM format.
Example
12:38
OptionalupdatedDepartureDate?: string
Format: date
Description
The estimated (before departure) or actual departure date in YYYY-MM-DD format in the airport's time zone.
Example
2024-07-09
OptionalupdatedDepartureTime?: string
Description
The estimated (before departure) or actual departure time in HH:MM format.
Lists all coupons of booked and ticketed flights. The corresponding flight itemId is provided if available. If a coupon cannot be associated with any flight present in the booking (e.g. due to schedule change), the itemId is hidden, however the coupon status details are still returned.
Lists details of seats to book or preferred seating areas in the cabin.
Optionalsource?: "LCC"|"ATPCO"
toAirportCode: string
Description
The three-letter IATA airport code of the destination airport.
Example
HNL
FlightToBookSourceEnum: "LCC"|"ATPCO"
Description
Identifies the booking method for a flight. ATPCO is the traditional booking method. LCC is the instant purchase booking method common across low cost carriers such as U2 or FR. If not specified, defaults to ATPCO.
Lists seats assigned to the travelers by matching the indices in the travelers array. Providing a null value instead of a SeatToModify object indicates that there is no seat assigned to the corresponding traveler. To obtain full seat details for modification, we recommended sending a Get Booking call with the extra feature returnEmptySeatObjects parameter set to false.
Identifies the type of payment method. The MISCELLANEOUS payment method must be activated on the agency level and requires a specific payment credit code. INSTALLMENTS is used for BSP Brazil customers only and refers to payment by means of card installments commonly referred to as "parcelado". VIRTUAL_CARD, AGENCY_NAME, AGENCY_IATA, CORPORATE, COMPANY_NAME are used for hotel bookings. VOUCHER is used for vehicle booking.
Identifies the type of the document to print during the fulfillment process. Can be Invoice, Electronic Ticketing Receipt, or All (prints both the invoice and the electronic ticketing receipt).
Identifies the type of error handling policy used by the Fulfill Flight Tickets service. Can be ALLOW_PARTIAL_FULFILLMENT (continues processing upon encountering any error from downline services during ticket issuance) or HALT_ON_INVALID_MINIMUM_CONNECTING_TIME_ERROR (stops processing if the minimum connecting time between flights is not met).
Identifies the type of the form of payment supported for fulfillment. Can be CASH, CHECK, PAYMENTCARD, VIRTUAL_CARD, MISCELLANEOUS (must be activated by the agency; requires a specific payment credit code), or INSTALLMENTS (applies only for BSP Brazil customers and refers to payment by means of card installments commonly referred to as "parcelado").
Contains the automated Net Remit ticketing qualifiers. Net Remit is used to arrange the payment of an additional commission above the standard commission amount. This extra commission is payable by the validating carrier through the BSP settlement cycle.
OptionalcashAmount?: string
Description
The cash amount of Net Remit.
Example
100.00
OptionalcommercialAgreementReferenceCode?: string
Description
The reference code used to indicate the Net Remit commercial contract.
Example
DEF456
OptionalcreditAmount?: string
Description
The credit amount of Net Remit.
Example
100.00
OptionaldiscountAmount?: string
Description
The amount of Net Remit discount.
Example
100.00
OptionalnetRemitCode?: string
Description
The value code used to enter a manual Net Remit code.
The maximum wait time in milliseconds applied to asynchronous updates during the ghost ticket validation process, which is performed to check if the newly issued tickets have been committed to the face of the PNR.
Default
0
Example
3000
confirmationId: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator value.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
The maximum wait time in milliseconds applied to asynchronous updates during the ghost ticket validation process, which is performed to check if the newly issued tickets have been committed to the face of the PNR.
Default
0
Example
3000
confirmationId: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator value.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Lists the response sections which are returned by the service. If this list is empty or not provided, then the full structure is returned. By using this option, the application may exclude or simplify calls of downline APIs, which usually results in a significant performance boost.
Optionalsurname?: string
Description
The traveler's last name.
Example
Smith
OptionaltargetPcc?: string
Description
The pseudo city code of the target destination in which the booking retrieval is requested.
Example
G7HE
OptionalunmaskPaymentCardNumbers?: boolean
Description
If true, the application unmasks payment card information stored in the booking. To display this data, the Employee Profile Record (EPR) needs to include the CCVIEW keyword.
Identifies flight status code that was considered unacceptable. Refer to the Sabre Central Status Codes page for more information on different status codes.
The two-letter IATA designator code of the marketing airline for the arrival flight.
Example
AA
OptionalarrivalFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the arrival flight.
Example
123
OptionalarrivalTime?: string
Description
The scheduled time of arrival in HH:MM format.
Example
12:28
OptionaldepartureAirlineCode?: string
Description
The two-letter IATA designator code of the marketing airline for the departure flight.
Example
AA
OptionaldepartureFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the departure flight.
Example
123
OptionaldepartureTime?: string
Description
The scheduled time of departure in HH:MM format.
Example
09:15
OptionalbookingKey?: string
Description
A mandatory value to provide in case of changes to the room type, number of guests, and check-in or check-out dates outside of the original date range. Returned in the Hotel Price Check API response.
Example
d9e73f0d-5f90-4b43-9c86-2d88a732604f
OptionalcheckInDate?: string
Format: date
Description
The check-in date in YYYY-MM-DD format in the hotel's local time zone.
Example
2024-07-09
OptionalcheckOutDate?: string
Format: date
Description
The checkout date in YYYY-MM-DD format in the hotel's local time zone.
Example
2024-07-19
OptionalcorporateDiscountCode?: number
Format: int32
Description
A discount code that a company may provide to an agency. Usually tied to a negotiated rate code.
Example
6878700
OptionalformOfPaymentIndex?: number
Format: int32
Description
The index of the payment type in the formsOfPayment list. Forms of payment applicable to a hotel booking: PAYMENT_CARD, AGENCY_NAME, AGENCY_IATA, CORPORATE, COMPANY_NAME, VIRTUAL_CARD.
Example
1
leadTravelerIndex: number
Format: int32
Description
Specifies the lead traveler from the travelers list with whom the hotel booking is associated.
The type of the room provided by the hotel supplier.
Example
2doublebeds
OptionalroomTypeCode?: string
Description
The unique ID for a room type at a given vendor.
Example
100144834
OptionaltravelerIndices?: number[]
Description
Lists the travelers within the travelers list. Indicates which travelers are considered to be guests associated with a particular room. It is possible that not all travelers are listed as hotel guests in the hotel booking.
OptionalsabrePropertyId?: string
Description
The code that uniquely identifies a single hotel property. This is a legacy concept, to be sunset in the future major version.
Example
7678
OptionalsourceTypeCode?: number
Format: int32
Description
A specific numeric code indicating the source of the hotel booking.
The two-letter IATA designator code of the marketing airline for the arrival flight.
Example
AA
OptionalarrivalFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the arrival flight.
Example
123
OptionalarrivalTime?: string
Description
The scheduled time of arrival in HH:MM format.
Example
12:28
OptionaldepartureAirlineCode?: string
Description
The two-letter IATA designator code of the marketing airline for the departure flight.
Example
AA
OptionaldepartureFlightNumber?: number
Format: int32
Description
The flight number associated with the marketing carrier for the departure flight.
Example
123
OptionaldepartureTime?: string
Description
The scheduled time of departure in HH:MM format.
Example
09:15
bookingKey: string
Description
The booking key is returned in the Hotel Price Check API response and is a mandatory value to perform the hotel booking.
Example
d9e73f0d-5f90-4b43-9c86-2d88a732604f
OptionalcorporateDiscountCode?: number
Format: int32
Description
A code that a company may give to an agency to use for a discount. It is quite often tied to a negotiated rate code. Applies to GDS hotels only.
Example
6878700
OptionalformOfPayment?: number
Format: int32
Description
Index of the payment type in the formsOfPayment list. Forms of payment applicable to hotel booking are - PAYMENT_CARD, AGENCY_NAME, AGENCY_IATA, CORPORATE, COMPANY_NAME, VIRTUAL_CARD.
Contains details of the hotel rooms that will be booked. Multiple room bookings are currently not supported by GDS hotels.
OptionalspecialInstruction?: string
Description
The special instruction provided to the property.
Example
Needawi-fiintheroom.
useCsl: boolean
Description
If true, the hotel originally sourced from the GDS will be booked using the Content Services for Lodging (CSL) booking path instead of the legacy path (low level services).
The expiration date of the identity document in the YYYY-MM-DD format.
Example
2024-07-09
OptionalflightIndices?: number[]
Description
Lists the indices of flights within a booking. This property will be deprecated in the future major version of this API. If you wish to list documents associated with the flight, use the identityDocuments property within the Flight object.
Contains details of the flights within the journey.
departureDate: string
Format: date
Description
The scheduled departure date in YYYY-MM-DD format in the airport's time zone.
Example
2024-07-09
departureTime: string
Description
The scheduled time of departure in HH:MM format.
Example
09:15
firstAirportCode: string
Description
The three-letter IATA airport code of the first flight in the journey.
Example
DFW
lastAirportCode: string
Description
The three-letter IATA airport code of the last flight in the journey.
Example
HNL
numberOfFlights: number
Description
The total number of flights in the journey.
Example
1
JourneyTypeCodeEnum: "F"|"M"|"B"
Description
Applicable to BSP France and Canada only. Identifies the journey type, which must be supplied if the refund is for a domestic flight. Possible values are B, F, or M.
Contains details of the Miscellaneous Intelligent Service Fee (MISF), applied for submitting a paperless service fee request using the amount stored in the travel journal record (TJR). May be combined with formsOfPayment details. Applicable to Canadian customers only.
Lists payment methods associated with the booking.
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists all special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
Lists payment methods associated with the booking.
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists all special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
The unique identifier of a booking, obtained by the means of the Get Booking method. Used to verify the state of the booking prior to a modification operation.
If true, the additional identity document FISCAL_ID is supported.
Default
false
returnFrequentRenter: boolean
Description
If true, the additional loyalty program type FREQUENT_RENTER is supported.
Default
false
returnWalletFormsOfPayment: boolean
Description
If true, returns the following additional forms of payment - DOCKET, GOVERNMENT_TRAVEL_REQUEST, and INVOICE.
Default
false
receivedFrom: string
Description
The entity that authorizes the changes in a booking.
Default
ModifyBooking
Example
BookingManagementAPItesting
retrieveBooking: boolean
Description
If true, the response includes the current state of the booking.
Default
false
Example
true
OptionaltargetPcc?: string
Description
Specifies the desired pseudo city code value. The API does not revert context after completing the booking.
Example
AAA
OptionalunmaskPaymentCardNumbers?: boolean
Description
If true, unmasks payment card information during the bookingSignature verification step. To use unmasked data, the Employee Profile Record (EPR) needs to include the CCVIEW keyword.
Lists all segments of the booking which overlaps with contextual booking elements such as flights, hotels, cars, trains and so on. This list also contains non-product related segments which exist in an underlying booking system.
OptionalbookingId?: string
Description
The booking reference ID as shown in the source supplier/vendor system. For SABRE, this is the PNR Locator or NDC orderId value, depending on content type.
Lists all the journeys associated with the booking.
* For one-way, this is a single element list.
* For round-trip, the list contains two journeys.
* For multi-destinations, the list contains more than two journeys.
Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.
Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists payment methods associated with the booking.
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists all special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
Lists payment methods associated with the booking.
OptionalretentionEndDate?: string
Format: date
Description
The retention date of the booking. Used optionally to keep the booking active past the date of the last itinerary item (flight, hotel, car, etc.). After this date, the booking is set for purging.
Lists all special service request (SSR) messages sent to an airline. The messages may contain traveler preferences or mandatory/optional information directed to the airline.
The unique identifier of a booking, obtained by the means of the Get Booking method. Used to verify the state of the booking prior to a modification operation.
If true, the additional identity document FISCAL_ID is supported.
Default
false
returnFrequentRenter: boolean
Description
If true, the additional loyalty program type FREQUENT_RENTER is supported.
Default
false
returnWalletFormsOfPayment: boolean
Description
If true, returns the following additional forms of payment - DOCKET, GOVERNMENT_TRAVEL_REQUEST, and INVOICE.
Default
false
receivedFrom: string
Description
The entity that authorizes the changes in a booking.
Default
ModifyBooking
Example
BookingManagementAPItesting
retrieveBooking: boolean
Description
If true, the response includes the current state of the booking.
Default
false
Example
true
OptionaltargetPcc?: string
Description
Specifies the desired pseudo city code value. The API does not revert context after completing the booking.
Example
AAA
OptionalunmaskPaymentCardNumbers?: boolean
Description
If true, unmasks payment card information during the bookingSignature verification step. To use unmasked data, the Employee Profile Record (EPR) needs to include the CCVIEW keyword.
Example
false
Optionaltimestamp?: string
Format: date-time
Description
Provides the exact point in time when the response was generated. The timestamp is expressed in UTC and presented in the YYYY-MM-DDTHH:MM:SSZ format.
Contains Automated Net Remit pricing qualifiers. Net Remit is used to arrange the payment of an extra commission that is over and above the standard commission. This extra commission is payable by the validating carrier through BSP reports.
Identifies the method of e-mail notification. DEFAULT sends a default e-mail notification based on the agency/PCC configuration. INVOICE sends an e-mail with a copy of the eInvoice, ETICKET sends an e-mail with a text copy of the eTicket, and ITINERARY sends an e-mail with a text copy of the itinerary.
Contains a desired passengerCode and the quantity used for pricing.
OptionalforcePassengerCode?: boolean
Description
If true, the system will price the booking based on the desired passengerCode.
Example
false
OptionalnumberOfpassengers?: number
Format: int32
Description
Identifies the number of travelers with the desired passengerCode.
Example
2
OptionalpassengerCode?: string
Description
Identifies the type (age) of the traveler. To book a flight that includes infant travelers, pass INF. Pass INY to indicate an infant without an assigned seat, or pass INS to indicate an infant with a seat.
Contains a maximum of two forms of payment from the formsOfPayment array. Multiple forms of payment may be defined only if your location uses Billing and Settlement Plan (BSP) reporting and/or the point of sale country does not prohibit providing more than one credit card as the form of payment.
OptionalamountOnSecondFormOfPayment?: string
Description
The desired base fare amount to charge to the second form of payment. Applicable only if two forms of payment are requested.
Example
100.00
primaryFormOfPayment: number
Format: int32
Description
The index of the primary form of payment type in the formsOfPayment array.
Example
1
OptionalsecondaryFormOfPayment?: number
Format: int32
Description
The index of the primary form of payment type in the formsOfPayment array.
Contains details of the acceptable booking price threshold that will be validated against. If the threshold is exceeded, system stops processing and terminates the transaction.
Optionalamount?: string
Description
The acceptable monetary threshold that the desired amount can exceed. Cannot be combined with percent.
Contains details of the acceptable booking price threshold that will be validated against. If the threshold is exceeded, system stops processing and terminates the transaction.
Contains required and optional fields needed to retrieve the profile information needed to complete a booking.
domainId: string
Description
Usually this is the user PCC. It could be a specific customer code as well.
Example
G7HE
OptionalfilterId?: string
Description
A unique profile filter ID which allows to retrieve a predefined subset of profile data.
Example
112676753
OptionalprofileName?: string
Description
A unique profile name used to blind move the profile into the AAA. Cannot be combined with domainId. To retrieve a profile, use either profileName or domainId.
Example
TESTPROFILE
profileTypeCode: string
Description
A unique profile type code.
Example
TVL
OptionaluniqueId?: string
Description
The unique profile ID number. Used to blind the move profile into the AAA. Cannot combine with profileName. Either profileName or domainId` need to be used in order to retrieve a profile.
The future queue placement date in ISO 8601 format. Can only be used when passing QUEUE_PLACE remark type from RemarkTypeEnum.
Example
2024-07-09
Optionalpcc?: string
Description
The pseudo city code.
Example
G7RE
prefatoryInstructionCode: number
Format: int32
Description
The programmable agency Prefatory Instruction Codes (PIC) that are unique to your agency. A PIC causes a message to display at the top of the booking when an agent displays it on queue. This message provides the agent information explaining why the booking is on the queue or what action needs to be completed depending on the PIC number you use.
Specifies the IATA-defined reason for the issuance code (RFIC) applicable to the Electronic Miscellaneous Document (EMD) that will be issued for the subcode identified in this record. The UNKNOWN option is used for the read-only purpose by getBooking API.
Lists codes and amounts of taxes to be overridden.
OptionalsplitRefundAmounts?: {amount?:string}[]
Description
Lists payment amounts to be applied when refunding a ticket that was issued to multiple forms of payment. Order has to match the forms of payment used when issuing the ticket. E.g. ticket was issue with 1. Form of Payment 'Cash' and 2. Form of Payment 'Credit Card'. In this case the first item should represent the amount to be refunded in cash and second the amount to be refunded to the credit card.
OptionaltourCode?: string
Description
A tour code to be applied to the refund. Input of a tourCode will override any tour code on the original ticket.
Example
123456789ABCDE
OptionalwaiverCode?: string
Description
A waiver code to be applied to the refund. Typically a waiver code will be supplied by the airline for the agent to use to override a cancel fee.
Lists codes and amounts of taxes to be overridden.
OptionalsplitRefundAmounts?: {amount?:string}[]
Description
Lists payment amounts to be applied when refunding a ticket that was issued to multiple forms of payment. Order has to match the forms of payment used when issuing the ticket. E.g. ticket was issue with 1. Form of Payment 'Cash' and 2. Form of Payment 'Credit Card'. In this case the first item should represent the amount to be refunded in cash and second the amount to be refunded to the credit card.
OptionaltourCode?: string
Description
A tour code to be applied to the refund. Input of a tourCode will override any tour code on the original ticket.
Example
123456789ABCDE
OptionalwaiverCode?: string
Description
A waiver code to be applied to the refund. Typically a waiver code will be supplied by the airline for the agent to use to override a cancel fee.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
The type of the room provided by the hotel supplier.
Example
2doublebeds
OptionalroomTypeCode?: string
Description
The unique ID for a room type at a given vendor.
Example
100144834
OptionaltravelerIndices?: number[]
Description
Lists the travelers within the travelers list. Indicates which travelers are considered to be guests associated with a particular room. It is possible that not all travelers are listed as hotel guests in the hotel booking.
Index of the traveler within the travelers list. Indicates which travelers will be booked into a particular room. It is assumed that the first traveler will be considered the lead guest.
Lists all IATA-defined characteristic codes associated with the seat. For the list of all codes refer to the following resource - IATA PADIS codeset element 9825.
number: string
Description
The traveler's assigned seat number.
Example
13A
OptionalstatusCode?: string
Description
The two-letter status code used by vendors. It indicates the seat status.
Identifies area preference. Cannot be combined with number. You can combine a maximum of three non-conflicting values such as FRONT and LEFT_SIDE, etc.
Example
AISLE @enum {string}
SeatToModify: {number:string;offerItemId?:string}
Description
Contains detailed information about a seat that should be modified.
number: string
Description
The traveler's assigned seat number.
Example
13A
OptionalofferItemId?: string
Description
The seat availability offer item ID. Applicable for NDC flights only.
Example
dx71wzhgpjxpvmuy80-1
Segment: {id?:string;sequence?:number}
Description
Contains reference to the segment for cancellation, identified either by sequence or by id.
Optionalid?: string
Description
The unique item id for the segment to be cancelled.
The date of the event represented by the segment in YYYY-MM-DD format and in the event's local time zone. Not returned for events that span multiple days.
The end date of the event represented by the segment, provided in YYYY-MM-DD format and in the event's local timezone. Not populated for a single-day event, such as a one-day tour.
Example
2024-07-09
OptionalendLocationCode?: string
Description
The code of the ending location of the event represented by the segment, such as destination airport code for a FLIGHT type segment. This attribute does not exist for a single location type event such as hotel or cruise reservation.
Example
HNL
OptionalendTime?: string
Description
The end time of the event represented by the segment in HH:MM format.
Example
12:28
OptionallocationCode?: string
Description
The code of the location of the event represented by the segment. This attribute does not exist for an event with start and end locations.
The start date of the event represented by the segment, provided in YYYY-MM-DD format and in the event's local timezone. Not populated for a single-day event.
Example
2024-07-09
OptionalstartLocationCode?: string
Description
The code of the start location of the event represented by the segment, such as origin airport code for a FLIGHT type segment. This attribute does not exist for a single location event, such as cruise trip.
Example
DFW
OptionalstartTime?: string
Description
The start time of the event represented by the segment in HH:MM format.
Example
09:15
Optionaltext?: string
Description
The name or description of the segment, such as flight number for the segment representing a flight.
Example
123
Optionaltime?: string
Description
The time of the event represented by the segment in HH:MM format.
Example
09:15
type: string
Description
The type of the booking segment.
Example
FLIGHT
OptionalvendorCode?: string
Description
The corresponding vendor code, such as carrier code for a FLIGHT type segment, or hotel vendor code for a HOTEL type segment.
Contains special service information (SSR) for a specific traveler.
Optionalcode?: string
Description
Defines the category of the special service request sent to the airline. Visit the official IATA website for the list of currently supported SSR code references. Some airline-specific codes may be missing within these IATA resources.
Example
WCHR
Optionalflights?: {itemId:string}[]
Description
Lists flights referenced by flight itemId. Multiple flight IDs can be returned for a single special service.
Optionalmessage?: string
Description
Miscellaneous free text information used in teletype messages sent to or from the airline. May contain additional special service details which are mandatory to distinguish product characteristics on the airline's side.
Example
/PREPAID
Optionalname?: string
Description
The name of the special service request. This property is not returned when the name is unknown.
Example
Wheelchair/Passengercanwalkupstairs
OptionalstatusCode?: string
Description
The two-letter status code used by vendors. It indicates the special service status.
Lists the travelers within the travelers list the special service belongs to. This list is not provided for special services without explicit traveler assignation.
Contains the special service request (SSR) message sent to an airline. The message may contain traveler preferences or mandatory/optional information directed to the airline.
code: string
Description
Defines the category of the special service request sent to the airline. Visit the official IATA website for the list of currently supported SSR code references. Some airline-specific codes may be missing within these IATA resources.
Example
WCHR
Optionalflights?: {itemId:string}[]
Description
Lists flights referenced by their itemId. A single special service can be associated with multiple flights.
Optionalmessage?: string
Description
Miscellaneous free text information used in teletype messages sent to or from the airline. May contain additional special service details which are mandatory to distinguish product characteristics on the airline's side.
Example
/PREPAID
OptionaltravelerIndices?: number[]
Description
Lists indices of travelers from the travelers array to whom the special service is assigned. For special services without explicit traveler assignation, this array should not be provided.
Contains strong customer authentication details for the payment card.
Optionalamount?: string
Description
Indicates purchase amount.
Example
1234.56
OptionalcardNumberCollectionCode?: string
Description
Determines how the card number was collected for the transaction. Can be K - keyed in for this transaction, or S - card on file (previously stored credentials).
Example
K
OptionalchannelCode?: string
Description
Indicates which channel the transaction was initiated in. Can be MO - Mail Order, TO - Telephone Order, EC - ECOM, FA - Face to Face.
Example
MO
OptionalcurrencyCode?: string
Description
The three-letter ISO 4217 currency code.
Example
USD
OptionalelectronicCommerceIndicator?: string
Description
The Electronic Commerce Indicator (ECI) is two alphanumeric code that is returned by the issuing banks and credit card specific networks.
Example
12
OptionalexemptionTypeCode?: string
Description
Determines which exemption was used by the Payment Service Provider (PSP). Can be SC - Secure Corporate Exemption, DA - Delegated Authentication, TR - Transaction Risk Analysis Exemption, TB - Trusted Beneficiary Exemption, LV - Low Value Exemption.
Example
SC
OptionalissueCode?: string
Description
Indicates that authentication was attempted for a transaction, but there was an authentication outage in the authentication flow between the merchant, gateway 3-D Secure (3DS) server, and the Directory Server. This means an authentication request was not possible and an authentication response could not be received. This is not a formal exemption, but information for issuers to consider.
Example
AO
OptionalmandateTypeCode?: string
Description
Describes the agreed mandate between the cardholder and the agent/third party. Can be one of the following values: NA - No agreement for future transactions, NS - Agreement for future no show or cancellation fee, AC - Agreement for any payments due after check in to cover charges during stay, CO - Any charges post checkout, BP - Agreement for pre-payment, deposit or balance payment, FR - Agreement for recurring payment (fixed date and fixed amount), VR - Agreement for recurring payment (fixed date and variable amount), UR - Agreement for recurring payment (non fixed date and variable amount). It is possible to enter more than one value using a comma as a separator e.g. NA, NS.
Example
NA
OptionalmerchantName?: string
Description
The name of the merchant containing up to 40 alphanumeric characters.
Example
TESTCREDITCARD
OptionaloriginalPaymentReference?: string
Description
The identifier of the authorization (Authorization Trace ID/Authorization Trans ID) request when performed by the booking agent. This value can be up to 16 alphanumeric and special characters, and is returned from the initial authorization response.
Example
1234547839012345
OptionalresultCode?: string
Description
Indicates whether authentication was successful.
Example
OK
OptionalsecureAuthenticationValue?: string
Description
The 3DS authentication value (MasterCard - AAV; Amex - AEVV; Visa - CAVV). A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Example
ABC123455533533444455555678
OptionalsecureTransactionId?: string
Description
The 3DS transaction ID returned by the 3DS Directory Server. A 20 byte unsigned binary value.
Example
ABCDEFGHI123456789012!.1234567890123
OptionaltokenAuthenticationValue?: string
Description
The authentication value for tokens (e.g. TAVV). A 20-byte value that has been Base64 encoded, giving a 28-byte result.
Example
ABC3434334343556677487312567
OptionalupdatedDateTime?: string
Format: date-time
Description
Identifies the SCA update date and time in ISO 8601 format.
Example
2024-07-07T16:00:00Z
OptionalverificationResultCode?: string
Description
Indicates whether the cardholder is enrolled in 3DS.
Example
PASS
Optionalversion?: string
Description
The 3DS Program Protocol version. A 3 alphanumeric character value, without dots between.
Lists penalty details associated with a fare exchange.
OptionalisAutomatedRefundsEligible?: boolean
Description
If true, the electronic document meets the requirements for an automated refund.
Example
true
OptionalisChangeable?: boolean
Description
If true, the fare can be exchanged with or without additional cost. Refer to the exchangePenalties array for more information. If the penalty source parameter indicates Category 16, exchangeability is not guaranteed.
Example
true
OptionalisRefundable?: boolean
Description
If true, the electronic document is fully or partially refundable. Refer to the refundPenalties array for more information. If the penalty source parameter indicates Category 16, refundability is not guaranteed.
Example
true
OptionalisVoidable?: boolean
Description
If true, the electronic document meets the requirements for the void procedure.
If true, overrides all pre-programmed endorsements and prints special endorsements of the fare.
Example
true
OptionalexcludeFareFocusFares?: boolean
Description
If true, fares with advance purchase requirements are excluded during pricing. Mutually exclusive with the priceQuoteRecordIds property within the fulfillment process.
Lists references to the travelers within the travelers array for the purpose of name association during the fulfillment process. Mutually exclusive with the priceQuoteRecordIds property.
OptionalvalidatingAirlineCode?: string
Description
The two-letter IATA designator code of the desired validating airline.
Contains information necessary to request time limit policies for tickets. This is used by travel agencies to request the first airline in the air booking to issue the tickets.
OptionalairlineCode?: string
Description
The two-letter IATA designator code of the marketing airline.
Identifies the penalty associated with the fare. Can be Changeable (changeable fare options), Either or (refundable or changeable fare options), or Refundable (refundable fare options).
Lists all flight payments, per each currency used, and is applicable only for ticketed bookings. It sums up all payments with the exclusion of Refunded/Voided tickets, obtained directly from the ticket data.
Lists all flight payments, per each currency used. For ticketed bookings it sums all payments irrespective of the document status. For non-ticketed bookings it sums payments from all price quotes stored in the booking.
Identifies the options that will be printed on the final ticket. Must be used in combination with tourCode. Can be REPLACE_WITH_BT (suppresses the fare amount and replaces it with BT), REPLACE_WITH_IT (suppresses the fare amount and replaces it with IT), SUPPRESS_IT (suppresses IT), or SUPPRESS_IT_AND_FARE (suppresses IT as well as the fare amount). IT stands for the inclusive tour ticket amount on the passenger coupon of a ticket, while BT indicates the bulk inclusive tour ticket amount on the passenger coupon of a ticket.
Lists loyalty programs the traveler participates in.
OptionalmiddleName?: string
Description
The traveler's middle name. Supported for NDC content only.
Example
Jack
OptionalpassengerCode?: string
Description
Specifies the type (age) of the traveler. Used for flights and hotel bookings. Available values for hotel reservations are limited to ADT (for adult) and CNN (for child).
Example
ADT
Optionalphones?: {label?:string;number:string}[]
Description
Lists all phone numbers associated with the traveler.
The detailed description of the room provided by the hotel supplier. Pass the value obtained from HotelPriceCheckRS/PriceCheckInfo/HotelRateInfo/Rooms/Room/RoomDescription/Text.
Example
DeluxeRoom, 2DoubleBeds
OptionalroomType?: string
Description
The type of the room provided by the hotel supplier. Pass the value obtained from HotelPriceCheckRS/PriceCheckInfo/HotelRateInfo/Rooms/Room/RoomDescription/@Name.
Example
2doublebeds
OptionalvirtualCardCharges?: string[]
Description
Lists all extra charges that can be covered by the virtual card. If the card is used to cover room only please pass "Room Only" value.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Lists printers or a printer profile to designate. It is possible to provide a single PrinterAddress object with a printer profile. Alternatively, the array may contain multiple PrinterAddress objects, but each of them must have the same printer type definition.
Description
Allows pricing of the booking by incorporating account codes.