Cancel Payment API Reference

POST

paymentoffer/reservationworkbench/{workbenchID}/payments/{paymentID}

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

For {paymentID} send the identifier in Payment/id returned 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. Supported only for Qantas (QF).

For NDC on Qantas only, within the void period, you can use the Cancel Payment API to cancel the payment on a ticket. This refunds the payment, cancels the ticket but retains the itinerary, and creates a held booking for later fulfillment. For example, you might want to use this workflow to use a different payment method than was sent in ticketing.

You must establish a workbench session before sending the Cancel Payment request detailed here. After sending Cancel Payment, you must commit the workbench to implement the change.

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

After creating a post-commit workbench, send a POST request to the endpoint above. There is no message payload.

Example Request

No message payload.

Example Response

For a successful cancel payment request, Cancel Payment returns an empty PaymentResponse object per below. After successfully canceling the payment, commit the workbench to implement the change. Because no payment is present in the workbench, the ticket is voided but the segments are retained.

Show Example Cancel Payment response

{
    "PaymentResponse": {}
}

If the ticket is outside the void period, Cancel Payment returns the following error message without canceling the payment or changing the ticket in any way. In this case you cannot void the ticket. See the NDC Modify, Cancel, and Exchange Guide for other available options, depending on fare rules.

Show Example Cancel Payment response for error outside void period

{
  "ErrorResponse": {
    "Result": {
      "Error": [
        {
          "@type": "Error",
          "StatusCode": 405,
          "Message": "Cannot cancel the ticket. The Reservation is outside void period."
        }
      ]
    }
  }
}