Industry Specific Data
If you are operating in a specific industry, then you can use our SOAP API to submit the addendum data, what may provide an incentive rate for a market segment.
Airline Specific Data
Full elements structure is available in v1.xsd file in AirlineDetails
complex type.
Attribute | Description |
---|---|
PassengerName | traveller's name; string 30 max |
TicketNumber | flight ticket number; string 20 max |
IssuingCarrier | carrier who issued the flight ticket; string 20 max |
CarrierName | carrier associated with a transaction; string 20 max |
TravelAgencyCodeOrIATACode | airline IATA code or travel agency code; string 20 max |
TravelAgencyName | name of the travel agency; string 30 max |
AirlinePlanNumber | string 2 max |
AirlineInvoiceNumber | airline's invoice number; string 6 max |
ComputerizedReservationSystem | reservation system; available values: - Start - TWA - Delta - Sabre - Covia-Apollo - Dr.Blank - DER - TUI |
Restricted | boolean |
TravelRoute | travel route, includes the following sub-elements:DepartureDate - date formatOrigin - string, 3 maxDestination - string 2 maxCarrierCode - string 2 maxServiceClass - string 1 maxStopoverType - 2 available values: "DIRECT" and "STOPOVER"FareBasisCode - string 2 maxDepartureTax FlightNumber - string 10 max |
RelatedTicketNumber | ticket number; String 20 max |
AncillaryServiceCategory | curently available values: -Bundled Service - Baggage Fee - Change Fee - Cargo - Cargo Offset - Frequent Flyer - Gift Card - Ground Transport - In-flight Entertainment - Lounge - Medical - Meal / Beverage - Other - Passenger Assist Fee - Pets - Seat Fees - Standby - Service Fee - Store - Travel Service - Unaccompanied Travel - Upgrades - Wi-Fi |
TicketPurchase | Identifies a purchase of ancillary goods or services with "false" value. If the element is not given, the transaction is assumed to be a purchase of airline ticket. boolean, default value = "true" |
Following XML document represents an example of a transaction request and response including airline addendum data:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header/>
<soap:Body>
<ns5:IPGApiOrderRequest xmlns:ns5="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/v1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ns4="http://api.clickandbuy.com/webservices/pay_1_0_0/">
<ns2:Transaction>
<ns2:CreditCardTxType>
<ns2:StoreId>2209950005</ns2:StoreId>
<ns2:Type>sale</ns2:Type>
</ns2:CreditCardTxType>
<ns2:CreditCardData>
<ns2:CardNumber>54260******4979</ns2:CardNumber>
<ns2:ExpMonth>12</ns2:ExpMonth>
<ns2:ExpYear>285</ns2:ExpYear>
<ns2:CardCodeValue>XXX</ns2:CardCodeValue>
</ns2:CreditCardData>
<ns2:CreditCard3DSecure>
<ns2:AuthenticationValue>QUNTRU1VUmV/MyVFPytkP284VjU=</ns2:AuthenticationValue>
<ns2:Secure3D2TransactionStatus>Y</ns2:Secure3D2TransactionStatus>
<ns2:Secure3D2AuthenticationResponse>Y</ns2:Secure3D2AuthenticationResponse>
<ns2:Secure3DProtocolVersion>2.2.0</ns2:Secure3DProtocolVersion>
<ns2:DirectoryServerTransactionId>00d31777-****a440</ns2:DirectoryServerTransactionId>
</ns2:CreditCard3DSecure>
<ns2:Payment>
<ns2:ChargeTotal>78.00</ns2:ChargeTotal>
<ns2:Currency>GBP</ns2:Currency>
</ns2:Payment>
<ns2:TransactionDetails>
<ns2:AirlineDetails>
<ns2:PassengerName>Passenger 03</ns2:PassengerName>
<ns2:TicketNumber>1112299999903</ns2:TicketNumber>
<ns2:IssuingCarrier>iss carrier</ns2:IssuingCarrier>
<ns2:CarrierName>carrier</ns2:CarrierName>
<ns2:TravelAgencyCodeOrIATACode>FRA83292</ns2:TravelAgencyCodeOrIATACode>
<ns2:TravelAgencyName>No Name</ns2:TravelAgencyName>
<ns2:AirlinePlanNumber>FR</ns2:AirlinePlanNumber>
<ns2:AirlineInvoiceNumber>BVQT02</ns2:AirlineInvoiceNumber>
<ns2:ComputerizedReservationSystem>Dr.Blank</ns2:ComputerizedReservationSystem>
<ns2:Restricted>false</ns2:Restricted>
<ns2:TravelRoute>
<ns2:DepartureDate>20150603</ns2:DepartureDate>
<ns2:Origin>LON</ns2:Origin>
<ns2:Destination>PAR</ns2:Destination>
<ns2:CarrierCode>AB</ns2:CarrierCode>
<ns2:ServiceClass>E</ns2:ServiceClass>
<ns2:StopoverType>DIRECT</ns2:StopoverType>
<ns2:FareBasisCode>KI1243</ns2:FareBasisCode>
<ns2:DepartureTax>33.1</ns2:DepartureTax>
<ns2:FlightNumber>729</ns2:FlightNumber>
</ns2:TravelRoute>
<ns2:TravelRoute>
<ns2:DepartureDate>20150723</ns2:DepartureDate>
<ns2:Origin>PAR</ns2:Origin>
<ns2:Destination>MUM</ns2:Destination>
<ns2:CarrierCode>AB</ns2:CarrierCode>
<ns2:ServiceClass>F</ns2:ServiceClass>
<ns2:StopoverType>STOPOVER</ns2:StopoverType>
<ns2:FareBasisCode>DE123456trsa</ns2:FareBasisCode>
<ns2:DepartureTax>10.1</ns2:DepartureTax>
<ns2:FlightNumber>3444</ns2:FlightNumber>
</ns2:TravelRoute>
<ns2:TravelRoute>
<ns2:DepartureDate>20150803</ns2:DepartureDate>
<ns2:Origin>MUM</ns2:Origin>
<ns2:Destination>MAA</ns2:Destination>
<ns2:CarrierCode>AB</ns2:CarrierCode>
<ns2:ServiceClass>E</ns2:ServiceClass>
<ns2:StopoverType>STOPOVER</ns2:StopoverType>
<ns2:FareBasisCode>FF12458</ns2:FareBasisCode>
<ns2:DepartureTax>5.1</ns2:DepartureTax>
<ns2:FlightNumber>293932</ns2:FlightNumber>
</ns2:TravelRoute>
</ns2:AirlineDetails>
<ns2:TransactionOrigin>ECI</ns2:TransactionOrigin>
</ns2:TransactionDetails>
<ns2:Billing>
<ns2:Address1>Flat 412a 123 London Rd</ns2:Address1>
<ns2:City>London</ns2:City>
<ns2:Zip>CH488AQ</ns2:Zip>
<ns2:Country>GB</ns2:Country>
</ns2:Billing>
</ns2:Transaction>
</ns5:IPGApiOrderRequest>
</soap:Body>
</soap:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ipgapi:IPGApiOrderResponse xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
<ipgapi:ApprovalCode>Y:946794:4439845610:PPXU:435049</ipgapi:ApprovalCode>
<ipgapi:AVSResponse>PPX</ipgapi:AVSResponse>
<ipgapi:Brand>MASTERCARD</ipgapi:Brand>
<ipgapi:Country>DEU</ipgapi:Country>
<ipgapi:CommercialServiceProvider>RESELLER</ipgapi:CommercialServiceProvider>
<ipgapi:OrderId>A-fa62ce9a-ef4e-4372-b082-a9ab37e9e69f</ipgapi:OrderId>
<ipgapi:IpgTransactionId>84439845610</ipgapi:IpgTransactionId>
<ipgapi:PaymentType>CREDITCARD</ipgapi:PaymentType>
<ipgapi:ProcessorApprovalCode>946794</ipgapi:ProcessorApprovalCode>
<ipgapi:ProcessorCCVResponse>U</ipgapi:ProcessorCCVResponse>
<ipgapi:ProcessorReferenceNumber>508413435049</ipgapi:ProcessorReferenceNumber>
<ipgapi:ProcessorResponseCode>00</ipgapi:ProcessorResponseCode>
<ipgapi:ProcessorResponseMessage>Function performed error-free</ipgapi:ProcessorResponseMessage>
<ipgapi:SchemeTransactionId>0325MCC821070</ipgapi:SchemeTransactionId>
<ipgapi:TDate>1742909159</ipgapi:TDate>
<ipgapi:TDateFormatted>2025.03.25 14:25:59 (CET)</ipgapi:TDateFormatted>
<ipgapi:TerminalID>80001078</ipgapi:TerminalID>
<ipgapi:TransactionResult>APPROVED</ipgapi:TransactionResult>
<ipgapi:TransactionTime>1742909159</ipgapi:TransactionTime>
<ipgapi:Secure3DResponse>
<v1:ResponseCode3dSecure>1</v1:ResponseCode3dSecure>
</ipgapi:Secure3DResponse> <ipgapi:PaymentAccountReferenceNumber>5665ABCDEFGHIJKLMNOPQRSTUVWXY</ipgapi:PaymentAccountReferenceNumber> </ipgapi:IPGApiOrderResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Updated 21 days ago