Request-Level Fields

The tables in this section describe the airline request fields to use with a capture or credit request.

 

When you send a capture or credit request with airline data, you must include the basic fields required for every capture or credit request. For information about the non-airline-data fields required for capture and credit requests, see Credit Card Services Using the SCMP API. You can also include fields for card-present transactions. See Card-Present Processing Using the SCMP API.

 

Submit ancillary data in a separate request. Do not combine ancillary data and airline data in the same request. When you include ancillary data in a request with airline data, OmniPay Direct ignores the ancillary data.

 

Table 35

General Request-Level Fields

CyberSource Field Name	OmniPay Direct Field Name	Description	Required / Optional1	Data Type & Length1
airline_agent_code	Travel Agency Code	IATA2 code for the travel agency.	Opt.	String (8)
airline_agent_name	Travel Agency Name	Name of the travel agency that is issuing the ticket.	Opt.	Visa: String (25) Mastercard, Maestro (UK Domestic), and Maestro (International): String (30) Discover and Diners Club: String (32)
airline_carrier_name	Issuing Carrier	Standard abbreviation for airline that generated the ticket.	Visa: not used Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. Discover and Diners Club: Opt.	Mastercard, Maestro (UK Domestic), and Maestro (International): String (4) Discover and Diners Club: String (3)
airline_check_digit	Ticket Check Digit	Check digit for the ticket number. CyberSource recommends that you validate the check digit. With Discover and Diners Club, a valid ticket number has these characteristics: ■ The value is numeric. ■ The first three digits are a valid IATA2 license plate carrier code. ■ The last digit is a check digit or zero (0). ■ All remaining digits are non-zero.	Discover and Diners Club: Opt. All other card types: not used	String (1)
airline_customer_code	Customer Code / Booking Reference Number	Reference number or code that identifies the cardholder.	Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. All other card types: Opt.	Discover and Diners Club: String (20) All other card types: String (17)
airline_passenger_name	Passenger Name	Passenger’s name. Use cardholder name if the passenger name is not available. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.	Visa: Req. Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. Discover and Diners Club: Opt.	Visa: String (20) Mastercard, Maestro (UK Domestic), and Maestro (International): String (29) Discover and Diners Club: String (42)
airline_restricted_ticket_indicator	Restricted Ticket Indicator	Flag that indicates whether the ticket is restricted (nonrefundable). Possible values: ■ 0: No restriction (refundable) ■ 1: Restricted (nonrefundable)	Visa: Opt. All other card types: not used	String (1)
airline_ticket_number	Ticket Number	Ticket number.	Req.	Discover and Diners Club: String (10) All other card types: String (15)
airline_ticket_update_indicator	Ticket Change Indicator	Type of update. Possible values: ■ C: Change to the existing ticket. ■ N: New ticket.	Visa: Opt. All other card types: not used	String (1)
airline_total_fee	Total Fare	Total fee for the ticket. For non‑U.S. airline transactions, this value must match the value for the grand_total_amount field.	Mastercard, Maestro (UK Domestic), and Maestro (International): Opt. for U.S. domestic airline transactions; Req. for non-U.S. airline transactions. All other card types: not used	String (12)
industry_datatype	No corresponding processor field	Flag that indicates that the transaction includes airline data. This field must be set to airline in order for airline data to be sent to the processor. If this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor.	Req.	String (7)
1 Unless otherwise indicated, the information in this column applies to all card types for which airline data is supported as described in Airline Data Processing. 2 IATA=International Air Transport Association

 

Table 36

Request-Level Fields for Travel Legs

CyberSource Field Name	OmniPay Direct Field Name	Description	Required / Optional1	Data Type & Length1
airline_leg#_arrival_time	Arrival Time	Time of arrival for this leg of the trip. Format: HHMM	Discover and Diners Club: Opt. All other card types: not used	String (4)
airline_leg#_carrier_code	Carrier Code	IATA2 code for the carrier for this leg of the trip.	Visa: Req. Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. Discover and Diners Club: Opt.	Discover and Diners Club: String (4) All other card types: String (2)
airline_leg#_class	Service Class / Service Class Code / Class of Travel	IATA2 code for the class of service for this leg of the trip.	Visa: Req. for reduced interchange; otherwise, opt. Mastercard, Maestro (UK Domestic), and Maestro (International): Req. in U.S.; required for reduced interchange in other countries; otherwise, opt. Discover and Diners Club: Opt.	Visa: String (1) Mastercard, Maestro (UK Domestic), and Maestro (International): String (2) Discover and Diners Club: String (1)
airline_leg#_leg_departure_date	Departure Date / Travel Date	Departure date for this leg of the trip. Visa format: MMDDYY Format for all other card types: YYMMDD	Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. All other card types: Opt.	Integer (6)
airline_leg#_departure_time	Departure Time	Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be 00-23 and the minutes must be 00-59.	Visa: not used All other card types: Opt.	Integer (4)
airline_leg#_departure_time_segment	Departure Time Segment	AM or PM for the departure time for this leg of the trip. Possible values: ■ A: 12:00 midnight to 11:59 a.m. ■ P: 12:00 noon to 11:59 p.m.	Mastercard, Maestro (UK Domestic), and Maestro (International): Opt. All other card types: not used	String (1)
airline_leg#_destination	Destination City / Airport Code / City of Destination / Arrival Airport Code	IATA2 code for the destination airport for this leg of the trip. For a miscellaneous3 airline charge with Mastercard, set this value to XAA. For a baggage charge with Mastercard, set this value to XAE.	Visa: Req. for reduced interchange; otherwise, opt. Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. Discover and Diners Club: Opt.	Visa: String (3) Mastercard, Maestro (UK Domestic), and Maestro (International): String (5) Discover and Diners Club: String (6)
airline_leg#_fare	Fare Amount	Total fare for this leg of the trip.	Discover and Diners Club: Opt. All other card types: not used	String (15)
airline_leg#_fare_basis	Fare Basis / Fare Basis Code	Code for the fare basis for this leg of the trip. The fare basis is assigned by the carriers and indicates a particular ticket type, such as business class or discounted/nonrefundable.	Opt.	Visa: String (6) All other card types: String (15)
airline_leg#_flight_number	Flight Number	Flight number for this leg of the trip.	Opt.	Discover and Diners Club: String (4) All other card types: String (5)
airline_leg#_originating_airport_code	Origination City / Airport Code / City of Origin / Departure Airport Code	IATA2 code for the originating airport for this leg of the trip. For a miscellaneous3 airline charge with Mastercard, set this value to XAA. For a baggage charge with Mastercard, set this value to XAE.	Mastercard, Maestro (UK Domestic), and Maestro (International): Req. for reduced interchange; otherwise, opt. All other card types: Opt.	Visa: String (3) Mastercard, Maestro (UK Domestic), and Maestro (International): String (5) Discover and Diners Club: String (6)
airline_leg#_stopover_code	Stopover Code / Stopover Allowed	Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: ■ O (capital letter “O”): Stopover allowed ■ X (capital letter “X”): Stopover not allowed ■ space (default): miscellaneous3 airline charge; valid for Mastercard but not for Visa	Opt.	String (1)
1 Unless otherwise indicated, the information in this column applies to all the card types for which airline data is supported as described in Airline Data Processing. 2 IATA=International Air Transport Association 3 A miscellaneous airline charge is a charge that is added to the ticket at the time of booking but is not for essential airline travel details such as carrier, destination, or leg. Examples of miscellaneous airline charges are baggage or upgrade. A miscellaneous airline charge must use non-airline codes. Best practice is to use ancillary data fields for miscellaneous airline charges when using a Visa card.

 

Submit ancillary data in a separate request. Do not combine ancillary data and airline data in the same request. When you include ancillary data in a request with airline data, OmniPay Direct ignores the ancillary data.

 

Table 37

Ancillary Request Fields

CyberSource Field Name	OmniPay Direct Field Name	Description	Required / Optional1	Data Type & Length1
ancillary_connected_ticket_number	Issued in Connection with Ticket Number	Number for the airline ticket to which the ancillary purchase is connected. If this purchase has a connection or relationship 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 a stand-alone purchase, the value for this field must be the same as the value for the ancillary_ticket_number field. Transaction will be processed as a non-enhanced authorization at standard rates if this field is not included for an ancillary transaction.	Visa: Req. for ancillary purchases All other card types: not used	String (15)
ancillary_credit_reason_indicator	Credit Reason Indicator 1	Reason for the credit. Possible values: ■ A: Cancellation of ancillary purchase. ■ B: Cancellation of airline ticket and ancillary purchase. ■ O: Other.	Visa: Opt. All other card types: not used	String (1)
ancillary_passenger_name	Passenger Name	Name of the passenger. If the passenger’s name is not available, this value is the cardholder’s name. If neither the passenger’s name nor the cardholder’s name is available, this value is a description of the ancillary purchase.	Visa: Req. for reduced interchange; otherwise, opt. All other card types: not used	String (20)
ancillary_service#_category_code	Ancillary Service Category N	Category code for the ancillary service that is provided. See Ancillary Service Category Codes. Note # is 0, 1, 2, or 3.	Visa: Req. for ancillary purchases All other card types: not used	String (4)
ancillary_service#_subcategory_code	Ancillary Service Sub-Category N	Subcategory code associated with the ancillary service category. Obtain the codes from the International Air Transport Association (IATA). Note # is 0, 1, 2, or 3.	Visa: Opt. All other card types: not used	String (4)
ancillary_ticket_number	Ancillary Ticket / Document Number	Form number assigned by the carrier.	Visa: Req. when the purpose of the ancillary transaction is to obtain airline rates. All other card types: not used	String (15)
1 Unless otherwise indicated, the information in this column applies to all the card types for which airline data is supported as described in Airline Data Processing.