Model: travelExtension

1 min

Model Parameters

travelExtension
- flightInformationflightInformation
  Description
  Nested object containing flight itinerary, segment, and passenger information.
  - pnrstring
    Example
    ABC123
    Description
    [Optional] Passenger name record for the itinerary.
  - flightTypestring<one-way | round-trip | multi-city>
    Example
    round-trip
    Description
    [Optional] Type of flight itinerary.
    Allowed
    one-wayround-tripmulti-city
  - isThirdPartyBookingboolean
    Description
    [Optional] Indicates whether the booking was made through a third party ("true"/"false" also accepted).
  - fareBasisCodestring
    Example
    YLOWUS
    Description
    [Optional] Alphanumeric code used by the airline to identify fare type.
  - otaIdentificationNumberstring
    Example
    OTA12345
    Description
    [Optional] Online travel agency identification number.
  - otaNamestring
    Example
    Expedia
    Description
    [Optional] Online travel agency name.
  - initialDepartingAirportstring
    Example
    ORD
    Description
    [Optional] Initial departing airport IATA code.
  - finalArrivalAirportstring
    Example
    LAX
    Description
    [Optional] Final arrival airport IATA code.
  - numberOfPassengersinteger
    Example
    2
    Description
    [Optional] Number of passengers on the itinerary; integer < 4 digits.
    Minimum
    0
  - segmentsflightSegment[]
    Description
    [Optional] Flight segments included in the itinerary.
    - routeInfostring
      Example
      ORD-LAX
      Description
      [Optional] Route information for the flight segment.
    - airlineNamestring
      Example
      American Airlines
      Description
      [Optional] Airline name for the flight segment.
    - operatingAirlinestring
      Example
      American Airlines
      Description
      [Optional] Operating airline for the flight segment.
    - flightNumberstring
      Example
      AA1234
      Description
      [Optional] Flight number for the segment.
    - ticketClassstring<economy | premium | business | first>
      Example
      economy
      Description
      [Optional] Ticket class for the segment.
      Allowed
      economypremiumbusinessfirst
    - fareClassstring
      Example
      Y
      Description
      [Optional] Fare class for the segment.
    - specialFareTypestring<bereavement | corporate | employee | infant | military | senior | student | unaccompaniedMinor | other>
      Example
      corporate
      Description
      [Optional] Special fare category applied to the segment.
      Allowed
      bereavementcorporateemployeeinfantmilitaryseniorstudentunaccompaniedMinorother
    - isAwardTicketboolean
      Description
      [Optional] Indicates whether the segment was booked using an award ticket; string "true"/"false" also accepted.
    - departureDateTimestring<date-time>
      Example
      2022-03-11T08:00:00-06:00
      Description
      [Optional] Departure date and time for the segment; ISO 8601 / RFC 3339.
      Format
      date-time
    - departureAirportCodestring
      Example
      ORD
      Description
      [Optional] Departure airport IATA code.
    - arrivalDateTimestring<date-time>
      Example
      2022-03-11T11:00:00-07:00
      Description
      [Optional] Arrival date and time for the segment; ISO 8601 / RFC 3339.
      Format
      date-time
    - arrivalAirportCodestring
      Example
      LAX
      Description
      [Optional] Arrival airport IATA code.
    - isFinalDestinationboolean
      Example
      true
      Description
      [Optional] Indicates whether this segment ends at the final destination ("true"/"false" also accepted).
  - passengersflightPassenger[]
    Description
    [Optional] Passengers included in the itinerary.
    - passengerIDstring
      Example
      PAX001
      Description
      [Optional] Merchant-assigned identifier for the passenger.
    - ticketNumberstring
      Example
      12345678901
      Description
      [Optional] Ticket number assigned to the passenger.
    - passengerDateOfBirthstring<date>
      Example
      1985-11-15
      Description
      [Optional] Passenger date of birth in ISO 8601 date format (YYYY-MM-DD).
      Format
      date
    - passengerGenderstring<F | M | U | O>
      Example
      F
      Description
      [Optional] Passenger gender code.
      Allowed
      FMUO
    - passengerAdultOrChildstring<adult | child | infant>
      Example
      adult
      Description
      [Optional] Passenger age category.
      Allowed
      adultchildinfant
    - passengerTitlestring
      Example
      Ms
      Description
      [Optional] Passenger title.
    - passengerFirstNamestring
      Example
      Jane
      Description
      [Optional] Passenger first name; maximum 40 characters.
      Max Length
      40
    - passengerMiddleNamestring
      Example
      Marie
      Description
      [Optional] Passenger middle name; maximum 20 characters.
      Max Length
      20
    - passengerLastNamestring
      Example
      Doe
      Description
      [Optional] Passenger last name; maximum 40 characters.
      Max Length
      40
    - passengerFullNamestring
      Example
      Jane Marie Doe
      Description
      [Optional] Passenger full name.
    - passengerPhonestring
      Example
      3125555555
      Description
      [Optional] Passenger phone number.
    - passengerPhoneCountryCodestring
      Example
      1
      Description
      [Optional] Passenger phone country code; numeric country code without + prefix.
    - passengerEmailAddressstring
      Example
      [email protected]
      Description
      [Optional] Passenger email address.
    - passengerCheckedBaggageCountinteger
      Example
      1
      Description
      [Optional] Number of checked bags for the passenger.
      Minimum
      0
    - passengerLoyaltyNumberstring
      Example
      AA123456
      Description
      [Optional] Passenger loyalty membership number.
    - passengerLoyaltySinceDatestring<date>
      Example
      2015-06-01
      Description
      [Optional] Date the passenger loyalty membership began, in ISO 8601 date format (YYYY-MM-DD).
      Format
      date
    - passengerLoyaltyLevelstring
      Example
      Gold
      Description
      [Optional] Passenger loyalty tier level.
    - passengerPassportNumberstring
      Example
      A12345678
      Description
      [Optional] Passenger passport number.
    - passengerPassportCountryCodestring
      Example
      US
      Description
      [Optional] Passenger passport country code; ISO 3166-1 alpha-2.
    - passengerPassportExpirationDatestring<date>
      Example
      2030-06-01
      Description
      [Optional] Passenger passport expiration date in ISO 8601 date format (YYYY-MM-DD).
      Format
      date
- lodgingInformationlodgingInformation
  Description
  Travel lodging information object
  - lodgingDetailslodgingDetail[]
    Description
    One lodging reservation within lodgingInformation.lodgingDetails[]
    - lodgingNamestring
      Example
      The Landmark London
      Description
      [Optional] Name of the lodging property.
    - lodgingPropertyIDstring
      Example
      LDMRK001
      Description
      [Optional] Merchant-assigned identifier for the lodging property.
    - lodgingChainNamestring
      Example
      Independent
      Description
      [Optional] Name of the lodging chain, if applicable.
    - lodgingAmountnumber
      Example
      350
      Description
      [Optional] Total amount charged for the lodging reservation; zero or positive.
      Minimum
      0
    - lodgingAmountCurrencyCodestring
      Example
      GBP
      Description
      [Optional] ISO 4217 currency code for the lodging amount.
    - lodgingRoomOccupancyinteger
      Example
      2
      Description
      [Optional] Number of guests occupying the room.
      Minimum
      0
    - lodgingBedTypestring
      Example
      King
      Description
      [Optional] Bed type for the room.
    - lodgingRoomTypestring
      Example
      Deluxe
      Description
      [Optional] Room type or category.
    - lodgingCommentsstring
      Example
      Non-smoking room requested
      Description
      [Optional] Free-text comments or special requests for the reservation.
    - lodgingCheckInDateTimestring<date-time>
      Example
      2022-04-16T15:00:00+01:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled check-in.
      Format
      date-time
    - lodgingCheckOutDateTimestring<date-time>
      Example
      2022-04-20T11:00:00+01:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled check-out.
      Format
      date-time
    - lodgingAddressIDstring
      Example
      23l4jk23klj24
      Description
      [Optional] Reference to the address record for the lodging property.
  - guestslodgingGuest[]
    Description
    One guest within lodgingInformation.guests[]
    - guestFirstNamestring
      Example
      Jane
      Description
      [Optional] First name of the lodging guest.
    - guestMiddleNamestring
      Example
      Marie
      Description
      [Optional] Middle name of the lodging guest.
    - guestLastNamestring
      Example
      Doe
      Description
      [Optional] Last name of the lodging guest.
- carRentalInformationcarRentalInformation
  Description
  Travel car rental information object
  - carRentalDetailscarRentalDetail[]
    Description
    One car rental reservation within carRentalInformation.carRentalDetails[]
    - carRentalBrandstring
      Example
      Hertz
      Description
      [Optional] Car rental company brand.
    - carRentalAmountnumber
      Example
      210
      Description
      [Optional] Total amount charged for the car rental; zero or positive.
      Minimum
      0
    - carRentalCurrencyCodestring
      Example
      GBP
      Description
      [Optional] ISO 4217 currency code for the car rental amount.
    - rentalTypestring
      Example
      daily
      Description
      [Optional] Rental duration type (e.g., daily, weekly).
    - rentalClassstring
      Example
      compact
      Description
      [Optional] Rental vehicle class (e.g., compact, midsize).
    - pickupAddressIDstring
      Example
      23l4jk23klj25
      Description
      [Optional] Reference to the address record for the pickup location.
    - pickUpDateTimestring<date-time>
      Example
      2022-04-16T16:00:00+01:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled pickup.
      Format
      date-time
    - returnAddressIDstring
      Example
      23l4jk23klj26
      Description
      [Optional] Reference to the address record for the return location.
    - returnDateTimestring<date-time>
      Example
      2022-04-20T10:00:00+01:00
      Description
      [Optional] ISO 8601 timestamp of the scheduled return.
      Format
      date-time
- cruiseInformationcruiseInformation
  Description
  Travel cruise information object
  - cruiseDetailscruiseDetail[]
    Description
    One cruise reservation within cruiseInformation.cruiseDetails[]
    - cruiseBrandstring
      Example
      Royal Caribbean
      Description
      [Optional] Cruise line brand.
    - cruiseAmountnumber
      Example
      1500
      Description
      [Optional] Total amount charged for the cruise; zero or positive.
      Minimum
      0
    - cruiseCurrencyCodestring
      Example
      USD
      Description
      [Optional] ISO 4217 currency code for the cruise amount.
    - cruiseDepartureAddressIDstring
      Example
      23l4jk23klj27
      Description
      [Optional] Reference to the address record for the departure port.
    - cruiseInitialStartDateTimestring<date-time>
      Example
      2022-06-01T16:00:00-04:00
      Description
      [Optional] ISO 8601 timestamp of the cruise departure.
      Format
      date-time
    - cruiseReturnAddressIDstring
      Example
      23l4jk23klj27
      Description
      [Optional] Reference to the address record for the return port.
    - cruiseFinalReturnDateTimestring<date-time>
      Example
      2022-06-08T09:00:00-04:00
      Description
      [Optional] ISO 8601 timestamp of the cruise return.
      Format
      date-time
- activityInformationactivityInformation
  Description
  Travel activity information object
  - activityDetailsactivityDetail[]
    Description
    One activity reservation within activityInformation.activityDetails[]
    - activitySupplierstring
      Example
      London Eye
      Description
      [Optional] Supplier or operator of the activity.
    - activityNamestring
      Example
      Thames River Cruise
      Description
      [Optional] Name of the activity.
    - activityAmountnumber
      Example
      45
      Description
      [Optional] Total amount charged for the activity; zero or positive.
      Minimum
      0
    - activityAmountCurrencyCodestring
      Example
      GBP
      Description
      [Optional] ISO 4217 currency code for the activity amount.
    - activityAddressIDstring
      Example
      23l4jk23klj28
      Description
      [Optional] Reference to the address record for the activity location.
    - activityStartDateTimestring<date-time>
      Example
      2022-04-17T14:00:00+01:00
      Description
      [Optional] ISO 8601 timestamp of when the activity begins.
      Format
      date-time

Travel-specific top-level fields for the Unified Fraud API preAuth and postAuth endpoints.