OrderCreate RQ

Request object

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

AltLangID (Attribute)

<Document>

NDC Message Document information

<Name>

<Party>

<AugmentationPoint>

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

A two-letter card code

Specifies the exact supported 3D-Secure version

Allowed value

3DS1

<AugmentationPoint>

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

The amount applied to the associated payment method

CurCode (Attribute)

Currency Code

Example: GBP

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

Name of the merchant

Authentication value

Example:

AAq64FHTYBBqwertyRRttdVZU54=

O

DS (Directory Server) transaction ID

Example:

ECI (electronic commerce indicator)

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

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

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

3DS version without dots

Example: 210

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

<Query>

<Order>

Order to be created.

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

<OrderItem>

<OfferItemID>

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

Owner (Attribute)

<OfferItemType>

Offer Item Type.

OfferItem for all passengers of the same type.

<DetailedFlightItem>

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

<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.

<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

Code (Attribute)

<Taxes>

<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

<OriginDestination>

<Flight>

<SegmentKey>

<Departure>

<AirportCode>

Departure airport IATA code

<Date>

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

<Time>

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

<Arrival>

<AirportCode>

Arrival airport IATA code

<Date>

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

<Time>

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

<MarketingCarrier>

Marketing Carrier information.

<AirlineID>

Marketing carrier code

<Name>

<FlightNumber>

Marketing flight number

Example: 1403

<ClassOfService>

Selling or booking class details

refs (Attribute)

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

Example:

FBCODE1ADT

FBCODE1CHD

FBCODE1INF

<Code>

Selling class or Booking class code

<SeatItem>

refs (Attribute)

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

Example: T4 F1

<Price>

Seat price

<Total>

<SimpleCurrencyPrice>

Total price for the seat.
Example: 15.00

<Descriptions>

This is the Seat Description.

<Description>

<Text>

The seat category this seat belongs to
Example: GeneralSideSeat

<Location>

Seat location details 

<Column>

Seat column.
Example: A

<Row>

<Number>

Seat row number.
Example: 2

<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>

Order to be created.

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

<Offer>

OfferID (Attribute)

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

Owner (Attribute)

ResponseID (Attribute)

<OfferItem>

OfferItemID (Attribute)

<PassengerRefs>

<SeatSelection>

Row (Attribute)

Column (Attribute)

<Payments>

<Payment>

<Type>

<Method>

<PaymentCard>

<CardCode>

Example: VI

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)

<CardNumber>

Example: 41111111111111111

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)

<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

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)

<CardHolderName>

<CardHolderBillingAddress>

Specifies the payment card address or Billing address

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)

<Street>

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

Example:

< Street1>1234 Main Street</Address>

<Street2>Pontes Avenue</Address>

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 

<CityName>

City name

Example: LONDON

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)

<StateProv>

State or province code

Examples: NY

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)

<PostalCode>

Postal Code

Example: SW3 1XH

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)

<CountryCode>

Billing country code (2 letter code)

Example: GB

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)

<Surcharge>

Surcharge fee applicable for the payment card

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)

<Amount>

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

Example: 5

Code (Attribute)

Currency code

 Example: GBP

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

Note: For the BA services, this must be passed

<EffectiveExpireDate>

<Effective>

Specifies payment card start date

Example: 0812

Where 08 = Month

12 = Year

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)

<Expiration>

Specifies payment card expiry date

Example: 0815

Where 08 = Month

15 = Year

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)

<Amount>

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

Example: 500.55

code (Attribute)

Currency code

Example: GBP

<Cash>

CashInd (Attribute)

<Amount>

Total amount payable by cash. 

Example: 500.55

Code (Attribute)

Currency code

 Example: GBP

Pass this section if the form of payment is eVoucher

O

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

M

Name details of the e-voucher

M

All the passenger references within the OrderCreate request

Example: SH1, SH2

M

Surname of the voucher owner

M

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

M

Currency code
Example: GBP

M

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

M

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

M

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

M

Airline code
Example: BA

M

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

M

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

<PassengerList>

<ContactList>

<RuleMetadatas>