On This Page
Airline Processing Developer Guide
This section describes how to use this guide and where to find further information.
- Audience and Purpose
- This guide is written for application developers who want to use theCybersourceREST APIto integrate credit card processing with airline data into their order management system.Implementing theCybersourcecredit 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
- This special statement is used in this document:IMPORTANTAnImportantstatement contains information essential to successfully completing a task or learning a concept.
- Related Documentation
- Visit theCybersourcedocumentation hub to find additional processor-specific versions of this guide and additional technical documentation.
- Customer Support
- For support information about any service, visit the Support Center:
Recent Revisions to This Document
26.02.01
- Elavon
- Added support forElavonancillary purchases. See Elavon Airline Requests.
25.09.07
This revision contains only editorial changes and no technical updates.
25.06.02
This revision contains only editorial changes and no technical updates.
25.06.01
This revision contains only editorial changes and no technical updates.
25.05.01
- FDC Nashville Global
- Removed thetravelInformation.transit.airline.legs[].conjunctionTicketfield from the capture required fields list. See Optional Fields for an Airline Capture.
VISA Platform Connect: Specifications and Conditions for
Resellers/Partners
The following are specifications and conditions that apply to a Reseller/Partner enabling
its merchants through
Cybersource for
. Failure to meet any of the specifications and conditions below is
subject to the liability provisions and indemnification obligations under
Reseller/Partner’s contract with Visa/Cybersource.Visa Platform Connect
(“VPC”)
processing- Before boarding merchants for payment processing on a VPC acquirer’s connection, Reseller/Partner and the VPC acquirer must have a contract or other legal agreement that permits Reseller/Partner to enable its merchants to process payments with the acquirer through the dedicated VPC connection and/or traditional connection with such VPC acquirer.
- Reseller/Partner is responsible for boarding and enabling its merchants in accordance with the terms of the contract or other legal agreement with the relevant VPC acquirer.
- Reseller/Partner acknowledges and agrees that all considerations and fees associated with chargebacks, interchange downgrades, settlement issues, funding delays, and other processing related activities are strictly between Reseller and the relevant VPC acquirer.
- Reseller/Partner acknowledges and agrees that the relevant VPC acquirer is responsible for payment processing issues, including but not limited to, transaction declines by network/issuer, decline rates, and interchange qualification, as may be agreed to or outlined in the contract or other legal agreement between Reseller/Partner and such VPC acquirer.
DISCLAIMER: NEITHER VISA NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR ANY ERRORS OR
OMISSIONS BY THE
Visa Platform Connect
ACQUIRER IN PROCESSING TRANSACTIONS. NEITHER VISA
NOR CYBERSOURCE WILL BE RESPONSIBLE OR LIABLE FOR RESELLER/PARTNER BOARDING MERCHANTS OR
ENABLING MERCHANT PROCESSING IN VIOLATION OF THE TERMS AND CONDITIONS IMPOSED BY THE
RELEVANT Visa Platform Connect
ACQUIRER. 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)
- Ticket Number
Before you can begin testing and processing airline payments, you must have airline
transactions enabled for your merchant account. Contact your
Cybersource
account manager for more information.IMPORTANT
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 occurs, 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. Prerequisite
To begin processing payments through
Cybersource
, you must first set
up your payment processing system to be REST compliant. If you have not set up
secure communications between your client and server using either JSON Web Token
(JWT)
or HTTP signature
messaging, see the Getting Started with REST Developer
Guide
.Confirmation Response
When you send a request with airline data,
Cybersource
does not save the
airline data. Instead, Cybersource
sends your airline data to the
processor. Cybersource
enforces only minimal field validation, which can
result in a successful response that did not send the airline data to the processor.To confirm that the processor received the airline data, some processors
support the
processingInformation.enhancedDataEnabled
response field to indicate if the airline is received. These are the possible field values:
- N: the airline data isnotincluded in the request to the processor.
- Y: the airline data is included in the request to the processor.
Airline Travel Legs
Some processors require travel legs in the API service request, even for direct flights.
This section describes how to successfully include travel legs in an API request.
Using Travel Legs
To include travel legs in an airline transaction, include one or more
travel legs in the
legs[]
array. For example, these three travel legs are valid:
"travelInformation": { "transit": { "airline": { "legs": [ { "carrierCode": "XX" }, { "carrierCode": "XZ" }, { "carrierCode": "XX" } ] }
Travel Leg Limitations
Some processors limit the number of travel legs for each trip based on the card type.
Barclays Airline Requests
Barclays
Airline RequestsThis section describes the airline payment services you can use when processing with
Barclays
.IMPORTANT
You cannot process a cash advance and airline data in the same transaction.
Supported Card Types
These are the card types that
Barclays
supports:- Maestro (International)
- Maestro (UK Domestic)
- Mastercard
- Visa
Travel Legs
Maximum number of travel legs: 99
Numbering for the travel legs: 0 to 98
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.Capture an Airline Ticket Payment
This section describes how to capture an airline payment for a ticket purchase.
Before you can capture payment, you must authorize the
funds by sending an authorization request. The authorization response includes a request
ID in the
id
field. The request ID is required in the capture request. For more
information about how to send an authorization request, see the Standard Payment
Processing
section in the Payments Developer Guide
.Leg Limitations
Barclays
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
[]
characters
in the field name with a sequential number starting with
0
. For example, for a trip with two legs, set the transit[]
field
as transit0
and
transit1
, 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.
Supported Card Types | Maximum Number of Trip Legs |
|---|---|
Maestro (International) | 99 |
Maestro (UK Domestic) | 99 |
Mastercard | 99 |
Visa | 99 |
Document Type
When capturing an airline payment, you must use the
travelInformation.transit.airline.documentType
field to specify the purpose of the transaction. For all possible values, see Airline Document Type Codes. Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for Capturing an Airline Payment
- Set the value toairline.
- travelinformation.agency.name
Card-Specific Field for Capturing an Airline Payment
Some card types require additional fields.
Visa
Use this field to capture an airline payment when using a Visa
card.
- airlineData_restrictedTicketIndicator
Optional Fields for Capturing an Airline Payment
- travelInformation.transit.airline.invoiceNumber
- travelInformation.transit.airline.legs[].departTaxAmount
Example: Capturing an Airline Payment
Request
{ "clientReferenceInformation": { "code": "refnum123" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "GBP" } }, "travelInformation": { "agency": { "name": "test-airline" }, "transit": { "airline": { "ticketNumber": "123456789", "passengerName": "John Smith", "legs": [ { "originatingAirportCode": "TST", "class": "A", "departureDate": "092525" } ] } } } }
Response
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6823025890736075903954/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6823025890736075903954" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6823025890736075903954", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "GBP" } }, "reconciliationId": "67720603YGMSE5JE", "status": "PENDING", "submitTimeUtc": "2025-04-24T02:16:29Z" }
Issue a Credit
Credit
This topic describes how to process an airline
credit
.IMPORTANT
All fields used in the original transaction must be included in your
request.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/credits/Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/Required Fields for Airline Credits
Credits
- orderInformation.billTo.administrationArea
- orderInformation.billTo.externality
- Set the value toairline.
- travelinformation.agency.name
Card-Specific Field for Airline Credits
Credits
Some card types require additional fields.
Visa
Use this field to capture an airline payment when using a Visa
card.
- airlineData_restrictedTicketIndicator
Optional Fields for Airline Credits
Credits
- travelInformation.transit.airline.invoiceNumber
- travelInformation.transit.airline.legs[].departTaxAmount
Example: Processing Airline Credits
Credits
Request
{ "clientReferenceInformation": { "code": "12345678" }, "processingInformation": { "industryDataType": "airline" }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "01", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "GBP" }, "billTo": { "firstName": "John", "lastName": "Deo", "address1": "1 The Street", "externality": "City", "administrativeArea": "County", "postalCode": "AB12CD", "country": "GB", "email": "test@email.co.uk" } }, "travelInformation": { "agency": { "name": "test-airline" }, "transit": { "airline": { "ticketIssuer": { "address": "123 Happy St" }, "ticketNumber": "123456789", "passengerName": "John Smith", "legs": [ { "originatingAirportCode": "AAA", "departureDate": "03092025" } ] } } } }
Response
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6823025890736075903954/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6823025890736075903954" } }, "clientReferenceInformation": { "code": "12345678" }, "id": "6823025890736075903954", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "GBP" } }, "reconciliationId": "67720603YGMSE5JE", "status": "PENDING", "submitTimeUtc": "2025-04-24T02:16:29Z" }
Elavon Airline Requests
Elavon
Airline RequestsThis section describes the airline payment services you can use when processing with
Elavon
.Supported Card Types
This table lists the card types that
Elavon
supports.Supported Card Types |
|---|
Diners Club |
Discover |
JCB Card |
Mastercard |
Visa |
Capture a Payment
This section describes how to capture an airline payment.
You can include an airline ticket purchase and any ancillary purchases in the same
capture request. Ancillary purchases are any additional services, such as baggage,
meals, and paid seats, your customers can purchase.
- Prerequisite
- Before you can capture payment, you must authorize the funds by sending an authorization request. The authorization response includes a request ID in theidfield. The request ID is required in the capture request. For more information about how to send an authorization request, see the Standard Payment Processing section in thePayments Developer Guide.
Leg Limitations
Elavon
limits the maximum number of legs for each trip based on
card type.This table describes the maximum number of legs for each trip based on card
type.
Supported Card Types | Maximum Number of Trip Legs |
|---|---|
Diners Club | 4 |
Discover | 4 |
Mastercard | 4 |
Visa | 4 |
Document Type
When capturing an airline payment, you must use the
travelInformation.transit.airline.documentType
field to specify the purpose of the transaction. For all possible values, see Airline Document Type Codes. Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for Capturing an Airline Ticket Payment
- Set toairline.
Required Fields for an Ancillary Purchase
Include these fields, in addition to the above fields, if there is an ancillary
purchase:
- Include one of the possible values listed in the Ancillary Service Category Codes section.
- To send multiple category codes, you must include additional entries of this field in the array.
Card-Specific Field for Capturing an Airline Payment
Card-Specific Field for Capturing an Airline Payment
Certain card types require additional fields.
Diners Club
Use this field in addition to the required fields to capture an airline
authorization when using a Diners Club card.
Optional Fields for Capturing an Airline Payment
- For a list of all possible values, see Ancillary Service Category Codes.
- For a list of all possible values, see Ancillary Service Category Codes.
Example: Capturing an Airline Payment
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "350.00", "currency": "USD" } }, "travelInformation": { "agency": { "name": "Test Airline" }, "transit": { "airline": { "ticketIssuer": { "code": "123456789" }, "ticketNumber": "123456798", "restrictedTicketIndicator": null, "passengerName": "John Smith", "legs": [ { "carrierCode": "AA", "originatingAirportCode": "DFW", "class": "First", "stopoverIndicator": "X", "departureDate": "20251231", "destinationAirportCode": "DFW" } ] } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/7659260363866784003812/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/7659260363866784003812" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "7659260363866784003812", "orderInformation": { "amountDetails": { "totalAmount": "350.00", "currency": "USD" } }, "reconciliationId": "69854049CJ7QD97N", "status": "PENDING", "submitTimeUtc": "2025-12-16T23:00:36Z" }
Example: Capturing an Airline Payment with Ancillary
Purchase
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "350.00", "currency": "USD" } }, "travelInformation": { "agency": { "name": "Test Airline" }, "transit": { "airline": { "ticketIssuer": { "code": "123456789" }, "ticketNumber": "123456798", "restrictedTicketIndicator": null, "passengerName": "John Smith", "legs": [ { "carrierCode": "AA", "originatingAirportCode": "DFW", "class": "First", "stopoverIndicator": "X", "departureDate": "20251231", "destinationAirportCode": "DFW" } ] } }, "travelInformation": { "transit": { "airline": { "ancillaryInformation": { "ticketNumber": "123456789", "passengerName": "John Smith", "connectedTicketNumber": "987654321", "service": [ { "categoryCode": "BF" } ] } } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/7659260363866784003812/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/7659260363866784003812" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "7659260363866784003812", "orderInformation": { "amountDetails": { "totalAmount": "350.00", "currency": "USD" } }, "reconciliationId": "69854049CJ7QD97N", "status": "PENDING", "submitTimeUtc": "2025-12-16T23:00:36Z" }
Refund a Payment
This section describes how to issue a refund. A refund is follow-on request that returns
the payment amount from a completed capture or sale. You must have a capture or sale
transaction ID.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/refundsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/refundsThe is the transaction ID
returned in the capture or sale response.
{id}
Required Fields for Refunding a Payment
Required Fields for an Ancillary Purchase
Include these fields, in addition to the above fields, if there is an ancillary
purchase:
- Include one of the possible values listed in the Ancillary Service Category Codes section.
- To send multiple category codes, you must include additional entries of this field in the array.
Card-Specific Field for Processing Airline Refund
Certain card types require additional fields.
Diners Club
Use this field in addition to the required fields to capture an airline
authorization when using a Diners Club card.
Optional Fields for Refunding a Payment
- Set to one of these 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
- For a list of all possible values, see Ancillary Service Category Codes.
- For a list of all possible values, see Ancillary Service Category Codes.
Example: Refunding a Payment
Request
{ "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "102.21" } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/refunds/6805496388936342404953/voids" }, "self": { "method": "GET", "href": "/pts/v2/refunds/6805496388936342404953" } }, "clientReferenceInformation": { "code": "1680549638986" }, "id": "6805496388936342404953", "orderInformation": { "amountDetails": { "currency": "USD" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "712678686G0ONA52", "refundAmountDetails": { "currency": "USD", "refundAmount": "102.21" }, "status": "PENDING", "submitTimeUtc": "2023-04-03T19:20:39Z" }
Example: Refunding a Payment with Ancillary Purchase
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "USD" } }, "travelInformation": { "transit": { "airline": { "ancillaryInformation": { "ticketNumber": "123456789123456", "passengerName": "John Smith", "connectedTicketNumber": "987654321987654", "service": [ { "categoryCode": "1" } ] } } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/refunds/6805496388936342404953/voids" }, "self": { "method": "GET", "href": "/pts/v2/refunds/6805496388936342404953" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6805496388936342404953", "orderInformation": { "amountDetails": { "currency": "USD" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "712678686G0ONA52", "refundAmountDetails": { "currency": "USD", "refundAmount": "102.21" }, "status": "PENDING", "submitTimeUtc": "2023-04-03T19:20:39Z" }
Issue a Credit
This topic describes how to issue an airline credit.
IMPORTANT
All fields used in the original transaction must be included in your
request.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/credits/Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/Required Fields for Airline Credits
Required Fields for an Ancillary Purchase
Include these fields, in addition to the above fields, if there is an ancillary
purchase:
- Include one of the possible values listed in the Ancillary Service Category Codes section.
- To send multiple category codes, you must include additional entries of this field in the array.
Card-Specific Field for Processing Airline Credits
Credits
Certain card types require additional fields.
Diners Club
Use this field in addition to the required fields to capture an airline
authorization when using a Diners Club card.
Optional Fields for Airline Credits
Credits
- Set to one of these 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
- For a list of all possible values, see Ancillary Service Category Codes.
- For a list of all possible values, see Ancillary Service Category Codes.
Example: Processing Airline Credits
Credits
Request
{ "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "07", "expirationYear": "2027" } }, "orderInformation": { "amountDetails": { "totalAmount": "300.00", "currency": "USD" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "externality": "Sunnyville", "administrativeArea": "TX", "postalCode": "55555", "country": "US", "email": "johnsmith@testemail.com" } } }
Response
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/credits/7678035881236488904805/voids" }, "self": { "method": "GET", "href": "/pts/v2/credits/7678035881236488904805" } }, "clientReferenceInformation": { "code": "1767803588270" }, "creditAmountDetails": { "currency": "USD", "creditAmount": "300.00" }, "id": "7678035881236488904805", "orderInformation": { "amountDetails": { "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "JDWEIJB43Y09", "status": "PENDING", "submitTimeUtc": "2026-01-07T16:33:08Z" }
Example: Issue a Credit for an Ancillary Purchase
Credit
for an Ancillary PurchaseRequest
{ "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "07", "expirationYear": "2027" } }, "orderInformation": { "amountDetails": { "totalAmount": "300.00", "currency": "USD" }, "billTo": { "firstName": "John", "lastName": "Smith", "address1": "123 Happy St", "externality": "Sunnyville", "administrativeArea": "TX", "postalCode": "55555", "country": "US", "email": "johnsmith@testemail.com" } }, "travelInformation": { "transit": { "airline": { "ancillaryInformation": { "ticketNumber": "1234567981234567989", "passengerName": "John Smith", "connectedTicketNumber": "987654321987654", "service": [ { "categoryCode": "1" } ] } } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/credits/7678040337136100204805/voids" }, "self": { "method": "GET", "href": "/pts/v2/credits/7678040337136100204805" } }, "clientReferenceInformation": { "code": "1767804033806" }, "creditAmountDetails": { "currency": "USD", "creditAmount": "300.00" }, "id": "7678040337136100204805", "orderInformation": { "amountDetails": { "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "JQT0PJB4FMOB", "status": "PENDING", "submitTimeUtc": "2026-01-07T16:40:33Z" }
FDC Nashville Global Airline Requests
FDC Nashville Global
Airline RequestsThis section describes the airline payment services you can use when processing with
FDC Nashville Global
.Supported Card Types
This table lists the card types
FDC Nashville Global
supports and their
values. When including the paymentInformation.card.type
field, set the field to a
value listed in the card type value column.Supported Card Type | Card Type Value |
|---|---|
American Express | 003 |
Discover | 004 |
Mastercard | 002 |
Visa | 001 |
Authorize a Payment
This section describes how to process an airline authorization.
Authorization Restrictions
Ticket purchases that include multiple passengers may be included in a single
authorization request, however,
Cybersource
recommends sending a
separate capture request for each passenger.If any ancillary purchases are made at the same time as the ticket purchase, you may
include all the items in a single authorization request, however,
Cybersource
recommends separating the ancillary and ticket purchases into
individual capture requests.If any ancillary purchases are not made at the same time as the ticket purchase,
Cybersource
recommends separating the authorization and capture requests
for the ancillary and ticket purchases. Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/paymentsTest:
POST
https://apitest.cybersource.com
/pts/v2/paymentsProduction in Saudi Arabia:
POST
https://api.sa.cybersource.com
/pts/v2/paymentsTest in Saudi Arabia:
POST
https://apitest.sa.cybersource.com
/pts/v2/paymentsRequired Fields for an Airline Authorization
Include these fields to process an airline authorization.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used,
not all fields in this list are required. It is your responsibility to determine
whether your account is enabled to use this feature and which fields are required.
For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
- Set the value toairline.
Card-Specific Fields for an Airline Authorization
This section includes card-specific information required for an airline
authorization.
American Express
Include these fields in addition to the required fields when using an American
Express card. American Express requires leg fields in the authorization request. For
more information about leg fields, see Airline Travel Legs.
REST Example: Airline Authorization
REST
Example: Airline Authorization Request
{ "clientReferenceInformation": { "code": "RTS-Auth" }, "orderInformation": { "billTo": { "country": "US", "lastName": "VDP", "address2": "test", "address1": "201 S. Division St.", "postalCode": "48104-2201", "externality": "Ann Arbor", "administrativeArea": "MI", "firstName": "RTS", "phoneNumber": "999999999", "district": "MI", "buildingNumber": "123", "company": "Visa", "email": "test@cybs.com" }, "amountDetails": { "totalAmount": "100.00", "currency": "usd" }, "shipTo": { "firstName": "Michale" } }, "paymentInformation": { "card": { "expirationYear": "2031", "number": "3782822463xxxxx", "expirationMonth": "12", "securityCode": "123", "type": "003" } }, "processingInformation": { "industryDataType": "airline" }, "travelInformation": { "transit": { "airline": { "passengerName": "Michale", "legs": [ { "carrierCode": "123", "fareBasis": "B1", "departureDate": "20230202", "destinationAirportCode": "NY", "originatingAirportCode": "SFO" }, { "carrierCode": "456", "fareBasis": "B2", "departureDate": "20230202", "destinationAirportCode": "SFO", "originatingAirportCode": "SJC" } ] } } } }
Response to a Successful Request
{ "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6902464806406008803234/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6902464806406008803234" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6902464806406008803234/captures" } }, "clientReferenceInformation": { "code": "1690246480572" }, "id": "6902464806406008803234", "issuerInformation": { "responseRaw": "0110322000000E1000020000000000000100000725005441300026475537344F4B48495131314D38333130303030300001590064003631342030313631373831313031353439343520202020202036363030533036303030303100103232415050524F56414C0012534443523030355959595959" }, "orderInformation": { "amountDetails": { "authorizedAmount": "100.00", "currency": "usd" } }, "paymentAccountInformation": { "card": { "type": "003" } }, "paymentInformation": { "tokenizedCard": { "type": "003" }, "card": { "type": "003" } }, "pointOfSaleInformation": { "terminalId": "00092940" }, "processorInformation": { "electronicVerificationResults": { "phoneNumberRaw": "Y", "emailRaw": "Y", "phoneNumber": "Y", "code": "Y", "postalCodeRaw": "Y", "street": "Y", "postalCode": "Y", "codeRaw": "Y", "streetRaw": "Y", "email": "Y" }, "merchantNumber": "000000000001234", "approvalCode": "831000", "responseCode": "00", "avs": { "code": "Y", "codeRaw": "Y" } }, "reconciliationId": "GU74OKHIQ11M", "status": "AUTHORIZED", "submitTimeUtc": "2023-07-25T00:54:41Z" }
Request
{ "clientReferenceInformation": { "code": "RTS-Auth" }, "processingInformation": { "industryDataType": "airline" }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031", "type": "001" } }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "USD" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "1 Market St", "externality": "san francisco", "administrativeArea": "CA", "postalCode": "94105", "country": "US", "email": "test@cybs.com" } } }
Successful Response
{ "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6917758602546577403955/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6917758602546577403955" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6917758602546577403955/captures" } }, "clientReferenceInformation": { "code": "1691775860306" }, "id": "6917758602546577403955", "orderInformation": { "amountDetails": { "authorizedAmount": "102.21", "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "68209505QL5OEHAU", "status": "AUTHORIZED", "submitTimeUtc": "2023-08-11T17:44:20Z" }
Unsuccessful Response
{ "submitTimeUtc" : "2020-05-20T21:06:56Z", "status" : "INVALID_REQUEST", "reason" : "INVALID_DATA", "message" : "Declined - One or more fields in the request contains invalid data", "details" : [ { "field" : "stopover_code", "reason" : "INVALID_DATA" } ] }
Capture a Ticket Payment
This section describes how to capture an airline ticket payment, such as when a person is
purchasing a ticket on your e-commerce store.
Capture Restrictions
For a ticket purchase with multiple passengers,
Cybersource
recommends
sending separate capture requests for each passenger. The original authorization may
be a single request. When ancillary purchases are made at the same time as the ticket purchase,
Cybersource
recommends sending separate capture requests for the ticket
and ancillary purchases. Airline Travel Legs
FDC Nashville Global
requires you to include travel leg fields in your
requests, even for direct flights. For more information about how to format travel
leg fields, see Airline Travel Legs.Leg Limitations
FDC Nashville Global
limits the maximum number of legs for each trip based
on card type. This table describes the maximum number of legs for each trip based on
processor and card type.Supported Card Types | Maximum Number of Trip Legs |
|---|---|
American Express | 4 |
Discover | 4 |
Mastercard | 99 |
Visa | 4 |
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for Capturing a Ticket Payment
Include these required fields to capture an airline payment for tickets.
- Set the value toairline.
- travelInformation.transit.airline.ticketNumber
Card-Specific Fields for Capturing a Ticket
Payment
This section includes card-specific information required to capture a payment for
tickets.
Discover
Include these fields in addition to the required fields when using a Discover
card.
- Set the value toAorP.
- Set the value toAorP.
Mastercard
Include these fields in addition to the required fields when using a Mastercard
card.
Visa
Include this field in addition to the required fields when using a Visa card.
- Set the value to0for refundable.
- Set the value to1for nonrefundable.
Optional Fields for an Airline Capture
Choose from these optional fields to include additional information when capturing an
airline payment for direct flight tickets.
- travelInformation.transit.airline.clearingCount
- travelInformation.transit.airline.clearingSequence
- Set the value toO(capital letter "O") to indicate the leg of a trip is allowed to stopover. Default value.
- Set the value toXto indicate the leg of a trip is not allowed to stopover.
- travelInformation.transit.airline.totalClearingAmount
REST Example: Capturing a Visa Airline Payment
REST
Example: Capturing a Visa Airline PaymentRequest
{ "clientReferenceInformation": { "code": "RTS-Bill" }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "processingInformation": { "industryDataType": "airline" }, "travelInformation": { "agency": { "name": "Thomascook" }, "transit": { "airline": { "passengerName": "John", "ticketNumber": "asd23", "customerCode": "LDTYOU789", "totalFeeAmount": "200", "planNumber": "49252", "exchangeTicketAmount": "11", "exchangeTicketFeeAmount": "1", "legs": [ { "carrierCode": "AA", "originatingAirportCode": "SFO", "class": "1", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "NY", "exchangeTicketNumber": "ticket12", "endorsementsRestrictions": "Endorsement1234", "feeAmount": "999.99", "taxAmount": "99" }, { "carrierCode": "BB", "originatingAirportCode": "NY", "class": "2", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "SFO", "exchangeTicketNumber": "ticket13", "endorsementsRestrictions": "Endorsement1234", "feeAmount": "999.99", "taxAmount": "99" } ] } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6917768579016106103954/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6917768579016106103954" } }, "clientReferenceInformation": { "code": "RTS-Bill" }, "id": "6917768579016106103954", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "reconciliationId": "682098706L5PQJ7Y", "status": "PENDING", "submitTimeUtc": "2023-08-11T18:00:58Z" }
Request
{ "clientReferenceInformation": { "code": "RTS-Bill" }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "processingInformation": { "industryDataType": "airline" }, "travelInformation": { "agency": { "name": "Thomascook", "code": "123" }, "transit": { "airline": { "passengerName": "John", "ticketNumber": "asd23", "customerCode": "LDTYOU789", "totalFeeAmount": "200", "planNumber": "49252", "exchangeTicketAmount": "11", "exchangeTicketFeeAmount": "1", "ticketIssueDate": "20190202", "arrivalDate": "20230808", "ticketIssuer": { "address": "Silicon Vally" }, "legs": [ { "carrierCode": "AA", "flightNumber": "UA789", "originatingAirportCode": "SFO", "class": "1", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "NY", "fareBasis": "B1", "totalFareAmount": "12", "exchangeTicketNumber": "ticket12", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234", "arrivalTime": "1920", "arrivalTimeMeridian": "A", "departureTime": "1230", "departureTimeMeridian": "A" }, { "carrierCode": "BB", "flightNumber": "UA788", "originatingAirportCode": "NY", "class": "2", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "SFO", "fareBasis": "B1", "totalFareAmount": "12", "exchangeTicketNumber": "ticket13", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234", "arrivalTime": "0120", "arrivalTimeMeridian": "A", "departureTime": "2030", "departureTimeMeridian": "A" } ] } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6917775047466121303955/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6917775047466121303955" } }, "clientReferenceInformation": { "code": "RTS-Bill" }, "id": "6917775047466121303955", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "reconciliationId": "68210417JL5O06RJ", "status": "PENDING", "submitTimeUtc": "2023-08-11T18:11:44Z" }
Request
{ "clientReferenceInformation": { "code": "RTS-Bill" }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "processingInformation": { "industryDataType": "airline" }, "travelInformation": { "agency": { "name": "Thomascook" }, "transit": { "airline": { "passengerName": "John", "ticketNumber": "asd23", "customerCode": "LDTYOU789", "totalFeeAmount": "200", "planNumber": "49252", "exchangeTicketAmount": "11", "exchangeTicketFeeAmount": "1", "legs": [ { "carrierCode": "AA", "flightNumber": "UA789", "originatingAirportCode": "SFO", "class": "1", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "NY", "fareBasis": "B1", "exchangeTicketNumber": "ticket12", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234" }, { "carrierCode": "BB", "flightNumber": "UA788", "originatingAirportCode": "NY", "class": "2", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "SFO", "fareBasis": "B1", "exchangeTicketNumber": "ticket13", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234" } ] } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6917778689216158003955/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6917778689216158003955" } }, "clientReferenceInformation": { "code": "RTS-Bill" }, "id": "6917778689216158003955", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "reconciliationId": "68210471JL5O06T1", "status": "PENDING", "submitTimeUtc": "2023-08-11T18:17:49Z" }
Request
{ "clientReferenceInformation": { "code": "RTS-Bill" }, "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "processingInformation": { "industryDataType": "airline" }, "travelInformation": { "agency": { "name": "Thomascook" }, "transit": { "airline": { "passengerName": "John", "ticketNumber": "asd23", "customerCode": "LDTYOU789", "totalFeeAmount": "200", "planNumber": "49252", "exchangeTicketAmount": "11", "exchangeTicketFeeAmount": "1", "restrictedTicketIndicator": "0", "legs": [ { "carrierCode": "AA", "originatingAirportCode": "SFO", "class": "1", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "NY", "exchangeTicketNumber": "ticket12", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234" }, { "carrierCode": "BB", "originatingAirportCode": "NY", "class": "2", "stopoverIndicator": "O", "departureDate": "20230202", "destinationAirportCode": "SFO", "exchangeTicketNumber": "ticket13", "departureTime": "1720", "endorsementsRestrictions": "Endorsement1234" } ] } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6917788755186225803955/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6917788755186225803955" } }, "clientReferenceInformation": { "code": "RTS-Bill" }, "id": "6917788755186225803955", "orderInformation": { "amountDetails": { "totalAmount": "100.00", "currency": "USD" } }, "reconciliationId": "68211484JL5O0702", "status": "PENDING", "submitTimeUtc": "2023-08-11T18:34:35Z" }
Capture an Ancillary Purchase
Ancillary purchases are any additional services, such as baggage, meals, and paid seats,
your customers can purchase. Captures for ancillary purchases must be separate for
captures for ticket purchases.
FDC Nashville Global
supports up to four
ancillary purchases for each capture. Capture Restrictions
When ancillary purchases are made at the same time as the ticket purchase,
Cybersource
recommends that you send separate capture requests for the
ticket and ancillary purchases. When ancillary purchases are not made at the same time as the ticket purchase,
Cybersource
recommends that you send separate authorization and
capture requests for the ancillary and ticket purchases.Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for an Airline Capture
Ancillary Airline Fields
Choose from these optional ancillary airline fields to include in your capture
request in addition to the required fields listed above.
IMPORTANT
FDC Nashville Global
supports up to four ancillary
purchases for each capture.- For a list of possible values, see Ancillary Service Category Codes.
- For a list of possible values, see Ancillary Service Category Codes.
- Set the value toCfor changing an existing ticket.
- Set the value toNfor a new ticket.
REST Example: Capturing an Airline Payment for Ancillary
Purchases
REST
Example: Capturing an Airline Payment for Ancillary
PurchasesRequest
{ "clientReferenceInformation": { "code": "TC50171_3" }, "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "USD" } }, "travelInformation": { "transit": { "airline": { "ancillaryInformation": { "ticketNumber": "123456789", "passengerName": "John Doe", "connectedTicketNumber": "987654321", "service": [ { "categoryCode": "65", "subCategoryCode": "75" } ] } } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6811595456806928403955/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6811595456806928403955" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6811595456806928403955", "orderInformation": { "amountDetails": { "totalAmount": "102.21", "currency": "USD" } }, "reconciliationId": "658927039G5GNF51", "status": "PENDING", "submitTimeUtc": "2023-04-10T20:45:45Z" }
Refund a Payment
Refund a Payment
This section describes how to process an airline refund, which requires
you to have the transaction ID from the original payment.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/refundsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/refundsThe is the transaction ID
returned in the capture or sale response.
{id}
Required Fields for an Airline Refund
Refund
Optional Fields for an Airline Refund
Refund
Choose from these optional fields to include additional information when processing an
airline
refund
.- travelInformation.transit.airline. clearingCount
- travelInformation.transit.airline. clearingSequence
- travelInformation.transit.airline. totalClearingAmount
- travelInformation. transit. airline.ancillaryInformation. creditReasonIndicator
- Set to one of these 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
REST Example: Processing an Airline Refund
REST
Example: Processing an Airline Refund
Request
{ "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "102.21" } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/refunds/6805496388936342404953/voids" }, "self": { "method": "GET", "href": "/pts/v2/refunds/6805496388936342404953" } }, "clientReferenceInformation": { "code": "1680549638986" }, "id": "6805496388936342404953", "orderInformation": { "amountDetails": { "currency": "USD" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "712678686G0ONA52", "refundAmountDetails": { "currency": "USD", "refundAmount": "102.21" }, "status": "PENDING", "submitTimeUtc": "2023-04-03T19:20:39Z" }
Visa Platform Connect Airline Requests
Visa Platform Connect
Airline RequestsThis section describes how to process airline payments using
Visa Platform Connect
.Requirement
When you are ready to go live with airline data processing, contact
Cybersource
Customer
Support to have your account configured to process airline data. If your account is not
enabled, and you try to send airline transactions, you will receive an error for invalid
data.Related Information
- See Airline Data for information about and requirements for processing payments that include airline data.
- See Airline Data Reference Information for a list and description of the different document type and ancillary service category codes that are used when processing payments that include airline data.
Authorize an Airline Ticket Payment
This section describes how to process an airline authorization.
Authorization Restrictions
Ticket purchases that include multiple passengers may be included in a single authorization
request, but you must make separate capture requests for every passenger.
If any ancillary purchases are made at the same time as the ticket purchase, you may
include all items in a single authorization request, but you must separate the ancillary
and ticket purchases into their own capture requests.
If any ancillary purchases are made not at the same time as the ticket purchase, you
must send separate authorization and capture requests for the ancillary and ticket
purchases.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/paymentsTest:
POST
https://apitest.cybersource.com
/pts/v2/paymentsProduction in Saudi Arabia:
POST
https://api.sa.cybersource.com
/pts/v2/paymentsTest in Saudi Arabia:
POST
https://apitest.sa.cybersource.com
/pts/v2/paymentsRequired Fields for Authorizing an Airline Payment
Include these required fields for authorizing an airline payment.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used,
not all fields in this list are required. It is your responsibility to determine
whether your account is enabled to use this feature and which fields are required.
For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
- Set the value toairline.
REST Example: Authorizing an Airline Payment
Request
{ "processingInformation": { "industryDataType": "airline" }, "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "2031" } }, "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "usd" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "123 Happy St.", "externality": "Sunny Town", "administrativeArea": "CA", "postalCode": "12345-1234", "country": "US", "email": "test@cybs.com" } } }
Response to a Successful Request
{ "_links": { "authReversal": { "method": "POST", "href": "/pts/v2/payments/6823009451126309503954/reversals" }, "self": { "method": "GET", "href": "/pts/v2/payments/6823009451126309503954" }, "capture": { "method": "POST", "href": "/pts/v2/payments/6823009451126309503954/captures" } }, "clientReferenceInformation": { "code": "1682300945230" }, "id": "6823009451126309503954", "orderInformation": { "amountDetails": { "authorizedAmount": "500.00", "currency": "usd" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "pointOfSaleInformation": { "terminalId": "111111" }, "processorInformation": { "approvalCode": "888888", "networkTransactionId": "123456789619999", "transactionId": "123456789619999", "responseCode": "100", "avs": { "code": "X", "codeRaw": "I1" } }, "reconciliationId": "67720603YGMSE5JE", "status": "AUTHORIZED", "submitTimeUtc": "2023-04-24T01:49:05Z" }
Captures for Ticket Purchases
This section describes how to capture an airline payment for ticket purchases.
Captures for ticket purchases must be made separately from captures for ancillary
purchases. For more information about how to capture an ancillary purchase, see Captures for Ancillary Purchases.
Travel Legs
You can use travel leg fields for trips that have multiple legs. For more information
on how to use travel leg fields, see Airline Data.
Leg Limitations
Visa Platform Connect
limits the maximum number of legs for each trip based on card
type. This table describes the maximum number of legs for each trip based on card type.Supported Card Types | Maximum Number of Trip Legs |
|---|---|
American Express | 4 |
Discover | 4 |
Mastercard | 4 |
Visa | 4 |
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for Capturing an Airline Payment
Include these required fields to capture an airline payment for ticket
purchases.
Card-Specific Field to Capture an Airline Payment
This section includes card-specific information.
Mastercard
Use this card-specific field in addition to the required fields when capturing an
authorization with a Mastercard.
Optional Fields for Capturing an Airline Payment
You can use these optional fields to include additional information when capturing an
airline payment.
Related Information
Example: Capturing an Airline Payment
Use this example as a reference for capturing an airline payment.
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "USD" } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6823025890736075903954/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6823025890736075903954" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6823025890736075903954", "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "USD" } }, "reconciliationId": "67720603YGMSE5JE", "status": "PENDING", "submitTimeUtc": "2023-04-24T02:16:29Z" }
Captures for Ancillary Purchases
This section describes how to capture an airline payment for ancillary
purchases.
Ancillary purchases are any additional services, such as baggage, meals, and paid seats,
that your customers can purchase. Captures for ancillary purchases must be made
separately from captures for ticket purchases.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/capturesTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/capturesThe is the transaction ID
returned in the authorization response.
{id}
Required Fields for Capturing an Authorization for Ancillary Purchases
Include these required fields to capture an airline payment for ancillary
purchases.
Related Information
Ancillary Fields for Capturing an Authorization for an Ancillary Purchase
Choose from these optional ancillary fields to add additional information when
capturing an ancillary purchase.
REST Example: Capturing an Authorization for an Ancillary Purchase
Use this example as a reference for capturing an ancillary purchase with the
ancillary fields.
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "USD" } }, "travelInformation": { "transit": { "airline": { "ancillaryInformation": { "ticketNumber": "123456789123456", "passengerName": "John Doe", "connectedTicketNumber": "654321987654321" } } } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/captures/6823030661646093703954/voids" }, "self": { "method": "GET", "href": "/pts/v2/captures/6823030661646093703954" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6823030661646093703954", "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "USD" } }, "reconciliationId": "67221841NGMV8WOT", "status": "PENDING", "submitTimeUtc": "2023-04-24T02:24:26Z" }
Refunds
Refunds
This topic describes how to process an airline refund.
This service returns the funds used in the initial capture and requires the original
capture ID.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/refundsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/refundsThe is the transaction ID
returned in the capture or sale response.
{id}
Required Fields for Processing an Airline Refund
Refund
Include these required fields to process an airline refund.
Related Information
Optional Fields for Processing an Airline Refund
Refund
This section includes these types of optional fields for an airline
refund
:General Optional Fields
You can use these optional fields to include additional information in any airline
purchase.
- travelInformation.agency.code
- travelInformation.agency.name
- travelInformation.transit.airline.arrivalDate
- travelInformation.transit.airline.carrierName
- travelInformation.transit.airline.clearingCount
- travelInformation.transit.airline.clearingSequence
- travelInformation.transit.airline.creditReasonIndicator
- travelInformation.transit.airline.customerCode
- travelInformation.transit.airline.documentType
- For a list of possible values, see Airline Document Type Codes.
- travelInformation.transit.airline.electronicTicketIndicator
- travelInformation.transit.airline.exchangeTicketFeeAmount
- travelInformation.transit.airline.numberOfPassengers
- travelInformation.transit.airline.passengerName
- travelInformation.transit.airline.planNumber
- travelInformation.transit.airline.purchaseType
- travelInformation.transit.airline.reservationSystemCode
- travelInformation.transit.airline.restrictedTicketDesciption
- travelInformation.transit.airline.restrictedTicketIndicator
- travelInformation.transit.airline.ticketChangeIndicator
- travelInformation.transit.airline.ticketIssueDate
- travelInformation.transit.airline.ticketIssuer.externality
- travelInformation.transit.airline.ticketNumber
- travelInformation.transit.airline.totalClearingAmount
- travelInformation.transit.airline.totalFeeAmount
- travelInformation.transit[].exchangeTicketAmount
Airline Optional Fields for Ticket Purchases
You can use these optional fields to include additional information when requesting
an airline
credit
for a ticket purchase.- travelInformation.transit.airline.legs[].arrivalTime
- travelInformation.transit.airline.legs[].arrivalTimeMeridian
- travelInformation.transit.airline.legs[].carrierCode
- travelInformation.transit.airline.legs[].class
- travelInformation.transit.airline.legs[].conjunctionTicket
- travelInformation.transit.airline.legs[].couponNumber
- travelInformation.transit.airline.legs[].departureDate
- travelInformation.transit.airline.legs[].departureTime
- travelInformation.transit.airline.legs[].departureTimeMeridian
- travelInformation.transit.airline.legs[].destinationAirportCode
- travelInformation.transit.airline.legs[].endorsementsRestrictions
- travelInformation.transit.airline.legs[].exchangeTicketNumber
- travelInformation.transit.airline.legs[].fareBasis
- travelInformation.transit.airline.legs[].feeAmount
- travelInformation.transit.airline.legs[].flightNumber
- travelInformation.transit.airline.legs[].originatingAirportCode
- travelInformation.transit.airline.legs[].stopoverIndicator
- travelInformation.transit.airline.legs[].taxAmount
- travelInformation.transit.airline.legs[].totalFareAmount
Ancillary Optional Fields
You can use these optional fields to include additional information when requesting
an airline
credit
for an ancillary purchase.- travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber
- travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator
- travelInformation.transit.airline.ancillaryInformation.passengerName
- travelInformation.transit.airline.ancillaryInformation.service[].categoryCode
- For a list of possible values, see Ancillary Service Category Codes.
- travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode
- travelInformation.transit.airline.ancillaryInformation.ticketNumber
Related Information
REST Example: Processing an Airline Refund
Use this example as a reference for processing an airline refund.
Request
{ "clientReferenceInformation": { "code": "TC50171_3" }, "processingInformation": { "industryDataType": "airline" }, "orderInformation": { "amountDetails": { "totalAmount": "500", "currency": "USD" } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/refunds/6823038625416445403955/voids" }, "self": { "method": "GET", "href": "/pts/v2/refunds/6823038625416445403955" } }, "clientReferenceInformation": { "code": "TC50171_3" }, "id": "6823038625416445403955", "orderInformation": { "amountDetails": { "currency": "USD" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "67722608EGMV6Q7V", "refundAmountDetails": { "currency": "USD", "refundAmount": "500.00" }, "status": "PENDING", "submitTimeUtc": "2023-04-24T02:37:42Z" }
Issue a Credit
This topic describes how to process an airline credit.
This service distributes funds without requiring a capture ID.
IMPORTANT
All fields used in the original transaction must be included in your
request.
Endpoint
Production:
POST
https://api.cybersource.com
/pts/v2/credits/Test:
POST
https://apitest.cybersource.com
/pts/v2/credits/Required Fields for Processing an Airline Credit
Credit
Include these required fields to process an airline credit.
IMPORTANT
When relaxed requirements for address data and the expiration date are being used,
not all fields in this list are required. It is your responsibility to determine
whether your account is enabled to use this feature and which fields are required.
For details about relaxed requirements, see Relaxed Requirements for Address Data and Expiration Date in Payment Transactions.
Optional Fields for Processing an Airline Credit
Credit
This section includes these types of optional fields for an airline
credit
:General Optional Fields
You can use these optional fields to include additional information in any airline
purchase.
- travelInformation.agency.code
- travelInformation.agency.name
- travelInformation.transit.airline.arrivalDate
- travelInformation.transit.airline.carrierName
- travelInformation.transit.airline.clearingCount
- travelInformation.transit.airline.clearingSequence
- travelInformation.transit.airline.creditReasonIndicator
- travelInformation.transit.airline.customerCode
- travelInformation.transit.airline.documentType
- For a list of possible values, see Airline Document Type Codes.
- travelInformation.transit.airline.electronicTicketIndicator
- travelInformation.transit.airline.exchangeTicketFeeAmount
- travelInformation.transit.airline.numberOfPassengers
- travelInformation.transit.airline.passengerName
- travelInformation.transit.airline.planNumber
- travelInformation.transit.airline.purchaseType
- travelInformation.transit.airline.reservationSystemCode
- travelInformation.transit.airline.restrictedTicketDesciption
- travelInformation.transit.airline.restrictedTicketIndicator
- travelInformation.transit.airline.ticketChangeIndicator
- travelInformation.transit.airline.ticketIssueDate
- travelInformation.transit.airline.ticketIssuer.externality
- travelInformation.transit.airline.ticketNumber
- travelInformation.transit.airline.totalClearingAmount
- travelInformation.transit.airline.totalFeeAmount
- travelInformation.transit[].exchangeTicketAmount
Airline Optional Fields for Ticket Purchases
You can use these optional fields to include additional information when requesting
an airline
credit
for a ticket purchase.- travelInformation.transit.airline.legs[].arrivalTime
- travelInformation.transit.airline.legs[].arrivalTimeMeridian
- travelInformation.transit.airline.legs[].carrierCode
- travelInformation.transit.airline.legs[].class
- travelInformation.transit.airline.legs[].conjunctionTicket
- travelInformation.transit.airline.legs[].couponNumber
- travelInformation.transit.airline.legs[].departureDate
- travelInformation.transit.airline.legs[].departureTime
- travelInformation.transit.airline.legs[].departureTimeMeridian
- travelInformation.transit.airline.legs[].destinationAirportCode
- travelInformation.transit.airline.legs[].endorsementsRestrictions
- travelInformation.transit.airline.legs[].exchangeTicketNumber
- travelInformation.transit.airline.legs[].fareBasis
- travelInformation.transit.airline.legs[].feeAmount
- travelInformation.transit.airline.legs[].flightNumber
- travelInformation.transit.airline.legs[].originatingAirportCode
- travelInformation.transit.airline.legs[].stopoverIndicator
- travelInformation.transit.airline.legs[].taxAmount
- travelInformation.transit.airline.legs[].totalFareAmount
Ancillary Optional Fields
You can use these optional fields to include additional information when requesting
an airline
credit
for an ancillary purchase.- travelInformation.transit.airline.ancillaryInformation.connectedTicketNumber
- travelInformation.transit.airline.ancillaryInformation.creditReasonIndicator
- travelInformation.transit.airline.ancillaryInformation.passengerName
- travelInformation.transit.airline.ancillaryInformation.service[].categoryCode
- For a list of possible values, see Ancillary Service Category Codes.
- travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode
- travelInformation.transit.airline.ancillaryInformation.ticketNumber
REST Example: Processing an Airline Credit
Request
{ "paymentInformation": { "card": { "number": "4111111111111111", "expirationMonth": "12", "expirationYear": "31" } }, "orderInformation": { "amountDetails": { "totalAmount": "500.00", "currency": "USD" }, "billTo": { "firstName": "John", "lastName": "Doe", "address1": "123 Happy St.", "externality": "Sunnyville", "administrativeArea": "CA", "postalCode": "12345", "country": "US", "email": "johndoe@test.com" } } }
Response to a Successful Request
{ "_links": { "void": { "method": "POST", "href": "/pts/v2/credits/6823065885666134104951/voids" }, "self": { "method": "GET", "href": "/pts/v2/credits/6823065885666134104951" } }, "clientReferenceInformation": { "code": "1682306588644" }, "creditAmountDetails": { "currency": "USD", "creditAmount": "500.00" }, "id": "6823065885666134104951", "orderInformation": { "amountDetails": { "currency": "USD" } }, "paymentAccountInformation": { "card": { "type": "001" } }, "paymentInformation": { "tokenizedCard": { "type": "001" }, "card": { "type": "001" } }, "processorInformation": { "approvalCode": "888888", "responseCode": "100" }, "reconciliationId": "74259417PGM9TXHT", "status": "PENDING", "submitTimeUtc": "2023-04-24T03:23:08Z" }
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
travelInformation.transit.airline.documentType
field to a value listed in the Code column.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
travelInformation.transit.airline.ancillaryInformation.service[].categoryCode
and travelInformation.transit.airline.ancillaryInformation.service[].subCategoryCode
fields to a value listed in the Ancillary Service Category Code column.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 |
Airline Data
Airline data processing goes beyond basic payment transactions by allowing you to process
specific travel data. This requires you to submit additional information, such as:
- Carrier
- Departure Date
- Destination Airport
- Purchase Date
- Originating Airport
- Ticket Class
- Trip Legs
Supported Processor
Requirement
When you are ready to go live with airline data processing, contact
Cybersource
Customer
Support to have your account configured to process airline data. If your account is not
enabled, and you try to send airline transactions, you will receive an error for invalid
data.Related Information
- See Airline Data Processing for information that shows you how to process payments that include airline data.
Relaxed Requirements for Address Data and Expiration Date in Payment Transactions
With relaxed requirements for address data and the expiration date, not all standard payment request fields are required. It is your responsibility to determine whether your account is enabled to use this feature and which fields are required.
Airline Data Processing
This section describes how to process airline payments.
Requirement
When you are ready to go live with airline data processing, contact
Cybersource
Customer
Support to have your account configured to process airline data. If your account is not
enabled, and you try to send airline transactions, you will receive an error for invalid
data.Related Information
- See Airline Data for information about and requirements for processing payments that include airline data.
- See Airline Data Reference Information for a list and description of the different document type and ancillary service category codes that are used when processing payments that include airline data.