Message Capabilities
  • Updated on 04 Oct 2019
  • 4 minutes to read
  • Contributors
  • Print
  • Dark
    Light

Message Capabilities

  • Print
  • Dark
    Light

The OrderCancel transaction set requests the cancellation of a specified Order and returns confirmation of cancellation.

The Seller, if the Customer wishes to proceed, can then send an Order Cancellation request to the Airline. The Airline will reply with a confirmation in an Order Cancellation response.

The OrderCancel message may be used at a point at which the customer knows the cancellation charges (for example after an OrderReshop where the Customer understands the impact of the Cancellation).

OrderCancel Request Elements

Identifying the Order to Cancel

01. Requesting Cancellation

The Seller may request a simple cancellation by simply providing the Order ID to be cancelled.

<iata:Request>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
</iata:Request>
Order ID
Note if you have a PNR Record Locator, best practice is to use the Order ID and Owner Code field (not the BookingRef structure). Note that the Order ID is determined by the Carrier and shall come from another Order ID response (for example, OrderRetrieve, OrderList)

Validating the Cancellation Amount

Not to be confused with quoting for the cancellation amount which will use the OrderReshop RQ/RS. These validations ensure that nothing has changed from a quotation to the actual execution of the Cancellation.

02. Requesting Cancellation with Expected Refund Amount

The Seller, while requesting the airline to cancel the Order may also advise the airline the expected refund amount. If the expected refund amount does not match that of the expected amount, the airline may return an error or warning instead of cancelling the Order.

<iata:Request>
	<iata:ExpectedRefundAmount>
		<iata:TotalAmount CurCode="CHF">1000.00</iata:TotalAmount>
	</iata:ExpectedRefundAmount>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
</iata:Request>
Additional Detail
Note that the Seller can add additional detail of the Refund Amount to include the Base Amount and specific taxes, fees, and charges.

03. Requesting Cancellation with Expected Loyalty Refund

The Seller, while requesting the airline to cancel the Order may also advise the airline the expected loyalty refund. If the expected refund does not match that of the expected loyalty amount, the airline may return an error or warning instead of cancelling the Order.

iata:Request
iata:ExpectedRefundAmount
iata:LoyaltyUnitAmount1000</iata:LoyaltyUnitAmount>
iata:LoyaltyUnitNameP</iata:LoyaltyUnitName>
</iata:ExpectedRefundAmount>
iata:Order
iata:OrderIDXBXXX1A2B3C4D</iata:OrderID>
iata:OwnerCodeXB</iata:OwnerCode>
</iata:Order>
</iata:Request>

@(Info)PADIS Codest 6411)(Note the Codeset to use for the Miles or Points Unit is PADIS Codeset 6411)

Specifying the type of Refund to Receive

04. Requesting Cancellation with Refund to Original Form of Payment

The Seller may request that any refund amount available after the cancellation is refunded to the original form of payment of the Order.

<iata:Request>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
	<iata:OrderCancelProcessing>
		<iata:RefundPaymentMethodPref>
		<iata:OriginalPaymentMethodInd>true</iata:OriginalPaymentMethodInd>
		</iata:RefundPaymentMethodPref>
	</iata:OrderCancelProcessing>
</iata:Request>

05. Requesting Cancellation with Refund to a Specific Form of Payment

The Seller may request the airline to change the form of refund to a specific form, for example, a Payment Card as opposed to the original form of payment (if known).

<iata:Request>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
	<iata:OrderCancelProcessing>
		<iata:RefundPaymentMethodPref>
			<iata:PaymentCard>
				<iata:CardHolderName>Andrew Blake</iata:CardHolderName>
				<iata:CardNumber>4111111111111111</iata:CardNumber>
				<iata:CardProductTypeCode>VA</iata:CardProductTypeCode>
				<iata:ExpirationDate>2018-11-05+01:00</iata:ExpirationDate>
			</iata:PaymentCard>
		</iata:RefundPaymentMethodPref>
	</iata:OrderCancelProcessing>
</iata:Request>

06. Requesting Cancellation with Refund to a Specific Form of Payment Type

A Seller may specify the type of payment method to refund to without specifying the details of that method (the Airline may have this information on file).

<iata:Request>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
	<iata:OrderCancelProcessing>
		<iata:RefundPaymentMethodPref>
			<iata:PaymentCard/>
		</iata:RefundPaymentMethodPref>
	</iata:OrderCancelProcessing>
</iata:Request>

07. Requesting Cancellation with Refund to Voucher

A seller could request a refund to a voucher for later use by the customer.

<iata:Request>
	<iata:Order>
		<iata:OrderID>XBXXX1A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
	<iata:OrderCancelProcessing>
		<iata:RefundPaymentMethodPref>
			<iata:Voucher>
				<iata:ExpirationDate>2019-12-12</iata:ExpirationDate>
				<iata:VoucherID>12345678910</iata:VoucherID>
			</iata:Voucher>
		</iata:RefundPaymentMethodPref>
	</iata:OrderCancelProcessing>
</iata:Request>

Detailing the Reason for Cancellation

08. Requesting Cancellation with a Reason

A Seller may request the airline to Cancel the Order for any such reason, in this example the Seller advises the airline that the Passenger must cancel due to bereavement purposes (PADIS Codeset REA, value 6 meaning Bereavement).

<iata:Request>
	<iata:Order>
		<iata:OrderID>XB0001A2B3C4D</iata:OrderID>
		<iata:OwnerCode>XB</iata:OwnerCode>
	</iata:Order>
	<iata:OrderCancelProcessing>
		<iata:ReasonCode>6</iata:ReasonCode>
	</iata:OrderCancelProcessing>
</iata:Request>
Airline Response
Note the Airline may return with a Warning advising the Seller to have the Customer provide further information, for example, a doctor’s certificate may be required if PADIS Codeset 7 was sent.

09. Requesting Cancellation with a Grace Period

A Seller may send a cancellation request within a grace period (for example a cooling off period of 24 hours) where a full refund may be required due to government regulations. The request shall be the same as the example Request to Cancel an Order. However, the Seller needs to identify where it’s located (using the Party Information) allowing the Airline can assess the request appropriately.

OrderCancel Response Elements

01. Cancellation

The response section of the message shall specify the response details to the OrderCancel Request. If the cancellation request was successful, the Airline to respond with the Order ID reference. If no errors and warnings are provided the Sender shall assume that the order was successfully cancelled.

<iata:Response>
	<iata:OrderRefID>XBXXX1A2B3C4D</iata:OrderRefID>
</iata:Response>

02. Cancellation with Cancellation Fee

The Airline may return advise on the cancellation fees that were calculated during the Order Cancellation.

<iata:Response>
	<iata:ChangeFees>
		<iata:AppCode>PDE</iata:AppCode>
		<iata:CancelFeeInd>true</iata:CancelFeeInd>
		<iata:PenaltyAmount CurCode="EUR">100.00</iata:PenaltyAmount>
		<iata:TypeCode>Cancel</iata:TypeCode>
	</iata:ChangeFees>
	<iata:OrderRefID>XBXXX1A2B3C4D</iata:OrderRefID>
</iata:Response>

03. Cancellation with Residual Ticket Information

The Airline may also return tickets in the response which may still have residual value with a successful cancellation while also advising the Cancellation fees.

<iata:Response>
	<iata:ChangeFees> 
		<iata:AppCode>PDE</iata:AppCode>
		<iata:CancelFeeInd>true</iata:CancelFeeInd>
		<iata:PenaltyAmount CurCode="EUR">100.00</iata:PenaltyAmount>
		<iata:TypeCode>Cancel</iata:TypeCode>
	</iata:ChangeFees>
	<iata:OrderRefID>XBXXX1A2B3C4D</iata:OrderRefID> 
	<iata:TicketDocInfo>
		<iata:Ticket>
			<iata:Coupon>
				<iata:CouponNumber>1</iata:CouponNumber>
				<iata:CouponSeqNumber>1</iata:CouponSeqNumber>
				<iata:CouponStatusCode>E</iata:CouponStatusCode>
				<!--Optional:-->
				<iata:CouponValidityPeriod>
					<iata:Duration>P1Y4M2DT22H5M29S</iata:Duration>
					<iata:EffectiveDate>2005-10-07</iata:EffectiveDate>
					<iata:ExpirationDate>2010-03-07+01:00</iata:ExpirationDate>
				</iata:CouponValidityPeriod>
				<iata:FareBasisCode>JFBC</iata:FareBasisCode>
				<iata:NonRefundableInd>false</iata:NonRefundableInd>
				<iata:ValueAmount CurCode="CHF">10.00</iata:ValueAmount>
			</iata:Coupon>
			<iata:ReportingTypeCode>ORA</iata:ReportingTypeCode>
			<iata:TicketDocTypeCode>T</iata:TicketDocTypeCode>
			<!--Ticket-->
			<iata:TicketNumber>00022212345678</iata:TicketNumber>
		</iata:Ticket> 
	</iata:TicketDocInfo>
</iata:Response>