Ticket as FOP API Reference

Get

book/airoffer/reservationworkbench/{LocatorCode}/offers/buildfromoffer

For {LocatorCode} send the locator code of the reservation to retrieve (returned in the workbench commitClosed API call that ends a workbench session, finalizing all changes and requests in that session. Depending on the workbench transactions, the commit workbench request may create a reservation, issue a ticket or EMD, exchange tickets, or modify a reservation. in Confirmation/Locator/value).

Base path:

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

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

Related Content: Booking Guide, Ticketing Guide

For supporting NDC carriers only, the JSON APIs support using the value on an unused ticket as form of payment (FOP)Closed Details for the payment to be used to pay for an offer, such as credit card information. The subsequent Add Payment step is required to charge the payment. when ticketing a separate, held booking.

For carrierClosed An airline. support, see Deferred Payment in NDC capabilities by airline through JSON API in the Travelport Knowledge Base.

Ticket as FOP Details

The following must be in place to use a ticket as FOP: 

Supported Options

When applying an unused ticket as FOP:

  • Only one ticket per passenger can be exchanged.

  • Tickets are non-transferable and must match the passenger listed on the order.

  • If a held booking has multiple passengers, a ticket must be submitted for each passenger on the held booking.

  • When exchanging multiple tickets, each ticket must have the same itinerary and coupon status.

  • Tickets cannot have segments with an active itinerary.

Workflow

Use the following workflow to apply an unused ticket to a held booking:

  1. Create post-commit workbench.

  2. Send the OfferQueryBuildFromOffer request per below. The response returns the value of the ticket that can be applied to any new booking.

  3. Additional steps may be required depending on the price of the held booking compared to the available ticket value. If the total price of the held booking:

  4. Commit the workbench to issue the new ticket. If a balance due was paid for, the commit issues an EMD. If a balance remains, the passive PNR is updated with DI linesClosed Document instruction (DI) lines in the booking record contain information such as price, flight information, confirmation, ticketing time limits, fees, and form of payment. Not returned as DI lines in the JSON APIs but available through a desktop program. referencing the EMD and the remaining balance contained on it.

Request

Query Parameters

None.

Request Body

Response

Pending.

Example Request

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

The example request below sends the ticket number for the unused ticket in DocumentNumber.

Example Response

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

In the following example excerpt from the commit response, the value of the unused ticket exceeded the cost of the held booking. In this case, an instance of Document with @type DocumentTicket returns the ticket number and an amount of 0, while the instance of Document with @type DocumentEMD has a positive amount of 118.2, indicating that a residual value of 118.2 remained on the ticket and has been issued as an EMD.