Attention: Please check the Hotel Release Notes page for the latest updates and enhancements.
Add Passive Reservation Full Payload API Reference
Put |
book/reservations/{reservationIdentifier}/passive Base path: Pre-production https://api.pp.travelport.com/11/hotel/ Production https://api.travelport.com/11/hotel/ |
Related Content: Hotel Guide, Hotel Workflow Diagram, Hotel Availability API Reference
Use the Add Passive Reservation full payload request to add a passive hotel booking segment to an existing PNR. The full payload request will result in a single HTL MK segment or HTL AK placeholder segment in the PNR constructed from the components of the request.
Request
Also see Authorization and Common Hotel API Headers.
Query Parameters
None.
Request Body

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 |
Offer object
Object |
Description |
Required/Optional |
---|---|---|
Offer |
Top level object for reservation details. Includes Product, Price, and TermsAndConditionsFull object. |
Required |
Product |
Details about the property, dates, and number of guests. Includes PropertyAddress, GuestCounts, PropertyKey, and DateRange objects. |
Required |
|
Number. The number of rooms requested; 1-9 inclusive supported. If not provided, default quantity is 1. Example: MK1 |
Optional |
|
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 for MK |
|
String. Booking code returned in the provider system. Value will be stored in /R- parameter. |
Required for MK |
|
String. Name of property. Value will be stored in /N- parameter. |
Required for MK if property ID not entered. |
|
String. IATA city code associated with property. Default value: HDQ |
Optional |
PropertyAddress |
Object for address details. |
Required for MK if property ID not entered. |
|
String. Street Address. Value will be stored in the /W- parameter. |
Required for MK |
|
String. City where property is located. Value will be stored in the /W- parameter. |
Required for MK |
|
Object for State or Province. |
Optional |
|
String. State or Province code where property is located. Value will be stored in the /W- parameter. |
Optional |
|
Object for Country where property is located. |
Optional |
|
String. Country code where property is located. Value will be stored in the /W- parameter. |
Optional |
|
String. Postal code where property is located. Value will be stored in the /W- parameter. |
Optional |
|
String. 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 for MK if children are part of the request. |
GuestCount |
Array of qualifying codes and ages. |
Required for MK if children are part of the request. |
|
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 for MK if children are part of the request. |
|
String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8 |
Required for MK if children are part of the request. |
|
String. Age of traveler. Required only when request includes a child in room. |
Required for MK for the children in the request. |
DateRange |
Reservation date range. |
Required for both MK and AK. |
|
String. Check-in date in YYYY-MM-DD format. |
Required for both MK and AK. |
|
String. Check-out date in YYYY-MM-DD format. |
Required for both MK and AK. |
PropertyKey |
Object for Travelport Property ID information. |
Required if not using property name and address. |
|
String. Two-character Travelport chain code to book. |
Optional |
|
String. Travelport property code of the property within the hotel chain. Value will be stored in the /P- parameter. |
Required for MK if not using property name and address. |
Price |
Top level object for price information. Includes CurrencyCode and PriceBreakdown objects. |
Required for MK. |
|
Number. Total price of room rate. Value will be stored in the /RQ- parameter |
Required for MK. |
|
Number. Base price of room rate. |
Optional |
CurrencyCode |
Top level object. |
Required for MK. |
|
Number. Number of decimal places for the currency code. |
Required for MK. |
|
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 for MK. |
PriceBreakdown |
Object describing breakdown components of the rate price. Includes Commission and Amount objects. |
Required for MK if using commission. |
|
Describes the complete stay details. Accepted Value: Per stay |
Required for MK if using commission. |
Commission |
Object describing commission type (Percent or Amount) and value. |
Optional |
|
Describes the presence of a commission. Accepted Value: Commissionable. |
Optional |
|
Integer. Percent value of commission. Value will be stored in /CM- parameter. |
Optional |
Amount |
Object describing the currency amount of the commission. |
Optional |
|
Integer. Amount of commission. Value will be stored in /CM- parameter. |
Optional |
|
String. Currency code of commission. |
Optional |
TermsAndConditionsFull |
Object for the rules applied to this rate. Includes 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 |
|
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 |
|
String. Traveler first name. |
Required |
|
String. Traveler last name. |
Required |
|
String. Salutation or honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) |
Optional |
Telephone |
Traveler telephone details. |
Required |
|
String. Phone country code. |
Optional |
|
String. Phone number. |
Required |
|
String. Phone local area code. |
Required |
|
String. Phone city code. |
Optional |
|
Traveler email address. |
Optional |
|
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 |
|
String. Credit card expiration date in MMYY format. |
Required |
|
String. Type of card including Credit, Debit, and Gift. |
Optional |
|
String. Code for credit card type. |
Required |
|
String. Name on credit card. |
Optional |
CardNumber |
Card number details. |
Required |
|
String. Credit card number. |
Required |
SeriesCode |
Security code of card. |
Optional |
|
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:
Includes Amount object. |
Required |
|
String. Customer-assigned identifier for the payment. |
Optional |
|
String. Customer-assigned name for the payment. |
Optional |
|
Boolean (true/false). If set to true, form of payment will be stored in /D- field. |
Required |
|
Boolean (true/false). If set to true, form of payment will be stored in the /G- field. |
Required |
Amount |
Amount of payment. |
Optional |
|
String. Currency code. |
Optional |
|
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 |
|
String. Status associated to the sold hotel segment. Accepted value: Confirmed |
Optional |
Locator |
The supplier confirmation number. |
Required |
|
String. Accepted value: Confirmation Number. |
Required |
|
String. Content source. Supplier chain code. |
Optional |
|
String. Accepted value: Supplier. |
Required |
|
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 |
|
String. Originator of comment. Accepted value: Agency. |
Required |
|
String. Designates visibility of remark.
Special instructions: Supplier |
Required |
Comment |
Array of name/value pairs. |
Required |
|
String. Type of remark.
Special instruction remarks: SI |
Required |
|
String. Remark text. Limits:
Special instruction remarks: 50 characters |
Required |
Response
The response for the Add Passive Reservation Full Payload request is nearly identical to the response for the create reference payload request.
See the Create Reservation Reference Payload API Reference for the response table and examples.
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

{
"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 Request – Placeholder Segment
The example below shows the Add Passive Reservation full payload request to produce a passive placeholder segment:
-
HTL ZZ AK1 HDQ 20MAY-OUT22MAY

{
"ReservationDetail": {
"Offer": [
{
"@type": "Offer",
"Product": [
{
"@type": "ProductHospitality",
"DateRange": { //mandatory
"start": "2025-11-10",
"end": "2025-11-15"
}
}
]
}
]
}
}
Example Response
The response for the Add Passive Reservation Full Payload request is identical to the response for the Create Passive Reservation Full Payload request and can be found here: See the Create Passive Reservation Reference Payload API Reference.
Error Messages
These error messages are specific to all Passive Reservation Full Payload type 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.