Add Payment API Reference

POST

paymentoffer/reservationworkbench/{workbenchID}/payments

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/

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

If multiple forms of payment have been added, repeat the Add Payment step for each FOP. While an Add Payment request can include multiple offer IDs, such as for the itinerary and for paid seats, it supports only one FOP. In subsequent releases, AirTicketing will support linking a form of payment to a specific offer, and using a different FOP for individual offers.

Show Request Body Table

Object	Description	Required/Optional
Payment	Top level object. Includes the Identifier object.	Required
id	A user-assigned identifier for the payment. Supports up to 256 alphanumeric characters.	Required
Payment/Identifier	Payment identifier.	Required
authority	For both GDS and NDC send with the value Travelport.	Required
value	This is a placeholder value that has no use at this time. Any text can be sent.	Required
Amount	Top level object for amount of payment.	Required
code	Currency code that applies to the payment.	Required
minorUnit	The smallest unit of currency for the currency in code. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit.	Required
currencySource	Pending.	Required
value	The amount of the charge for this payment, in the currency noted in the code object.	Required
FormOfPaymentIdentifier	Top level object for FOP to reference.	Required
id	The id for the form of payment to be charged. Must match to a FOP already in the reservation or added to the workbench. Must mach a value sent in FormOfPaymentPaymentCard/id (for credit card) or FormOfPaymentCash/id (for cash) in the Add FOP request.	Required
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.	Required
FormOfPaymentIdentifier/Identifier	Send the payment identifier returned in the Add Form of Payment response.	Required
authority	Send with the value Travelport.	Required
value	This is a placeholder value that has no use at this time. Any text can be sent.	Required
OfferIdentifier	Top level object for offer to reference.	Required
id	Id for the offer to which this payment should apply. If the booking contains multiple offers, be sure to send the offer identifiers for all offers you are ready to ticket. For example, a booking could contain multiple offers for any of the following: air and one or more paid ancillaries multiple air offers air and/or hotel and car offers (as support for multi-content bookings is developed)	Required
offerRef	Id for the offer to which this payment should apply. Same value as sent in id. See above note for id and multiple offers.	Required
OfferIdentifier/Identifier		Required
authority	Send with the value Travelport for all content.	Required
value	The system-generated offer identifier returned in the applicable Search, Seats, Ancillary etc. response.	Required

Response

Show Response Body Table

Object	Description
PaymentResponse	Top level object for response.
Payment	Includes 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.

Object

Description

PaymentResponse

Top level object for response.

Payment

Includes 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.

Example Request

Show Example Add Payment Request for itinerary only

{
 "Payment": {
  "id": "payment_1",
  "Identifier": {
   "authority": "Travelport",
   "value": "A0656EFF-FAF4-456F-B061-0161008D6A5E"
  },
  "Amount": {
   "code": "USD",
   "minorUnit": 2,
   "currencySource": "Charged",
   "approximateInd": true,
   "value": "2773.5"
  },
  "FormOfPaymentIdentifier": {
   "id": "formOfPayment_5", 
   "FormOfPaymentRef": "formOfPayment_5", 
   "Identifier": {
    "authority": "Travelport",
    "value": "A0656EFF-FAF4-456F-B061-0161008D6FOP" 
   }
  },
  "OfferIdentifier": [
   {
    "id": "offer_1",
    "offerRef": "offer_1",
    "Identifier": {
     "authority": "Travelport",
     "value": "4ac0a1d8-fd2a-4192-83f5-cab69979ef4e"
    }
   }
  ]
 }
}

To issue the ticket and an EMD for a paid ancillary that has been added to the workbench, send both offer IDs per this example.

Show Example Add Payment request for itinerary + ancillary offer

To issue the ticket and an EMD for a paid ancillary that has been added to the workbench, send both offer IDs per this example. Offer offer_1 is for the itinerary and an_o1 is for the ancillary offer.

{
 "Payment": {
  "id": "payment_1",
  "Identifier": {
   "authority": "Travelport",
   "value": "A0656EFF-FAF4-456F-B061-0161008D6A5E"
  },
  "Amount": {
   "code": "AUD",
   "minorUnit": 2,
   "currencySource": "Charged",
   "approximateInd": true,
   "value": 63.1
  },
  "FormOfPaymentIdentifier": {
   "id": "formOfPayment_5",
   "FormOfPaymentRef": "formOfPayment_5",
   "Identifier": {
    "authority": "Travelport",
    "value": "A0656EFF-FAF4-456F-B061-0161008D6FOP"
   }
  },
  "OfferIdentifier": [
   {
    "id": "offer_1",
    "offerRef": "offer_1",
    "Identifier": {
     "authority": "Travelport",
     "value": "07664bb3-37a0-4c63-a2ef-ed71b5f48d49"
    }
   },
   {
    "id": "an_o1",
    "Identifier": {
     "authority": "Travelport",
     "value": "3427d42c-a72d-49ff-b29e-7bb8faa28a47"
    }
   }
  ]
 }
}

Example Response

Show Example Response

{
    "PaymentResponse": {
        "Payment": {
            "@type": "PaymentIdentifier",
            "Identifier": {
                "authority": "Travelport",
                "value": "af076693-cfc3-49f3-b7d6-554aa9d8bfce"
            }
        }
    }
}