Introduction

The OrderCancel Webservice provides IATA Accredited Travel Agents, new retailers and Service Providers the ability to cancel the booking. The service cancels the booking and refunds the refundable amount to the original form of payment if applicable.

This service supports cancelling both hold booking (bookings without eTickets) and booking with eTickets.

1. Hold Booking - It cancels the itinerary and sends the confirmation email upon successful booking cancellation.
2. Booking with eTickets – It cancels the itinerary and refunds the refundable amount to the original form of payment. It also sends the confirmation email upon successful booking cancellation and refund process.

 

This service can only be used on existing bookings made using the Shop and Order APIs and may only be accessed by the agent who created the booking. If the agent went through a 3rd party provider to create the initial booking (GDS or service provider), it is also mandatory to go through this same provider in order to access the booking. If the above conditions are not met, the service will return an error and prevent access.

To cancel and refund bookings with eTickets, it is recommended that a client should call the  OrderReshop  service to get a refund quote before proceeding to the OrderCancel service, which cancels the booking.

Interface Design

 

This web service is called with the following inputs:

1. OrderID (Booking reference or PNR reference)
2. Expected refund amount (required only when booking with eTickets are cancelled)

The output data this service returns include:

• OrderID (Booking reference or PNR reference)
• Success or Error
• Total Refunded Price for booking including ancillaries
• E-ticket/EMD details along with amount refunded per Ticket/EMD.
   

Voiding / Cooling off policy for NDC

This is a complete summary of our cooling off/void windows. All timings are based off the time of the POS of the booking, so if it’s UK then it will be 23:59 GMT.

Void

Whenever a ticket is issued, either at booking creation or when ticketing a held booking, you have until 23:59L on the same day to cancel and ‘void’. This is where, for cash and credit card payments, we do not take any payment.

Cooling off

NDC applies a 24 hour ‘cooling off’ period from booking creation where you can cancel and receive a full refund if you have ticketed the booking in the first 24 hours (e.g. If you make a booking at 15:00 and ticket it at 22:00 the same day, you have 1hr59mins to void (until 23:59L) and until 14:59 the following day to get a full refund). As above, if the ticket is cancelled before 23:59L no payment will be taken. If after 23:59L but still within 24 hours of booking creation, a full refund is applicable. Note that this is primarily a benefit to those that ticket instantly, not to those that hold bookings for a period of time before ticketing.

This web service is called with the following inputs:

1. OrderID (Booking reference or PNR reference)

 The output data this service returns include:

1. Success or Error
2. Warning message which explains the details on when and how the refund will be processed
3. OrderID (Booking reference or PNR reference)

 

In these unsettled times of COVID-19 crisis, we want to make it easy for customers by allowing them to make a new booking with confidence, that’s why we are introducing a flexible option where customers can cancel a booking and get a refund voucher for the full ticket value irrespective of the booking type.

This helps customers to retain their entire ticket value and can use the same for their next travel (within 12 months from the first flight departure of the booking).

This web service is called with the following inputs:

1. OrderCancelParameters (‘BWC’ as the reason for refund voucher per booking - single voucher or 'BWM' as the reason for refund voucher per passenger - multi vouchers)
2. OrderID (Booking reference or PNR reference)

 The output data this service returns include:

1. Success or Error
2. In case of success, there will be a warning message to indicate that tickets will not be refunded, alternatively the ticket value can be used for future travel.
3. A remark to indicate “Total voucher value of the itinerary”
4. Ticket and EMD documents along with their statuses.
5. OrderID (Booking reference or PNR reference)

 

HttpHeaders

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

Client-key: Your 24-bit API connection key
SOAPAction: OrderCancel17_2_V1

 

Endpoints

LIVE	PRE-LIVE	BETA
https://api.ba.com/selling-distribution/OrderCancel/17.2/V1	https://test.api.ba.com/selling-distribution/OrderCancel/17.2/V1	https://test.api.ba.com/selling-distribution/sandbox/OrderCancel/17.2/V1

WSDL

https://test.api.ba.com/selling-distribution/ OrderCancel /api/V1?WSDL

Please update your WSDL to point to the correct endpoint.

 

1. Copy the Test URL ie  https://test.api.ba.com/selling-distribution/ OrderCancel /api/V1

2. Paste this URL into the SOAP address location.
   Example:

   WSDL Snippet Example

   <service name="OrderCancelDistributionAdapter">   <port name="OrderCancelDistributionAdapterSoap11" binding="tns:OrderCancelDistributionAdapterSoap11">     <soap:address location="[Paste the Test URL here]"/>   </port> </service>