AirFrance KL - AirDocIssue This document describes the AirFrance KL AirDocIssue Service Document Version: 1.0 Document Status: approved Date of last Update: 10/26/2017 Document Location: https://developer.airfranceklm.com/ Revision History Date Version Summary of Changes 25/10/2017 1.0 Document 1 st release Linked Documents Document Filename Version Location TABLE OF CONTENTS 1. Overview... 1 2. Invocation... 2 2.1. AirDocIssueRQ... 2 2.2. OrderViewRS... 4 3. Process Steps... 7 4. Business Rules... 7 4.1. Parties... 7 4.1.1. Sender... 7 4.1.2. Participant... 7 4.1.3. Recipient... Error! Bookmark not defined. 4.2. Order & order item definition... 7 4.2.1. Order... 7 4.2.2. Order item... 7 4.3. Payment... 7 4.3.1. Total payment... 7 4.3.2. Payment by BSP... 7 4.3.3. Payment by credit card through the tokenisation wall... 8 Document : BSD SOA Business Service Description.doc Page: ii
4.4. Quoting process... 8 4.4.1. Fare basis definition... Error! Bookmark not defined. 4.4.2. Rule... 8 5. Business Exceptions... 9 5.1. andatory elements... 9 5.2. BSP Payment... 9 5.3. Payment time limit exceeded... 9 6. Policies... 10 Document : BSD SOA Business Service Description.doc Page: iii
1. Overview Goal: AFKL message corresponds to the IATA NDC AirDocIssue schema version 17.1. This message enables to pay and issue an order. An Order have been created first using the CreateOrder service. Form of payment in scope are: BSP settlements and credit/debit cards. This service needs to be sent to another touch point : AD wall instead of AF/KL, for tokenization. This service can also be used in case of the travel agent wants to reissue the tickets : after itineraryreshop and OrderChange messages Under development. It can also be used to issue the ED after the booking of seats and/or Bags Under Development Result(s): When called the service returns a paid and ticketed order. SCOPE IN Scope equals to global/shopping scope : One way, round trip, 1 to 9 passengers, ADT, CHD, INF, AF and KL marketing flights, Public and Corporate fares, only flights, no ancillaries. Form of payment allowed : BSP settlment, Credit/debit cards Full issuance of tickets Request : Order ID Payment type and details Results: Payment is done and tickets are issued SCOPE Coming Soon Invoice EDs (Ancillaries Seats and Bags.) Youth/senior Abonnés (subscribers cards) SCOPE To be planned General: Private fares Rich Content ulti City (Open Jaw, Stop) HOP marketing flights U Specific to issuance and payment service: Document: BSD SOA Business Service Description.doc Page: 1
Other Form of payment ulti Form of payment ARC settlement Partial payment Interaction Type: Request/Reply Pre-Condition(s): AirShoppingRQ/RS and OrderCreateRQ/RS messages have been called. Offers have been suggested to the sender, one offer have been converted into one order. Post-Condition(s): N/A Support Process 1. If any issues are encountered on the services, the third party support will do a 1 st analysis to exclude a problem on third party side 2. If the issue comes from AFKL, the third party support will raise an incident ticket to AFKL support. 3. AFKL wil analyse and resolve the issue and revert to the Third Party 2. Invocation This service is triggered by a request received from an external actor (travel agency, aggregator etc.). 2.1. AirDocIssueRQ = andatory; O = Optional; C = Conditional Business Information Description /O Remark/Example Sender : travel agency Agency name Name of the travel agency Ex: Tour Travel Type Type of agency O Example: TA, OTA, TC IATA number Ex: 67890890 Pseudo-city Pseudo city code of the travel agency Example: PAR11LL Agency ID ID of the travel agency This field is mandatory in the NDC grammar, but AFKL will not use it. Recommendation is to put the IATA number in this field. Participants is the party through who the message will pass O Document: BSD SOA Business Service Description.doc Page: 2
NDC Enabled System Participant C Name Name of the enabled system participant ust be decided between the third party and AFKL System ID Unique external system ID ust be decided between the third party and AFKL Aggregator participant C Name Name of the aggregator Example: Travel Fusion ust be decided between the third party and AFKL. Aggregator ID Unique external ID of the aggregator Example: TF ust be decided between the third party and AFKL. Recipient Is the airline which receives the request ORA Recipient Offer Responsible Airline who AF or KL receives the request Name Name of the airline O Possible values: Air France or KL Airline ID IATA code of the airline Possible Values: AF or KL. Order ID The order to be pay Ex f5e09339-e0bf-4b90- ac22-43b34ee88bc8 Quantity of ticket Passengers Payments Payment Type Quantity of ticket to be issued in the order Passengers for who tickets have to be issued Payment details needed to pay the order Form of payment selected to pay the order (BSP or payment card) Payment card Payment by card C Only full issuance is possible, it must be equal to the total nr of document to be issued. Only full issuance is possible, it must contain all pax references. Use the payment types provided in the OrderViewRS. Type of card List of cards accepted provided below C Ex: VISA Document: BSD SOA Business Service Description.doc Page: 3
Series code Series code of the card C Ex: 123 Name of the card holder Name of the card holder C Ex:. John Dupont Billing address Billing address of the card holder C Street Street of the billing address C Ex: Labourdonnais City name City name of the billing address C Ex: St Denis Postal Code Postal code of the billing address C Ex: 97400 Country code Country code of the billing address C Ex: FR Effective Expire Date Expiration date C Ex: 0819 Card Number Tokenized Card Number 2.2. OrderViewRS Business Information Description Card number in clear through the Amadeus wall Tokenized number of the payment card C Ex: 4789876578 C Will be completed by Amadeus Wall = andatory; O = Optional; C = Conditional /O Remark/Example Order ID ID of the order created Ex:Ife61051a-bb11-48b2- a861-7f85c2ac5d82 PNR reference Booking reference Ex: WGWOV5 Total Order Price Total price of the order (base amount + taxes) and currency Ex: 150EUR Status Status of the order Encoding Scheme: IATA Padis Codeset - List for data element 4405 (status coded) Order item ID/ Offer item ID/ Service ID associations Associating each order item to its corresponding offer item and services Ex:ce41ae84-63b8-43bc- 82a8-932e5cd44b7c ce41ae84-53b8-43bc-82a8-932e5cd45b7c ce41fr84-53b8-43bc-82a8-932e5cd44b7c Order ID item ID of the order item created The order item corresponds to an offer item Document: BSD SOA Business Service Description.doc Page: 4
Price of the order item Detailed price of the order item (base amount + taxes) and currency Ex: 1500EUR Tax Details Details of the tax included in this item Ex: 100EUR Passenger references Segment references Tickets information An order item includes passengers with the same price References to the flight segments provided in the order item Passengers details is provided Below Segment details is provided below Type Type of ticket Only Ticket, EDs are under development Possible value: T Document number Ticket document number Ex: 057-2398590355 Payment Payment Status Status of the payment Example: Paid Cash Order paid by cash C Applicable if payment by cash Card Type Card use to pay the order C Applicable if payment by card Tokenised Card Number Tokenised card number used to pay the order C Applicable if payment by card Passenger Information Information of the passenger referenced in the order item Same information is provided for each passenger Type Typology of the passenger Ex: ADT Title Title of the passenger Ex: r Last name Name of the passenger Ex: Dupont Email address andatory for the booker Ex: Test@test.fr Phone number Phone number of the passenger C Ex: +3356789008 Loyalty Program O Program Name Flying Blue program O Ex: KL Account number Flying blue account number O Ex: 67876897 Tier name Tier level of the passenger O Ex: IVORY Origin & Destination Airport code or city code of origin and destination Total Journey Total journey between origin and destination Ex: Document: BSD SOA Business Service Description.doc Page: 5
Segment information Details of the segment referenced in the order item Same information is provided for each segment of inbound/outbound Departure/Arrival Name of the airport of Departure/Arrival Ex: Charles de Gaulle Airport Name Departure/Arrival Code of the airport of Departure/Arrival Ex: CDG Airport Code Departure/Arrival Date and time Date and time of the travel of Departure/Arrival Ex: January 24 th 2017, 09:10 Change of day If applicable at landing C Ex: (+1) Cabin Name of the cabin Ex: Business arketing flight Flight number and carrier code Ex: AF 6789 Operating flight Flight number and carrier code Ex: KL 1234 Equipment Equipment Ex: Aircraft Code and name (318/ Airbus) Flight duration Flight duration Ex: 08h50 Ticket Conditions Checked baggage Number of checked baggage authorised Example: 2 allowance Advance purchase Condition of advance purchase : C Example: P0Y20DT0H00.000S Advance stay Condition of minimum and maximum stay C Example: 6 months Cancellation/Change Cancellation or change of the order C Application Allowed before or after departure C Possible values : - ADE= After Departure - PDE = Prior to Departure Penalties Penalties to pay if cancellation or changec Example: 150 EUR applied No Show Possibility to board on another flight C Example: NOS Fare description Fare Basis Code of the fare basis Example: UAFPREV Fare code Public or Private fare IATA PADIS Code set Corporate OIN of the corporate if the booking is a corporate booking. O Example: KV07 Document: BSD SOA Business Service Description.doc Page: 6
3. Process Steps The OrderCreate service can be used in the following sequence of services: - AirShoppingRQ/RS - FlightPriceRQ/RS - Optional - OrderCreateRQ/OrderViewRS - AirDocIssueRQ/OrderViewRS 4. Business Rules 4.1. Parties 4.1.1. Sender The Sender must be the travel agent requesting for the order. It has to be the same as the one who received the Offers 4.1.2. Participant The Participant is either the party through which the NDC message (aggregator or NDC enabled system) or the party on behalf which the request is done (a corporate). 4.1.3. Recipient The recipient is the party receiving the NDC message. It is either Air France or KL. 4.2. Order & order item definition 4.2.1. Order An Order contains the flights a passenger is entitled to, and that need to be delivered. The content of an Order includes one or multiple Order Items (with a unique Airline-assigned Order Item ID), individually priced items within the Order. 4.2.2. Order item An order item has a one to one relationship with an offer item (i.e.: an offer item is converted into an order item). An order item includes one or multiple passengers travelling on the same segments and consuming the same services at the same price. A service can either be flights or ancillaries (currently AFKL does not offer any ancillary). 4.3. Payment 4.3.1. Total payment Currently, our service only supports total payment, which means all order items of an order have to be paid in once. Partial payment will be covered in a later version of the schema. 4.3.2. Payment by BSP The sender can choose to pay by BSP. Document: BSD SOA Business Service Description.doc Page: 7
If payment by BSP is chosen, NDC application checks within the NDC agency database if the Sender is BSP accredited. If yes, NDC application authorises the request. If not, NDC application sends back an error message. 4.3.3. Payment by credit card through the tokenisation wall AFKL has externalised its PCI DSS compliancy. The agency can send credit card in clear, the AirDocIssueRQ message will go through the Amadeus tokenisation wall which will tokenise the credit card information so it does not enter in clear in our system. 4.4. Quoting process 4.4.1. Rule If there is at least one adult fare basis in the quote, all passengers included in the order has the adult fare basis. To quote an order for an adult + a senior: the adult fare basis is applied for both passenger. To quote an order for a senior only: the senior fare basis is applied. Same rule is to be applied for other youths. Document: BSD SOA Business Service Description.doc Page: 8
5. Business Exceptions 5.1. andatory elements If one of the mandatory elements are not provided in the request, an error message should be sent to the consumer. 5.2. BSP Payment If the Sender is not accredited BSP, NDC application declines the request and sends backs an error message: BSP accreditation failed. 5.3. Payment time limit exceeded If the payment time limit is exceeded, the order cannot be paid and no ticket can be issued. An error message payment time limit exceeded is sent. The requestor has to re-shop. 5.4. All errors codes Code Error message (ShortText) Description 911 Internal error (unknown internal technical error) 911 ORDER_PAYENT_REQUEST_ISSING_ORDER_ITES 911 NO_ORDER_ITES 129 NO_OPEN_ORDER No PNR atch Found 911 ORDER_ITE_NOT_FOUND 911 ORDER_TRANSACTION_NOT_FOUND 911 OFFER_ERROR 293 OFFER_EXPIRED Unable to Sell Due to Sales Limit being Reached 911 OFFER_ITE_NOT_FOUND 911 OFFER_ITE_PASSENGER_NOT_ATCHING 260 FREQUENT_FLYER_PROGRA_ISATCH Invalid Frequent Traveller Number 911 ULTIPLE_ACCOUNT_CODES 467 FLIGHT_SEGENT_NOT_FOUND Flight segment not found in carriers PNR 911 OFFER_ALREADY_IN_ORDER 911 ORDER_CHANGE_NOT_ALLOWED 466 NO_PAYENTS_IN_REQUEST Form of payment missing or invalid for ticket/document 911 PAYENT_ALREADY_STARTED 911 ORDER_PAYENT_REQUEST_ISSING_ORDER_ITES 911 UNABLE_TO_CREATE_AIR_PRODUCT_LAST_SEAT_SOLD Document: BSD SOA Business Service Description.doc Page: 9
129 UNABLE_TO_CREATE_AIR_PRODUCT 376 UNABLE_TO_QUOTE_AIR_PRODUCT 376 UNABLE_TO_QUOTE_SERVICES Pricing/ticketing error, text information specified 911 UNABLE_TO_RESERVE_SERVICES 318 VALIDAITON_ERROR_PASSENGERFIELD 911 PASSENGER_ATTRIBUTE_UNEXPECTED 911 FIELD_ISSING 911 DATE_OF_BIRTH_IN_FUTURE 911 PASSENGERTYPE_DATE_OF_BIRTH_ISATCH 920 Credit card payment has failed 921 Credit card payment is declined 922 Credit card payment is fraudulent 923 Credit card payment state is unknown 924 Cash payment has failed 925 Cash payment has an unknown status 6. Policies Business Criticality <Sensitive > Business Volume < > Business Use <7/24> Information classification according AF/KL Security office Availability 3 Critical Downtime cannot exceed 4 hours (impact > 1) 2 Sensitive / Significant Downtime may exceed 4 hours but is less than a maximum defined in the GOA General Operating Agreement or specified in chapter 6. 1 - Normal Best effort (impact < 10 K) Specification of additional availability requirements Confidentiality 3 Secret Information whose unauthorized disclosure (even within the organization) would cause serious damage to the interests of AFKL 2 Confidential Information whose unauthorized disclosure (even within the organization) would cause significant harm to the interests of AFKL) 1 Internal use only Document: BSD SOA Business Service Description.doc Page: 10
Integrity Accountability Interface Variant Information whose unauthorized disclosure, particularly outside of AFKL, would be inappropriate and inconvenient 0 Unrestricted Public domain information which requires no special protection measures As well as the above classifications it is possible to make use of the following qualifiers: Under Embargo The information is to be put and remain at a certain classification level until a predetermined date. At that time the embargo is lifted and the information will revert to a lower classification. Both classifications and the date of change should be indicated Personal The information is intended for an individual and may contain sensitive personal information and should therefore be treated as Addressee only. Access is limited therefore to the person for whom the information is intended. Specification of additional confidentiality requirements 3 high No loss of integrity is tolerated and corrective measures are in place to prevent any change to the original state of the information 2 medium Loss of integrity would significantly damage AFKL interests and corrective measures are in place to restore to the original state within a predetermined amount of time 1 low Loss of integrity should be logged Specification of additional integrity requirements 3 High Authentication and access to the information must be logged and preserved for a fixed period. Non-adherence of these constraints would cause serious harm to the interests of AFKL 2 medium Access to the information must be logged and preserved for a fixed period 1 low Access to the information need not be logged Specification of additional accountability requirements Specification of requirements for additional variation in interface Document: BSD SOA Business Service Description.doc Page: 11