Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
nameQuery_Common

Query - Common

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query> (Common)

OrderID

Order ID previously generated

Alphanumeric

AnyIATA Schema

OrderChangeRQ Query Common example

Expand
title

...

OrderChangeRQ Query Common example
Code Block
languagexml
<Query>
	<OrderID>IB2f9657fdab8e458e90a30e15fd1d1f19OC</OrderID>
</Query>

Query - AcceptRepricedOrder

The PriceGuaranteeTimeLimit (PGTL) element will appear in all Offers and Orders for all markets. Note that this element will have the same value as the PaymentTimeLimit (PTL), except for those markets where the new Reprice on hold is required.

The first market requiring this is Argentina. The PGTL element will be different to the PTL, forcing all users to use the new Reprice on hold functionality.

The price of an Order on hold (un paid) is only guaranteed until the PGTL expires, after which the new Reprice functionality must be used together with the OrderChange-Accept function.

The PTL, is not affected and if expires, the Order is no longer available.

There are three scenarios:

  1. Before both the PTL and the PGTL expire,

    1. This is as today, whereby any Reprice will return the same price and conditions (including PGTL) given when booked. An OrderChange-Accept is not necessary in this case, and an OrderChange-Payment can be sent to fulfill the Order.

  2. After both the PTL and the PGTL have expired.

    1. The Order is cancelled, you need to create a new one.

  3. After the PGTL has expired, but before the PTL expires. In this case, you must Reprice the Order, as per the following flow:

    1. Send a new OrderReshopRQ-Reprice to get the applicable fare and conditions

    2. If the price has not changed, send an OrderChange-Payment (No OrderChange-Accept is necessary)

    3. If the price has changed the system will generate a new Offer which must be accepted using the OrderChange-Accept. Once accepted it can then be paid for. The steps would be as per the following:

Then in the OrderChangeRQ> you can:

  • Accept the modification of the order: <AcceptRepricedOrder> you will have the new PGTL with the original PTL from the Order. The PGTL will never be greater than the PTL, the Order has to be paid before the PTL expires.

  • If the Order has ancillaries, you will get a warning message at OrderReshop-Reprice indicating that they have not been repriced: “Repricing is not allowed for additional services”, as the prices, today, are maintained at the original cost.

  • When accepting the reprice, an OrderView is generated ONLY with the repriced Flight OrderItems and their associated costs, and if you try to pay this value, and your Order has other OrderItems (such as ancillaries) you will get an error “Incorrect amount”. You must do an OrderRetrieve to recover a complete OrderView, with all the OrderItems of the Order and their costs. After that, you can pay by OrderChange-Payment.

Excerpt
nameQuery_AcceptRepricedOrder

Query - AcceptRepricedOrder (BETA ONLY for now)

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

...

NDC SERVICES

<Query /

...

AcceptRepricedOrder>

ResponseID

The ID of the response from

...

which the new offer is being accepted and applied to the Order on hold

Alphanumeric

Any

...

AcceptRepriceOrder example

Expand
titleAcceptRepriceOrder Example
Code Block
languagexml
<Query>
  <OrderID>IB4b0ea07906aa4a078895421c19dc6f1dOC</OrderID>
  <AcceptRepricedOrder>
    

...

<ResponseID>Qm9va2luZ0AxNjk3Nzg5ODA2MDU1LUVDSG8x</ResponseID>
  </AcceptRepricedOrder>
</Query>

Excerpt
nameQuery_PassengerServicing

Query - PassengerServicing

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query / PassengerServicing> (Update contact info flows, name, e-mail, phone, frequent flyer info…)

New

Info

Attribute

New@PassengerIDPassengerID

The unique identifier of the Passenger whose information is being updated.

Alphanumeric

The PassengerID obtained from the previous OrderViewRS having previously retrieved the Order.

IATA Schema if 'PassengerServicing / New' tag is indicated.

New / ContactInfoRef

Contact info reference, which contact info (email & phone) filled in below will update original contact info.

Alphanumeric

Any

Iberia NDC in case of:

  • Contact info (email & phone) correction flow

New / Individual / Given

Name of the passenger to change

Alphanumeric

Any

Iberia NDC in case of:

Name correction flow

New / Individual / Surname

Surname of the passenger to change

  • (Agency can specify separated by a special character "@" first and second surname → Ex: De la Morena@López)

Alphanumeric

AnyIATA Schema if 'New / Individual' tag is indicated

New / LoyaltyProgramAccount / Airline / AirlineDesignator

Airline ID associated to frequent flyer number

Alphanumeric

Any

Iberia NDC in case of:

  • Add/Update Frequent Flyer Number

New / LoyaltyProgramAccount / AccountNumber

Frequent Flyer or On Business number account

Alphanumeric

Any

Iberia NDC in case of:

  • Add/Update Frequent Flyer Number

  • Add/Update On Business Number

New / ActionType

Action type

Alphabetical

  • Add

  • Remove

Iberia NDC in case of:

  • Name correction flow

  • Contact info (email & phone) correction flow

  • Add/Update Frequent Flyer Number

  • Add/Update On Business Number

New / IdentityDocument / IdentityDocumentNumber

Identity document number

Alphanumeric

Any

New / IdentityDocument / IdentityDocumentType

Type of identity document

Alphanumeric

Any

New / IdentityDocument / IssuingCountryCode

Country code for identity document issuing

Alphabetical

List of Countries

New / IdentityDocument / ExpiryDate

Expire date for identity document

Date

Any future date

New / IdentityDocument / Birthplace

Birth place for the identity document holder

Alphabetical

List of Countries

New / IdentityDocument / Visa / VisaNumber

New visa number

Numeric

Any

New / IdentityDocument / Visa / VisaType

New type of visa

Alphabetical

Any

Alphabetical

  • Add

  • Remove

Previous

Info

Attribute

Previous@PassengerIDPassengerID

Passenger ID, which info will be updated

PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.

Alphanumeric

Alphanumeric

Type of Passengers

Value indicated in PassengerID attribute from AirShopping requestIATA Schema if 'PassengerServicing / Previous' tag is indicated.

Previous / Individual / GivenName

Old passenger given name, not mandatory, but if informed and does not match, an error will be shown

Alphanumeric

Any

Previous / Individual / Surname

Old passenger surname, not mandatory, but if informed and does not match, an error will be shown

Alphanumeric

AnyIATA Schema if 'Previous / Individual' tag is indicated

Previous / ContactInfoRef

Old contact info reference

Alphanumeric

Any

Previous / ActionType

Action type

Alphabetical

  • Add

  • Remove

PassengerServicing example

Expand
title

...

PassengerServicing example
Code Block
languagexml
<Query>
      <OrderID>xxxxxxxxxxxxxxxxxxx</OrderID>
      <PassengerServicing>
         <New PassengerID="ADULT_01">
            <LoyaltyProgramAccount>
               <Airline>
                  <AirlineDesignator>IB</AirlineDesignator>
               </Airline>
               <AccountNumber>#########</AccountNumber>
            </LoyaltyProgramAccount>
            <ActionType>Add</ActionType>
         </New>
      </PassengerServicing>
</Query>

Excerpt
nameQuery_OrderServicing

Query - OrderServicing

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Query / OrderServicing> (Add ancillaries, delete paxes, partial refund and voluntary flight change flows…)

AcceptOffer / Offer

Info

Attribute

Offer@OfferIDOfferID

Identification of the service Offer

SeatAvailability ResponseID / ServiceList ResponseID / New Offer Identification (Voluntary Change Flow)Alphanumeric

Any

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

Alphanumeric

Any

AcceptOffer / Offer

Info

Attribute

Offer@OwnerOwner

Airline identification

Alphabetical

IB

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

Alphabetical

IB

AcceptOffer / Offer

Info

Attribute

Offer@ResponseIDResponseID

Response Identification

Alphanumeric

Any

IATA Schema if 'AcceptOffer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

Alphanumeric

Any

AcceptOffer / Offer / OfferItem

Info

Attribute

OfferItem@OfferItemIDOfferItemID

Offer item identification of the new service to addAlphanumeric

Any

IATA Schema if 'Offer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

Alphanumeric

Any

AcceptOffer / Offer / OfferItem / PassengerRefs

Reference for the passengers

Alphanumeric

Type of Passengers

IATA Schema if 'Offer' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

  • Voluntary Change flow

  • Delete Passengers flow

  • Partial Refund flow

Alphanumeric

Type of Passengers

AcceptOffer / Offer / OfferItem / SeatSelection / Row

Row for the seat

  • Add ancillaries flow

Numeric

Any

IATA Schema if 'SeatSelection' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

AcceptOffer / Offer / OfferItem / SeatSelection / Column

Column for the seat

  • Add ancillaries flow

Alphabetical

Any

IATA Schema if 'SeatSelection' tag is indicated and Iberia NDC in case of:

  • Add ancillaries flow

Delete / OrderItemID

OrderItem identification to be deleted.

When cancelling flights with Ancillaries or other associated services it is only necessary to include the OrderItemIDs of the flights, as all associated services will automatically be cancelled with the flights.

Alphanumeric

AnyIATA Schema if 'Delete' tag is indicated

OrderServicing example

Expand
title

...

OrderServicing example
Code Block
languagexml
<OrderServicing>
	<AcceptOffer>
		<Offer OfferID="IB1ce71d2c930a46afbca517f2feb15730OP" Owner="IB" ResponseID="Qm9va2luZ0AxNjk3NzE4ODAyNjA0LXlpdWlx">
			<OfferItem OfferItemID="IB1ce71d2c930a46afbca517f2feb15730OP_01">
				<PassengerRefs>ADULT_01</PassengerRefs>
			</OfferItem>
		</Offer>
	</AcceptOffer>
	<Delete>
		<OrderItemID>IB79563e1e6cd94495a58513924d3cd894OC_01</OrderItemID>
	</Delete>
</OrderServicing>

Excerpt
nameQuery_Payments

Query - Payments

IATA Schema if 'Payment' tag is indicated----

Iberia NDC

In Cash Payment Method is OPTIONAL

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUESNDC SERVICES

<Query / Payments / Payment> (Add ancillaries and voluntary flight change flows…)

Type

Payment Methods can vary depending on market and type of seller.

Please check here.

Alphabetical

  • CA (Cash)

  • CC (Credit Card)

  • MS (Voucher)

--  This refers to Cash payment method  --

Method / Cash

Info

Attribute

Cash@CashIndCashInd

Cash payment method.

Alphabetical

true

IATA Schema if 'Payment' tag is indicated and Iberia NDC

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

In Cash Payment Method is OPTIONAL

Alphanumeric

Any valid reference associated in the XML below.

--  This refers to Credit Card method  – If Secure Payment applies additional info needed is defined below in 3DS INFO --

Method PaymentCard

Info

Attribute

PaymentCard@refsrefs

NDC Mandatory for 3DS and/or installments payment.

This is used to reference the associated 3DS info in PaymentCardSecureInfo ObjectKey, and/or the intallment installment payment info in PaymentFormMetadata MetadataKey.

If both 3DS and installment payments are being used for the same Order, then the two references are included here together separated by a space.

Example:

Code Block
languagexml
<PaymentCard refs="KEY_3DS KEY_QUOTAS">

Alphanumeric

Any

NDC Mandatory for 3DS and/or intallments payment.

Method / PaymentCard / CardType 

Type of credit card

Alphanumeric

1-6 characters

Iberia NDC

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-19 characters

Iberia NDC

Method / PaymentCard / SeriesCode

Series Code of credit card

Numeric

1-8 characters

Iberia NDC

Method / PaymentCard / CardHolderName

Card Holder Name

Alphanumeric

0-50 characters

Method / PaymentCard / CardHolderBillingAddress / Street

Street of the billing address of the cardholder.

NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

If tag is indicated once, only first 40 characters will be considered

If tag is indicated twice, only first 80 characters will be considered

Iberia NDC that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Method / PaymentCard / CardHolderBillingAddress / CityName

City of the Billing Address of cardholder

Alphanumeric

Only first 50 characters will be considered

Iberia NDC NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

Only first 50 characters will be considered

Method / PaymentCard / CardHolderBillingAddress / StateProv

State Prov. of the Billing Address of cardholder

Alphanumeric

1-40 characters

Iberia NDC NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

1-40 characters

Method / PaymentCard / CardHolderBillingAddress / PostalCode

Postal Code of the Billing Address of cardholderAlphanumeric

2-10 characters

Iberia NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphanumeric

2-10 characters

Method / PaymentCard / CardHolderBillingAddress / CountryCode

Country Code of the Billing Address of cardholderAlphabetical

2 characters

Iberia NDC Mandatory that at least one field has to be filled in inside "CardHolderBillingAddress" tag.

Alphabetical

2 characters

Method / PaymentCard / CardNumber

Number of credit card

Numeric

1-9 characters

Method / PaymentCard / EffectiveExpireDate / Expiration

Effective expiration date of the credit card

Numeric

4 charactersIberia NDC

Amount

Info

Attribute

Code

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

--  This refers to Voucher payment method  --

Method / Voucher

Voucher payment method.

AlphabeticAlphabetical

true

IATA Schema if 'Payment' tag is indicated and Iberia NDC

Method / Voucher / Number 

Number of the voucher

Alphanumeric

any

Iberia NDCAmount

Info

Attribute

Amount@CodeCode

Total amount of the offer.

Code refers to currency code for payment.

Numeric

Any

IATA Schema

Payer / ContactInfoRefs

Reference for the payer info, that must be associated correctly in the XML below.

Alphanumeric

Any valid reference associated in the XML below.

-- This refers to Service Fee method --

Method / Other / Remarks

Info

Attribute

refs

References for all passengers of the order

Alphanumeric

any

Method / Other / Remarks / Remark

Service Fee payment method

Mandatory for schema if "Remarks" tag is indicated

Alphabetical

ServiceFee

Amount

Info

Attribute

Code

Total amount of the Service Fee

Code refers to currency code for payment.

Numeric

Any

OrderChangeRQ Query Payments examples

Expand
titleQuery Cash Payment example
Code Block
languagexml
<Payments>
    <Payment>
      <Type>CA</Type>
      <Method>
          <Cash CashInd="true"/>
      </Method>
      <Amount Code="EUR">10.00</Amount>
      <Payer>
          <ContactInfoRefs>Payer</ContactInfoRefs>
      </Payer>
    </Payment>
</Payments>
Expand
title

...

Query Credit Card Payment example
Code Block
languagexml
<Payments>

...

    <Payment>
      <Type>CC</Type>

...


      <Method>
          <PaymentCard refs="

...

KEY_QUOTAS">
         

...

   <CardType>VI</CardType>

...

            <SeriesCode>XXX</SeriesCode>
            <CardHolderName>JANE SMITH</CardHolderName>
            <CardHolderBillingAddress>
                <Street>125 PRESTON RD BRIGH</Street>
                <CityName>MA</CityName>
                <StateProv>BN</StateProv>
                <PostalCode>BN12LP</PostalCode>
                <CountryCode>PE</CountryCode>
            </CardHolderBillingAddress>
            <CardNumber>44XXXXXXXXXXXX04</CardNumber>
            <EffectiveExpireDate>
                <Expiration>MMYY</Expiration>
            </EffectiveExpireDate>
          </PaymentCard>
      </Method>
      <Amount Code="USD">119.80</Amount>
      <Payer>
          <ContactInfoRefs>Payer</ContactInfoRefs>
      </Payer>
    </Payment>
</Payments>
Expand
titleQuery Voucher Payment example
Code Block
languagexml
<Payments>
	<Payment>
		<Type>MS</Type>
		<Method>
			<Voucher>
				<Number>BONO100EUR</Number>
			</Voucher>
		</Method>
		<Amount Code="EUR"

...

>339.

...

67</Amount>
		<Payer>
			<ContactInfoRefs>Payer</ContactInfoRefs>
		</Payer>
	</Payment>
</Payments>
Expand
titleQuery Service Fee Payment example
Code Block
languagexml
<Payments>
  <Payment>
      <Type>SF</Type>
      <Method>
        <Other>
            <Remarks refs="ADULT_01">
              <Remark>ServiceFee</Remark>
            </Remarks>
        </Other>
      </Method>
      <Amount Code="EUR">11.00</Amount>
  </Payment>
</Payments>