Add Passive Reservation API Reference

ReservationDetail*

Top level object for the request. Includes the Offer object.

---

Offer*

Top level object for offer details. Includes Product object.

---

Product*

Array. Send one instance with the dates for the segment. Includes ProductHospitality object.

---

ProductHospitality*

Dates for the placeholder segment. Properties:

start: Segment start date in YYYY-MM-DD format.

end: Segment start date in YYYY-MM-DD format.

Example adds placeholder segment

{
 "ReservationDetail": {
  "Offer": [
   {
    "@type": "Offer",
    "Product": [
     {
      "@type": "ProductHospitality",
      "DateRange": {
       "start": "2025-11-10",
       "end": "2025-11-15"
      }
     }
    ]
   }
  ]
 }
}

The tables in this section break down the Add Passive Reservation request into its top level objects to separate the information in each.

 

ReservationDetail*

Top level object for the request.

Includes the Offer, Traveler, FormOfPayment, Payment, Receipt, and ReservationComment objects.

---

Offer*

Top level object for reservation details.

Send with @type value of Offer.

Includes Product, Price, and TermsAndConditionsFull object.

---

Product*

Details about the property, dates, and number of guests.

Send with @type value ProductHospitality.

Includes PropertyAddress, GuestCounts, PropertyKey, and DateRange objects.

Quantity : Number. The number of rooms requested; 1-9 inclusive supported. If not provided, default quantity is 1.

The terminal equivalent is MK1 for a confirmed passive segment.

passiveBookingReasonCode* : String. Character representing the reason for creating a passive segment. Value is stored in /BC- parameter.

Supported values:

• G – Group booking

• H – Property not listed

• I – Internet only rate

• N – Multi-level rate not offered (negotiated/corporate rate)

• P – Package or Tour rate not offered

• R – Rate not offered

• U – Property sold out

• V – Government rate not offered

bookingCode* : String. Booking code returned in the provider system. Value is stored in /R- parameter.

propertyName* if PropertyKey not sent : String. Name of property. Value is stored in /N- parameter.

associatedCityCode : String. IATA city code associated with property.

---

PropertyAddress* if PropertyKey not sent

Object for address details.

AddressLine* if PropertyKey not sent : String. Street address. Value is stored in the /W- parameter.

City* if PropertyKey not sent : String. City where property is located. Value is stored in the /W- parameter.

StateProv : Object for state or province.

value : String. State or province code where property is located. Value is stored in the /W- parameter.

Country : Object for country where property is located.

value : String. Country code where property is located. Value is stored in the /W- parameter.

PostalCode : String. Postal code where property is located. Value is stored in the /W- parameter.

---

guests

Integer. An attribute of Product. Total number of guests. Numeric values 1-9 inclusive supported. Default is 1. Values in GuestCounts supersede value in guests.

If only Product/guests is sent, adults are implied. It is recommended that you use GuestCounts for clarity and flexibility.

Value is stored in the /EX- parameter.

---

GuestCounts* if children are part of the request

Top level object.

Includes GuestCount object.

---

GuestCount* if children are part of the request

Array of qualifying codes and ages.

count* if children are part of the request : Integer. The number of guests in one AgeQualifyingCode.

If adult, value is stored in the /EX- parameter. If child, value is stored in the /EC- parameter.

ageQualifyingCode* if children are part of the request : String. Required only for children or if traveler age is relevant, such as for a senior discount.

Supported values and meanings:

• 10: Traveler in this GuestCount is an adult

• 8: Traveler in this GuestCount is a child

age* if children are part of the request : Integer. Age of traveler. Required only when request includes a child in room.

To specify multiple children with different ages, send an elements for each age. If you send one element with multiple children, the age value applies to all children.

---

DateRange* : Reservation date range.

start* : String. Check-in date in YYYY-MM-DD format.

end* : String. Check-out date in YYYY-MM-DD format.

---

PropertyKey* if not using property name and address

Object for Travelport Property ID information.

Send either the PropertyKey or both the property address and property name to specify the hotel.

If both PropertyKey and the property address (Product/PropertyAddress) and (Product/propertyName) name are sent, PropertyKey takes precedence.

chainCode* if not using property name and address : String. Two-character Travelport chain code to book.

propertyCode* if not using property name and address : String. Travelport property code of the property within the hotel chain. Value is stored in the /P- parameter.

---

Price*

Top level object for price information.

Includes CurrencyCode and PriceBreakdown objects.

TotalPrice* : Number. Total price of room rate. Value is stored in the /RQ- parameter.

Base : Number. Base price of room rate.

---

CurrencyCode*

Top level object.

decimalPlace* : Number. Number of decimal places for the currency code.

value* : String. Three-character currency code. Value is stored in the /RQ- parameter.

---

PriceBreakdown* if using commission

Object describing breakdown components of the rate price.

Includes Commission and Amount objects.

roomPricingType* if using commission : Describes the complete stay details. Accepted value: Per stay

---

Commission

Object describing commission type (Percent or Amount) and value.

Application : Describes the presence of a commission. Accepted value: Commissionable

Percent : Integer. Percent value of commission. Value is stored in /CM- parameter.

---

Amount

Object describing the currency amount of the commission.

value : Integer. Amount of commission. Value is stored in /CM- parameter.

code : String. Currency code of commission.

---

TermsAndConditionsFull

Object for the rules applied to this rate.

Includes ProductRateCodeInfo object.

---

ProductRateCodeInfo

Object for describing a rate descriptor.

Includes RateCodeInfo object.

---

RateCodeInfo

Object for describing a rate code associated with this rate.

rateID : String. Used to represent a Corporate Discount number associated with this rate. Value is stored in /CD- parameter.

---

Traveler*

Traveler details. Includes PersonName, Telephone, and Email objects.

---

PersonName*

Traveler details.

Given*: String. Traveler first name. Value is stored in /NM- parameter.

Surname*: String. Traveler last name. Value is stored in /NM- parameter.

Title: String. Salutation or honorific (e.g., Mr., Mrs., Ms., Miss, Dr.)

---

Telephone

Traveler telephone details. The schema does not require Telephone. However, some business rules may require telephone information.

countryAccessCode: String. Phone country code.

phoneNumber*  if sending Telephone: String. Phone number.

areaCityCode: String. Phone local area code.

cityCode: String. Phone city code.

---

Email

Traveler email address.

value: String. Traveler email address.

---

FormOfPayment

Top level object for form of payment details. Includes PaymentCard object.

---

PaymentCard* if using FormOfPayment.

Form of payment details. Includes CardNumber and SeriesCode objects. Values is stored in the /G- parameter.

expireDate* if using FormOfPayment: String. Credit card expiration date in MMYY format.

CardType: String. Type of card. Supported values: 

• Credit

• Debit

• Gift

CardCode* if using FormOfPayment: String. Two-character code for the type of credit card.

CardHolderName: String. Name on credit card.

---

CardNumber* if using FormOfPayment: Card number details.

PlainText* if using FormOfPayment: String. Credit card number.

---

SeriesCode

Security code of card.

PlainText: String. The credit card three- or four-digit CVV code

---

Payment*

Top level object for payment details. The payment object is used to explicitly denote the amount expected to be charged for the hotel reservation in this style:

• For Prepay Required rates, the full total amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false.

• For Deposit Required rates, the deposit amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false.

• For Guarantee Required rates, the full total amount is used. This amount is expected to be charged to the credit card at check in. Indicators should be set as: depositInd = false; guaranteeInd = true.

Includes Amount object.

id: String. Customer-assigned identifier for the payment.

PaymentRef: String. Customer-assigned name for the payment.

depositInd* : Boolean (true/false). If set to true, form of payment will be stored in /D- parameter.

This flag is for informational purposes only. No credit card is charged.

guaranteeInd* : Boolean (true/false). If set to true, form of payment will be stored in the /G- parameter.

This flag is for informational purposes only. No credit card is charged.

---

Amount

Amount of payment.

code: String. Currency code.

value: Decimal number. Amount to pay.

---

Receipt*

Top level object for confirmation details. Includes Confirmation object.

---

Confirmation*

Confirmation details. Includes ConfirmationStatus and Locator objects.

---

ConfirmationStatus

Status of confirmation.

Status: String. Status associated to the sold hotel segment. Supported value: Confirmed

---

Locator*: The supplier confirmation number.

locatorType*: String. Supported value: Confirmation Number.

source: String. Content source. Supplier chain code.

sourceContext*: String. Supported value: Supplier.

value*: String. The supplier confirmation number from the booking system.

---

Optional objects - Comment

ReservationComment

Optional top level object used for special instruction remarks. Values are stored in the /SI- parameter. Information sent is a request only and is not guaranteed. Includes Comment object.

commentSource* : String. Originator of comment. Supported values:

• Agency

• Supplier

• Traveler

shareWith* : String. Designates visibility of remark. Supported values: 

• Agency

• Supplier

• Traveler

---

Comment* 

Array of name/value pairs.

name* : String. Type of remark.

• Special instruction remarks: SI

• Value is stored in the /SI- parameter.

value* : String. Remark text. Limits:

Special instruction remarks: 50-character limit

 

Example adds hotel passive segment

{
 "ReservationDetail": {
  "Offer": [
   {
    "@type": "Offer",
    "Product": [
     {
      "@type": "ProductHospitality",
      "Quantity": 1,
      "passiveBookingReasonCode": "G",
      "bookingCode": "ABC123",
      "GuestCounts": {
       "@type": "GuestCounts",
       "GuestCount": [
        {
         "ageQualifyingCode": "10",
         "count": 2,
         "@type": "GuestCount"
        },
        {
         "ageQualifyingCode": "8",
         "count": 1,
         "age": 4,
         "@type": "GuestCount"
        }
       ]
      },
      "PropertyKey": {
       "chainCode": "HT",
       "propertyCode": "F5829"
      },
      "DateRange": {
       "start": "2026-03-10",
       "end": "2026-03-11"
      }
     }
    ],
    "Price": {
     "@type": "PriceDetail",
     "CurrencyCode": {
      "value": "USD",
      "decimalPlace": 2
     },
     "TotalPrice": 256,
     "Base": 200
    }
   }
  ],
  "FormOfPayment": [
   {
    "@type": "FormOfPaymentPaymentCard",
    "PaymentCard": {
     "@type": "PaymentCardDetail",
     "expireDate": "1026",
     "CardCode": "VI",
     "CardNumber": {
      "@type": "CardNumber",
      "PlainText": "1234123412341234"
     }
    }
   }
  ],
  "Payment": [
   {
    "@type": "Payment",
    "Amount": {
     "code": "USD",
     "value": 256
    },
    "guaranteeInd": true,
    "depositInd": false
   }
  ],
  "Receipt": [
   {
    "@type": "ReceiptConfirmation",
    "Confirmation": {
     "@type": "ConfirmationHold",
     "confirmationStatus": {
      "@type": "OfferStatusHospitality",
      "Status": "Confirmed"
     },
     "Locator": {
      "value": "12344DJSH ",
      "locatorType": "Confirmation Number",
      "source": "HL",
      "sourceContext": "Supplier"
     }
    }
   }
  ]
 }
}