1. British Airways NDC API 17.2
  2. OrderChange Overview
  3. Confirm Held Booking

Confirm Held Booking RQ

Created by Darren Grimshaw
Last updated Nov 16, 2020





 OrderChangeRQ - Confirm Held Booking

Data Model


Schemas

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

User Guidance - Request Definitions - Service Input Parameters

Input ParametersType

Mandatory/Optional

Request objectOrderChangeRQM


<OrderChangeRQ>

ElementsDetails

Mandatory/Optional

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
Example: EN

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

Mandatory/Optional

<Document>
NDC Message Document informationM
<Name>
Document name will be always "BA"O

<Party>

ElementsDetails

Mandatory/Optional

<Party>
»Party & Sender DefinitionM

<Query>

ElementsDetails

Mandatory/Optional

<Query>

M
<OrderID>

Booking reference or PNR reference
Example: YOMH3W

M
<AcceptRepricedOrder>

Function to accept the proposed Order, as it has been repriced and returned in the preceding OrderReshopRS.

M

<ResponseID>

Response ID returned in the preceding OrderReshopRS

M

<Payments>

Specify payment information

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


The form of payment type. Examples: Credit Card, Cash, Miscellaneous - for E-Vouchers.

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

This section needs to be populated if the form of payment is a card.

M
<CardCode>

Example: VI

M
<CardNumber>

Example: 41111111111111111

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

M
<CardHolderName>

The Card holder's name

Example: Mr Test Smith

M
<CardHolderBillingAddress>

Specifies the payment card address or Billing address

(info)Note: Though this is optional in NDC schema, it must be specified if it was returned as a mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ 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 OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable)

M
<CityName>

City name

Example: London

M
<StateProv>

State or province code

Examples: NY

M
<PostalCode>

Postal Code
Example: SW3 1XH

M
<CountryCode>

Billing country code (2 letter code)
Example: GB

M
<Surcharge>

Surcharge fee applicable for the payment card.

M
<Amount>

Provide total surcharge amount for all passengers that were returned in the OrderReshopRS. 
Example: 5

M
Code (Attribute)

Currency code
Example: GBP

This should be the same as what was returned in the OrderReshopRS or OrderViewRS

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

Specifies payment card start date
Example: 0812 - Where 08 = Month and 12 = Year

M
<Expiration>

Specifies payment card expiry date
Example: 0815 - Where 08 = Month and 15 = Year

M
<Amount>

Total 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

Mandatory/Optional

<Query>

 

M

<OrderID>

Booking reference or PNR reference
Example: YOMH3W

M

<AcceptRepricedOrder>

Function to accept the proposed Order, as it has been repriced and returned in the preceding OrderReshopRS.

M

<ResponseID>

ResponseID returned in the preceding OrderReshopRS

M

<Payments>
Specify payment informationM
<Payment>

M
<Type>
The form of payment is Cash.
<Method>
Payment Form Details.
<Cash>

Cash is used as the form of payment (only available for agents registered for BSP settlement)

M
CashInd (Attribute)
This should always be “True” for cash payment.M
<Amount>

Total amount payable by Cash. 
Example: 500.55

M
Code (Attribute)

Currency code
Example: GBP

M

<Query>-
<OrderID>Booking reference or PNR reference
Example: YOMH3W
<AcceptRepricedOrder>Function to accept the proposed Order, as it has been repriced and returned in the preceding OrderReshopRS.
<ResponseID>ResponseID returned in the preceding OrderReshopRS
<Payments>Specify payment information
<Payment>e-voucher payment can be combined with cash or card payment if voucher does not cover the total cost of flights for all the passengers in the booking or if booking has any paid ancillary. This section should be repeated with cash/card details for the additional payment.
<Type>The form of payment is MS
<Method>Payment Form Details
<Voucher>Cash is used as the form of payment (only available for agents registered for BSP settlement)
Populate this section if the form of payment is cash (BSP settlement)
<Number>E-voucher number. Usually in the format of ‘125-‘ followed by 10 digit number.
Example – ‘125-4200195720’
<Name>Should contain the surname of the voucher owner
Refs (Attribute)Passenger reference ID to which voucher payment is applicable. Currently, BA supports 1 voucher per booking, hence the voucher is applicable for all the passengers in the booking. So, client need to pass reference of all the passengers present in the bookings and defined under Datalist/PassengerList and should be separated by space.
Example – ‘T1 T2’
<Surname>Surname of the voucher owner should be passed here. If the surname doesn’t match from the one present on the voucher, system is going to reject the request.
Refs (Attribute)BA validates the voucher using surname and email address, client should pass the voucher owner email address (email where voucher was received) in contact list and can give the reference in this section.
<Amount>

Total amount payable by Voucher.
Example: 500.55

Note – This is not the total voucher value. This should be the voucher value for paying the flights offers in the booking.

If the total flight value for all the passengers in booking is less than total voucher value, then the amount passed here should be the total flight offer value of all the passengers present in the booking.

Otherwise, if the flight value equals or exceeds the total voucher value then the amount in this section should be the total voucher value.

Client need to pass additional form of payment (card/cash) if the voucher does not cover the total cost of flight for all the passenger in the booking or there is any paid ancillary in the booking

Example -

Total Voucher ValueTotal flight value for all the passengersAncillary (Paid Seat)Amount paid using voucher (amount passed in this section)
1000 GBP800 GBPNo800 GBP
500 GBP800 GBPNo500 GBP
800 GBP800 GBPNo800 GBP
1000 GBP800 GBPYes (50 GBP)800 GBP
500 GBP800 GBPYes (50 GBP)500 GBP
800 GBP800 GBPYes (50 GBP)800 GBP

Code (Attribute)Currency code
Example: GBP
<Offers>Flight offers to which this voucher payment is applicable. Currently, BA supports 1 voucher per booking, hence the voucher is applicable for all the passengers in the booking. So, client need to pass flight offers for all the passengers returned in OrderReshop(Requote) response.
<Offer>

OfferID (Attribute)

Offer ID as returned in OrderReshop response

Example - OF-8f5e5217-e746-4ed8-8c50-a7c96a93e29c
OwnerShould be always ‘BA’
ResponseID

Response ID as returned in OrderReshop Response


Example - tx-09-211-ee497553-3fc0-4dda-a02b-3f7d8d58f669


OfferItemID

This should repeat for each passenger type in booking as returned in OrderReshop RS


Example - OF-8f5e5217-e746-4ed8-8c50-a7c96a93e29c-OI-1


<DataLists>

ElementsDetails

Mandatory/Optional

<PassengerList>

List of passengers with Passenger type code (PTC)

O
<ContactList>

List of contacts for passengers & payers.

O