Sign in

v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
Ticketing
GDS Exchanges

Add Payment

The Payment step takes place in a ticketing workbench session and applies the payment sent previously in the Form of Payment request to the offer/s specified in the Payment request payload. Payment can be sent for any type of offer, including air, seats, and ancillaries. Payment can be made for multiple offers and multiple types of offers in the same request. Form of payment information must either already be present in the reservation or the workbench. At workbench commit, tickets or EMDs are issued for any offer payment has been sent for. Payment is also required prior to ticketing when exchanging tickets in the case of an even exchange, or an add collect (price of new itinerary is greater than existing itinerary). In the case of an add collect, send Payment with a zero amount in Amount/value. See the Exchange, Refund, and Void Guide for details.

post/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments

Path parameters

ReservationResource_Identifierstring required
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

The Reservation Identifier you wish to add the payment to

Headers

travelportPlusSessionIdentifierstring
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TraceIdstring
Example:TraceID_123456789

Identifier used to correlate Air API invocations across a multi-call business flows.

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

@typestring required

Discriminator classes PaymentID or Payment

idstring

Customer-assigned identifier for the payment.

PaymentRefstring

Customer-assigned name for the payment.

depositIndboolean

If true, the payment is a deposit on the referenced Offer; at booking the provided card is charged for deposit or prepay rate.

guaranteeIndboolean

If true, the payment is a guarantee for the referenced Offer; no amounts are charged at booking; the customer is to make payment in person upon arrival.

Example request

{
  "@type": "Payment",
  "Identifier": {
    "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
    "authority": "TVPT"
  },
  "Amount": {
    "value": 124.56,
    "code": "USD",
    "minorUnit": 2,
    "currencySource": "Supplier",
    "approximateInd": true
  },
  "FormOfPaymentIdentifier": {
    "@type": "FormOfPaymentPaymentCash",
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "activeInd": true
  },
  "OfferIdentifier": [
    {
      "id": "offer_1",
      "offerRef": "offer_1",
      "Identifier": {
        "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
        "authority": "TVPT"
      }
    }
  ],
  "Fees": {
    "@type": "FeesDetail",
    "TotalFees": 111.11,
    "TotalAdditionalFeesPayableLocally": 2.1
  },
  "Taxes": {
    "@type": "TaxesDetail",
    "TotalTaxes": 330.1,
    "TaxInfo": [
      {
        "@type": "TaxInfo",
        "TaxCode": "XF",
        "CurrencyCode": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TaxBreakdown": [
          {
            "@type": "TaxInfo",
            "AirportCode": "MIA",
            "CurrencyCode": {
              "value": "USD",
              "codeAuthority": "ISO 4217",
              "decimalPlace": 4,
              "decimalAuthority": "ISO 4217"
            }
          }
        ]
      }
    ]
  },
  "TravelerIdentifierRef": [
    {
      "uris": [
        "google.com"
      ]
    }
  ],
  "BaseAmount": {
    "value": 124.56,
    "code": "USD",
    "minorUnit": 2,
    "currencySource": "Supplier",
    "approximateInd": true
  },
  "ExtendedPayment": {
    "NumberOfInstallments": 6,
    "FirstInstallment": 100,
    "RemainingAmount": 50
  }
}

Response

OK - Successful Response - 200

Example response

{
  "PaymentResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}