Request-Level Fields for Capture and Credit Requests

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.

 

 

When you include airline data in a capture or credit request, you have the option of using the transaction reference number to provide an airline booking number for the transaction. The fields you can use are bill_trans_ref_no and credit_trans_ref_no. For information about including a transaction reference number in a request, contact CyberSource Customer Support.

 

The airline_iata_numeric_code field was renamed to airline_agent_code. For a new implementation you must use the new field name. If you already implemented airline data processing with the old field name, CyberSource will continue to support the field name for a limited period of time and recommends that you update your code to support the new field name at your earliest convenience.

 

 

Table 11

General Request Fields for Capture and Credit Requests

SCMP API Field	American Express Direct Field Name	Description	Required / Optional	Data Type & Length
airline_agent_code	IATA1 Numeric Code	IATA1 numeric code for the airline.	Required if you are an IATA1 member and have been issued this code.	String (8)
airline_carrier_name	Ticketing Carrier Name	Airline carrier that generated the ticket.	Required	String (25)
airline_document_type	Document Type	Airline document type code that specifies the purpose of the transaction. For the possible values, see Airline Document Type Codes.	Required	String (2)
airline_electronic_ticket	Electronic Ticket Indicator	Flag that indicates whether an electronic ticket was issued. Possible values: ■ Y: Yes ■ N: No	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (1)
airline_number_of_passengers	Number In Party	Number of passengers for whom the ticket was issued. If you do not include this field in your request, CyberSource uses the default value of 1.	Required for ticket purchases and ticket exchanges; otherwise, optional.	Integer (3)
airline_original_ticket_number	Exchanged / Original Ticket Number	Original ticket number when the transaction is for a replacement ticket.	Optional	String (14)
airline_passenger_name	Passenger Name	Name of the passenger to whom the ticket was issued. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (25)
airline_process_identifier	Airline Process Identifier	Airline process identifier. This value is the airline’s three-digit IATA1 code which is used to process extended payment airline tickets.	Required	String (3)
airline_purchase_type	Transaction Type	Type of purchase. Possible values: ■ EXC: Exchange ticket ■ MSC: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket)	Optional	String (3)
airline_ticket_issue_date	Ticket Issue Date	Date on which the transaction occurred. Format: YYYYMMDD	Required	Integer (8)
airline_ticket_issuer_city	Ticket Issue City	City in which the transaction occurred. If the name of the city exceeds 18 characters, use meaningful abbreviations.	Required	String (18)
airline_ticket_number	Ticket Number	Ticket number or a value that American Express Direct refers to as a “document number printed on the source document,” which might be a booking reference number. If you need to submit a ticket number and a booking reference number, put the ticket number in this airline_ticket_number field and put the booking reference number in the reconciliation ID field: ■ bill_trans_ref_no for a capture request ■ credit_trans_ref_no for a credit request For information about including a transaction reference number in a request, contact CyberSource Customer Support.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (14)
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. Important If this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor.	Required	String (7)
1 IATA=International Air Transport Association

You must include information for at least the first leg of the trip (leg 0). You must use consecutive numbers for the legs; do not skip a number. If you skip a number, CyberSource ignores the legs that follow the skipped number.

Table 12

Travel Leg Request Fields for Capture and Credit Requests

SCMP API Field	American Express Direct Field Name	Description	Required / Optional	Data Type & Length
airline_leg#_carrier_code	Segment Carrier Code	IATA1 code for the carrier for this leg of the trip.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (2)
airline_leg#_class	Class of Service Code	IATA1 code for the class of service for this leg of the trip. The service class is assigned by the carriers and provides additional information about the ticket type, such as premium or discounted.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (1)
airline_leg#_leg_departure_date	Departure Date	Departure date for this leg of the trip. Format: YYYYMMDD	Required for ticket purchases and ticket exchanges; otherwise, optional.	Integer (8)
airline_leg#_destination	Arrival Location Code	IATA1 code for the destination airport for this leg of the trip.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (3)
airline_leg#_fare	Fare	Total fare for this leg of the trip. For USD, the maximum fare is 99,999.99. For all other currencies, the maximum fare is the equivalent of 99,999.99 USD.	Required	Decimal (12)
airline_leg#_fare_basis	Fare Basis	IATA1 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 first class, business, or economy.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (5)
airline_leg#_flight_number	Flight Number	Flight number for this leg of the trip.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (4)
airline_leg#_originating_airport_code	Departure Location Code	IATA1 code for the originating airport for this leg of the trip.	Required for ticket purchases and ticket exchanges; otherwise, optional.	String (3)
airline_leg#_stopover_code	Stopover Indicator	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	Optional	String (1)
1 IATA=International Air Transport Association