On This Page

Airline Processing

This section describes how to use this developer guide and where to find further information.

Audience and Purpose

This guide is written for application developers who want to use the
Cybersource
Simple Order API
 to integrate credit card processing with airline data into their order management system.
Implementing the
Cybersource
 credit card services requires software development skills. You must write code that uses the API request and reply fields to integrate the credit card services into your existing order management system.

Conventions

The following special statements are used in this document:
An
Important
 statement contains information essential to successfully completing a task or learning a concept.

Customer Support

For support information about any service, visit the Support Center:

Recent Revisions to This Document

24.02

This revision contains only editorial changes and no technical updates.

24.01

OmniPay Direct
Added format requirements for the
airlineData_carrierName
 field value. See OmniPay Direct Airline Processing.

23.02

This revision contains only editorial changes and no technical updates.

23.01

This revision contains only editorial changes and no technical updates.

19.02

This revision contains only editorial changes and no technical updates.

19.01

This revision contains only editorial changes and no technical updates.

18.04

This revision contains only editorial changes and no technical updates.

18.03

This revision contains only editorial changes and no technical updates.

Introduction to Airline Processing

Airline data processing exceeds basic payment processing by enabling you to process specific travel data. To make use of this capability, you must submit additional information, such as:
  • Carrier (airline)
  • Departure date
  • Destination airport
  • Purchase date
  • Originating airport
  • Ticket class
  • Travel legs (segments)

Cybersource
 Airline Data Processing

Cybersource
 does not store airline data. Instead, it functions as a pass-through service for the data.
Cybersource
 enforces only the minimal level of field validation.
When you request an airline service,
Cybersource
 responds with certain fields and values to indicate whether the airline data was processed. The response fields for each service are:
  • Authorization:
    ccAuthReply_enhancedDataEnabled
  • Capture:
    ccCaptureReply_enhancedDataEnabled
  • Credit:
    ccCreditReply_enhancedDataEnabled
The possible values for the response fields are:
  • N
    : the airline data was not included in the request to the processor.
  • Y
    : the airline data was included in the request to the processor.
Cybersource
 temporarily disables your account's airline data processing capability and contacts you if your airline data transactions produce batching errors when the information is sent to the processor. If this happens, your request is not rejected, but you receive one of the above listed fields with the
N
 value in the response indicating that airline data in the request has been ignored and not sent to the processor.

OmniPay Direct
 Airline Processing

This section describes the airline payment services you can use when processing with
OmniPay Direct
.

Supported Acquirers and Card Types

This table describes the acquirers supported by
OmniPay Direct
 and the card types supported by each acquirer.
Supported Acquirers and Card Types
Supported Acquirers
Supported Card Types
Bank of America
Mastercard
Visa
Cardnet International
Maestro (International)
Maestro (UK Domestic)
Mastercard
Visa
First Data Merchant Solutions (Europe)
Diners Club
Discover
Mastercard
Visa
Global Payments International Acquiring
Mastercard
Visa

Captures for Ticket Purchases

This section describes how to capture an airline payment for ticket purchases.
Capture requests for ticket purchases must be separate from ancillary purchases. When you include ancillary data in a request with airline data,
OmniPay Direct
 ignores the ancillary data. For more information about captures for ancillary purchases, see Captures for Ancillary Purchases.

Leg Limitations

OmniPay Direct
 limits the maximum number of legs for each trip based on card type.
You must include information for the first leg of the trip (leg 0), and you must use consecutive numbers for any additional legs. To do so, replace the
#
 character in the field name with a sequential number starting with
0
. For example, for a trip with two legs, set the
airlineData_leg_#
 field as
airlineData_leg_0
 and
airlineData_leg_1
, for the first and second legs, respectively. If you skip a number,
Cybersource
 ignores the legs that follow the skipped number.
This table describes the maximum number of legs for each trip based on card type.
OmniPay Direct
 Leg Limitations
Supported Card Types
Maxiumum Number of Trip Legs
Diners Club
999
Discover
999
Maestro (International)
999
Maestro (UK Domestic)
999
Mastercard
999
Visa
4

Document Type

When capturing an airline payment, you must use the
airlineData_documentType
 field to specify the purpose of the transaction. For all possible values, see Airline Document Type Codes.

Endpoint

Set the
ccCaptureService_run
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for Capturing an Airline Payment

Include these required fields to capture an airline payment.
airlineData_ticketNumber
Set to
airline
.
Set to the
merchant_ref_number
 value used in corresponding authorization request.

Card-Specific Fields for Capturing an Airline Payment

Use this information to find additional information a card type requires.

Visa

Use this field in addition to the required fields when capturing an authorization with a Visa card.

Reduced Interchange Fields for Capturing an Airline Payment

This section includes card-specific fields for reduced interchange.

Maestro (International)

For reduced interchange, use these fields when capturing an airline payment with a Maestro (International) card.

Maestro (UK Domestic)

For reduced interchange, use these fields when capturing an airline payment with a Maestro (UK Domestic) card.

Mastercard

For reduced interchange, use these fields when capturing an airline payment with a Mastercard.

Visa

For reduced interchange, use these fields when capturing an airline payment with a Visa card.

Optional Fields for Capturing an Airline Payment

This topic includes both general optional fields and card-specific optional fields.

Diners Club

Choose from these optional fields to add additional information when using a Diners Club card.

Discover

Choose from these optional fields to add additional information when using a Discover card.

Maestro (International)

Choose from these optional fields to add additional information when using a Maestro (International) card.
Optional only for US domestic airline transactions.

Maestro (UK Domestic)

Choose from these optional fields to add additional information when using a Maestro (UK Domestic) card.
Optional only for US domestic airline transactions.

Mastercard

Choose from these optional fields to add additional information when using a Mastercard card.
Optional only for US domestic airline transactions.

Visa

Choose from these optional fields to add additional information when using a Visa card.

Simple Order API
 Example: Capturing an Airline Payment

Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.124">
   <merchantID>World Wide Travel</merchantID>
   <merchantReferenceCode>R98TV09EN200W</merchantReferenceCode>
   <ccCaptureService run="true">
      <industryDatatype>airline</industryDatatype>
      <authRequestID>0839543530000172034078</authRequestID>
   </ccCaptureService>
   <purchaseTotals>
      <currency>EUR</currency>
      <grandTotalAmount>204.78</grandTotalAmount>
   </purchaseTotals>
   <airlineData>
      <agentCode>98222147</agentCode>
      <agentName>Cyber Vacations</agentName>
      <passengerName>Jane Smith</passengerName>
      <restrictedTicketIndicator>0</restrictedTicketIndicator>
      <ticketNumber>02721187251</ticketNumber>
      <leg id="0">
         <class>H</class>
         <departureDate>121516</departureDate>
         <departureTime>0931</departureTime>
         <departureTimeSegment>A</departureTimeSegment>
         <carrierCode>AA</carrierCode>
         <destination>CDG</destination>
         <fareBasis>HL7WNR</fareBasis>
      </leg>
      <leg id="1">
         <class>H</class>
         <departureDate>122016</departureDate>
         <departureTime>1625</departureTime>
         <departureTimeSegment>P</departureTimeSegment>
         <carrierCode>AA</carrierCode>
         <destination>LHR</destination>
         <fareBasis>HL7WNR</fareBasis>
      </leg>
   </airlineData>
</requestMessage>
Response
<replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.124">
   <requestID>0305782650000167905080</requestID>
   <decision>ACCEPT</decision>
   <reasonCode>100</reasonCode>
   <merchantReferenceCode>R98TV09EN200W</merchantReferenceCode>
   <purchaseTotals><currency>EUR</currency></purchaseTotals>
   <ccCaptureReply>
      <reasonCode>100</reasonCode>
      <amount>204.78</amount>
      <reconciliationID>1094820975023470</reconciliationID>
      <enhancedDataEnabled>y</enhancedDataEnabled>
   </ccCaptureReply>
</replyMessage>

Captures for Ancillary Purchases

This section describes how to capture an airline payment for ancillary purchases.
Capture requests for ancillary purchases must be separate from captures for ticket purchases. When you include ancillary data in a request with airline data,
OmniPay Direct
 ignores the ancillary data. For more information on captures for ticket purchases, see Captures for Ticket Purchases.

Ancillary Service Category Codes

When making an ancillary purchase, you must use the
ancillaryData_service_#_categoryCode
 field to indicate the service provided. For all possible field values, see Ancillary Service Category Codes.

Endpoint

Set the
ccCaptureService_run
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for Capturing an Airline Payment

Include these required fields to capture an airline payment for ancillary purchases.
airlineData_ticketNumber
Set to
airline
.
Set to the
merchant_ref_number
 value used in corresponding authorization request.

Card-Specific Fields for Capturing an Airline Payment

For reduced interchange, use these fields when capturing an airline payment.

Visa

ancillaryData_connected_TicketNumber
Required only when the purpose of the ancillary transaction is to obtain airline rates.

Reduced Interchange Fields for Capturing an Airline Payment

This section includes card-specific fields for reduced interchange.

Maestro (International)

For reduced interchange, use these fields when capturing an airline payment with a Maestro (International) card.
airlineData_carrierName
Format: 2 letter IATA airline code

Maestro (UK Domestic)

For reduced interchange, use these fields when capturing an airline payment with a Maestro (UK Domestic) card.

Mastercard

For reduced interchange, use these fields when capturing an airline payment with a Mastercard card.

Visa

For reduced interchange, use these fields when capturing an airline payment with a Visa card.

Optional Fields for Capturing an Airline Payment

This topic includes both general optional fields and card-specific optional fields.

General Optional Fields for Capturing an Airline Payment

Choose from these optional fields to include additional information when capturing an airline payment for any card type.

Diners Club

Choose from these optional fields to add additional information when using a Diners Club card.
airlineData_carrierName
airlineData_checkDigit

Discover

Choose from these optional fields to add additional information when using a Discover card.
airlineData_carrierName
airlineData_checkDigit

Maestro (International)

Choose from these optional fields to add additional information when using a Maestro (International) card.
airlineData_carrierName
Optional only for US domestic airline transactions.

Maestro (UK Domestic)

Choose from these optional fields to add additional information when using a Maestro (UK Domestic) card.
airlineData_carrierName
Set to two letter IATA airline code.
Optional only for US domestic airline transactions.

Mastercard

Choose from these optional fields to add additional information when using a Mastercard.
airlineData_carrierName
Optional only for US domestic airline transactions.

Simple Order API
 Example: Capturing an Airline Payment

Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.124">
   <merchantID>World Wide Travel</merchantID>
   <merchantReferenceCode>ABCDEFG0123456</merchantReferenceCode>
   <ccCaptureService run="true">
      <industryDatatype>airline</industryDatatype>
      <authRequestID>4685801292856003701540</authRequestID>
   </ccCaptureService>
   <purchaseTotals>
      <currency>GBP</currency>
      <grandTotalAmount>234.00</grandTotalAmount>
   </purchaseTotals>
   <ancillaryData>
      <ticketNumber>BA123456</ticketNumber>
      <service id="0">
         <categoryCode>BF</categoryCode>
      </service>
      <passengerName>Jane Smith</passengerName>
      <creditReasonIndicator>A</creditReasonIndicator>
      <connectedTicketNumber>BA1234567</connectedTicketNumber>
   </ancillaryData>
</requestMessage>
Response
<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.124">
   <c:requestID>4685801292856003701540</c:requestID>
   <c:decision>ACCEPT</c:decision>
   <c:reasonCode>100</c:reasonCode>
   <c:merchantReferenceCode>ABCDEFG0123456</c:merchantReferenceCode>
   <c:purchaseTotals><c:currency>GBP</c:currency></c:purchaseTotals>
   <c:ccCaptureReply>
      <c:reasonCode>100</c:reasonCode>
      <c:amount>234.00</c:amount>
      <c:reconciliationID>5406772989</c:reconciliationID>
      <c:enhancedDataEnabled>y</c:enhancedDataEnabled>
   </c:ccCaptureReply>
</c:replyMessage>

Stand-Alone Credits

This topic describes how to process an airline
stand-alone credit
.
All fields used in the original transaction must be included in your request.

Endpoint

Set the
ccCreditService_run
 field to
true
.
Send the request to
https://ics2ws.ic3.com/commerce/1.x/transactionProcessor
.

Required Fields for Airline
Stand Alone Credits

Simple Order API
 Example: Processing Airline
Stand-Alone Credits

Request
<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.213">
	<merchantID>test-merchant</merchantID>
	<merchantReferenceCode>refnum-1234</merchantReferenceCode>
	<purchaseTotals>
		<currency>USD</currency>
		<grandTotalAmount>204.78</grandTotalAmount>
	</purchaseTotals>
	<ccCreditService run="true">
		<captureRequestID>0305782650000167905080</captureRequestID>
	</ccCreditService>
</requestMessage>
Response
<replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.213">
	<merchantReferenceCode>Postman-1701820687</merchantReferenceCode>
	<requestID>0305782650000167905080</requestID>
	<decision>ACCEPT</decision>
	<reasonCode>100</reasonCode>
	<requestToken>Axj/7wSTfHUvjqCkViFEABEg2asWjlgzb0qE+c4YxmKeQXe+aFgKeQXe+bn6QHymhcMmkmXoxZaH/wJyb46l4wXgbv0b4AAAAxnW</requestToken>
	<purchaseTotals>
		<currency>USD</currency>
	</purchaseTotals>
	<ccCreditReply>
		<reasonCode>100</reasonCode>
		<requestDateTime>2023-12-05T23:58:07Z</requestDateTime>
		<amount>204.78</amount>
		<reconciliationID>65149037RPON81F1</reconciliationID>
		<authorizationCode>888888</authorizationCode>
		<processorResponse>100</processorResponse>
	</ccCreditReply>
</replyMessage>

Airline Data Reference Information

This section contains reference information that is useful when using Airline Data.

Airline Document Type Codes

To indicate the purpose of a purchase, set the
airlineData_documentType
 field to a value listed in the Code column.
Airline Document Type Codes
Code
Description
01
Passenger ticket
02
Additional collection
03
Excess baggage
04
Miscellaneous charge order (MCO) or prepaid ticket authorization
05
Special service ticket
06
Supported refund
07
Unsupported refund
08
Lost ticket application
09
Tour order voucher
10
Ticket by mail
11
Undercharge adjustment
12
Group ticket
13
Exchange adjustment
14
SPD or air freight
15
In-flight adjustment
16
Agency passenger ticket
17
Agency tour order or voucher
18
Agency miscellaneous charge order (MCO)
19
Agency exchange order
20
Agency group ticket
21
Debit adjustment for duplicate refund or use
22
In-flight merchandise order
23
Catalogue merchandise order
24
In-flight phone charges
25
Frequent flyer fee or purchase
26
Kennel charge
27
Animal transportation charge
28
Firearms case
29
Upgrade charge
30
Credit for unused transportation
31
Credit for class of service adjustment
32
Credit for denied boarding
33
Credit for miscellaneous refund
34
Credit for lost ticket refund
35
Credit for exchange refund
36
Credit for overcharge adjustment
37
Credit for multiple Unused tickets
38
Exchange order
39
Self-service ticket
41
In-flight duty-free purchase
42
Senior citizen discount booklets
43
Club membership fee
44
Coupon book
45
In-flight charges
46
Tour deposit
47
Frequent flyer overnight delivery charge
48
Frequent flyer fulfillment
49
Small package delivery
50
Vendor sale
51
Miscellaneous taxes or fees
52
Travel agency fee
60
Vendor refund or credit
64
Duty free sale
65
Preferred seat upgrade
66
Cabin upgrade
67
Lounge or club access or day pass
68
Agent assisted reservation or ticketing fee
69
Ticket change or cancel fee
70
Trip insurance
71
Unaccompanied minor
72
Standby fee
73
Curbside baggage
74
In-flight medical equipment
75
Ticket or pass print fee
76
Checked sporting or special equipment
77
Dry ice fee
78
Mail or postage fee
79
Club membership fee or temporary trial
80
Frequent flyer activation or reinstatement
81
Gift certificate
82
Onboard or in-flight prepaid voucher
83
Optional services fee
84
Advance purchase for excess baggage
85
Advance purchase for preferred seat upgrade
86
Advance purchase for cabin upgrade
87
Advance purchase for optional services
88
Wi-Fi
89
Packages
90
In-flight entertainment or internet access
91
Overweight bag fee
92
Sleep sets
93
Special purchase fee

Ancillary Service Category Codes

To indicate the service provided in an ancillary purchase, set the
ancillaryData_service_#_categoryCode
 and
ancillaryData_service_#_subcategoryCode
 fields to a value listed in the Ancillary Service Category Code column.
Ancillary Service Category Codes
Ancillary Service Category Codes
Description
BF
Bundled service
BG
Baggage fee
CF
Change fee
CG
Cargo
CO
Carbon offset
FF
Frequent flyer
GF
Gift card
GT
Ground transport
IE
In-flight entertainment
LG
Lounge
MD
Medical
ML
Meal or beverage
OT
Other
PA
Passenger assist fee
PT
Pets
SA
Seat fees
SB
Standby
SF
Service fee
ST
Store
TS
Travel service
UN
Unaccompanied travel
UP
Upgrades
WI
Wi-Fi