travelInformation
The following fields provide travel information.
travelInformation. actualFinalDestination
Use to specify the airport code for the actual final destination of the trip.
This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-).
For example, if the route is
SFO-LAX:LAX-MCT:MCT-BLR:BLR-MCT:MCT-LAX:LAX-SFO
, the actual final destination might be
BLR
(
SFO
is the last destination only because this is a round trip.)
Specifications
-
Data Type:String
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.actualFinalDestination
-
SCMP API Field:decision_manager_travel_actual_final_destination
-
Simple Order API Field:decisionManager_travelData_actualFinalDestination
travelInformation. actualFinalDestination.city
City of the actual final destination.
For example, if the route is
SFO-LAX:LAX-MCT:MCT-BLR:BLR-MCT:MCT-LAX:LAX-SFO
, the actual final destination is
BLR
(
SFO
is the last destination only because this is a round trip).
The value must be included as a destination in the
travelInformation.completeRoute
field in order to be present in the response along with the corresponding city, country, and geographical details.
Specifications
-
Data Type:String
-
Data Length:90
Mappijava.io.PrintWriter@1eb98529 ng Information
-
REST API Field:travelInformation.actualFinalDestination.city
-
SCMP API Field:decision_travel_actual_final_destination_city
-
Simple Order API Field:decisionReply_travel_actualFinalDestinationCity
travelInformation. actualFinalDestination.country
Country of the actual final destination.
Specifications
-
Data Type:String
-
Data Length:90
Mapping Information
-
REST API Field:travelInformation.actualFinalDestination.country
-
SCMP API Field:decision_travel_actual_final_destination_country
-
Simple Order API Field:decisionReply_travel_actualFinalDestinationCountry
travelInformation. actualFinalDestination.latitude
Latitude of the actual final destination.
Use the format: ###.######
For example: 12.982267
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.actualFinalDestination.latitude
-
SCMP API Field:decision_travel_actual_final_destination_latitude
-
Simple Order API Field:decisionReply_travel_actualFinalDestinationLatitude
travelInformation. actualFinalDestination.longitude
Longitude of the actual final destination.
Use the format: ###.######
For example: 80.16378
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.actualFinalDestination.longitude
-
SCMP API Field:decision_travel_actual_final_destination_longitude
-
Simple Order API Field:decisionReply_travel_actualFinalDestinationLongitude
travelInformation. agency.code
International Air Transport Association (IATA) code for the travel agency that made the reservation.
Specifications
-
Data Type:String
-
Data Length:8
Mapping Information
-
REST API Field:travelInformation.agency.code
-
SCMP API Fields:
-
airline_agent_code
-
lodging_travel_agency_code
-
-
Simple Order API Fields:
-
airlineData_agentCode
-
lodgingData_travelAgencyCode
-
travelInformation. agency.name
Name of the travel agency that made the reservation.
Specifications
-
Data Type:String
-
Data Length:25
Mapping Information
-
REST API Field:travelinformation.agency.name
-
SCMP API Fields:
-
airline_agent_name
-
lodging_travel_agency_name
-
-
Simple Order API Fields:
-
airlineData_agentName
-
lodgingData_travelAgencyName
-
travelInformation. completeRoute
Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn]
or example:
SFO-JFK:JFK-LHR:LHR-CDG
.
In your request, send either the complete route or the individual legs (
_leg#_orig
and
_leg#_dest
). If you send all the fields, the value of
_complete_route
takes precedence over that of the
_leg#
fields.
Specifications
-
Data Type:String
-
Data Length:255
Mapping Information
-
REST API Field:travelInformation.completeRoute
-
SCMP API Field:decision_manager_travel_complete_route
-
Simple Order API Field:decisionManager_travelData_completeRoute
travelInformation. departureTime
Departure date and time of the first leg of the trip.
Use one of the following formats:
-
yyyy-MM-dd HH:mm z
-
yyy-MM-dd hh:mm a z
-
yyyy-MM-dd hh:mma z
HH = hour in 24-hour format
hh = hour in 12-hour format
a = a.m. or p.m. (case insensitive)
z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure.
IMPORTANT
For travel information, use GMT or offset from GMT.
2020-03-20 11:30 pm GMT
2020-03-20 11:30 pm GMT-05:00
The format must follow the example when specifying an offset from GMT. Insert no spaces between the time zone and the offset.
Specifications
-
Data Type: Date Time
-
Data Length: 28
Mapping Information
-
REST API Field:travelInformation.departureTime
-
SCMP API Field:decision_manager_travel_departure_time
-
Simple Order API Field:decisionManager_travelData_departureDateTime
travelInformation. duration
Number of days of the auto rental or lodging rental.
-
Auto rental
-
This field is supported for Visa, Mastercard, and American Express.IMPORTANTIf this field is not included when theprocessingInformation.industryDataTypefield is set toauto_rental, the transaction is declined.
-
Lodging
-
For a lodging deposit, the value for this field specifies the number of days covered by the advance payment. Possible values:01through99.
-
IMPORTANTIf this field is not included when theprocessingInformation.industryDataTypefield is set tolodging, the transaction is declined.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.duration
-
SCMP API Field:duration
-
Simple Order API Fields:
-
ccAuthService_duration
-
ccIncrementalAuthService_duration
-
travelInformation. journeyType
Type of travel, for example
one way
or
round trip
.
Specifications
-
Data Type:String
-
Data Length:32
Mapping Information
-
REST API Field:travelInformation.journeyType
-
SCMP API Field:decision_manager_travel_journey_type
-
Simple Order API Field:decisionManager_travelData_journeyType
travelInformation. legs[]. departureDate
Departure date and time of each leg of the trip.
For example, if route is
SFO-JFK: JFK-LHR: LHR-MUM
, then
SFO-JFK
is leg 0 and LHR-MUM is leg2.
The leg number can be a positive integer from 0 to N. The departure time in leg N+1 must be higher than the departure time in leg N.
Use one of the following shared formats:
-
yyyy-MM-dd HH:mm z
-
yyy-MM-dd hh:mm a z
-
yyyy-MM-dd hh:mma z
HH = hour in 24-hour format
hh = hour in 12-hour format
a = a.m. or p.m. (case insensitive)
z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure.
IMPORTANT
For travel information, use GMT or offset from GMT.
2020-03-20 11:30 pm GMT
2020-03-20 11:30 pm GMT-05:00
When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset.
Specifications
-
Data Type:Date Time
-
Data Length:25
Mapping Information
-
REST API Field:travelInformation.legs.[].departureDate
-
SCMP API Field:decision_manager_travel_legnum_departure_time
-
Simple Order API Field:decisionManager_travelData_leg_#_departureDateTime
travelInformation. legs[]. destination
Specifies the destination for each leg of the trip using the three digit airport code.
For example,
decision_manager_travel_leg0_dest = SFO
decision_manager_travel_leg1_dest = SFO
IMPORTANT
In your request, send either the complete route or the individual legs (
_leg#_orig
and
_leg#_dest
). If you send all the fields, the complete route takes precedence over the individual legs.
Specifications
-
Data Type:String
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.legs.[].destination
-
SCMP API Field:decision_manager_travel_legnum_destination
-
Simple Order API Field:decisionManager_travelData_leg_#_destination
travelInformation. legs[]. origination
Specifies the origniation for each leg of the trip using the three digit airport code.
For example: SFO = San Francisco. Do not use the colon (:) or the dash (-). The leg number can be a positive integer from 0 to N. For example,
decision_manager_travel_leg0_dest = SFO
decision_manager_travel_leg1_dest = SFO
IMPORTANT
In your request, send either the complete route or the individual legs (
_leg#_orig
and
_leg#_dest
). If you send all the fields, the complete route takes precedence over the individual legs.
Specifications
-
Data Type:String
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.legs.[].origination
-
SCMP API Field:decision_manager_travel_legnum_orig
-
Simple Order API Field:decisionManager_travelData_leg_#_origin
travelInformation.lodging. additionalDiscountAmount
Amount of an additional coupon or discount.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.additionalDiscountAmount
-
SCMP API Field:lodging_additional_coupon
-
Simple Order API Field:java.io.PrintWriter@7ae9aaa8lodgingData_additionalCoupon
travelInformation.lodging. adjustmentAmount
Adjusted amount charged in addition to the reservation amount after the stay is complete.
Specifications
-
Data Type:string
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.adjustmentAmount
-
Simple Order API Field:lodgingData_adjustmentAmount
travelInformation.lodging. audioVisualCost
Cost of audio visual services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.audioVisualCost
-
Simple Order API Field:lodgingData_audioVisualCost
travelInformation.lodging. banquetCost
Cost of banquet services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.banquetCost
-
Simple Order API Field:lodgingData_banquetCost
travelInformation.lodging. businessCenterCost
Cost of business center services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.businessCenterCost
-
Simple Order API Field:lodgingData_businessCenterCost
travelInformation.lodging. cashDisbursementCost
Cost of the cash that was disbursed plus any associated service fees.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.cashDisbursementCost
-
Simple Order API Field:lodgingData_cashDisbursementCost
travelInformation.lodging. checkInDate
Date on which the guest checked in.
In the case of a no-show or a reservation, it is the scheduled arrival date.
Format:
MMDDYY
.
For the best interchange rates, make sure it is a valid date.
Specifications
-
Data Type:String
-
Data Length:6
Mapping Information
-
REST API Field:travelInformation.lodging.checkInDate
-
Simple Order API Field:java.io.PrintWriter@cc37a6clodgingData_checkInDate
travelInformation.lodging. checkOutDate
Date on which the guest checked out.
Format: MMDDYY
Specifications
-
Data Type:String
-
Data Length:6
Mapping Information
-
REST API Field:travelInformation.lodging.checkOutDate
-
Simple Order API Field:lodgingData_checkOutDate
travelInformation.lodging. conferenceRoomCost
Cost of conference room services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.conferenceRoomCost
-
Simple Order API Field:lodgingData_conferenceRoomCost
travelInformation.lodging. corporateClientCode
Code assigned to a business. You can use this code to identify corporate rates and discounts for guests.
Specifications
-
Data Type:String
-
Data Length:17
Mapping Information
-
REST API Field:travelInformation.lodging.corporateClientCode
-
Simple Order API Field:lodgingData_corporateClientCode
travelInformation.lodging. customerServicePhoneNumber
Your toll-free customer service phone number.
Specifications
-
Data Type:String
-
Data Length:27
Mapping Information
-
REST API Field:travelInformation.lodging.customerServicePhoneNumber
-
Simple Order API Field:lodgingData_customerServicePhoneNumber
travelInformation.lodging. earlyCheckOutCost
Service fee for early departure.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.earlyCheckOutCost
-
Simple Order API Field:lodgingData_earlyCheckOutCost
travelInformation.lodging. foodAndBeverageCost
Cost for all food and beverages.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.foodAndBeverageCost
-
Simple Order API Field:lodgingData_foodAndBeverageCost
travelInformation.lodging. giftShopCost
Cost of gift shop purchases.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.giftShopCost
-
Simple Order API Field:lodgingData_giftShopCost
travelInformation.lodging. gratuityAmount
Amount of the lodging gratuity.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.gratuityAmount
-
Simple Order API Field:lodgingData_gratuityCost
travelInformation.lodging. guestName
Name of the guest under which the room is reserved.
Specifications
-
Data Type:String
-
Data Length:40
Mapping Information
-
REST API Field:travelInformation.lodging.guestName
-
Simple Order API Field:lodgingData_guestName
travelInformation.lodging. healthClubCost
Cost of health club services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.healthClubCost
-
Simple Order API Field:lodgingData_healthClubCost
travelInformation.lodging. internetAccessCost
Cost of internet access.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.internetAccessCost
-
Simple Order API Field:lodgingData_internetAccessCost
travelInformation.lodging. laundryCost
Cost of laundry services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.laundryCost
-
Simple Order API Field:lodgingData_laundryCost
travelInformation.lodging. loungeBarCost
Cost of lounge and bar purchases.
Specifications
-
Data Type:Sting
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.loungeBarCost
-
Simple Order API Field:lodgingData_loungeBarCost
travelInformation.lodging. miniBarCost
Cost of mini-bar purchases.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.miniBarCost
-
Simple Order API Field:lodgingData_miniBarCost
travelInformation.lodging. miscellaneousCost
Miscellaneous costs.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.miscellaneousCost
-
Simple Order API Field:lodgingData_miscellaneousCost
travelInformation.lodging. movieCost
Cost of movies.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.movieCost
-
Simple Order API Field:lodgingData_movieCost
travelInformation.lodging. nonRoomCost
Cost of non-room purchases, such as meals and gifts.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.nonRoomCost
-
Simple Order Field Name:lodgingData_nonRoomCost
travelInformation.lodging. nonRoomTaxAmount
Tax on non-room purchases.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.nonRoomTaxAmount
-
Simple Order Field Name:lodgingData_nonRoomTax
travelInformation.lodging. numberOfGuests
Number of guests staying in the room.
Specifications
-
Data Type:Integer
-
Data Length:2
Mapping
-
REST Field Name:travelInformation.lodging.numberOfGuests
-
Simple Order Field Name:lodgingData_numberOfGuests
travelInformation.lodging. numberOfRooms
Number of rooms booked by the cardholder.
Specifications
-
Data Type:Integer
-
Data Length:2
Mapping
-
REST Field Name:travelInformation.lodging.numberOfRooms
-
Simple Order Field Name:lodgingData_numberOfRooms
travelInformation.lodging. phoneCost
Cost of telephone services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.phoneCost
-
Simple Order Field Name:lodgingData_phoneCost
travelInformation.lodging. prepaidCost
Prepaid amount, such as a deposit.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.prepaidCost
-
Simple Order Field Name:lodgingData_prepaidCost
travelInformation.lodging. restaurantCost
Cost of restaurant purchases.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.restaurantCost
-
Simple Order Field Name:lodgingData_restaurantCost
travelInformation.lodging. roomBedType
Type of room, such as queen, king, or two doubles.
Specifications
-
Data Type:String
-
Data Length:12
Mapping
-
REST Field Name:travelInformation.lodging.roomBedType
-
Simple Order Field Name:lodgingData_roomBedType
travelInformation.lodging. room[].dailyRate
Daily cost of the room.
Specifications
-
Data Type:String
-
Data Length:8
Mapping
-
REST Field Name:travelInformation.lodging.room[].dailyRate
-
Simple Order Field Name:lodgingData_dailyRoomRate#
travelInformation.lodging. roomLocation
Location of room, such as lake view or ocean view.
Specifications
-
Data Type:String
-
Data Length:10
Mapping Information
-
REST API Field:travelInformation.lodging.roomLocation
-
Simple Order API Field:lodgingData_roomLocation
travelInformation.lodging. room[].numberOfNights
Number of nights billed at the rate specified by
travelInformation.lodging.room.dailyRate
.
Specifications
-
Data Type:Integer
-
Data Length:4
Mapping
-
REST Field Name:travelInformation.lodging.room[].numberOfNights
-
Simple Order Field Name:lodgingData_roomNights#
travelInformation.lodging. roomRateType
Type of rate, such as corporate or senior citizen.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.roomRateType
-
Simple Order API Field:lodgingData_roomRateType
travelInformation.lodging. roomServiceCost
Cost of room service.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.roomServiceCost
-
Simple Order API Field:lodgingData_roomServiceCost
travelInformation.lodging. roomTaxAmount
Total tax for the room.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.roomTaxAmount
-
Simple Order API Field:lodgingData_roomTax
travelInformation.lodging. roomTaxType
Type of tax, such as tourist or hotel.
Specifications
-
Data Type:String
-
Data Length:10
Mapping Information
-
REST API Field:travelInformation.lodging.roomTaxType
-
Simple Order API Field:lodgingData_roomTaxElements
travelInformation.lodging. smokingPreference
Smoking preference of the guest.
Possible values:
-
Y: Smoking room
-
N: Non-smoking room
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.lodging.smokingPreference
-
Simple Order API Field: lodgingData_guestSmokingPreference
travelInformation.lodging. specialProgramCode
Code that identifies special circumstances.
Possible values:
-
1: Lodging (default)
-
2: No show reservation
-
3: Advanced deposit
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.lodging.specialProgramCode
-
Simple Order API Field:lodgingData_specialProgramCode
travelInformation.lodging. totalTaxAmount
Total tax amount.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.totalTaxAmount
-
Simple Order API Field:lodgingData_tax
travelInformation.lodging. transportationCost
Cost of transportation services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.transportationCost
-
Simple Order API Field:lodgingData_transportationCost
travelInformation.lodging. valetParkingCost
Cost of valet parking services.
Specifications
-
Data Type:String
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.lodging.valetParkingCost
-
Simple Order API Field:lodgingData_valetParkingCost
travelInformation. numberOfPassengers
Number of passengers for whom the ticket was issued.
If you do not include this field in your request, a default value of 1 is used.
Required for American Express SafeKey (US) for travel-related requests.
Specifications
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.numberOfPassengers
-
SCMP API Field:No corresponding field
-
Simple Order API Field:No corresponding field
travelInformation. passengers.firstName
First name of the passenger to whom the ticket was issued.
If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.
Required for American Express SafeKey (US) for travel-related requests.
Specifications
-
Data Type:Array of strings
-
Data Length:60
Mapping Information
-
REST API Field:travelInformation.passengers.firstName
-
Sjava.io.PrintWriter@3b87d284 CMP API Field:airline_passenger#_firstname
-
Simple Order API Field:airlineData_passenger_#_firstName
travelInformation. passengers.lastName
Last name of the passenger to whom the ticket was issued.
If there are multiple passengers, include all that are listed on the ticket. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.
Required for American Express SafeKey (US) for travel-related requests.
Specifications
-
Data Type:Array of strings
-
Data Length:60
Mapping Information
-
REST API Field:travelInformation.passengers.lastName
-
SCMP API java.io.PrintWriter@985c0f2 Field:airline_passenger#_lastname
-
Simple Order API Field:airlineData_passenger_#_lastName
travelInformation. transit.airline.ancillaryInformation. connectedTicketNumber
Airline ticket number connected to ancillary purchase.
If purchase has connection or relation to another purchase, such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase.
For stand-alone purchases, the value for this field must be the same value used for the
travelInformation.transit.airline.ancillaryInformation.ticketNumber
field.
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber
-
SCMP API Field:ancillary_connected_ticket_number
-
Simple Order API Field:ancillaryData_connectedTicketNumber
travelInformation. transit.airline. ancillaryInformation. creditReasonIndicator
Indicates reason for credit to cardholder.
Possible Values:
-
A: Passenger transport ancillary fee cancellation
-
B: Airline ticket and passenger transport ancillary fee cancellation
-
C: Airline ticket cancellation
-
O: Other
-
P: Partial refund of airline ticket
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator
-
SCMP API Field:ancillary_credit_reason_indicator
-
Simple Order API Field:ancillaryData_creditReasonIndicator
travelInformation. transit.airline.ancillaryInformation. passengerName
Passenger name or the cardholder name if the passenger is unavailable. If neither names are available, this value is a description of the ancillary purchase.
Specifications
-
Data Type:String
-
Data Length:20
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.passengerName
-
SCMP API Field:ancillary_passenger_name
-
Simple Order API Field:ancillaryData_passengerName
travelInformation. transit.airline.ancillaryInformation.service[]. categoryCode
Category code for ancillary service provided. Obtain the codes from the International Air Transport Association (IATA).
Specifications
-
Data Type:String
-
Data Length:4
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.service[].categoryCode
-
SCMP API Field:ancillary_service#_category_code
-
Simple Order API Field:ancillaryData_service_#_categoryCode
travelInformation. transit.airline.ancillaryInformation.service[]. subCategoryCode
Subcategory code for the ancillary service category. Obtain codes from the International Air Transport Association (IATA).
Specifications
-
Data Type:String
-
Data Length:4
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode
-
SCMP API Field:java.io.PrintWriter@2074fbdancillary_service#_subcategory_code
-
Simple Order API Field:ancillaryData_service_#_subcategoryCode
travelInformation. transit.airline.ancillaryInformation. ticketNumber
Ticket number, which consists of carrier code, form, and serial number, without the check digit.
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.transit.airline.ancillaryInformation.ticketNumber
-
SCMP API Field:ancillary_ticket_number
Simple Order API Field:
ancillaryData_ticketNumber
Processor Field Names:
Processor-specific field names for each processor supporting this field:
-
FDC Nashville Global: Ancillary Ticket Document Number
travelInformation. transit.airline.arrivalDate
Date of final arrival after completion of all legs of travel.
Format:
-
FDC Nashville Global:YYYYMMDD
-
All other processors:MMDDYYYY
Specifications
-
Data Type:String
-
Data Length:8
Mapping Information
-
REST API Field:java.io.PrintWriter@20f506d7travelInformation.transit.airline.arrivalDate
-
SCMP API Field:airline_arrival_date
-
Simple Order API Field:airlineData_arrivalDate
travelInformation. transit. airline. carrierName
The name of the airline carrier that generated the airline ticket.
-
OmniPay DirectandLloyds-OmniPay
-
The field value is the two letter IATA carrier code for the airline carrier.This is applicable to allOmniPay Directprocessors.
Specifications
-
Data Type:String
-
Data Length:25
Mapping Information
-
REST API Field:travelInformation.transit.airline.carrierName
-
Simple Order API Field:airlineData_carrierName
travelInformation. transit. airline. clearingCount
Total number of clearing messages associated with the authorization request.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.transit.airline.clearingCount
-
Simple Order API Field:airlineData_clearingCount
travelInformation. transit. airline. clearingSequence
Number that identifies each clearing message associated with an authorization request.
Each clearing message linked to an authorization request must include a unique clearing sequence number between 1 and the total number of clearing records.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.transit.airline.clearingSequence
-
Simple Order API Field:airlineData_clearingSequence
travelInformation. transit. airline. creditReasonIndicator
Code showing reason customer was provided a credit.
Possible values:
-
A: Cancellation of the ancillary passenger transport purchase.
-
B: Cancellation of the airline ticket and the ancillary passenger transport purchase.
-
C: Cancellation of the airline ticket.
-
O: Other.
-
P: Partial refund of the airline ticket.
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.creditReasonIndicator
-
Simple Order API Field:airlineData_creditReasonIndicator
travelInformation. transit.airline.customerCode
Code assigned by carrier to a corporation or business entity to identify corporate rates or discounts; or, a code supplied by cardholder to merchant; or, a code supplied by cardholder.
Specifications
-
Data Type:String
-
Data Length:17
Mapping Information
-
REST API Field:travelInformation.transit.airline.customerCode
-
SCMP API Field:airline_customer_code
-
Simple Order API Field:airlineData_customerCode
travelInformation. transit.airline.documentType
Travel package code for indicating whether the package includes a car rental, airline flight, both, or neither.
This field is only used with American Express cards.
FDC Nashville Global
possible value:
-
A: Airline flight reservation included.
Possible values for all other processors:
-
A: Airline flight reservation included.
-
B: Both car rental and airline flight reservations included.
-
C: Car rental reservation included.
-
N: Unknown.
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.documentType
-
SCMP API Field:airline_document_type
-
Simple Order API Field:airlineData_documentType
travelInformation. transit. airline. electronicTicketIndicator
Flag indicates an e-ticket was issued.
Possible values:
-
True: Ticket issued electronically.
-
False: Ticket issued as a paper ticket.
Specifications
-
Data Type:Boolean
Mapping Information
-
REST API Field:travelInformation.transit.airline.electronicTicketIndicator
-
Simple Order API Field:airlineData_electronicTicket
travelInformation. transit.airline.legs[].arrivalTime
Arrival time for a leg of a trip.
Format:
HHMM
Possible values for hours (
HH
) range from
00
to
23
.
Possible values for minutes (
MM
) range from
01
to
59
.
Specifications
-
Data Type:String
-
Data Length:4
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].arrivalTime
-
SCMP API Field:airline_leg#_arrival_time
-
Simple Order API Field:airlineData_leg_#_arrivalTime
travelInformation. transit.airline.legs[].arrivalTimeMeridian
Indicates whether arrival time for a segment of a trip occurs during AM or PM.
Possible values:
-
A: 12:00 AM — 11:59 AM
-
P: 12:00 PM — 11:59 PM
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].arrivalTimeMeridian
-
SCMP API Field:airline_leg#_arrival_time_segment
-
Simple Order API Field:airlineData_leg_#_arrivalTimeSegment
travelInformation. transit.airline.legs[].carrierCode
Standard code for the airline or railway carrier for a leg of the trip. Required for each leg.
Payer Authentication services only use the first leg of the trip.
International Air Transport Association (IATA) code is obtained from the Official Airline Guide or its equivalent.
-
FDC Nashville Global
-
Airline carrier code for each leg of ticket, including origin and destination.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].carrierCode
-
SCMP API Field:airline_leg#_carrier_code
-
Simple Order API Field:airlineData_leg_#_carrierCode
travelInformation. transit.airline.legs[].class
Service type for trip, such as coach or first-class.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].class
-
SCMP API Field:airline_leg#_class
-
Simple Order API Field:airlineData_leg_#_class
travelInformation. transit.airline.legs[].conjunctionTicket
Ticket that contains additional coupons on an itinerary that is more than four segments.
Specifications
-
Data Type:String
-
Data Length:14
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].conjunctionTicket
-
SCMP API Field:airline_leg#_conjunction_ticket
-
Simple Order API Field:airlineData_leg_#_conjunctionTicket
travelInformation. transit.airline.legs[]. couponNumber
Coupon number for a specific travel leg within a ticket.
A ticket may consist of multiple legs of travel. Each leg requires its own unique coupon number.
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].couponNumber
-
SCMP API Field:airline_leg#_java.io.PrintWriter@7387fb12 coupon_number
-
Simple Order API Field:airlineData_leg_#_couponNumber
travelInformation. transit.airline.legs[]. departureTime
Departure time for a leg of a trip.
Format:
HHMM
Possible values for hours (
HH
) range from
00
to
24
.
Possible values for minutes (
MM
) range from
01
to
59
.
Specifications
-
Data Type:String
-
Data Length:4
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].departureTime
-
SCMP API Field:airline_leg#_departure_time
-
Simple Order API Field:airlineData_leg_#_departureTime
travelInformation. transit.airline.legs[]. departureTimeMeridian
Indicates whether departure time for a segment of a trip occurs during AM or PM.
Possible values:
-
A: 12:00 AM — 11:59 AM
-
P: 12:00 PM — 11:59 PM
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].departureTimeMeridian
-
SCMP API Field:airline_leg#_departure_time_segment
-
Simple Order API Field:airlineData_leg_#_departureTimeSegment
travelInformation. transit.airline.legs[]. departureDate
Departure date for the first leg of the trip. Can also be referred to as effective date.
Format:
YYYYMMDD
Specifications
-
Data Type:String
-
Data Length:8
Mapping Information
-
REST API Field:travelInformation.transit.airline.java.io.PrintWriter@73745264 legs[].departureDate
-
SCMP API Field:airline_leg#_leg_departure_date
-
Simple Order API Field:airlineData_leg_#_departureDate
travelInformation. transit.airline.legs[]. destinationAirportCode
International Air Transport Association (IATA) code for the destination airport for this leg of trip.
Required for reduced interchange.
-
Payer Authentication
-
Payer Authentication services only use the first leg of the trip.
Specifications
-
Data Type:String
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].destinationAirportCode
-
SCMP API Field:airline_leg#_destination
-
Simple Order API Field:airlineData_leg_#_destination
travelInformation. transit.airline.legs[]. endorsementsRestrictions
Notations of an endorsement or restriction for a leg of a trip.
Endorsements can be notations added by the travel agency, including mandatory government required notations, such as value added tax.
Restrictions are limitations for the ticket based on fare type, such as nonrefundable tickets.
Specifications
-
Data Type:String
-
Data Length:20
Mapping Information
-
REST API Fiejava.io.PrintWriter@49dd032f ld:travelInformation.transit.airline.legs[].endorsementsRestrictions
-
SCMP API Field:airline_leg#_endorsements_restrictions
-
Simple Order API Field:airlineData_leg_#_endorsementsRestrictions
travelInformation. transit.airline.legs[]. exchangeTicketNumber
New ticket number issued when a ticket is exchanged.
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].exchangeTicketNumber
-
SCMP API Field:airline_leg#_exchange_ticket
-
Simple Order API Field:airlineData_leg_#_exchangeTicket
travelInformation. transit.airline.legs[]. fareBasis
Code assigned by carrier to indicate ticket type, such as business class, discounted, or non-refundable.
Specifications
-
Data Type:String
-
Data Length:
-
FDC Nashville Global: 15
-
All other processors: 6
-
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].fareBasis
-
SCMP API Field:airline_leg#_fare_basis
-
Simple Order API Field:airlineData_leg_#_fareBasis
travelInformation. transit.airline.legs[]. feeAmount
Fee amount for a leg of a trip, such as an airport fee or country fee.
Specifications
-
Data Type:String
-
Data Length:
-
FDC Nashville Global: 9
-
All other processors: 12
-
Mapping Information
-
REST API Field:travelInformatjava.io.PrintWriter@f20ca04 ion.transit.airline.legs[].feeAmount
-
SCMP API Field:airline_leg#_fee
-
Simple Order API Field:airlineData_leg_#_fee
travelInformation. transit.airline.legs[]. flightNumber
Flight number for a leg of a trip. Number assigned by operating or marketing carrier.
Specifications
-
Data Type:String
-
Data Length:
-
FDC Nashville Global: 5
-
All other processors: 6
-
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].flightNumber
-
SCMP API Field:airline_leg#_flight_number
-
Simple Order API Field:airlineData_leg_#_flightNumber
travelInformation. transit.airline.legs[]. originatingAirportCode
International Air Transport Association (IATA) code for originating airport for the first leg of the trip.
Specifications
-
Data Type:String
-
Data Length:
-
FDC Nashville Global: 5
-
All other processors: 3
-
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].originatingAirportCode
-
SCMP API Field:airline_leg#_originating_airport_code
-
Simple Order API Field:airlineData_leg_#_originatingAirportCode
travelInformation. transit.airline.legs[]. stopoverIndicator
Code indicating whether a stopover is allowed on this leg of the trip.
Possible values:
-
O: Stopover allowed (capital letter "O"). Default value.
-
X: Stopover not allowed.
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].stopoverIndicator
-
SCMP API Field:airline_leg#_stopover_code
-
Simple Order API Field:airlineData_leg_#_stopoverCode
travelInformation. transit.airline.legs[]. taxAmount
Tax amount for a leg of a trip.
Specifications
-
Data Type:String
-
Data Length:9
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].taxAmount
-
SCMP API Field:airline_leg#_tax
-
Simple Order API Field:airlineData_leg_#_tax
travelInformation. transit.airline.legs[]. totalFareAmount
Ticket amount for a leg of a trip.
Specifications
-
Data Type:String
-
Data Length:
-
FDC Nashville Global: 11
-
All other processors: 15
-
Mapping Information
-
REST API Field:travelInformation.transit.airline.legs[].totalFareAmount
-
SCMP API Field:airline_leg#_fare
-
Simple Order API Field:airlineData_leg_#_fare
travelInformation. transit. airline. numberOfPassengers
Number of passengers on ticket.
Specifications
-
Data Type:Integer
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.transit.airline.numberOfPassengers
-
Simple Order API Field:airlineData_numberOfPassengers
travelInformation. transit.airline. passengerName
Name of the person the ticket was issued to.
Specifications
-
Data Type:String
-
Data Length:25
Mapping Information
-
REST API Field:travelInformation.transit.airline.passengerName
-
SCMP API Field:airline_passenger_name
-
Simple Order API Field:airlineData_passengerName
travelInformation. transit.airline. planNumber
Plan number that is based on fare. It is supplied by the carrier.
Specifications
-
Data Type:String
-
Data Length:2
Mapping Information
-
REST API Field:travelInformation.transit.airline.planNumber
-
SCMP API Field:airline_plan_number
-
Simple Order API Field:airlineData_planNumber
travelInformation. transit. airline. purchaseType
Type of purchase.
Possible values:
-
EXC: Ticket exchange.
-
MSC: Miscellaneous purchase (not a ticket purchase or related to a ticket exchange).
-
REF: Refund.
-
TKT: Ticket purchase.
Specifications
-
Data Type:String
-
Data Length:3
Mapping Information
-
REST API Field:travelInformation.transit.airline.purchaseType
-
Simple Order API Field:airlineData_purchaseType
travelInformation. transit. airline. reservationSystemCode
Code specifying the reservation system used to make the reservation and purchase the ticket.
Codes can only use letters, numbers, and spaces. No special characters are allowed.
Specifications
-
Data Type:String
-
Data Length:20
Mapping Information
-
REST API Field:travelInformation.transit.airline.reservationSystemCode
-
Simple Order API Field:airlineData_reservationSystem
travelInformation. transit. airline. restrictedTicketDescription
Text describing any ticket restrictions or limitations such as
_nonrefundable_
.
Specifications
-
Data Type:String
-
Data Length:20
Mapping Information
-
REST API Field:travelInformation.transit.airline.restrictedTicketDescription
-
Simple Order API Field:No corresponding field
travelInformation. transit.airline. restrictedTicketIndicator
Indicates whether ticket is refundable.
Possible values:
-
0: refundable
-
1: nonrefundable
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:travelInformation.transit.airline.rejava.io.PrintWriter@6137e75b strictedTicketIndicator
-
SCMP API Field:airline_restricted_ticket_indicator
-
Simple Order API Field:airlineData_restrictedTicketIndicator
travelInformation. transit.airline. ticketChangeIndicator
Indicates the type of update to a ticket.
Possible values:
-
C: Change to existing ticket
-
N: New ticket
Specifications
-
Data Type:String
-
Data Length:1
Mapping Information
-
REST API Field:
travelInformation.transit.airline.ticketChangeIndicator -
SCMP API Field:airline_ticket_update_indicator
-
Simple Order API Field:airlineData_ticketUpdateIndicator
travelInformation. transit.airline. ticketIssueDate
Date that the ticket was issued to customer.
If information is not available, use spaces.
Format:
-
MMDDYY
Specifications
-
Data Type:String
-
Data Length:6
Mapping Information
-
REST API Field:travelInformatjava.io.PrintWriter@21d865f9 ion.transit.airline.ticketIssueDate
-
SCMP API Field:airline_ticket_issue_date
-
Simple Order API Field:airlineData_ ticketIssueDate
travelInformation. transit.airline. ticketIssuer.address
Address of agency issuing the ticket.
Specifications
-
Data Type:String
-
Data Length:16
Mapping Information
-
REST API Field:travelInformation.transit.airline.ticketIssuer.address
-
SCMP API Field:airline_ticket_issuer_address
-
Simple Order API Field:airlineData_ticketIssuerAddress
travelInformation. transit. airline. ticketIssuer. locality
City of agency issuing the ticket.
If the city exceeds 18 characters, the name will be truncated. We recommend that if the city name exceeds 18 characters, use a meaningful abbreviation.
Specifications
-
Data Type:String
-
Data Length:18
Mapping Information
-
REST API Field:travelInformation.transit.airline.ticketIssuer.locality
-
Simple Order API Field:airlineData_tijava.io.PrintWriter@60dc8578 cketIssuerCity
travelInformation. transit. airline. ticketNumber
Ticket number.
This field only accepts letters, numbers and spaces. Special characters are not allowed.
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.transit.airline.ticketNumber
-
Simple Order API Field:airlineData_ticketNumber
travelInformation.transit.airline.ticketNumber
Ticket number used to identify a travel ticket.
Specifications
-
Data Type:String
-
Data Length:15
Mapping Information
-
REST API Field:travelInformation.transit.airline.ticketNumber
-
SCMP API Field:airline_ticket_number
-
Simple Order API Field:airlineData_ticketNumber
travelInformation. transit. airline. totalClearingAmount
The total amount for all transactions in the clearing count set.
This value cannot exceed 99,999,999,999,999,999,999 (twenty 9s) (comma added for readability).
Specifications
-
Data Type:String
-
Data Length:20
Mapping Information
-
REST API Field:travelInformation.transit.airline.totalClearingAmount
-
Simple Order API Field:airlineData_totalClearingAmount
travelInformation. transit.airline. totalFeeAmount
Fee that the customer is charged to change the destination or departure time of an original ticket.
Specifications
-
Data Type:Numerical
-
Data Length:11
Mapping Information
-
REST API Field:travelInformation.transit.airline.totalFeeAmount
-
SCMP API Field:airline_total_fee
-
Simple Order API Field:airlineData_totalFee
travelInformation. transit. exchangeTicketAmount
Amount of the exchanged ticket.
Specifications
-
Data Type: Numerical
-
Data Length: 12
Mapping Information
-
REST API Field:travelInformation.transit.exchangeTicketAmount
-
SCMP API Field:airline_exchange_ticket_amount
-
Simple Order API Field:airlineData_exchangeTicketAmount
travelInformation. transit.airline. exchangeTicketFeeAmount
Fee amount for changing the destination or departure time of the original ticket.
Specifications
-
Data Type:Numerical
-
Data Length:12
Mapping Information
-
REST API Field:travelInformation.transit.airline.exchangeTicketFeeAmount
-
SCMP API Field:airline_exchange_ticket_fee
-
Simple Order API Field:airlineData_exchangeTicketFee