OrderCreate RQ

Data Model


Data Model - OrderItems

Schemas

The service adheres to the IATA NDC OrderCreate schema version 17.2, with some modifications

User Guidance - Request Definitions - Service input Parameters

Input ParametersType

Optional/Mandatory

Request object

OrderCreateRQM

<OrderCreateRQ>

AttributesDetails

Optional/Mandatory

Version (Attribute)

Specify NDC schema message version. Always pass 17.2

M

PrimaryLangID (Attribute)

Specifies the agent’s preferred language. Service response will be returned in this language

O
AltLangID (Attribute)

Specifies the preferred language in which the mail to be sent. eTicket receipt email and any other communication emails from BA will be sent in this language

O

<Document>

ElementsDetails

Optional/Mandatory

<Document>

NDC Message Document information

M
<Name>
Document name will be always "BA"O

<Party>

ElementsDetails

Optional/Mandatory

<Party>
M

<AugmentationPoint> - To request for “Airline initiated authentication (3DS1)”

Backport Schema for 3DSecure payment capabilities for NDC 17.2 messages
ElementsDetails

Optional/Mandatory

<AugmentationPoint>

O
<SecurePayment>
M
<PaymentMethodCriteria>

Populate this section only if the seller/agent wants to carry out “Airline initiated authentication (3DS1)”

O
<PaymentCardCriteria>
O
<CardBrandCode>

A two-letter card code


Example: VI
M
<SecurePaymentAuthenticationVersion>Used by Seller if 3D-Secure is supported. Seller can specify which version of 3d-Secure is supportedO
<SupportedVersionText>

Specifies the exact supported 3D-Secure version


Allowed value

 

3DS1

M
<TypeCode>

The payment method type. Examples: Credit Card, Cash

IATA definition from codeset 9888

The code can be one of the following from the table depending on the form of payment being used

Code       

Description

CC          

Card

CA            

Cash

MS

eVoucher

For card payments it will always be “CC” regardless of credit or debit card

M

<AugmentationPoint> - Seller completes authentication and provides authenticated data (3DS2)

Backport Schema for 3DSecure payment capabilities for NDC 17.2 messages
ElementsDetails

Optional/Mandatory

<AugmentationPoint>

O
<SecurePayment>
M
<PaymentProcessingDetails>

Populate this section only to pass “Seller initiated” authenticated data

O
<Amount>

The amount applied to the associated payment method


Example: 300
M
CurCode (Attribute)

Currency Code


Example: GBP

O
<PaymentMethod>
O
<PaymentCard>
O
<SecurePaymentVersion2>

Contains all information for the result of 3D-Secure authentication process

O
<AuthenticationMerchantName>

Name of the merchant


Example: Agentname*British Airways
O
<AuthenticationTokenValue>Authentication value of a TokenO
<AuthenticationValue>

Authentication value

Example:

AAq64FHTYBBqwertyRRttdVZU54=


O

<CardNumberCollectionCode>

Indicates the collection method of the card number. This will be newly entered or using previously saved information. This is supported by a enumerated list


Enumeration values:

K

S


Where

K - Keyed in for this transaction

S - Card on file (previously stored credentials)


O
<DirectoryServerTrxID>

DS (Directory Server) transaction ID


Example:

13c701a3-5a88-4c45-89e9-ef65e50a8bf9
O
<ElectronicCommerceInd>

ECI (electronic commerce indicator)


Example: 05
O
<PayerAuthenticationExemptionCode>

Used to identify an exemption to performing payer authentication. An enumeration includes the types of exemption


Enumeration values:

TR

TB

LV

SC

DA

MA

AD


Where

AO - Authentication Outage

DA - Delegated authentication

LV - Low Value Exemption

MA - Merchant Problem or Major Outage

ND - None defined

SC - Secure Corporate Exemption

TB - Trusted Beneficiary Exemption

TR - Transaction Risk Analysis Exemption


O
<PayerAuthenticationFailureToCompleteCode>

Used to identify possible pre-defined reasons for failure to complete payer authentication. This is supported by a enumerated list


Enumeration values:

NC

NS


Where

NC- Authentication Not Complete

NS - Authentication Not Successful
O
<PaymentTrxChannelCode>

Indicates the payment transaction channel. This is supported by a enumerated list


Enumeration values:
MO

TO

EC

FA


Where

MO - Mail order (paper mail, fax and email)

TO - Telephone order/IVR

EC - Electronic commerce

FA - Face to face

NS - Other not specified
O
<ProgramProtocolText>

3DS version without dots

Example: 210

O
<TrxStatusReasonText>Outcome of authentication coming from the DS - see EMVCO documentation for list of possible values.O
<TrxStatusText>Outcome of authenticationO
<TypeCode>

The payment method type. Examples: Credit Card, Cash

IATA definition from codeset 9888

The code can be one of the following from the table depending on the form of payment being used

Code       

Description

CC          

Card

CA            

Cash

MS

eVoucher

For card payments it will always be “CC” regardless of credit or debit card
M

<Query>

ElementsDetails

Optional/Mandatory

<Query>
M

<Order> - Long Sell

ElementsDetails

Optional/Mandatory

<Order>

Order to be created.

Specifying individual Order Item Sets and their associated Offer Item(s). 

M
<OrderItem>

Used for selling by value (long sells).

M
<OfferItemID>

The airline-assigned unique Offer Item ID. Pass a unique number for each OfferItem
Example: 1

M
Owner (Attribute)
Always pass “BA”M
<OfferItemType>

Offer Item Type.

OfferItem for all passengers of the same type.

M
<DetailedFlightItem>
Flight offer itemM
refs (Attribute)

Reference to passengers to whom the flight item is specified. The passenger reference should be the same as what was defined in /wiki/spaces/A1S/pages/524484739.

If this flight item is applicable for 2 passengers then refs should be T1 and T2 separated by a space

Example: T1 T2

M
<Price>

Flight pricing details (fare and tax) for one passenger of the pax type

This must be the same as what was returned in the OfferPrice response. The total fare and total tax are compared against the total fare and total tax returned during the booking process and if the price doesn’t match an error is returned.

M
<BaseAmount>

This is the total fare for one passenger of the passenger type. This must be the same as what was returned in the OfferPrice response

Example: 266

M
Code (Attribute)
M
<Taxes>
Ticket Tax/fee/charge details to indicate taxes that apply to the country of commencement of travel and routingM
<Total>

This is the total tax for one passenger of the passenger type. This must be the same as what was returned in the OfferPrice response
Example: 373

M
<OriginDestination>

Origin and destination (O&D) details. This must be repeated for each O&D. If the request is for EDI-AMS return then this must be repeated twice once for EDI-AMS and once for AMS-EDI.

M
<Flight>
List of flights within an O&D. If the request is for EDI-AMS return with each O&D containing 2 flights (EDILHR and LHRAMS; AMSLHR and LHREDI) then for each O&D Flight should be repeated twice once for EDILHR and once for LHRAMSM
<SegmentKey>

Unique flight segment key
Example: F1

This key will be used to associate seat item on a flight. Specify this key only for the first DetailedFlightItem, as the flight items are the same for all passengers

O
<Departure>
Departure (origin) Airport, Date and Time information.M
<AirportCode>

Departure airport IATA code

Example: LHR
M
<Date>

Local Departure date i.e. local to the departure location

Example: 2015-08-13
M
<Time>

Local Departure time i.e. local to the departure location

Example: 08:30

<Arrival>
Arrival informationM
<AirportCode>

Arrival airport IATA code

Example: AMS
M
<Date>

Local Arrival date i.e. local to the arrival location
Example: 2015-08-19

O
<Time>

Local Arrival time i.e. local to the arrival location
Example: 11:10

O
<MarketingCarrier>

Marketing Carrier information.

M
<AirlineID>

Marketing carrier code

Example: BA
M
<Name>
Airline Name.
Example: British Airways

<FlightNumber>

Marketing flight number

Example: 1403

M
<ClassOfService>

Selling or booking class details

M
refs (Attribute)

Reference to a fare basis code for the passenger type applicable for this OfferItem

Example:

FBCODE1ADT

FBCODE1CHD

FBCODE1INF

M
<Code>

Selling class or Booking class code

Example: Q
M
<SeatItem>

This list should be repeated for each passenger and for each flight they purchase the seat for. The details specified in this section must have been taken from SeatAvailabilityRS

Example: If the request is for 2 ADT and 2 flights (LHRAMS and AMSLHR) and both passengers are buying seats in both flights then SeatItem must be repeated 4 times

O
refs (Attribute)

Reference to a passenger and flight on which the seat reservation is requested.

Example: T4 F1

M
<Price>

Seat price

M
<Total>


M
<SimpleCurrencyPrice>

Total price for the seat.
Example: 15.00

M
<Descriptions>

This is the Seat Description.

M
<Description>

M
<Text>

The seat category this seat belongs to
Example: GeneralSideSeat

M
<Location>

Seat location details 

M
<Column>

Seat column.
Example: A

M
<Row>
Seat row number and row characteristicsM
<Number>

Seat row number.
Example: 2

M
<BaggageItem>

A bag item with bag quantity, passenger & flight details.

O

refs (Attribute)

Reference to a passenger and flight(s) on which the additional bag is requested.

Example: T4 F1

M

<Price>

Bag(s) Price

M

<Total>

M

<SimpleCurrencyPrice>

Total price for the bag(s)
Example: 15.00

M

<BagDetails>

Bag details should be passed here

M

<BagDetail>

M

<ValidatingCarrier>

Should always by ‘BA’

M

<CheckedBags>

M

<CheckedBag>

M

<PieceAllowance>

M

<ApplicableParty>

Should Always be ‘Party’

M

<TotalQuantity>

Number of bags

M

<PieceMeasurements>

M

Quantity (Attribute)

Number of bags

M

<Order> - Short Sell

ElementsDetails

Optional/Mandatory

<Order>

Order to be created.

Specifying individual Order Item Sets and their associated Offer Item(s). 

M
<Offer>
Offer selected by the Passenger for requesting an Order to be created. Multiple Offers can be requested at the same timeM
OfferID (Attribute)

Reference to the OfferID of the selected Offer returned in a previous OfferPrice/SeatAvailability/ServiceList response.

M
Owner (Attribute)
Example: BAM
ResponseID (Attribute)
Reference to unique shopping session response ID, as provided in the previous OfferPrice/SeatAvailability/ServiceList response.
M
<OfferItem>
OfferItem selected by the Passenger for inclusion in the requested Order. Repeat occurrence of OfferItem (once per passenger) if different passengers want to select different service options, different quantities of a-la-carte items or different seat locations. As a minimum, all mandatory OfferItems from the desired offer should be explicitly defined within these selections and should repeat the same Passenger and Flight Segment associations defined in the originating OfferItems.M
OfferItemID (Attribute)
Pass the OfferItemID that is returned in OfferPrice/SeatAvailability/ServiceList reponse for the selected offer
Example: OF-3749b7c1-ddcb-455c-9f46-394e64307387-OI-1


<PassengerRefs>
Reference to the passenger(s) for which this OfferItem and selected Services (bag or seat) applies.
M
<SeatSelection>

Selection of specific seat location, as provided in Seat Availability response. When used, only a single Passenger must be referenced for a single Segment

M
Row (Attribute)
Seat row number. Example: 2M
Column (Attribute)
Seat column to identify a particular seat position on an aircraftM

<Payments>

ElementsDetails

Optional/Mandatory

<Payments>

Specify payment information

O
<Payment>
BA accepts one card form of payment per bookingM
<Type>

The form of payment type. Examples: credit card, cash and e-voucher.

M
<Method>
Payment Form Details.M
<PaymentCard>

Specify all mandatory information as returned by OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

(info)Note: This must be provided if a card is used as the form of payment

M
<CardCode>

Example: VI

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<CardNumber>

Example: 41111111111111111

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<SeriesCode>

This is the verification digits printed on the card following the embossed number. This may also accommodate the customer identification/batch number (CID), card verification value (CVV2), card validation code number (CVC2) on credit card.

Example: 123

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<CardHolderName>

Cardholders name

Example: Mr Test Smith

M
<CardHolderBillingAddress>

Specifies the payment card address or Billing address

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<Street>

This is a list and can be repeated twice to specify 2 Streets

Example:

< Street1>1234 Main Street</Address>

<Street2>Pontes Avenue</Address>

(info)Note: Specify only Street 1 if Street 1 was mandatory and specify  both Street 1 and 2 if both Street 1 and Street 2 were returned as mandatory in OfferPriceRS or OrderViewRS 

M
<CityName>

City name

Example: LONDON

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<StateProv>

State or province code

Examples: NY

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<PostalCode>

Postal Code

Example: SW3 1XH

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderCreateRS (returned as part of an error when payment card passed in OrderCreateRQ is not applicable)

M
<CountryCode>

Billing country code (2 letter code)

Example: GB

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<Surcharge>

Surcharge fee applicable for the payment card

(info)Note: This must be specified if it was returned as a mandatory for the card in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in AirDocIssueRQ is not applicable)

M
<Amount>

Provide total surcharge amount for all passengers that were returned in the OfferPriceRS or OrderViewRS

Example: 5

M
Code (Attribute)

Currency code

 Example: GBP

This should be the same as what was returned in the OfferPriceRS.

(info)Note: For the BA services, this must be passed

M
<EffectiveExpireDate>
Payment Card Effective and/ or Expiration date(s).M
<Effective>

Specifies payment card start date

Example: 0812

Where 08 = Month

12 = Year

(info)Note: This must  be specified as mandatory in OfferPriceRS or OrderViewRS (returned as part of the error when a payment card is passed in OrderCreateRQ is not applicable)

M
<Expiration>

Specifies payment card expiry date

Example: 0815

Where 08 = Month

15 = Year

(info)Note: This must be specified if it was returned as a mandatory in OfferPriceRS or OrderViewRS (returned as part of error when payment card passed in OrderCreateRQ is not applicable)

M
<Amount>

The amount payable by Card. This should include a card surcharge as well for card payment

Example: 500.55


M
code (Attribute)

Currency code

Example: GBP

M
<Payer>
O
<ContactInfoRefs>
Ref to 3rd party payer contact informationM
ElementsDetails

Optional/Mandatory

<Cash>

(info)Note: This must be provided if cash is used as the form of payment (only available for agents registered for BSP settlement)

O
CashInd (Attribute)
This should always be “True” for cash paymentM
<Amount>

Total amount payable by cash. 

Example: 500.55

M
Code (Attribute)

Currency code

 Example: GBP

M
ElementsDetails

Optional/Mandatory

<Voucher>

Pass this section if the form of payment is eVoucher

O

<Number>

A 13-digit e-voucher number E.g. 125-1234567890

M

<Name>

Name details of the e-voucher

M

refs (Attribute)

All the passenger references within the OrderCreate request

Example: SH1, SH2

M

<Surname>

Surname of the voucher owner

M

refs (Attribute)

Contact reference of the e-voucher owner email address.

Note:

If the voucher owner email address is one of the passenger contact email address, then the same passenger contact reference can be passed in this element.
If the voucher owner email address is not the contact email address of any of the passengers within the booking, then a separate contact element with e-voucher owner email address should be passed in the ContactList and that contact reference should be passed in this element.

M

<Amount>

Total amount payable from e-voucher. 
Example: 1451.00

M

Code (Attribute)

Currency code
Example: GBP

M

<Offers>

Flight offer details, which include offer ID, response ID and OfferItemIDs

M

<Offer>

Flight offer details, which include offer ID, response ID and OfferItemIDs

M

OfferID (Attribute)

Flight offer ID from the OfferPrice response
Example: OF-925d9c43-0ed0-4b23-95a8-7f94b12bc283

M

Owner (Attribute)

Airline code
Example: BA

M

Response ID (Attribute)

Response ID from the OfferPrice response
Example: op08.tx-08-01-1-d8e614eb-600f-4eee-a6f7-b0a09c43cc1c

M

<OfferItemID>

All the OfferItemIDs from the OfferPrice response
Example: OF-925d9c43-0ed0-4b23-95a8-7f94b12bc283-OI-1

Note: This element can be repeated if there is more than one OfferItemID in the offer price response

M

<DataLists>

ElementsDetails

Optional/Mandatory

<PassengerList>

List of all passengers with Passenger type code (PTC).

M
<ContactList>

List of contacts for passengers, e-voucher owners, and payers.

M

<MetaData>

ElementsDetails

Optional/Mandatory

<RuleMetadatas>
O