Ticketing API Reference

This topic provides an API reference for the requests and responses in the AirTicketing workflow. Workflow details and code examples are in AirTicketing Workflow.

In this topic:

Create Workbench with PNR

The first step in the AirTicketing workflow is to create a post-commit workbench. Use the workbench ID returned in subsequent requests up until the itinerary is ticketed, at which point the workbench is discarded.

Query Parameters

Parameter Description Required/Optional

Locator

Send the PNR in the Locator parameter when creating a workbench for an existing reservation.

Required

POST Request

Send the POST request to the following resource:

POST book/session/reservationworkbench/buildfromlocator?Locator={PNR}

Base path:

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

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

Payload

Object Description Required Optional

ReservationID

Empty container to request workbench ID.

None

None

Create Workbench Response

The response is the same as for a PNR retrieve, plus a workbench ID at the end of the response in an additional Identifier object, per the table below.

This workbench ID must be sent in all subsequent steps in the workflow.
Object Description

See PNR Retrieve for all other objects in the response.

 

Identifier

Returns workbench identifier.

  • authority: Issuer of the workbench ID. This is always Travelport.
  • id: Identifier for the workbench session. This must be sent in the remaining steps in the workflow.

Add Form of Payment

The next step is to add form of payment (FOP) details to the workbench.

Form of payment details are sent in the message payload. Either cash or credit card FOP is supported.

Query Parameters

None.

POST Request

Send the POST request to the following resource:

POST payment/reservationworkbench/{workbenchID}/formofpayment

Base path:

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

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

Payload

Request Payload for Credit Card FOP
Object Description Required Optional

FormOfPaymentPaymentCard

Top level object for request.

id: A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

None

FormOfPaymentRef

A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

Must be the same value sent in FormOfPaymentPaymentCard/id in the row above.

None

None

PaymentCard

Credit card details.

Includes CardType, CardCode, CardHolderName, CardNumber, Series, and Address objects.

id: A user-assigned identifier for this payment card. Supports up to 256 alphanumeric characters.

expireDate: Expiration date of the card in MMYY format.

None

CardType

Type of card.

This value must be 'Credit'.

None

CardCode

Card code.

Code for the credit card type.

None

CardHolderName

Optional text string for the cardholder name.

None

None

CardNumber

Top level object for the credit card number.

Contains the PlainText object.

None

None

PlainText

The credit card number.

None

None

SeriesCode

Top level object for the CVV code.

The CVV code is required for an NDC itinerary. It is not used for GDS itineraries. This and the remainder of the objects in this table apply only to NDC content.

None

None

PlainText

The credit card 3-digit CVV code.

None

None

Address

Billing address details.

Includes Number, Street, AddressLine, City, StateProv, Country, and PostalCode objects.

None

None
Number

 

The street number of the billing address.

value: The street number.

None
Street

 

The street name of the billing address.

value: The street name.

None

AddressLine

Extra address line.

None

None
City

 

The city of the billing address.

None

None

StateProv

The state or province of the billing address.

value: The state or province.

None

Country

The country of the traveler address.

None

None

PostalCode

The postal code of the billing address.

None

None
Request Payload for Cash FOP
Object Description Required Optional

FormOfPaymentCash

Top level object for request.

id: A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

None

FormOfPaymentRef

A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

Must be the same value sent in FormOfPaymentCash/id in the row above.

agentNonRefundableInd: Value of true indicates agent is using its own FOP; value of false does not need to be sent and is ignored if sent.

 

None

Identifier

Payment identifier.

authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.

value: This is a placeholder value that has no use at this time. Any text can be sent.

None
Request Payload for Agent Invoice FOP
Object Description Required Optional

FormOfPaymentInvoice

Top level object for request.
  • id: A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

None

FormOfPaymentRef

A user-assigned identifier for this form of payment. Supports up to 256 alphanumeric characters.

  • agentNonRefundableInd: Value of true indicates agent is using its own FOP; value of false does not need to be sent and is ignored if sent.

 

None

Identifier

Payment identifier.
  • authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.
  • value: This is a placeholder value that has no use at this time. Any text can be sent.

None

InvoiceNumber

Agent invoice number.

None

None

Response for Add Form of Payment

Object Description

FormofPaymentResponse

Top level object for response.

Identifier

Returns confirmation identifier.

  • authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.
  • value: Confirmation identifier. This identifier has no subsequent use at this time.

Add Payment

The add payment step commits the payment for the itinerary. It references both the form of payment and the offer.

Query Parameters

None.

POST Request

Send the POST request to the following resource:

POST paymentoffer/reservationworkbench/{workbenchID}/payments

Base path:

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

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

Payload

The following table lists all required and optional payload objects.

Object Description Required Optional

Payment

ID for the payment.

Contains the Identifier object.

id: A user-assigned identifier for the payment. Supports up to 256 alphanumeric characters.

None

Payment/Identifier

Payment identifier.

authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.

value: This is a placeholder value that has no use at this time. Any text can be sent.

None

Amount

Details about the payment to be made.

Provides cost amount in the following key value pairs:

  • code: Currency code that applies to the payment.
  • minorUnit: The smallest unit of currency for the currency in code.
  • currencySource: Pending.
  • approximateInd: true indicates the charge is approximate, false indicates the charge is an exact price.

None

FormOfPaymentIdentifier

 

id: The id for the form of payment to use. Must be the same value sent in FormOfPaymentPaymentCard/id (for credit card) or FormOfPaymentCash/id (for cash) in the Add FOP request.

None

FormOfPaymentRef

The id for the form of payment to use. Must be the same value sent in FormOfPaymentRef in the Add FOP request. Must also match the value sent above in FormOfPaymentIdentifier/id.

None

None

FormOfPaymentIdentifier/Identifier

 

authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.

value: This is a placeholder value that has no use at this time. Any text can be sent.

None

OfferIdentifier

The offer for which this payment should be applied.

id: Id for the offer to which this payment should apply.

offerRef: Id for the offer to which this payment should apply. Same value as sent in id.

None

OfferIdentifier/Identifier

 

authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.

value: The offer identifier.

None

Add Payment Response

Object Description

PaymentResponse

Top level object for response.

Payment

Contains Identifier object.

Identifier

Returns confirmation identifier.

  • authority: For GDS content this value is Travelport. For NDC content this value is the issuing carrier's name.
  • value: Confirmation identifier. This identifier has no subsequent use at this time.

Commit (Issue Ticket)

After submitting payment, commit the transaction and issue the ticket. There is no message payload. You can include the optional Issuance parameter, detailed below, in the POST request.

Query Parameters

Parameter Description Required/Optional

Issuance

Updates any back office accounting systems with ticket information. Send with a value of BACKOFFICE. The ticket can have already been issued, or not issued yet. If payment has been added to the workbench, a ticket is also issued. See Back Office Accounting for details.

Optional

POST Request

Send the POST request to the following resource:

POST receipt/reservations/{workbenchID}

Priceline customers should instead use the following endpoint, which is for use only by Priceline and will be deprecated in the future and replaced with the endpoint above:
receipt/reservations/{workbenchID}/receipts/buildfromlocator?ReservationLocator={PNR}

Base path:

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

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

Payload

None.

Issue Ticket Response

Object Description

ReceiptListResponse

Top level object for response.

Includes the ReceiptID object.

ReceiptId

Contains all ticketing details. One instance for each ticket on the PNR.

Document

Returns the ticket number in Number.