Check the Hotel Release Notes for updates across all Hotel APIs.

Create Passive Reservation API Reference

POST

book/reservations/passive

Base path:

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

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

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

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/11/hotel/

Production https://api.travelport.net/11/hotel/

Use Create Passive Reservation to add a passive hotel booking segment to an existing booking. This is a full payload request that creates a single HTL MK segment in the PNR constructed from the components of the request. There is no reference payload version of this request.

Request

Also see Authentication and Common Hotel API Headers.

Query Parameters

None.

Request Body

Show Request Body Table

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

Object	Description	Required/Optional
ReservationDetail	Top level object for the request. Includes the Offer, Traveler, FormOfPayment, Payment, Receipt, and ReservationComment objects.	Required

Object

Description

Required/Optional

ReservationDetail

Top level object for the request.

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

Required

Offer object

Object	Description	Required/Optional
Offer	Top level object for reservation details. Includes Product, Price, and TermsAndConditionsFullobjects.	Required
Product	Details about the property, dates, and number of guests. Includes PropertyAddress, GuestCounts, PropertyKey, and DateRange objects.	Required
Quantity	Integer. The number of rooms requested; 1-9 inclusive supported. If not provided, default quantity is 1. Example: MK1	Optional
passiveBookingReasonCode	String. Character representing the reason for creating a passive segment. Value will be stored in /BC- parameter. Codeset: 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	Required
bookingCode	String. Booking code returned in the provider system. Value will be stored in /R- parameter.	Required
propertyName	String. Name of property. Value will be stored in /N- parameter	Required if property ID not entered.
associatedCityCode	String. IATA city code associated with property. Default value: HDQ	Optional
PropertyAddress	Object for address details.	Required if property ID not entered.
AddressLine	Array of strings. Street Address. Value will be stored in the /W- parameter	Required
City	String. City where property is located. Value will be stored in the /W- parameter	Required
StateProv	Object for State or Province.	Optional
value	String. State or Province code where property is located. Value will be stored in the /W- parameter.	Optional
Country	Object for Country where property is located.	Optional
value	String. Country code where property is located. Value will be stored in the /W- parameter.	Optional
PostalCode	String. Postal code where property is located. Value will be stored in the /W- parameter.	Optional
guests	Integer. Total number of guests. Numeric values 1-9 inclusive supported. Default is 1. Value will be stored in the /EX- parameter. Values in GuestCounts supersede value in guests.	Optional
GuestCounts	Top level object. Includes GuestCount object.	Required if children are part of the request.
GuestCount	Array of qualifying codes and ages.	Required if children are part of the request.
count	Integer. The number of guests in one AgeQualifyingCode. If adult, value will be stored in the /EX- parameter. If child, value will be stored in the /EC- parameter.	Required if children are part of the request.
ageQualifyingCode	String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8	Required if children are part of the request.
age	Integer. Age of traveler. Required only when request includes a child in room.	Required for the children in the request.
DateRange	Reservation date range.	Required
start	String. Check-in date in YYYY-MM-DD format.	Required
end	String. Check-out date in YYYY-MM-DD format.	Required
PropertyKey	Object for Travelport Property ID information.	Required if not using property name and address.
chainCode	String. Two-character Travelport chain code to book.	Optional
propertyCode	String. Travelport property code of the property within the hotel chain. Value will be stored in the /P- parameter.	Required if not using property name and address.
Price	Top level object for price information. Includes CurrencyCode and PriceBreakdown objects.	Required
TotalPrice	Decimal number. Total price of room rate. Value will be stored in the /RQ- parameter	Required
Base	Decimal number. Base price of room rate.	Optional
CurrencyCode	Top level object.	Required
decimalPlace	Integer. Number of decimal places for the currency code.	Required
value	String. Three-character currency code for the offer returned in either the Availability or Rules response. Value will be stored in the /RQ- parameter.	Required
PriceBreakdown	Object describing breakdown components of the rate price. Includes Commission and Amount objects.	Required if using commission.
roomPricingType	String. Describes the complete stay details. Accepted Value: Per stay	Required if using commission.
Commission	Object describing commission type (Percent or Amount) and value.	Optional
Application	String. Describes the presence of a commission. Accepted Value: Commissionable.	Optional
Percent	Integer. Percent value of commission. Value will be stored in /CM- parameter.	Optional
Amount	Object describing the currency amount of the commission.	Optional
value	Decimal number. Amount of commission. Value will be stored in /CM- parameter.	Optional
code	String. Currency code of commission.	Optional
TermsAndConditionsFull	Object for the rules applied to this rate Includes the ProductRateCodeInfo object.	Optional
ProductRateCodeInfo	Object for describing a rate descriptor Includes RateCodeInfo object.	Optional
RateCodeInfo	Object for describing a rate code associated with this rate	Optional
rateID	String. Used to represent a Corporate Discount number associated with this rate. Value will be stored in /CD- parameter.	Optional

Traveler object

Object	Description	Required/Optional
Traveler	Traveler details. Includes PersonName, Telephone, and Email objects.	Required
PersonName	Traveler details. Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. PersonName exceeding 22 characters is truncated in the response.	Required
Given	String. Traveler first name.	Required
Surname	String. Traveler last name.	Required
Title	String. Salutation or honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)	Optional
Telephone	Traveler telephone details.	Required
countryAccessCode	String. Phone country code.	Optional
phoneNumber	String. Phone number.	Required
areaCityCode	String. Phone local area code.	Required
cityCode	String. Phone city code.	Optional
Email	Traveler email address.	Optional
value	String. Traveler email address.	Optional

FormOfPayment object

Object	Description	Required/Optional
FormOfPayment	Top level object for form of payment details. Includes PaymentCard object.	Optional
PaymentCard	Form of payment details. Includes CardNumber and SeriesCode objects. Values will be stored in the /G- parameter.	Required if using FormOfPayment.
expireDate	String. Credit card expiration date in MMYY format.	Required if using FormOfPayment.
CardType	String. Type of card including Credit, Debit, and Gift.	Optional
CardCode	String. Code for credit card type.	Required if using FormOfPayment.
CardHolderName	String. Name on credit card.	Optional
CardNumber	Card number details.	Required if using FormOfPayment.
PlainText	String. Credit card number.	Required if using FormOfPayment.
SeriesCode	Security code of card.	Optional
PlainText	String. The credit card three- or four-digit CVV code.	Optional

Payment object

Object	Description	Required/Optional
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.	Required
id	String. Customer-assigned identifier for the payment.	Optional
PaymentRef	String. Customer-assigned name for the payment.	Optional
depositInd	Boolean (true/false). If set to true, form of payment will be stored in /D- field.	Required
guaranteeInd	Boolean (true/false). If set to true, form of payment will be stored in the /G- field.	Required
Amount	Amount of payment.	Optional
code	String. Currency code.	Optional
value	Decimal number. Amount to pay.	Optional

Receipt object

Object	Description	Required/Optional
Receipt	Top level object for confirmation details. Includes Confirmation object.	Required
Confirmation	Confirmation details. Includes ConfirmationStatus and Locator objects	Required
ConfirmationStatus	Status of confirmation.	Optional
Status	String. Status associated to the sold hotel segment. Accepted value: Confirmed	Optional
Locator	The supplier confirmation number.	Required
locatorType	String. Accepted value: Confirmation Number.	Required
source	String. Content source. Supplier chain code.	Optional
sourceContext	String. Accepted value: Supplier.	Required
value	String. The supplier confirmation number from the booking system.	Required

Optional objects - Comment

Object	Description	Required/Optional
ReservationComment	Optional top level object used for special instruction remarks. Values will be stored in the /SI- parameter. Includes Comment object.	Optional
commentSource	String. Originator of comment. Accepted value: Agency.	Required
shareWith	String. Designates visibility of remark. Special instructions: Supplier	Required
Comment	Array of name/value pairs.	Required
name	String. Type of remark. Special instruction remarks: SI	Required
value	String. Remark text. Limits: Special instruction remarks: 50 characters	Required

Response

The following response objects and elements are specific to passive segments within a reservation. If the complete reservation has both active and passive segments, additional

objects and elements may be present as found in the Create Reservation Reference Payload API Reference.

Show Response Body Table

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

Top level objects

Object	Description
ReservationResponse	Top level object for the response.
Reservation	Top level object. Key value pair: id: Internal identifier for the response. Includes Offer, Traveler, TravelerProduct, and Receipt objects. May include ReservationComment.
Offer	Top level object for offer details. Key value pair: id: System-generated offer identifier value sent in the reference payload request to book that offer. Note that id is not returned in the response to a full payload request. This is the only difference in the two responses. Includes Identifier object and, detailed in tables below, Product, Price, and TermsAndConditionsFull objects.
Identifier	Defines which supplier system returned that specific room rate (offer). Key value pair: authority: Indicates which supplier returned the lowest available rate for that property. Acceptable value is: TVPT: Travelport value: Reference offer ID value.
Traveler	Traveler details. See table below.
TravelerProduct	Reference numbers to link travelers to a specific offer. See table below.
Receipt	Top level object for confirmation details. See table below.
ReservationComment	Top level object for remarks stored in the PNR. See table below.

Offer/Product object

Object	Description
Product	Array. One instance for each product, type ProductHospitality. Product is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs: bookingCode: Booking code retrieved from the Availability response. passiveBookingReasonCode: One character reason code for choosing to use a passive segment. propertyName: Name of property offering this product. guests: Number of guests. Quantity: Number of rooms currently available matching this rate. associatedCityCode: A three character IATA city code associated to this property. associatedAirportCode: A three character IATA airport code associated to this property. passiveOfferInd: Boolean. Set to true for all passive segments. Includes PropertyKey, PropertyAddress, Telephone, GuestCounts, and DateRange objects.
PropertyKey	Top level property identification object. Key value pairs: chainCode: Chain code for the property propertyCode: Property code for the property.
PropertyAddress	Top level property address object. Key value pairs: City: Property city. PostalCode: Property postal code. Includes AddressLine, StateProv, and Country objects.
AddressLine	Array of strings (typically one string) for property street address.
StateProv	Property state or province. Key value pair: value: The state or province code of the property address. name: State/province name or code.
Country	Property country. Key value pair: name: Country name or code.
Telephone	Telephone number of property. Key value pairs: phoneNumber: string. Accepted characters: numeric, dash, space, period. cityCode: IATA city code if referenced by phone number
GuestCounts	Object for number and type of guests.
GuestCount	Array describing guest details. Key value pairs: count: Numeric. Number of travelers. age: Numeric. Child age. ageQualifyingCode: String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8
TravelerContact	Object for Traveler Contact information. Contains Email and Telephone objects.
Email	Object containing the Traveler email information. Key value pair: value: The email address of the traveler.
Telephone	Object containing the Traveler phone information. Key value pairs: countryAccessCode: Country code of traveler phone number areaCityCode: Area code of the traveler phone number phoneNumber: Main section of the traveler phone number cityCode: City code associated to traveler phone number
DateRange	Check-in and -out dates. Key value pairs: start: Check-in date in YYYY-MM-DD format. end: Check-out date in YYYY-MM-DD format.

Offer/Price object

Object	Description
Price	Price details for this offer or rate. Price is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs: Base: Base price before taxes and fees. Not returned by all suppliers. TotalPrice: The amount of the offer. Includes CurrencyCode and PriceBreakdown objects.
CurrencyCode	The currency code the amount is provided in. Key value pairs: decimalPlace: Decimal place number. value: Three-character currency code.
PriceBreakdown	The information returned in PriceBreakdown can vary by provider and location. Key value pair: roomPricingType: A string provided by the hotel to describe the rate, such as per night or per stay. Includes Amount and Commission objects.
Amount	The rate amount. Key value pairs: Base: Base amount of the rate not including taxes or fees. Total: Total for this group of nights. Includes CurrencyCode (see above) object.
Commission	Commission details. Key value pairs: When returned with type: CommissionPercent: application: A value of Commissionable indicates the rate pays commission. Non-paying indicates no commission. Percent: Provides the commission percentage. When returned with type: CommissionAmount application: Same as above. Amount: Exact amount of commission paid for this booking. code: Three-character currency code. value:Decimal number amount of commission.

Offer/TermsAndConditionsFull object

Object	Description
TermsAndConditionsFull	Top level object for terms and conditions, instances of TermsAndConditionsFullHospitality. Includes Guarantee and ProductRateCodeInfo objects. TermsAndConditionsFull is a common object in the model. Not all objects in this table may be returned in this specific API.
Guarantee	Array. Indicates if the room rate requires a guarantee to be booked. Key value pair: guaranteeType: The type of guarantee. The following are guarantee types that may be returned: PrepayRequired DepositRequired GuaranteesNotRequired Profile DepositNotRequired NoGuaranteesAccepted GuaranteeRequired CC/DC/Voucher PrepayNotRequired GuaranteesAccepted NoDepositsAccepted
ProductRateCodeInfo	Top level object for rate code details. Includes RateCodeInfo object.
RateCodeInfo	Rate code information. Key value pair: rateID: ID of the rate plan associated with the negotiated rate plan code.

Traveler object

Object	Description
Traveler	Traveler details. Key value pair: id: Travelport generated traveler identification number. Always the letter "T" followed by a unique number. Includes PersonName, Telephone, and Email objects.
PersonName	Key value pairs: Given: Traveler first name. Surname: Traveler last name. Prefix: Honorific title. The combination of Given and Surname is limited to 22 characters. Given name must have at least one character. Any additional characters beyond the 22 limit are truncated.
Telephone	Traveler telephone details. Key value pairs: phoneNumber: Phone number. areaCityCode: Phone local area code. countryAccessCode: Phone country code. cityCode: Traveler city code.
Email	Traveler email address. Key value pair: value: Traveler email address.

TravelerProduct object

Object	Description
TravelerProduct	Top level object array that links a particular traveler to a particular hotel segment (offer). Each offer has a linked traveler. Key value pairs: TravelerRef: Traveler reference number allowing a linkage to an offer. OfferRef: Offer reference number allowing a linkage to a traveler.

Object

Description

TravelerProduct

Top level object array that links a particular traveler to a particular hotel segment (offer). Each offer has a linked traveler.

Key value pairs:

TravelerRef: Traveler reference number allowing a linkage to an offer.

OfferRef: Offer reference number allowing a linkage to a traveler.

FormOfPayment object

Object	Description
FormOfPayment	Top level object array describing the form of payment Key value pair: id: Payment reference number allowing a linkage to an offer. Includes PaymentCard object.
PaymentCard	Object referencing payment card information. Key value pairs: expireDate: Four numeric code representing month and year of expiration date CardCode: Two character card brand code. CardHolderName: Name on card. Includes CardNumber object.
CardNumber	Object referencing details of the charge/debit card. Key value pair: PlainText: Number on charge/debit card.

Object

Description

FormOfPayment

Top level object array describing the form of payment

Key value pair:

id: Payment reference number allowing a linkage to an offer.

Includes PaymentCard object.

PaymentCard

Object referencing payment card information.

Key value pairs:

expireDate: Four numeric code representing month and year of expiration date

CardCode: Two character card brand code.

CardHolderName: Name on card.

Includes CardNumber object.

CardNumber

Object referencing details of the charge/debit card.

Key value pair:

PlainText: Number on charge/debit card.

Payment object

Object	Description
Payment	Top level object array linking the form of payment used for each segment purchased. Includes Amount, FormOfPaymentIndentifier, and OfferIdentifier objects.
Amount	Object detailing amount due for the hotel segment. Key value pairs: value: Amount due. code: Three character currency code
FormOfPaymentIndentifier	Object designating a form of payment used to complete purchase. Includes the Identifier object.
Identifier	Object describing linkage numbers involved in a hotel segment purchase. Key value pair: value: Travelport generated identifier number. FormOfPaymentIdentifier will start with the characters FOP. OfferIdentifier will start with the character O.
OfferIdentifier	Object designating a hotel segment purchase. Includes Identifier object (see above).

Receipt object

Object	Description
Receipt	Top level object. Includes OfferRef and Confirmation objects.
OfferRef	Reference number to link this set of receipt information to a specific offer. Always the letter “O” followed by a number.
Confirmation	Confirmation details. Includes Locator and OfferStatus objects.
Locator	Locator information for the reservation. Key value pairs: source: Content source. Two character Supplier code. If source matches chain code, the offer is directly with the supplier. If source is XZ, the offer is with Expedia. If source is BO, the offer is with Booking.com. sourceContext: Either Travelport, Agency, or Supplier. locatorType: Description of what value represents. Travelport: Confirmation number; PNR locator value: Reference number for locatorType.
OfferStatus	Status of offer. Key value pairs: Status: Status associated to the sold hotel segment. Possible values include: Canceled Confirmed Pending Rejected code: A two character confirmation code. Accepted values: HK, MK, AK, BK, GK

Remarks: ReservationComment / Accounting objects

Object	Description
ReservationComment	Object used for Special Instruction, Associated, Unassociated, Notepad, and OSI remarks. Key value pairs: commentSource: Entry source of comment. Agency or Supplier. shareWith: Describes who has visibility to the information contained within the remark. Agency or Traveler. Includes Comment and AppliesTo objects.
Comment	Key value pairs: value: text component of the remark name: type of remark
AppliesTo	Includes OfferIdentifier object. Appears with Special Instruction and Associated Remarks.
OfferIdentifier	Key value pair: offerRef: Defines which hotel segment linked to this remark

Example Request

The example below shows the Create Passive Reservation full payload request to produce a passive segment with all components:

HTL HL MK1 DEN 10NOV-OUT15NOV /P-12345/N-HILTON DOWNTOWN DENVER/RQ-USD256.00/R-ABC123/CF-12344DJSH/W-123 Main Street*Denver*CO*US*65445/BC-H/SI-Remark/NM-FIRST LAST/CD-12345678/G-VI1234123412341234EXP1026/CM-10/EX-2/EC-1

Show Example Request

{
    "ReservationDetail": {
        "Offer": [
            {
                "@type": "Offer",
                "Product": [
                    {
                        "@type": "ProductHospitality",
                        "Quantity": 1, //optional
                        "passiveBookingReasonCode": "H", //mandatory
                        "bookingCode": "ABC123", //mandatory
                        "propertyName": " HILTON DOWNTOWN DENVER ", //optional
                        "associatedCityCode": "DEN", //optional
                        "PropertyAddress": { //optional
                            "AddressLine": [
                                "123 Main Street"
                            ],
                            "City": "Denver",
                            "StateProv": {
                                "value": "CO"
                            },
                            "Country": {
                                "value": "US"
                            },
                            "PostalCode": "65445"
                        },
                        "guests": 4, // optional, GuestCounts is priority
                        "GuestCounts": { //optional
                            "@type": "GuestCounts",
                            "GuestCount": [
                                {
                                    "ageQualifyingCode": "10", //Adult
                                    "count": 2,
                                    "@type": "GuestCount"
                                },
                                {
                                    "ageQualifyingCode": "8", //Children
                                    "count": 1,
                                    "age": 4,
                                    "@type": "GuestCount"
                                }
                            ]
                        },
                        "PropertyKey": { //optional
                            "chainCode": "HL",
                            "propertyCode": "12345"
                        },
                        "DateRange": { //mandatory
                            "start": "2025-11-10",
                            "end": "2025-11-15"
                        }
                    }
                ],
                "Price": {
                    "@type": "PriceDetail",
                    "CurrencyCode": {
                        "value": "USD",
                        "decimalPlace": 2 //mandatory
                    },
                    "TotalPrice": 256.00, //mandatory
                    "Base": 200.00, //optional
                    "PriceBreakdown": [ //optional
                        {
                            "type": "PriceBreakdownHospitality",
                            "roomPricingType": "Per stay",
                            "Commission": {
                                "@type": "CommissionPercent",
                                "application": "Commissionable",
                                "Percent": 10
                            }
                            // "Commission": {
                            //     "@type": "CommissionAmount",
                            //     "application": "Commissionable",
                            //     "Amount": {
                            //         "value": 15.00,
                            //         "code": "USD"
                            //     }
                            // }
                        }
                    ]
                },
                "TermsAndConditionsFull": [ //optional
                    {
                        "type": "TermsAndConditionsFullHospitality",
                        "ProductRateCodeInfo": [
                            {
                                "RateCodeInfo": {
                                    "rateID": "12345678" //optional
                                }
                            }
                        ]
                    }
                ]
            }
        ],
        "Traveler": [ //mandatory to create PNR
            {
                "@type": "Traveler",
                "PersonName": {
                    "@type": "PersonName",
                    "Given": "First",
                    "Surname": "Last",
                    "Title": "Mr"
                },
                "Telephone": [
                    {
                        "@type": "TelephoneDetail",
                        "countryAccessCode": "91",
                        "areaCityCode": "011",
                        "phoneNumber": "9891766469",
                        "cityCode": "DL"
                    }
                ],
                "Email": [
                    {
                        "value": myemailexample@travelport.com
                    }
                ]
            }
        ],
        "FormOfPayment": [ //optional, only cardCode and number are relevant
            {   
                "@type": "FormOfPaymentPaymentCard",
                "PaymentCard": {
                    "@type": "PaymentCardDetail",
                    "expireDate": "1026",
                    // "CardType": "Credit",
                    "CardCode": "VI",
                    //  "CardHolderName": "Frank Sinatra",
                    "CardNumber": {
                        "@type": "CardNumber",
                        "PlainText": "1234123412341234"
                    }
                    // "SeriesCode": {
                    //     "@type": "SeriesCode",
                    //     "PlainText": "123"
                    // },
                    // "PersonName": {
                    //     "@type": "PersonNameDetail",
                    //     "Given": "Sridhar",
                    //     "Middle": "Example String Value",
                    //     "Surname": "Vudutha"
                    // },
                    //     "Address": {
                    //         "@type": "AddressDetail",
                    //         "Number": {
                    //             "value": "125"
                    //         },
                    //         "Street": "Billing Address Street",
                    //         "AddressLine": [
                    //             "125 Billing Address Street"
                    //         ],
                    //         "City": "Claremont",
                    //         "County": "Los Angeles",
                    //         "StateProv": {
                    //             "value": "CA",
                    //             "name": "Texas"
                    //         },
                    //         "Country": {
                    //             "value": "US",
                    //             "name": "United States"
                    //         },
                    //         "PostalCode": "91711-3323"
                    //     },
                    //     "Telephone": [
                    //         {
                    //             "@type": "TelephoneDetail",
                    //             "countryAccessCode": "1",
                    //             "areaCityCode": "909",
                    //             "phoneNumber": "1231234",
                    //             "cityCode": "DEN"
                    //         }
                    //     ],
                    //     "Email": [
                    //         {
                    //             "value": smith@example.com
                    //         }
                    //     ]
                }
            }
        ],
        "Payment": [ //optional
            {
                "@type": "Payment",
                "Amount": {
                    "code": "USD",
                    "value": 256.00
                },
                "guaranteeInd": true,
                "depositInd": false
            }
        ],
        "Receipt": [
            {
                "@type": "ReceiptConfirmation",
                "Confirmation": {
                    "@type": "ConfirmationHold",
                    "confirmationStatus": {
                        "@type": "OfferStatusHospitality",
                        "Status": "Confirmed"
                    },
                    "Locator": {
                        "value": "12344DJSH ", //mandatory
                        "locatorType": "Confirmation Number",
                        "source": "HL",
                        "sourceContext": "Supplier"
                    }
                }
            }
        ],
        "ReservationComment": [ //optional
            {
                "commentSource": "Agency",
                "shareWith": "Traveler",
                "Comment": [
                    {
                        "name": "Special Instruction",
                        "value": "This is my special instruction"
                    }
                ]
            }
        ]
    }
}

Example Response

The response for the Create Passive Reservation Full Payload request is nearly identical to the response for the reference payload request. An example of a PNR with passive segment is shown. See the Create Reservation Reference Payload API Reference.

Show Example Response

{
  "ReservationResponse": {
    "Reservation": {
      "@type": "ReservationDetail",
      "Offer": [
        {
          "@type": "Offer",
          "id": "O1",
          "Identifier": {
            "value": "71f61900-292f-48b0-af8a-8358f51addc4",
            "authority": "TVPT"
          },
          "Product": [
            {
              "@type": "ProductHospitality",
              "Quantity": 1,
              "bookingCode": "AAA111",
              "passiveBookingReasonCode": "G",
              "guests": 3,
              "propertyName": "HILTON AUSTIN",
              "associatedCityCode": "AUS",
              "associatedAirportCode": "MMR",
              "PropertyAddress": {
                "@type": "Address",
                "AddressLine": [
                  "500 East 4th Street"
                ],
                "City": "AUSTIN",
                "StateProv": {
                  "value": "TX",
                  "name": "TX"
                },
                "Country": {
                  "name": "US"
                },
                "PostalCode": "78701"
              },
              "Telephone": {
                "@type": "Telephone",
                "phoneNumber": "1-512-4828000",
                "cityCode": "AUS"
              },
              "GuestCounts": {
                "GuestCount": [
                  {
                    "age": 4,
                    "count": 1,
                    "ageQualifyingCode": "8"
                  },
                  {
                    "count": 2,
                    "ageQualifyingCode": "10"
                  }
                ]
              },
              "PropertyKey": {
                "@type": "PropertyKey",
                "chainCode": "HH",
                "propertyCode": "58010"
              },
              "TravelerContact": {
                "@type": "TravelerContact",
                "Email": {
                  "value": "myemailexample@travelport.com"
                },
                "Telephone": {
                  "@type": "Telephone",
                  "countryAccessCode": "91",
                  "areaCityCode": "011",
                  "phoneNumber": "9891766469",
                  "cityCode": "DL"
                }
              },
              "DateRange": {
                "start": "2025-07-06",
                "end": "2025-07-07"
              }
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "CurrencyCode": {
              "value": "USD",
              "decimalPlace": 2
            },
            "Base": 90.3,
            "TotalPrice": 100.55,
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "Amount": {
                  "@type": "Amount",
                  "CurrencyCode": {
                    "value": "USD",
                    "decimalPlace": 2
                  },
                  "Base": 90.3,
                  "Total": 100.55
                },
                "Commission": {
                  "@type": "CommissionPercent",
                  "application": "Commissionable",
                  "Percent": 10
                },
                "roomPricingType": "Per stay"
              }
            ]
          },
          "TermsAndConditionsFull": [
            {
              "@type": "TermsAndConditionsFullHospitality",
              "Guarantee": [
                {
                  "@type": "Guarantee",
                  "guaranteeType": "DepositRequired"
                }
              ],
              "ProductRateCodeInfo": [
                {
                  "RateCodeInfo": {
                    "rateID": "8888444"
                  }
                }
              ]
            }
          ],
          "passiveOfferInd": true
        }
      ],
      "Traveler": [
        {
          "@type": "Traveler",
          "id": "T1",
          "PersonName": {
            "@type": "PersonName",
            "Given": "Ionut",
            "Surname": "Rotaru"
          },
          "Telephone": [
            {
              "@type": "Telephone",
              "countryAccessCode": "91",
              "areaCityCode": "011",
              "phoneNumber": "9891766469",
              "cityCode": "DL"
            }
          ],
          "Email": [
            {
              "value": "myemailexample@travelport.com"
            }
          ]
        }
      ],
      "TravelerProduct": [
        {
          "@type": "TravelerProduct",
          "TravelerRef": "T1",
          "OfferRef": "O1"
        }
      ],
      "FormOfPayment": [
        {
          "@type": "FormOfPaymentPaymentCard",
          "id": "FOP1",
          "PaymentCard": {
            "@type": "PaymentCard",
            "expireDate": "0826",
            "CardCode": "VI",
            "CardNumber": {
              "@type": "CardNumber",
              "PlainText": "************1111"
            }
          }
        }
      ],
      "Payment": [
        {
          "@type": "Payment",
          "Amount": {
            "value": 844.97,
            "code": "KRW"
          },
          "FormOfPaymentIdentifier": {
            "Identifier": {
              "value": "FOP1"
            }
          },
          "OfferIdentifier": [
            {
              "Identifier": {
                "value": "O1"
              }
            }
          ]
        }
      ],
      "Receipt": [
        {
          "@type": "ReceiptConfirmation",
          "OfferRef": [
            "O1"
          ],
          "Confirmation": {
            "@type": "ConfirmationHold",
            "Locator": {
              "value": "1111AAA",
              "locatorType": "Confirmation Number",
              "source": "HH",
              "sourceContext": "Supplier"
            },
            "OfferStatus": {
              "@type": "OfferStatusHospitality",
              "code": "MK",
              "Status": "Confirmed"
            }
          }
        },
        {
          "@type": "ReceiptConfirmation",
          "Confirmation": {
            "@type": "ConfirmationHold",
            "Locator": {
              "value": "BXV4JR",
              "locatorType": "PNR Locator",
              "sourceContext": "Travelport"
            },
            "OfferStatus": {
              "@type": "OfferStatusHospitality",
              "Status": "Confirmed"
            }
          }
        }
      ],
      "ReservationComment": [
        {
          "@type": "ReservationComment",
          "Comment": [
            {
              "value": "This is my special instruction",
              "name": "Special Instruction"
            }
          ],
          "AppliesTo": [
            {
              "@type": "AppliesToOffer",
              "OfferIdentifier": [
                {
                  "offerRef": "O1"
                }
              ]
            }
          ]
        }
      ]
    },
    "traceId": "03550433-430e-4ece-ae17-2afac775541c"
  }
}

Error Messages

These error messages are specific to Create Passive Reservation Full Payload.

Show Error Messages

SourceCode	Message	StatusCode (HTTP code)
13090	PASSIVE BOOKING REASON CODE IS MISSING OR INVALID	400
13091	PASSIVE OFFER MUST CONTAIN PROPERTY ID OR COMBINATION OF HOTEL NAME AND ADDRESS	400

See the Create Reservation Reference Payload API Reference for general Create Reservation error messages.