Skip to main content

IATA NDC 24.4 — Retailaer transport contract (24.4)

Download OpenAPI specification:Download

HTTP transport contract for the IATA NDC 24.4 messages implemented in @oms/ndc-24-4. Each operation POSTs an XML message; responses are XML. The server is the sandbox (the demo environment); production URLs are issued at go-live. GENERATED — run pnpm ndc:docs:generate; do not edit by hand.

Shopping & Pricing

Discover and price offers — search availability, price selected offers, and merchandise à-la-carte services and seats.

Search for flight offers across one or more origin-destination pairs.

The first call in the shopping flow. Request offers by route, dates, passengers, and cabin/fare preferences; the airline responds with IATA_AirShoppingRS.

Request body validated against IATA_AirShoppingRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_AirShoppingRQ"
Request Body schema: application/xml
required
string

IATA_AirShoppingRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirShoppingRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <FlightRequest xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <AffinityShoppingCriteria>
        <AffinityOriginDest/>
      </AffinityShoppingCriteria>
    </FlightRequest>
  </Request>
</IATA_AirShoppingRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirShoppingRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_AirShoppingRS>

Re-price selected offer items to obtain a firm, bindable price.

After shopping and before order creation, to confirm the price and obtain the exact OfferItems (with taxes, fees, and conditions) to order.

Request body validated against IATA_OfferPriceRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OfferPriceRQ"
Request Body schema: application/xml
required
string

IATA_OfferPriceRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OfferPriceRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <PricedOffer xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <AcceptOrderItemList>
        <CreateOrderItem>
          <OwnerCode>X</OwnerCode>
        </CreateOrderItem>
      </AcceptOrderItemList>
    </PricedOffer>
  </Request>
</IATA_OfferPriceRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OfferPriceRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OfferPriceRS>

Request the seat map and per-seat availability and pricing for a flight or offer.

To render a seat map during shopping or post-booking servicing.

Request body validated against IATA_SeatAvailabilityRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_SeatAvailabilityRQ"
Request Body schema: application/xml
required
string

IATA_SeatAvailabilityRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_SeatAvailabilityRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <SeatAvailCoreRequest xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OfferRequest>
        <Offer>
          <OfferID>X</OfferID>
          <OwnerCode>X</OwnerCode>
        </Offer>
      </OfferRequest>
    </SeatAvailCoreRequest>
  </Request>
</IATA_SeatAvailabilityRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_SeatAvailabilityRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_SeatAvailabilityRS>

List the à-la-carte services (bags, seats, meals…) available for an offer or order.

To merchandise ancillaries for a shopping context or for an existing order.

Request body validated against IATA_ServiceListRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_ServiceListRQ"
Request Body schema: application/xml
required
string

IATA_ServiceListRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceListRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <ServiceListCoreRequest xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OfferRequest>
        <Offer>
          <OfferID>X</OfferID>
          <OwnerCode>X</OwnerCode>
        </Offer>
      </OfferRequest>
    </ServiceListCoreRequest>
  </Request>
</IATA_ServiceListRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceListRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_ServiceListRS>

Order Management

Create and manage orders through their lifecycle — book, retrieve, change, reshop, list, and audit.

Asynchronous notification that an order changed (initiated elsewhere).

Push channel — the airline notifies the seller that an order changed.

Request body validated against IATA_OrderChangeNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderChangeNotifRQ"
Request Body schema: application/xml
required
string

IATA_OrderChangeNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderChangeNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Notification>
    <ChangeGroup>
      <ChangeOperationGroup>
        <ChangeOperation>
          <ChangeDateTime>2024-06-01T09:00:00Z</ChangeDateTime>
          <ChangeTypeCode>X</ChangeTypeCode>
          <ReasonCode>X</ReasonCode>
        </ChangeOperation>
        <OrderVersionNumber>1</OrderVersionNumber>
      </ChangeOperationGroup>
    </ChangeGroup>
    <OrderRefID>X</OrderRefID>
  </Notification>
</IATA_OrderChangeNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Modify an existing order — add or remove services, accept reshop offers, add payment.

For post-booking servicing changes. The airline responds with IATA_OrderViewRS.

Request body validated against IATA_OrderChangeRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderChangeRQ"
Request Body schema: application/xml
required
string

IATA_OrderChangeRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_OrderChangeRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Notification that an order has been closed / finalized.

Push channel — signals end-of-life for an order.

Request body validated against IATA_OrderClosingNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderClosingNotifRQ"
Request Body schema: application/xml
required
string

IATA_OrderClosingNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderClosingNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_OrderClosingNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Create an order from priced offer items (with optional payment).

To book. Converts a priced offer into an order; the airline responds with IATA_OrderViewRS, the authoritative order snapshot.

Request body validated against IATA_OrderCreateRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderCreateRQ"
Request Body schema: application/xml
required
string

IATA_OrderCreateRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderCreateRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <CreateOrder xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <AcceptOrderItemList>
        <CreateOrderItem>
          <OwnerCode>X</OwnerCode>
        </CreateOrderItem>
      </AcceptOrderItemList>
    </CreateOrder>
  </Request>
</IATA_OrderCreateRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request the change history / audit trail of an order.

To show what changed on an order and when.

Request body validated against IATA_OrderHistoryRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderHistoryRQ"
Request Body schema: application/xml
required
string

IATA_OrderHistoryRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderHistoryRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_OrderHistoryRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderHistoryRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OrderHistoryRS>

Search for orders matching criteria (passenger, dates, status…).

When you don't have an OrderID and need to find orders.

Request body validated against IATA_OrderListRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderListRQ"
Request Body schema: application/xml
required
string

IATA_OrderListRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderListRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <OrderSearchFilterCriteria xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes"/>
  </Request>
</IATA_OrderListRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderListRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OrderListRS>

Request a quote for an order or change without committing.

To obtain an indicative or firm price for planned order content before ordering.

Request body validated against IATA_OrderQuoteRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderQuoteRQ"
Request Body schema: application/xml
required
string

IATA_OrderQuoteRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderQuoteRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Payload/>
</IATA_OrderQuoteRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request change offers for an existing order (rebook, upgrade, reroute…).

To obtain priced change options before committing a change with IATA_OrderChangeRQ.

Request body validated against IATA_OrderReshopRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderReshopRQ"
Request Body schema: application/xml
required
string

IATA_OrderReshopRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderReshopRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <OrderRefID xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</OrderRefID>
    <UpdateOrder xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <CancelOrderRef>
        <OrderRefID>X</OrderRefID>
      </CancelOrderRef>
    </UpdateOrder>
  </Request>
</IATA_OrderReshopRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderReshopRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OrderReshopRS>

Retrieve a known order by its OrderID.

To fetch the current IATA_OrderViewRS for an order you can already identify.

Request body validated against IATA_OrderRetrieveRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderRetrieveRQ"
Request Body schema: application/xml
required
string

IATA_OrderRetrieveRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderRetrieveRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <OrderValidationFilterCriteria xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes"/>
  </Request>
</IATA_OrderRetrieveRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request the fare, penalty, and change rules applicable to an order or offer.

To surface change/cancel/refund conditions to the customer or agent.

Request body validated against IATA_OrderRulesRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderRulesRQ"
Request Body schema: application/xml
required
string

IATA_OrderRulesRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderRulesRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <RulesCoreRequest xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <FareRef>
        <AirlineDesigCode>X</AirlineDesigCode>
        <Arrival>
          <IATA_LocationCode>XXX</IATA_LocationCode>
        </Arrival>
        <Dep>
          <IATA_LocationCode>XXX</IATA_LocationCode>
        </Dep>
        <FareBasisCode>X</FareBasisCode>
      </FareRef>
    </RulesCoreRequest>
  </Request>
</IATA_OrderRulesRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderRulesRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OrderRulesRS>

Notification carrying sales / accounting information for an order.

Push channel — conveys sales data (e.g. for settlement and reporting).

Request body validated against IATA_OrderSalesInformationNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_OrderSalesInformationNotifRQ"
Request Body schema: application/xml
required
string

IATA_OrderSalesInformationNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderSalesInformationNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OrderItem>
        <OrderItemID>X</OrderItemID>
        <OwnerCode>X</OwnerCode>
        <Service>
          <InternalValue/>
          <OrderServiceAssociation>
            <PaxSegmentRef>
              <PaxSegmentRefID>X</PaxSegmentRefID>
            </PaxSegmentRef>
          </OrderServiceAssociation>
          <PaxRefID>X</PaxRefID>
          <ServiceID>X</ServiceID>
        </Service>
      </OrderItem>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_OrderSalesInformationNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Servicing & Delivery

Fulfil and service ordered items — delivery status plus status-change and document notifications.

Notification carrying accountable-document data (ticket / EMD).

Push channel — communicates issued document details for an order.

Request body validated against IATA_AirDocNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_AirDocNotifRQ"
Request Body schema: application/xml
required
string

IATA_AirDocNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirDocNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <DocNotification>
    <Coupon xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <CouponNumber>1</CouponNumber>
    </Coupon>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OwnerCode>X</OwnerCode>
    </Order>
    <Pax xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <PaxID>X</PaxID>
    </Pax>
  </DocNotification>
</IATA_AirDocNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Notification of a service-delivery event.

Push channel — reports that a service was delivered or consumed.

Request body validated against IATA_ServiceDeliveryNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_ServiceDeliveryNotifRQ"
Request Body schema: application/xml
required
string

IATA_ServiceDeliveryNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceDeliveryNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OrderItem>
        <OrderItemID>X</OrderItemID>
        <OwnerCode>X</OwnerCode>
        <Service>
          <DeliveryProvider>
            <ID>X</ID>
            <Name>X</Name>
          </DeliveryProvider>
          <OrderServiceAssociation>
            <PaxSegmentRef>
              <PaxSegmentRefID>X</PaxSegmentRefID>
            </PaxSegmentRef>
          </OrderServiceAssociation>
          <PaxRefID>X</PaxRefID>
          <ServiceID>X</ServiceID>
        </Service>
      </OrderItem>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_ServiceDeliveryNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request delivery / fulfilment status or action for an ordered service.

Servicing — to query or trigger delivery of a service on an order.

Request body validated against IATA_ServiceDeliveryRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_ServiceDeliveryRQ"
Request Body schema: application/xml
required
string

IATA_ServiceDeliveryRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceDeliveryRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request/>
</IATA_ServiceDeliveryRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceDeliveryRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
</IATA_ServiceDeliveryRS>

Notification that a service's status changed.

Push channel — e.g. a service became available, used, or cancelled.

Request body validated against IATA_ServiceStatusChangeNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_ServiceStatusChangeNotifRQ"
Request Body schema: application/xml
required
string

IATA_ServiceStatusChangeNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_ServiceStatusChangeNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OrderItem>
        <OrderItemID>X</OrderItemID>
        <OwnerCode>X</OwnerCode>
        <Service>
          <DeliveryProvider>
            <ID>X</ID>
            <Name>X</Name>
          </DeliveryProvider>
          <OrderServiceAssociation>
            <PaxSegmentRef>
              <PaxSegmentRefID>X</PaxSegmentRefID>
            </PaxSegmentRef>
          </OrderServiceAssociation>
          <PaxRefID>X</PaxRefID>
          <ServiceID>X</ServiceID>
        </Service>
      </OrderItem>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_ServiceStatusChangeNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Notification updating service details on an order.

Push channel — conveys updated service information.

Request body validated against IATA_UpdateServiceNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_UpdateServiceNotifRQ"
Request Body schema: application/xml
required
string

IATA_UpdateServiceNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_UpdateServiceNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <OrderID>X</OrderID>
      <OrderItem>
        <OrderItemID>X</OrderItemID>
        <OwnerCode>X</OwnerCode>
        <Service>
          <DeliveryProvider>
            <ID>X</ID>
            <Name>X</Name>
          </DeliveryProvider>
          <OrderServiceAssociation>
            <PaxSegmentRef>
              <PaxSegmentRefID>X</PaxSegmentRefID>
            </PaxSegmentRef>
          </OrderServiceAssociation>
          <PaxRefID>X</PaxRefID>
          <ServiceID>X</ServiceID>
        </Service>
      </OrderItem>
      <OwnerCode>X</OwnerCode>
    </Order>
  </Request>
</IATA_UpdateServiceNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Airline Profile

Discover an airline's distribution capabilities and receive profile updates.

Notification pushing airline-profile updates.

Push channel — the airline publishes profile changes.

Request body validated against IATA_AirlineProfileNotifRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_AirlineProfileNotifRQ"
Request Body schema: application/xml
required
string

IATA_AirlineProfileNotifRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirlineProfileNotifRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Notif>
    <AirlineProfile xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <ProfileOwner>
        <AirlineDesigCode>X</AirlineDesigCode>
      </ProfileOwner>
    </AirlineProfile>
  </Notif>
</IATA_AirlineProfileNotifRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request an airline's distribution profile and capabilities.

To discover an airline's supported messages, markets, and settings.

Request body validated against IATA_AirlineProfileRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_AirlineProfileRQ"
Request Body schema: application/xml
required
string

IATA_AirlineProfileRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirlineProfileRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <AirlineProfileFilterCriteria xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes"/>
  </Request>
</IATA_AirlineProfileRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_AirlineProfileRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_AirlineProfileRS>

Interline

Shop and order across multiple participating carriers.

Request interline offers between participating carriers.

Interline shopping across multiple airlines.

Request body validated against IATA_InterlineOfferRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_InterlineOfferRQ"
Request Body schema: application/xml
required
string

IATA_InterlineOfferRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_InterlineOfferRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Payload/>
  <Retailer>
    <AirlineAccountingCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineAccountingCode>
    <AirlineDesigCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineDesigCode>
  </Retailer>
</IATA_InterlineOfferRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_InterlineOfferRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
  <Supplier>
    <AirlineAccountingCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineAccountingCode>
    <AirlineDesigCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineDesigCode>
  </Supplier>
</IATA_InterlineOfferRS>

Create or manage an interline order between carriers.

Interline ordering across multiple airlines.

Request body validated against IATA_InterlineOrderRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_InterlineOrderRQ"
Request Body schema: application/xml
required
string

IATA_InterlineOrderRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_InterlineOrderRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Payload>
    <BDC xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <AirlineAccountingCode>X</AirlineAccountingCode>
      <AirlineDesigCode>X</AirlineDesigCode>
    </BDC>
    <RetailerOrderInfo xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes"/>
  </Payload>
  <Retailer>
    <AirlineAccountingCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineAccountingCode>
    <AirlineDesigCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineDesigCode>
  </Retailer>
</IATA_InterlineOrderRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_InterlineOrderRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
  <Supplier>
    <AirlineAccountingCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineAccountingCode>
    <AirlineDesigCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</AirlineDesigCode>
  </Supplier>
</IATA_InterlineOrderRS>

Payment Clearance

Settlement-layer messages (IATA 2022.1 namespace) for clearing and reconciling payments between participants.

Request cancellation of a previously submitted clearance.

To reverse or cancel a clearance.

Request body validated against IATA_PaymentClearanceCancellationRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearanceCancellationRQ"
Request Body schema: application/xml
required
string

IATA_PaymentClearanceCancellationRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceCancellationRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCancellationRQ">
  <ClearanceID>0000000AAAAAAAA</ClearanceID>
</IATA_PaymentClearanceCancellationRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceCancellationRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCancellationRS">
  <Clearance>
    <ClearanceID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">0000000AAAAAAAA</ClearanceID>
    <StatusCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">AAAAA</StatusCode>
  </Clearance>
</IATA_PaymentClearanceCancellationRS>

List payment clearances matching criteria.

To query clearance records.

Request body validated against IATA_PaymentClearanceListRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearanceListRQ"
Request Body schema: application/xml
required
string

IATA_PaymentClearanceListRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceListRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceListRQ">
  <ClearanceFilterCriteria/>
</IATA_PaymentClearanceListRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceListRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceListRS">
  <Clearance>
    <ClearanceID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">0000000AAAAAAAA</ClearanceID>
    <ClearancePayeeData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayee>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayee>
    </ClearancePayeeData>
    <ClearancePayerData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayer>
    </ClearancePayerData>
    <NetClearanceAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</NetClearanceAmount>
    <PaymentBrandCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">1</PaymentBrandCode>
    <PaymentCommitmentDateTime xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
    <ProcessRuleCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">IATACAA</ProcessRuleCode>
    <RemittanceDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</RemittanceDate>
    <SettlementDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</SettlementDate>
    <StatusCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">AAAAA</StatusCode>
  </Clearance>
</IATA_PaymentClearanceListRS>

Notification of a payment-clearance event.

Push channel — reports clearance status.

Request body validated against IATA_PaymentClearanceNotif.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearanceNotif"
Request Body schema: application/xml
required
string

IATA_PaymentClearanceNotif XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceNotif xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceNotif">
  <Clearance>
    <ClearanceID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">0000000AAAAAAAA</ClearanceID>
    <ClearancePayeeData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayee>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayee>
    </ClearancePayeeData>
    <ClearancePayerData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </ClearancePayer>
    </ClearancePayerData>
    <NetClearanceAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</NetClearanceAmount>
    <PaymentBrandCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">1</PaymentBrandCode>
    <PaymentCommitmentDateTime xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
    <ProcessRuleCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">IATACAA</ProcessRuleCode>
    <RemittanceDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</RemittanceDate>
    <SettlementDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</SettlementDate>
    <StatusCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">AAAAA</StatusCode>
  </Clearance>
  <ClearanceCount>1</ClearanceCount>
</IATA_PaymentClearanceNotif>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Request clearance of a payment between participants.

Settlement layer — initiate clearance for a transaction.

Request body validated against IATA_PaymentClearanceRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearanceRQ"
Request Body schema: application/xml
required
string

IATA_PaymentClearanceRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceRQ">
  <Clearance>
    <ClearanceData xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearanceID>0000000AAAAAAAA</ClearanceID>
      <ClearancePayeeData>
        <ClearancePayee>
          <Carrier>
            <AirlineAccountingCode>X</AirlineAccountingCode>
            <AirlineDesigCode>AA</AirlineDesigCode>
          </Carrier>
        </ClearancePayee>
      </ClearancePayeeData>
      <ClearancePayerData>
        <ClearancePayer>
          <Carrier>
            <AirlineAccountingCode>X</AirlineAccountingCode>
            <AirlineDesigCode>AA</AirlineDesigCode>
          </Carrier>
        </ClearancePayer>
      </ClearancePayerData>
      <NetClearanceAmount CurCode="X">1</NetClearanceAmount>
      <PaymentCommitmentDateTime>2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
      <ProcessRuleCode>IATACAA</ProcessRuleCode>
    </ClearanceData>
    <PaymentBrandCode xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">1</PaymentBrandCode>
  </Clearance>
  <ClearanceCount>1</ClearanceCount>
</IATA_PaymentClearanceRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearanceRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceRS">
  <Error/>
</IATA_PaymentClearanceRS>

List payment-clearing (settlement) records.

To query clearing records.

Request body validated against IATA_PaymentClearingListRQ.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearingListRQ"
Request Body schema: application/xml
required
string

IATA_PaymentClearingListRQ XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearingListRQ xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearingListRQ">
  <ClearingDate>
    <FromDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</FromDate>
    <ToDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</ToDate>
  </ClearingDate>
</IATA_PaymentClearingListRQ>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearingListRS xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearingListRS">
  <ClearingProcess>
    <ClearanceClearingNotif xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearanceID>0000000AAAAAAAA</ClearanceID>
      <NetClearanceAmount CurCode="X">1</NetClearanceAmount>
      <PaymentBrandCode>1</PaymentBrandCode>
      <PaymentCommitmentDateTime>2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
      <ProcessRuleCode>IATACAA</ProcessRuleCode>
      <StatusCode>AAAAA</StatusCode>
    </ClearanceClearingNotif>
    <ClearingDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</ClearingDate>
    <ClearingID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">SWSAAAAAAA</ClearingID>
    <ClearingParty xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <RemittancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </RemittancePayer>
    </ClearingParty>
    <FundsTransfer xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <MethodCode>AAAAAAA</MethodCode>
      <TypeCode>AAA</TypeCode>
      <ValueDate>2024-06-01</ValueDate>
    </FundsTransfer>
    <TotalAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</TotalAmount>
  </ClearingProcess>
</IATA_PaymentClearingListRS>

Notification of a payment-clearing event.

Push channel — reports clearing status.

Request body validated against IATA_PaymentClearingNotif.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_PaymentClearingNotif"
Request Body schema: application/xml
required
string

IATA_PaymentClearingNotif XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_PaymentClearingNotif xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearingNotif">
  <ClearingProcess>
    <ClearanceClearingNotif xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <ClearanceID>0000000AAAAAAAA</ClearanceID>
      <NetClearanceAmount CurCode="X">1</NetClearanceAmount>
      <PaymentBrandCode>1</PaymentBrandCode>
      <PaymentCommitmentDateTime>2024-06-01T09:00:00Z</PaymentCommitmentDateTime>
      <ProcessRuleCode>IATACAA</ProcessRuleCode>
      <StatusCode>AAAAA</StatusCode>
    </ClearanceClearingNotif>
    <ClearingDate xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">2024-06-01</ClearingDate>
    <ClearingID xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">SWSAAAAAAA</ClearingID>
    <ClearingParty xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <RemittancePayer>
        <Carrier>
          <AirlineAccountingCode>X</AirlineAccountingCode>
          <AirlineDesigCode>AA</AirlineDesigCode>
        </Carrier>
      </RemittancePayer>
    </ClearingParty>
    <FundsTransfer xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes">
      <MethodCode>AAAAAAA</MethodCode>
      <TypeCode>AAA</TypeCode>
      <ValueDate>2024-06-01</ValueDate>
    </FundsTransfer>
    <TotalAmount xmlns="http://www.iata.org/IATA/2015/00/2022.1/IATA_PaymentClearanceCommonTypes" CurCode="X">1</TotalAmount>
  </ClearingProcess>
</IATA_PaymentClearingNotif>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Acknowledgement

The generic acknowledgement / error envelope used across the API.

The generic acknowledgement / error envelope returned across the API.

Sent to acknowledge receipt, or to report errors and warnings when a typed response is not applicable. Notification (push) messages are typically answered with an Acknowledgement.

Request body validated against IATA_Acknowledgement.xsd.

Authorizations:
oauth2apiKey
header Parameters
IATA-Message-Name
required
string

Routes the request to the NDC message handler.

Value: "IATA_Acknowledgement"
Request Body schema: application/xml
required
string

IATA_Acknowledgement XML document.

Responses

Request samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>

Response samples

Content type
application/xml
<?xml version="1.0" encoding="UTF-8"?>
<IATA_Acknowledgement xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"/>