Refund Quote API Reference

POST

book/airoffer/reservationworkbench/{{workbenchID}/offers/canceloffer

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: NDC Modify, Cancel, and Exchange Guide

NDC only; not supported for GDS.

Use the Refund Quote API to determine what if any refund value may be available on a ticket. Establish a workbench session, send the Refund Quote request detailed here, then send an Order Cancel request if you want to cancel the ticket for a refund.

For Singapore Airlines (SQ) only, you can use the Refund Quote request to cancel specified segments instead of the entire itinerary: Send a product identifier along with the offer identifier. The ticket value is retained.

Refund Quote is a mandatory step when canceling a ticket outside the void period and there is any difference between the value of any potential refund and the purchase price. If Refund Quote is not sent, and there is not an available refund in the exact amount of the purchase price, Order Cancel returns the error message OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN.

See the NDC Modify, Cancel, and Exchange Guide for details on supported options and workflows.

For differences in support between GDS and NDC in the JSON APIs, see the support tables for seats, ancillaries, fare rules, and exchanges. Also see the NDC Carrier-Specific Notes and the NDC and GDS Functionality Comparison Chart.

For carrier-specific NDC differences, see NDC capabilities by airline through JSON API in the Travelport Knowledge Base. If you need login assistance, see Knowledge Base NDC Resources.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Send the message payload per below. For Singapore Airlines (SQ) only, you can cancel specified segments by sending a product identifier along with the offer identifier.

Show Request Body Table

Object	Description	Required/Optional
OfferQueryCancelOffer	Top level object.	Required
BuildFromOffer	Top level object.	Required
OfferIdentifier	Top level object.	Required
Identifier	Top level object for the offer identifier.	Required
value	Send the offer identifier for the offer you want to cancel and check refund status for. The offer identifier is returned in the Create Workbench response in Offer/Identifier/value.	Required
ProductIdentifier	If you want to cancel only one leg of the itinerary, send the product identifier for the leg you want to cancel. Includes Identifier object. Supported only on SQ to cancel segments on the specified leg of the itinerary; segments on products not sent will not be canceled when you send the Order Cancel request.	Optional; supported only for SQ
Identifier	Top level object for the product identifier for for the leg you want to cancel.	Optional; supported only for SQ
value	Send the product identifier for the leg to cancel, returned in the Create Workbench response in Offer/Product/Identifier/value.	Optional; supported only for SQ

Response

Show Response Body Table

Object	Description
OfferListResponse	Top level object. Includes OfferID object.
OfferID	Returns details of any possible refund. Includes Identifier, Product, Price, and ModifyPrice objects.
Identifier	Offer identifier for the offer sent in request. In this case, authority is always the NDC carrier code. Key value pairs: authority: Source of information. value: Unique system-generated identifier.
Product	Standard Product object with flight details for the offer as ticketed. See Reservation Retrieve for details.
Price	Standard Price object with price details for the offer as ticketed. See Reservation Retrieve for details.
ModifyPrice	Details about any refund. Includes CurrencyCode and TotalPrice objects.
CurrencyCode	The currency of the fare. Key value pairs: decimalPlace: Number of decimal places in the currency. value: String. Currency code.
TotalPrice	Number. A positive number here indicates the amount of the refund if the ticket is canceled with a subsequent Order Cancel request. A negative value indicates the amount of the ticket value that would be forfeited if the ticket is canceled with a subsequent Order Cancel request.

Example Request

The following example sends an offer identifier. All segments on the itinerary will be canceled in the subsequent Order Cancel request.

Show Request Refund Quote Example Request

{
 "OfferQueryCancelOffer": {
  "BuildFromOffer": {
   "@type": "BuildFromOfferAir",
   "OfferIdentifier": {
    "Identifier": {
     "value": "NUVJNUNCfFNRXzVFSTVDQl9BSVItMXxTUXxTUV81RUk1Q0J8cHJvZHVjdDFfczEtU0VHMXxBRFQ6UEFYMw=="
    }
   }
  }
 }
}

Example Response

For additional examples and scenarios, download the developer toolkits and see Using Postman and Developer Toolkits.

The response returns in the Modify Price object any refund that may be available. A positive number indicates the amount of the refund if the ticket is canceled with a subsequent Order Cancel request. A negative value indicates the amount of the ticket value that would be forfeited if the ticket is canceled with a subsequent Order Cancel request.

Show Example Request Refund Quote response

In the following example response, ModifyPrice indicates that if this ticket is canceled an amount of $2,935 HKD will be refunded.

{
 "OfferListResponse": {
  "@type": "OfferListResponse",
  "OfferID": [
   {
    "@type": "OfferModify",
    "scheduleChangeInd": true,
    "Identifier": {
     "authority": "SQ",
     "value": "NUVJNUNCfFNRXzVFSTVDQl9BSVItMXxTUXxTUV81RUk1Q0J8cHJvZHVjdDFfczEtU0VHMXxBRFQ6UEFYMw=="
    },
    "Product": [
     {
      "@type": "ProductAir",
      "totalDuration": "PT4H",
      "id": "product1",
      "Identifier": {
       "authority": "SQ",
       "value": "762fe1dd-d4b5-4458-be4a-af74b79d9e02"
      },
      "FlightSegment": [
       {
        "@type": "FlightSegment",
        "id": "s1",
        "sequence": 1,
        "Flight": {
         "@type": "Flight",
         "carrier": "SQ",
         "number": "895",
         "id": "seg1",
         "Identifier": {
          "authority": "SQ",
          "value": "c4e81840-f2d5-4a61-80a8-b5b218a6e20f"
         },
         "Departure": {
          "@type": "DepartureDetail",
          "terminal": "1",
          "location": "HKG",
          "date": "2022-12-22",
          "time": "18:50:00"
         },
         "Arrival": {
          "@type": "ArrivalDetail",
          "terminal": "0",
          "location": "SIN",
          "date": "2022-12-22",
          "time": "22:50:00"
         }
        }
       }
      ],
      "PassengerFlight": [
       {
        "@type": "PassengerFlight",
        "passengerQuantity": 1,
        "passengerTypeCode": "ADT",
        "FlightProduct": [
         {
          "@type": "FlightProduct",
          "segmentSequence": [
           1
          ],
          "classOfService": "W",
          "fareBasisCode": "W14HKO"
         }
        ]
       }
      ]
     }
    ],
    "Price": {
     "@type": "PriceDetail",
     "CurrencyCode": {
      "decimalPlace": 0,
      "value": "HKD"
     },
     "Base": 2670,
     "TotalTaxes": 265,
     "TotalFees": 0,
     "TotalPrice": 2935,
     "PriceBreakdown": [
      {
       "@type": "PriceBreakdownAir",
       "quantity": 1,
       "requestedPassengerType": "ADT",
       "Amount": {
        "@type": "Amount",
        "CurrencyCode": {
         "decimalPlace": 0,
         "value": "HKD"
        },
        "Base": 2670,
        "Taxes": {
         "@type": "TaxesDetail",
         "TotalTaxes": 265,
         "Tax": [
          {
           "taxCode": "G3",
           "value": 90
          },
          {
           "taxCode": "HK",
           "value": 120
          },
          {
           "taxCode": "I5",
           "value": 55
          }
         ]
        },
        "Total": 2935
       }
      }
     ]
    },
    "ModifyPrice": {
     "@type": "ModifyPriceDetail",
     "CurrencyCode": {
      "value": "HKD"
     },
     "TotalPrice": 2935
    }
   }
  ]
 }
}