Check Flight Tickets
The Check Flight Tickets method is designed to facilitate the process of checking flight ticket options (void or refund) in a single, seamless API call.
The Check Flight Tickets method is part of the larger Booking Management API, available in RPC/JSON format and designed to operate in a stateless way.
While this API is designed to operate in a stateless way, it accepts both sessionless (ATK) and session-based (ATH) tokens. When a call is made to this API via a session-based token, the session (AAA) is cleared before and after execution.
The logic executed by Check Flight Tickets is defined by the electronic documents or the
confirmationId submitted. The application will retrieve details for the entire reservation, or each document, and then validates if the requirements for the refund procedure are met. This includes pricing the refundable amount. With this logic, you can specify refund qualifiers for all ATPCO tickets.
In the second step, the application will verify void requirements. The analysis includes void period, coupon status, and if all of the documents belong to the same reservation.
Note: Support for refund pricing depends on the participation of the issuing carrier and market.
The APIs orchestrated by Check Flight Tickets include:
Check Flight Tickets Request Structure
The Check Flight Tickets method checks tickets as specified. This allows you to submit a list of up to 12 elements from the same reservation to be checked.
targetPCCis used to specify which city (PCC) should change context using
ContextChange(AAA). If empty, or equals the current city, the context doesn't change.
ticketsis an array used to provide a list of 12 tickets to be checked. 1 to 12 elements are accepted.
numberis the 13-digits electronic document number of the ticket.
refundQualifiersallows you to specify your request with additional parameters. This might override the automated pricing logic and is at your own responsibility.
overrideCancelFeeis used to set a specific cancel fee agreed with the issuing carrier.
overrideTaxesallows you to override any refundable tax amount from the ticket. For XF tax, the airport code where its collected is required.
commissionAmountis used to set a total commission amount to be collected. This cannot be combined with
commissionPercentageis used to set a relative commission. This cannot be combined with
commissionOnPenaltyis used to collect the commission from the applicable penalty for the refund.
waiverCodeis used to specify the max 14 characters waiver code.
tourCodeis used to specify the max 15 characters tour code.
splitRefundAmountsspecifies split refund amounts. This requires more than one form of payment when issuing tickets. Values of zero are accepted.
journeyTypeCodespecifies the journey code in the markets where required.
confirmationIdis used to specify the PNR Locator or Sabre Order ID. Alternatively,
ticketscan be defined.
Check Flight Tickets Response Structure
The Check Flight Tickets response contains:
errorscontains errors and warnings (if applicable)
requestcontains the request send to the API
ticketscontains detailed information about voidability and refundability of each ticket
cancelOfferscontains detailed information about voidability and refundability of the NDC Order
- Only the entire NDC order can be checked. Partial voids or refunds are currently not supported.
- A maximum of 12 documents is supported
- All documents must belong to the same reservation (PNR)
- EMDs are currently not supported
This section illustrates the current error handling logic for Check Flight Tickets:
Note: Please access the Check Flight Tickets - Error List section for additional details on possible errors returned by Check Flight Tickets.
Errors/Warnings returned by downstream services
The Check Flight Tickets response contains errors and warnings returned by downstream APIs and are always returned as a