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: Exchange, Refund, and Void Guide

NDCClosed New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide. only; not supported for GDSClosed Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport.. Supported only for Qantas (QF).

For NDC on Qantas only, within the voidClosed Voiding a ticket cancels the ticket and payment and is based on rules for the market in which the ticket was issued. Generally a ticket can be voided only the same day it was issued, usually up to midnight local agency time. See the Exchange, Refund, and Void Guide. period, you can use the Cancel Payment API to cancelClosed Cancel a ticket outside the void period without rebooking on another itinerary. Depending on the airline ticket policy, canceling a ticket may result in a full, partial, or no refund. the payment on a ticket. This refunds the payment, cancels the ticket but retains the itineraryClosed The entire trip on a booking, including all flights on all legs. Also called a journey., and creates a held bookingClosed A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. 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.

For differences in how the JSON APIs support GDS and NDC content, see the support tables for seats, ancillaries, fare rules, and exchanges. Also see the NDC and GDS Functionality Comparison.
For carrierClosed An airline.-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. 

{
    "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 Exchange, Refund, and Void Guide for other available options, depending on fare rules.

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