OrderCancel 19.2

Attachments

Introduction

This service allows NDC agent to Cancel and Void issued documents.

OrderCancel Webservice

Supported operations

PNR Cancel;
Document VOID.

Limitations (This list is not exhaustive)

Ticket refund is not supported;
VOID is not supported by document number;
VOID operation supported only for documents issued via NDC channel;
Document VOID is possible for not cancelled PNR and on the same day of ticketing.

This web service is called with the following inputs

Party data;
OrderID;
<OrderCancelProcessing> for VOID documents operation.

The output data this service returns include

Success or error reply;
OrderReference;
Document number;
Document amount and currency;
Cupon status;
Document type;
Cupon number.

Cancel and VOID operations flow

1. Order RetrieveRQ: Retrieve the PNR by record locator;

2. OrderViewRS: Receive a reply with OrderId;

3. OrderCancelRQ (Document VOID): Pass OrderID received in OrderViewRS and add <OrderCancelProcessing> section with action code 16;

3.1 OrderCancelRQ (PNR Cancel): Pass OrderID received in OrderViewRS;

4. OrderCancelRS: OrderID and success status.

Access

In order to access API, you will need to pass the following two headers for each call.

Authentication and authorization stand on the protocol layer using basic HTTP authentication. Given username and password with separator “:” MUST be base64-encoded and passed as HTTP header “Authorization”. This header is mandatory for all requests. For example, if "TestLogin" set as the username and "TestPass" set as the password, then the field's value is base64-encoding of TestLogin: TestPass, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Header 'Content-Type: text/xml'
Message structure: <soapenv:Envelope><soapenv:Body> Message... </soapenv:Body></soapenv:Envelope>

OrderCancelRQ (PNR Cancel) structure

IATA_OrderCancelRQ

<IATA_OrderCancelRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ ../NDC/19_2_schemas/IATA_OrderCancelRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>TravelAgent</Name>
				<PseudoCityID>IEVPS28ND</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<Order>
			<OrderID>a464b896-1365-4032-b501-48367dd5262e</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
	</Request>
</IATA_OrderCancelRQ>

OrderCancelRQ (VOID) structure

IATA_OrderCancelRQ

<IATA_OrderCancelRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ ../NDC/19_2_schemas/IATA_OrderCancelRQ.xsd">
	<MessageDoc>
		<RefVersionNumber>19.2</RefVersionNumber>
	</MessageDoc>
	<Party>
		<Sender>
			<TravelAgency>
				<AgencyID>TA123</AgencyID>
				<Name>TravelAgent</Name>
				<PseudoCityID>IEVPS28ND</PseudoCityID>
			</TravelAgency>
		</Sender>
	</Party>
	<Request>
		<Order>
			<OrderID>a464b896-1365-4032-b501-48367dd5262e</OrderID>
			<OwnerCode>PS</OwnerCode>
		</Order>
		<OrderCancelProcessing>
			<Device/>
			<ReasonCode>16</ReasonCode>
		</OrderCancelProcessing>
	</Request>
</IATA_OrderCancelRQ>

OrderCancelRQ fields description

Click here to expand...

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
IATA_OrderCancelRQ	The OrderCancel transaction set requests the cancellation of specified order and returns confirmation of cancellation.	M	<IATA_OrderCancelRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRQ ../NDC/19_2_schemas/IATA_OrderCancelRQ.xsd">
↳ MessageDoc	NDC Message Document information.	M
↳ RefVersionNumber	Service Version.	M	<RefVersionNumber>19.2</RefVersionNumber>
↳ Party	NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.	M
↳ Sender	Information related to the party sending this message.	M
↳ TravelAgency	SELLER: Travel Agency	M
↳ AgencyID	Unique Agency Seller ID. Example: TA123	M	<AgencyID>TA123</AgencyID>
↳ Name	Agency name. Example: Carson Travel	M	<Name>TravelAgent</Name>
↳ PseudoCityID	Travel Agent's Office ID.	M	<PseudoCityID>IEVPS28ND</PseudoCityID>
↳ Request	OrderCancelRQ payload information.	M
↳ Order	A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions. Order supports the sale of a flexible range of airline products and services that are not necessarily Journey based (e.g. subscription services).	M
↳ OrderID	Carrier assigned ID which uniquely identifies a specific Order across several messages.	M	<OrderID>a464b896-1365-4032-b501-48367dd5262e</OrderID>
↳ OwnerCode	Airline code assigned to a carrier. IATA-defined 2-character code.	M	<OwnerCode>PS</OwnerCode>
↳ OrderCancelProcessing	Information related to how response results should be returned.	O
↳ Device	The device upon which the secure transaction will occur. Currently not used. Closed tag should be present in the query	M	<Device/>
↳ ReasonCode	Should be used for the Seller to communicate the reason for cancellation to the Seller (and for the Airline to respond with advice on the cancellation request. Uses PADIS REA Codeset. For void request supported value 16. Othe codes not supported	M	<ReasonCode>16</ReasonCode>

OrderCancelRS (Cancel) structure

IATA_OrderCancelRS

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
    <Header/>
    <Body>
        <IATA_OrderCancelRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRS">
            <Response>
                <OrderRefID>6acbc3b8-8e02-4013-91d3-231f2f32a833</ns2:OrderRefID>
            </Response>
        </IATA_OrderCancelRS>
    </Body>
</Envelope>

OrderCancelRS (VOID) structure

IATA_OrderCancelRS

<IATA_OrderCancelRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRS" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRS ../NDC/19_2_schemas/IATA_OrderCancelRS.xsd">
		<Response>
			<OrderRefID>a464b896-1365-4032-b501-48367dd5262e</OrderRefID>
			<TicketDocInfo>
				<PaymentInfo>
					<Amount CurCode="EUR">300.00</Amount>
					<PaymentInfoRefID/>
					<PaymentMethod/>		
					<TypeCode>CA</TypeCode>
				</PaymentInfo>
				<Ticket>
					<Coupon>
						<CouponNumber>1</CouponNumber>
						<CouponStatusCode>V</CouponStatusCode>
					</Coupon>
					<Coupon>
						<CouponNumber>2</CouponNumber>
						<CouponStatusCode>V</CouponStatusCode>
					</Coupon>
					<ReportingTypeCode>BSP</ReportingTypeCode>
					<TicketDocTypeCode>T</TicketDocTypeCode>
					<TicketNumber>5662406986061</TicketNumber>
				</Ticket>
			</TicketDocInfo>
		    <TicketDocInfo>
				<PaymentInfo>
					<Amount CurCode="EUR">15.00</Amount>
					<PaymentInfoRefID/>
					<PaymentMethod/>		
					<TypeCode>CA</TypeCode>
				</PaymentInfo>
				<Ticket>
					<Coupon>
						<CouponNumber>1</CouponNumber>
						<CouponStatusCode>V</CouponStatusCode>
					</Coupon>
					<ReportingTypeCode>BSP</ReportingTypeCode>
					<TicketDocTypeCode>J</TicketDocTypeCode>
					<TicketNumber>5668207361063</TicketNumber>
				</Ticket>
			</TicketDocInfo>
			<Warning>
				<Code>440</Code>
				<DescText>5668207361062 REJECTED - DOCUMENT ALREADY CANCELLED</DescText>
			</Warning>
		</Response>
</IATA_OrderCancelRS>

OrderCancelRS fields description

Click here to expand...

M = Mandatory; O = Optional; C = Conditional

Field name	Description	M/O/C	Example
IATA_OrderCancelRS	The OrderCancel transaction set requests the cancellation of specified order and returns confirmation of cancellation.	M	<IATA_OrderCancelRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderCancelRS ../NDC/19_2_schemas/IATA_OrderCancelRS.xsd">
↳ Error	Error(s) that prevented the message from processing.	C
↳ Code	The code corresponding to the processing error as defined by PADIS 9321.	M	<Code>911</Code>
↳ DescText	Free text description of the provided error.	M	<DescText>Unable to process - system error / Invalid query</DescText>
↳ Response	Order cancel results.	C
↳ OrderRefID	References the cancelled Order's Order ID.	M	<OrderRefID>a464b896-1365-4032-b501-48367dd5262e</OrderRefID>
↳ TicketDocInfo	Information corresponding to a group of 1 to 4 Tickets for a single Origin Destination and a single Passenger.	M
↳ PaymentInfo	Information related to the settlement of a transaction through monetary or other compensations. For example, a payment may be applied to an entire Order or individual Order Items.	M
↳ Amount	The amount applied to the associated payment method. Attribute: CurCode	M	<Amount CurCode="EUR">300.00</Amount>
↳ PaymentInfoRefID	If creating the order after payment authorization it is a way of linking order to an existing payment reference. not triggering the whole process again. Currently not used	M	<PaymentInfoRefID/>
↳ PaymentMethod	A form of procedure for the payment of goods or services, plus any transactional information specific to the payment method other than the amount. Currently not used	M	<PaymentMethod/>
↳ TypeCode	The payment method type. Supported value: CA - Cash	M	<TypeCode>CA</TypeCode>
↳ Ticket	The accountable document issued by or on behalf of a carrier which includes notices and the flight and passenger coupons contained therein.	M
↳ Coupon	The portion of the Passenger Ticket and Baggage Check or Excess Baggage Ticket that indicates particular places between which the coupon is good for carriage.	M
↳ CouponNumber	The number assigned to the issued coupon.	M	<CouponNumber>1</CouponNumber>
↳ CouponStatusCode	Current status of the flight/ value coupon. PADIS: 4405	M	<CouponStatusCode>V</CouponStatusCode>
↳ ReportingTypeCode	For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action (via BSP, ARC, directly by ORA, etc.).	M	<ReportingTypeCode>BSP</ReportingTypeCode>
↳ TicketDocTypeCode	Document type code as defined by PADIS 1001 (Document/ Message Name, coded).	M	<TicketDocTypeCode>T</TicketDocTypeCode>
↳ TicketNumber	The document number comprised of the airline code, form code, and serial number.	M	<TicketNumber>5662406986061</TicketNumber>
↳ Warning	Contains information related to potential business errors detected during the processing of the preceding request.	O
↳ Code	The code corresponding to the processing warning as defined by PADIS 9321.	M	<Code>440</Code>
↳ DescText	Free text description of the provided warning.	M	<DescText>5668207361062 REJECTED - DOCUMENT ALREADY CANCELLED</DescText>

OrderCancel Error/Validation Checks

Click here to expand...

PADIS Error Code	PADIS Error Text	Use Cases
System errors
911	Unable to process - system error / Invalid query	Invalid query
486	Unknown	The equivalent of -1 error
304	System Temporarily unavailable	The system is not available/HOST problem
916	EDIFACT version not supported	Not supported NDC service version.
Agent authorization errors
368	Not authorized	Wrong agent authentication key. Agent is inactive
79A	Invalid office identification	OID is missing or incorrect
Query errors
129	No PNR Match Found	Invalid OrderID in the request
912	Incomplete message - data missing in query	Mandatory parameters are missing in the query
486	PNR cancelled	PNR is cancelled or does not have flight segments
52	Void of issue not allowed
440	Void request on already voided or printed coupons
74Y	Void of an exchange/reissue not allowed (request is not within same calendar day)
91	Invalid code