Last updated 8 minutes ago

Southwest Airlines Functional Capabilities

OrderCancel Request

The OrderCancel service provides the ability to cancel the booking. The service cancels the booking and refunds the refundable amount to the original form of payment if applicable.

Details that are required to be passed in the request:

  • OrderCancelRQ/Query/Order/@OrderID
  • OrderCancelRQ/Query/Order/@Owner

OrderReshop-for-Cancel-initiate and OrderCancel-commit
Southwest Airlines supports voluntary ticketed order cancellation with full refund within 24 hours from the time of PNR creation. This can optionally be held in Residual Travel Fund (i.e., RTF). Usually such cancellations are refunded in original FOP. Funds for any cancellation done beyond 24 hours from the time of PNR creation will be held in RTF. These rules apply to all fare families.

Also important, depending on the fare type and the form of payment you used to purchase your ticket, you'll either receive reusable travel funds or a refund. A seller may choose to override such refund-to-original FOP to keep the residual value in a Residual Traveler Fund (RTF). Similarly for cancellation beyond 24 hours, a seller may want to override it by advising WN to refund to original FOP instead of keeping the remaining balance in an RTF.

OrderReshopRQ can be used to initiate such override with the values "RTF" (for Hold representing "Residual Travel Funds") and "RF" (for Refund) in the field OrderReshopRQ/ReshopParameters/Reason.

The feature of overriding cancellation rules is also available in OrderCancelRQ. This service can be used to commit such override with "RTF" (for Hold representing "Residual Travel Funds") and "RF" (for Refund) in the field OrderCancelRQ/OrderCancelParameters/Reason.

If such /@reason was not included in the RQ payload, a seller should expect fund to be refunded if the cancellation has occurred within 24 hours from the booking timestamp. In case the order was cancelled after 24 hours from the booking timestamp, the fund would be held in an RTF (Residual Travel Fund) by default. After 24 hours from the booking timestamp, the eligibility for a refund-to-original-FOP also depends on the rules associated with the fare family in the booking.

OrderCancelRQ can be used to commit cancellation override with the values "RTF" (for Hold representing "Residual Travel Funds") and "RF" (for Refund) in the field OrderCancelRQ/OrderCancelParameters/Reason to override cancellation rules.

The following OrderCancelRQ sample includes /reason “RTF” (i.e., seeking hold the fund in a residual travel fund):

<OrderCancelRQ EchoToken="12345" TimeStamp="2011-04-28T12:48:00Z" Target="Production" Version="17.2" SequenceNmbr="1" TransactionStatusCode="End" TransactionIdentifier="daadf3d1d87245a1871c64fdbba9b235" PrimaryLangID="en-us" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.iata.org/IATA/EDIST/2017.2" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 file:///C:/Users/atp1kxb/OneDrive/NDCx/IATASchemas/17.2/NDC-2017.2-schemas-edist/OrderCancelRQ.xsd">
	<Document>
		<Name>ATPCO AGG NDCx 2.0</Name>
		<ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
	</Document>
	<Party>
		<Sender>
			<TravelAgencySender>
				<IATA_Number>00012345</IATA_Number>
				<AgentUser>
					<Contacts>
						<Contact>
							<Name>
								<Given>KBONE</Given>
								<Surname>ADULTONE</Surname>
							</Name>
						</Contact>
					</Contacts>
				</AgentUser>
			</TravelAgencySender>
		</Sender>
	</Party>
	<OrderCancelParameters>
		<!-- RTF=HOLD, RF=Refund-->
		<Reason>RTF</Reason>
	</OrderCancelParameters>
	<Query>
		<Order OrderID="2Z7BQR" Owner="WN"/>
	</Query>
</OrderCancelRQ>

The following OrderCancelRQ sample includes /reason “RF” (i.e., seeking refund to original form of payment):

<OrderCancelRQ EchoToken="12345" TimeStamp="2011-04-28T12:48:00Z" Target="Production" Version="17.2" SequenceNmbr="1" TransactionStatusCode="End" TransactionIdentifier="daadf3d1d87245a1871c64fdbba9b235" PrimaryLangID="en-us" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.iata.org/IATA/EDIST/2017.2" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 file:///C:/Users/atp1kxb/OneDrive/NDCx/IATASchemas/17.2/NDC-2017.2-schemas-edist/OrderCancelRQ.xsd">
	<Document>
		<Name>ATPCO AGG NDCx 2.0</Name>
		<ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
	</Document>
	<Party>
		<Sender>
			<TravelAgencySender>
				<IATA_Number>00012345</IATA_Number>
				<AgentUser>
					<Contacts>
						<Contact>
							<Name>
								<Given>Krishnarup</Given>
								<Surname>Basu</Surname>
							</Name>
						</Contact>
					</Contacts>
				</AgentUser>
			</TravelAgencySender>
		</Sender>
	</Party>
	<OrderCancelParameters>
		<!-- RTF=HOLD, RF=Refund-->
		<Reason>RF</Reason>
	</OrderCancelParameters>
	<Query>
		<Order OrderID="2Z7BQR" Owner="WN"/>
	</Query>
</OrderCancelRQ>

The following OrderCancelRQ sample does not include any /reason:

<OrderCancelRQ EchoToken="12345" TimeStamp="2011-04-28T12:48:00Z" Target="Production" Version="17.2" SequenceNmbr="1" TransactionStatusCode="End" TransactionIdentifier="daadf3d1d87245a1871c64fdbba9b235" PrimaryLangID="en-us" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.iata.org/IATA/EDIST/2017.2" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 file:///C:/Users/atp1kxb/OneDrive/NDCx/IATASchemas/17.2/NDC-2017.2-schemas-edist/OrderCancelRQ.xsd">
	<Document>
		<Name>ATPCO AGG NDCx 2.0</Name>
		<ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
	</Document>
	<Party>
		<Sender>
			<TravelAgencySender>
				<IATA_Number>00012345</IATA_Number>
				<AgentUser>
					<Contacts>
						<Contact>
							<Name>
								<Given>KBTWO</Given>
								<Surname>ADULTTWO</Surname>
							</Name>
						</Contact>
					</Contacts>
				</AgentUser>
			</TravelAgencySender>
		</Sender>
	</Party>
	<Query>
		<Order OrderID="3E6L2N" Owner="WN"/>
	</Query>
</OrderCancelRQ>

OrderCancel Response - Commit

This response returns an offer per PNR-TicketNumber with the details of what refunded or held (RTF):

  • /OrderCancelRS/Response/OrderCancelProcessing/Remarks/Remark returns comment on what happened to the fund.

RTF (Residual Travel Fund) RS:

  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue - Returns the total amount that was cancelled in a PNR.
  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark - Returns original FOP where the money was refunded and/ or what rule was applied to the cancellation process.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration - Returns the respective RTF’s expiration.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue - Returns the respective RTF’s value.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr - Returns the PNR.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type - Can be ignored. It defaults to “14”.
<OrderCancelRS xmlns="http://www.iata.org/IATA/EDIST/2017.2" EchoToken="12345" SequenceNmbr="1" Target="Production" TimeStamp="2011-04-28T12:48:00Z" TransactionIdentifier="Cancel" TransactionStatusCode="End" Version="2.001">
   <Document>
      <Name>ATPCO AGG NDCx 2.0</Name>
      <ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
   </Document>
   <Success/>
   <Response>
      <OrderCancelProcessing>
         <Remarks>
            <Remark>Flight credit held on the PNR for future use</Remark>
            <Remark>Flight credit held on the PNR for future use</Remark>
            <Remark>Flight credit held on the PNR for future use</Remark>
         </Remarks>
      </OrderCancelProcessing>
      <OrderReference>2Z7BQR</OrderReference>
      <ChangeFees>
         <Details>
            <Detail>
               <Type>Cancellation</Type>
               <Amounts>
                  <Amount>
                     <CurrencyAmountValue>2022.60</CurrencyAmountValue>
         <ApplicableFeeRemarks>
            <Remark>Flight credit held on the PNR for future use</Remark>
         </ApplicableFeeRemarks>
                  </Amount>
               </Amounts>
            </Detail>
         </Details>
      </ChangeFees>
      <TicketDocInfos>
         <TicketDocInfo>
            <Payments>
               <Payment>
                  <Method>
                     <VoucherMethod>
                        <Number>2Z7BQR-XXXXXXXXXXXX7336</Number>
                        <EffectiveExpireDate>
                           <Expiration>2023-01-21</Expiration>
                        </EffectiveExpireDate>
                        <RemainingValue>674.20</RemainingValue>
                     </VoucherMethod>
                     <VoucherMethod>
                        <Number>2Z7BQR-XXXXXXXXXXXX7344</Number>
                        <EffectiveExpireDate>
                           <Expiration>2023-01-21</Expiration>
                        </EffectiveExpireDate>
                        <RemainingValue>674.20</RemainingValue>
                     </VoucherMethod>
                     <VoucherMethod>
                        <Number>2Z7BQR-XXXXXXXXXXXX7328</Number>
                        <EffectiveExpireDate>
                           <Expiration>2023-01-21</Expiration>
                        </EffectiveExpireDate>
                        <RemainingValue>674.20</RemainingValue>
                     </VoucherMethod>
                  </Method>
               </Payment>
            </Payments>
            <TicketDocument>
               <TicketDocNbr>2Z7BQR</TicketDocNbr>
               <Type>14</Type>
               <NumberofBooklets>0</NumberofBooklets>
               <ReportingType>Airline</ReportingType>
            </TicketDocument>
         </TicketDocInfo>
      </TicketDocInfos>
   </Response>
</OrderCancelRS>

Refund RS:

  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue - Returns refunded amount.
  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark - Returns original FOP where the money was refunded and/ or what rule was applied to the cancellation process.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo//Payments/Payment/Method/PaymentCardMethod - Can be ignored.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr - Returns the PNR.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type - Can be ignored. It defaults to “14”.
<OrderCancelRS xmlns="http://www.iata.org/IATA/EDIST/2017.2" EchoToken="12345" SequenceNmbr="1" Target="Production" TimeStamp="2011-04-28T12:48:00Z" TransactionIdentifier="Cancel" TransactionStatusCode="End" Version="2.001" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 file:///C:/Users/atp1kxb/OneDrive/NDCx/IATASchemas/17.2/NDC-2017.2-schemas-edist/OrderCancelRS.xsd">
	<Document>
		<Name>ATPCO AGG NDCx 2.0</Name>
		<ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
	</Document>
	<Success/>
	<Response>
		<OrderCancelProcessing>
			<Remarks>
				<Remark>Cancelled with Refund</Remark>
			</Remarks>
		</OrderCancelProcessing>
		<OrderReference>2IZ362</OrderReference>
		<ChangeFees>
			<Details>
				<Detail>
					<Type>Cancellation</Type>
					<Amounts>
						<Amount>
							<CurrencyAmountValue>674.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
					</Amounts>
				</Detail>
				<Detail>
					<Type>Cancellation</Type>
					<Amounts>
						<Amount>
							<CurrencyAmountValue>674.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
					</Amounts>
				</Detail>
				<Detail>
					<Type>Cancellation</Type>
					<Amounts>
						<Amount>
							<CurrencyAmountValue>674.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
					</Amounts>
				</Detail>
			</Details>
		</ChangeFees>
		<TicketDocInfos>
			<TicketDocInfo>
				<Payments>
					<Payment>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
					</Payment>
				</Payments>
				<TicketDocument>
					<TicketDocNbr>2IZ362</TicketDocNbr>
					<Type>14</Type>
					<NumberofBooklets>0</NumberofBooklets>
					<ReportingType>Airline</ReportingType>
				</TicketDocument>
			</TicketDocInfo>
		</TicketDocInfos>
	</Response>
</OrderCancelRS>

RTF and Refund RS:

  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/CurrencyAmountValue - Returns the total amount that was cancelled in a PNR. Also it returns refunded amount.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/EffectiveExpireDate/Expiration - Returns the respective RTF’s expiration.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/VoucherMethod/RemainingValue - Returns the respective RTF’s value.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/TicketDocNbr - Returns the PNR.
  • /OrderCancelRS/Response/ChangeFees/Details/Detail/Amounts/Amount/ApplicableFeeRemarks/Remark - Returns original FOP where the money was refunded and/ or what rule was applied to the cancellation process.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/Payments/Payment/Method/PaymentCardMethod - Can be ignored.
  • /OrderCancelRS/Response/TicketDocInfos/TicketDocInfo/TicketDocument/Type - Can be ignored. It defaults to “14”.
<OrderCancelRS xmlns="http://www.iata.org/IATA/EDIST/2017.2" EchoToken="12345" SequenceNmbr="1" Target="Production" TimeStamp="2011-04-28T12:48:00Z" TransactionIdentifier="Cancel" TransactionStatusCode="End" Version="2.001" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.iata.org/IATA/EDIST/2017.2 file:///C:/Users/atp1kxb/OneDrive/NDCx/IATASchemas/17.2/NDC-2017.2-schemas-edist/OrderCancelRS.xsd">
	<Document>
		<Name>ATPCO AGG NDCx 2.0</Name>
		<ReferenceVersion>IATA NDC 17.2</ReferenceVersion>
	</Document>
	<Success/>
	<Response>
		<OrderCancelProcessing>
			<Remarks>
				<Remark>Cancelled with Refund</Remark>
				<Remark>Funds held on the PNR</Remark>
			</Remarks>
		</OrderCancelProcessing>
		<OrderReference>2LC5CN</OrderReference>
		<ChangeFees>
			<Details>
				<Detail>
					<Type>Cancellation</Type>
					<Amounts>
						<Amount>
							<CurrencyAmountValue>500.00</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>TicketNumber="2LC5CN-XXXXXXXXXXXX0993"</Remark>
								<Remark>Funds held on the PNR</Remark>
							</ApplicableFeeRemarks>
						</Amount>
						<Amount>
							<CurrencyAmountValue>674.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
						<Amount>
							<CurrencyAmountValue>674.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
						<Amount>
							<CurrencyAmountValue>174.20</CurrencyAmountValue>
							<ApplicableFeeRemarks>
								<Remark>CardType="AX" MaskedCardNumber="XXXXXXXXXXX0009"</Remark>
								<Remark>Cancelled with Refund</Remark>
							</ApplicableFeeRemarks>
						</Amount>
					</Amounts>
				</Detail>
			</Details>
		</ChangeFees>
		<TicketDocInfos>
			<TicketDocInfo>
				<Payments>
					<Payment>
						<Method>
							<VoucherMethod>
								<Number>2LC5CN-XXXXXXXXXXXX0993</Number>
								<EffectiveExpireDate>
									<Expiration>2023-01-21</Expiration>
								</EffectiveExpireDate>
								<RemainingValue Code="TKT">500.00</RemainingValue>
							</VoucherMethod>
						</Method>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
						<Method>
							<PaymentCardMethod>
								<CardType>AX</CardType>
								<CardCode>CC</CardCode>
								<MaskedCardNumber>XXXXXXXXXXX0009</MaskedCardNumber>
								<CardholderAddress>
									<StructuredAddress>
										<Street>BEECH HILLS GARDEN APARTMENTS</Street>
										<CityName>LITTLE NECK</CityName>
										<StateProv>NY</StateProv>
										<PostalCode>11362</PostalCode>
										<CountryCode>US</CountryCode>
									</StructuredAddress>
								</CardholderAddress>
							</PaymentCardMethod>
						</Method>
					</Payment>
				</Payments>
				<TicketDocument>
					<TicketDocNbr>2LC5CN</TicketDocNbr>
					<Type>14</Type>
					<NumberofBooklets>0</NumberofBooklets>
					<ReportingType>Airline</ReportingType>
				</TicketDocument>
			</TicketDocInfo>
		</TicketDocInfos>
	</Response>
</OrderCancelRS>