Confirm Change Booking - RQ
OrderChangeRQ - Confirm Change 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 Parameters | Type | Mandatory/Optional |
---|---|---|
Request object | OrderChangeRQ | M |
<OrderChangeRQ> | ||
Elements | Details | 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 | 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> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Document> | NDC Message Document information | M |
<Name> | Document name will be always "BA" | O |
<Party> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<Party> | »Party & Sender Definition | M |
<Query> | ||||||||
Elements | Details | Mandatory/Optional | ||||||
---|---|---|---|---|---|---|---|---|
<Query> | M | |||||||
<OrderID> | Booking reference or PNR reference | M | ||||||
<OrderServicing> | Function to accept the proposed change/upgrade, as it has been repriced and returned in the preceding OrderReshopRS. | M | ||||||
<AcceptOffer> | Accept New Offer | M | ||||||
<Offer> | M | |||||||
OfferID (Attribute) | New Offer ID as returned in OrderReshopRS(Reprice) | M | ||||||
Owner (Attribte) | Should be always passed as ‘BA’ | M | ||||||
<OfferItem> | This should be repeated per passenger type or per OfferItem returned in OrderReshopRS(Reprice) | M | ||||||
OfferItemID (Attribute) | OfferItemID as returned in OrderReshopRS(Reprice) | M | ||||||
<PassengerRefs> | Passenger refers to which the OfferItemID is associated. Passenger reference should be defined under DataLists/PassengerList If OfferItem is associated with multiple passengers, then passenger reference should be delimited by space. Example – ‘P1 P2’ | M | ||||||
<Delete> | This should contain OLD OrderItems (flight items) present in the booking for all the passenger. | M | ||||||
<OrderItemID> | OrderItemID with flight services present in the booking for each passenger | M | ||||||
<Payments> | The total additional collection/refund amount for the new offer is returned in OrderReshopRS(Reprice). If change/upgrade incurs any additional collection, then the client should pass the Payment section. In case of zero additional collection or any refund, Payment is not required to be passed in OrderChangeRQ | O | ||||||
<Payment> | BA accepts one card form of payment per booking | M | ||||||
<Type> | The form of payment type. Examples: Credit Card, Cash. IATA definition from codeset 9888 The code can be one of the following from the table depends on the form of payment is used
| M | ||||||
<Method> | Payment Form Details. | M | ||||||
<PaymentCard> | This section needs to be populated if the form of payment is a card. This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<CardCode> | Example: VI This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<CardNumber> | Example: 41111111111111111 This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ 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 This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<CardHolderName> | The Card holder's name Example: Mr Test Smith | M | ||||||
<CardHolderBillingAddress> | Specifies the payment card address or Billing address 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> 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 This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<StateProv> | State or province code Examples: NY This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<PostalCode> | Postal Code This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<CountryCode> | Billing country code (2 letter code) This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<Surcharge> | Surcharge fee applicable for the payment card. This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<Amount> | Provide total surcharge amount for all passengers that were returned in the OrderReshopRS. | M | ||||||
Code (Attribute) | Currency code 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 This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<Expiration> | Specifies payment card expiry date This must be specified if it was returned as mandatory in OrderReshopRS or OrderViewRS (returned as part of error when payment card passed in OrderChangeRQ is not applicable) | M | ||||||
<Amount> | Total amount payable by Card. This should include a card surcharge as well for card payment | M | ||||||
code (Attribute) | Currency code | M | ||||||
<Payer> | Populate this section if the payer is not a passenger (3rd party payer) | O | ||||||
<ContactInfoRefs> | Ref to 3rd party payer contact information | M |
Elements | Details | Mandatory/Optional |
---|---|---|
<Query> |
| M |
<Payments> | Specify payment information | O |
<Payment> | ||
<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. | M |
Code (Attribute) | Currency code | M |
<DataLists> | ||
Elements | Details | Mandatory/Optional |
---|---|---|
<PassengerList> | List of passengers with Passenger type code (PTC) | M |
<ContactList> | List of contacts for passengers & payers. | M |