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.

 

Table 19

General Request-Level Fields

CyberSource Field Name	CyberSource through VisaNet Field Name	Description	Required / Optional1	Data Type & Length1
airline_agent_code	agencyCode	IATA2 code for the travel agency. Format: English characters only.	Optional	Restricted String (8)3
airline_agent_name	agencyName	Name of the travel agency that is issuing the ticket. Format: English characters only.	Optional	String (25)
airline_arrival_date	arrivalDate	Date of arrival for the last leg of the trip. Format: MMDDYYYY English characters only.	Optional	String (8)
airline_carrier_name	carrierName	Airline that generated the ticket. Format: English characters only.	Optional	Discover: String (19) All other card types: String (25)
airline_clearing_count	clearingSequence Count	Total number of clearing messages associated with the authorization request. Format: English characters only.	Optional	Integer (2)
airline_clearing_sequence	clearingSequence Number	Number that identifies the clearing message when multiple clearing messages are allowed per authorized transaction. Each clearing message linked to one authorization request must include a unique clearing sequence number between 1 and the total number of clearing records. Format: English characters only.	Optional	Integer (2)
airline_credit_reason_indicator	creditReason Indicator	Reason for the credit. Possible values: ■ A: Cancellation of the ancillary passenger transport purchase. ■ B: Cancellation of the airline ticket and the passenger transport ancillary purchase. ■ C: Cancellation of the airline ticket. ■ O: Other. ■ P: Partial refund of the airline ticket. Format: English characters only.	Optional	String (1)
airline_customer_code	customerCode	Reference number or code that identifies the cardholder. Format: English characters only.	Optional	Restricted String (25)3
airline_document_type	documentType	Airline document type code that specifies the purpose of the transaction. For the possible values, see Airline Document Type Codes. Format: English characters only.	Optional	String (2)
airline_electronic_ticket	electronicTicket	Flag that indicates whether an electronic ticket was issued. Possible values: ■ Y: Yes ■ N: No Format: English characters only.	Optional	String (1)
airline_exchange_ticket_amount	exchangeTicket Amount	Amount of the exchanged ticket. Format: English characters only.	Optional	Decimal (12)
airline_exchange_ticket_fee	exchangeTicket Fee	Fee for exchanging the ticket. Format: English characters only.	Optional	Decimal (12)
airline_number_of_passengers	numberOf Passengers	Number of passengers for whom the ticket was issued. Format: English characters only.	Optional	String (3)
airline_passenger_name	passengerName	Passenger’s name. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Format: English characters only.	Optional	String (20)
airline_plan_number	planNumber	Plan number based on the fare. This value is provided by the airline. Format: English characters only.	Optional	String (2)
airline_purchase_type	ticketType	Type of purchase. Possible values: ■ EXC: Exchange ticket ■ MSC: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket) ■ REF: Refund ■ TKT: Ticket Format: English characters only.	Optional	String (3)
airline_reservation_system	reservation System	Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only.	Optional	Restricted String (4)3
airline_restricted_ticket_indicator	restrictedTicket Indicator	Flag that indicates whether the ticket is restricted (nonrefundable). Possible values: ■ 0: No restriction (refundable) ■ 1: Restricted       (nonrefundable) Format: English characters only.	Optional	Restricted String (1)3
airline_ticket_issue_date	ticketIssueDate	Date on which the transaction occurred. Format: MMDDYYYY Format: English characters only.	Optional	String (8)
airline_ticket_issuer_city	ticketIssueCity	City in which the transaction occurred. If the name of the city exceeds 18 characters, use meaningful abbreviations. Format: English characters only.	Optional	String (18)
airline_ticket_issuer_code	issuerCode	IATA2 airline code. Format: English characters only.	Mastercard: Required All other card types: Optional	String (4)
airline_ticket_number	ticketNumber	Ticket number. Format: English characters only.	Optional	Restricted String (15)3
airline_ticket_restriction_text	ticketRestriction Text	Text that describes the ticket limitations, such as non-refundable. Format: English characters only.	Optional	String (20)
airline_ticket_update_indicator	ticketChange Indicator	Type of update. Possible values: ■ C: Change to the existing ticket. ■ N: New ticket. Format: English characters only.	Optional	String (1)
airline_total_clearing	clearingAmount	Total clearing amount for all transactions in the clearing count set. This value cannot exceed 99999999999999999999 (twenty 9s). Format: English characters only.	Optional	Decimal (20)
airline_total_fee	totalFee	Total fee for the ticket. This value cannot exceed 99999999999999999999 (twenty 9s). Format: English characters only.	Optional	Decimal (20)
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. Format: English characters only.	Required	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 3 See Special Data Type for CyberSource through VisaNet.

 

Table 20

Ancillary Request Fields

CyberSource Field Name	CyberSource through VisaNet Field Name	Description	Required / Optional1	Data Type & Length1
ancillary_connected_ticket_number	connectedTicket DocumentNumber	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. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only.	Optional	String (15)
ancillary_credit_reason_indicator	creditReason Indicator	Reason for the credit. Possible values: ■ A: Cancellation of ancillary purchase. ■ B: Cancellation of airline ticket and ancillary purchase. ■ O: Other. Format: English characters only.	Optional	String (1)
ancillary_passenger_name	passengerName	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. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only.	Optional	String (20)
ancillary_service#_category_code	category	Category code for the ancillary service that is provided. Obtain the codes from the International Air Transport Association (IATA). Note # is either 0, 1, 2, or 3. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only.	Optional	String (4)
ancillary_service#_subcategory_code	subcategory	Subcategory code for the ancillary service category. Obtain the codes from the International Air Transport Association (IATA). Note # is 0, 1, 2, or 3. Format: English characters only.	Optional	String (4)
ancillary_ticket_number	ticketNumber	Ticket number, which consists of the carrier code, form, and serial number, without the check digit. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only.	Optional	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.

 

Table 21

Request-Level Fields for Travel Legs

CyberSource Field Name	CyberSource through VisaNet Field Name	Description	Required / Optional1	Data Type & Length1
airline_leg#_arrival_time	arrivalTime	Time of arrival 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. Format: English characters only.	Optional	Integer (4)
airline_leg#_arrival_time_segment	arrivalTime Segment	AM or PM for the arrival 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. Format: English characters only.	Optional	Restricted String (1)2
airline_leg#_carrier_code	carrierCode	IATA3 code for the carrier for this leg of the trip. Format: English characters only.	Optional	Restricted String (2)2
airline_leg#_class	serviceClass	IATA3 code for the class of service for this leg of the trip. Format: English characters only.	Optional	Restricted String (1)2
airline_leg#_conjunction_ticket	conjunctionTicket	Ticket that contains additional coupons for this leg of the trip on an itinerary that has more than four segments. Format: English characters only.	Optional	Restricted String (25)2
airline_leg#_coupon_number	couponNumber	Coupon number. Each leg on the ticket requires a separate coupon, and each coupon is identified by the coupon number. Format: English characters only.	Optional	Restricted String (1)2
airline_leg#_leg_departure_date	departureDate	Departure date for this leg of the trip. The format is MMDDYY. Format: English characters only.	Optional	Integer (6)
airline_leg#_departure_time	departureTime	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. Format: English characters only.	Optional	Integer (4)
airline_leg#_departure_time_segment	departureTime 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. Format: English characters only.	Optional	Restricted String (1)2
airline_leg#_destination	destination	IATA3 code for the destination airport for this leg of the trip. Format: English characters only.	Optional	Restricted String (3)2
airline_leg#_endorsements_restrictions	endorsement Restrictions	Notes or notations about endorsements and restrictions for this leg of the 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 the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only.	Optional	String (20)
airline_leg#_exchange_ticket	exchangeTicket	New ticket number that is issued when the ticket is exchanged for this leg of the trip. Format: English characters only.	Optional	Restricted String (25)2
airline_leg#_fare	fare	Total fare for this leg of the trip. Format: English characters only.	Optional	Decimal (12)
airline_leg#_fare_basis	fareBasisCode	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. Format: English characters only.	Optional	Restricted String (6)2
airline_leg#_fee	fee	Fee for this leg of the trip, such as an airport fee or country fee. Format: English characters only.	Optional	Decimal (12)
airline_leg#_flight_number	flightNumber	Flight number for this leg of the trip. Format: English characters only.	Optional	Restricted String (5)2
airline_leg#_originating_airport_code	airportCode	IATA3 code for the originating airport for this leg of the trip. Format: English characters only.	Optional	Restricted String (3)2
airline_leg#_stopover_code	stopoverCode	Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: ■ O (capital letter “O”) (default): Stopover allowed ■ X (capital letter “X”): Stopover not allowed Format: English characters only.	Optional	Restricted String (1)2
airline_leg#_tax	tax	Tax for this leg of the trip. Format: English characters only.	Optional	Decimal (12)
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 See Special Data Type for CyberSource through VisaNet. 3 IATA=International Air Transport Association

 

Table 22

Offer-Level Field

CyberSource Field Name	CyberSource through VisaNet Field Name	Description	Required / Optional1	Data Type & Length1
tax_amount	totalTaxes	Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only.	Optional	Decimal (14)
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.