Developer Portal
Developer DocumentationLegacy APIRegLink APIsMessage Sample LibraryRegLink AdvancedCreate Reservation

Create Reservation

This API message allows a third party to create a housing reservation in Passkey. These messages are based on the OpenTravel (OTA) standards and the order in which these messages are used must be followed. For example, you cannot use the create reservation call to modify an existing reservation. It is also important to note that once a reservation is canceled, it cannot be made active again (reinstated). Many of the required elements for reservation messages can be received from the response from an availability call.

CreateReservationRQ - Single Guest - CC

<?xml version="1.0" encoding="UTF-8"?>
<CreateReservationRQ xmlns="http://www.Cvent Passkey.com/apiSchema" xmlns:ota="http://www.opentravel.org/OTA/2002/11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Security>
      <Login>
         <UserName>reglinkapi</UserName>
         <Password>passkey1</Password>
      </Login>
      <PartnerID>136260</PartnerID>
      <Token> </Token>
   </Security>
   <Message>
      <Version>4.00.04</Version>
      <Mode>S</Mode>
      <OP>CreateReservation</OP>
      <Service>CreateReservation</Service>
      <Locale>EN_US</Locale>
   </Message>
   <Data>
      <ota:OTA_HotelResRQ>
         <ota:HotelReservations>
            <ota:HotelReservation RoomStayReservation="true">
               <ota:RoomStays>
                  <ota:RoomStay>
                     <ota:RoomTypes>
                        <ota:RoomType NumberOfUnits="1"/>
                     </ota:RoomTypes>
                     <ota:GuestCounts>
                        <ota:GuestCount AgeQualifyingCode="1" Count="1"/>
                     </ota:GuestCounts>
                  </ota:RoomStay>
               </ota:RoomStays>
               <ota:ResGuests>
                  <ota:ResGuest ResGuestRPH="1">
                     <ota:Profiles>
                        <ota:ProfileInfo>
                           <ota:Profile>
                              <ota:Customer>
                                 <ota:PersonName>
                                    <ota:NamePrefix>Mr.</ota:NamePrefix>
                                    <ota:GivenName>Jöhèn</ota:GivenName>
                                    <ota:MiddleName>Test</ota:MiddleName>
                                    <ota:Surname>Pãsskéy</ota:Surname>
                                 </ota:PersonName>
                                 <ota:Telephone PhoneNumber="6173284800" PhoneTechType="1"/>
                                 <ota:Telephone PhoneNumber="6173281461" PhoneTechType="3"/>
                                 <ota:Email>noreply@Cvent.com</ota:Email>
                                 <ota:Address>
                                    <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                    <ota:AddressLine>Building 17</ota:AddressLine>
                                    <ota:CityName>Waltham</ota:CityName>
                                    <ota:PostalCode>02453</ota:PostalCode>
                                    <ota:StateProv>MA</ota:StateProv>
                                    <ota:CountryName Code="US">United States</ota:CountryName>
                                 </ota:Address>
                                 <ota:EmployeeInfo>Software Engineer</ota:EmployeeInfo>
                              </ota:Customer>
                              <ota:PrefCollections>
                                 <ota:PrefCollection>
                                    <ota:HotelPref SmokingAllowed="1">
                                       <ota:PhysChallFeaturePref>0</ota:PhysChallFeaturePref>
                                       <ota:SpecRequestPref>King Bed Requested</ota:SpecRequestPref>
                                    </ota:HotelPref>
                                 </ota:PrefCollection>
                              </ota:PrefCollections>
                              <ota:CompanyInfo>
                                 <ota:CompanyName>Cvent Solutions Inc.</ota:CompanyName>
                              </ota:CompanyInfo>
                           </ota:Profile>
                        </ota:ProfileInfo>
                     </ota:Profiles>
                  </ota:ResGuest>
               </ota:ResGuests>
               <ota:ResGlobalInfo>
                  <ota:GuestCounts>
                     <ota:GuestCount AgeQualifyingCode="1" Count="1"/>
                  </ota:GuestCounts>
                  <ota:TimeSpan>
                     <ota:StartDateWindow EarliestDate="2022-12-20" LatestDate="2022-12-27"/>
                  </ota:TimeSpan>
                  <ota:ResGuestRPHs>
                     <ota:ResGuestRPH/>
                  </ota:ResGuestRPHs>
                  <ota:Memberships/>
                  <ota:SpecialRequests>
                     <ota:SpecialRequest>
                        <ota:Text>This is an API Comment test</ota:Text>
                     </ota:SpecialRequest>
                  </ota:SpecialRequests>
                  <ota:Guarantee>
                     <ota:GuaranteesAccepted>
                        <ota:GuaranteeAccepted>
                           <ota:PaymentCard CardNumber="5105105105105100" ExpireDate="0625" CardType="MC">
                              <ota:CardHolderName>Jöhèn Pãsskéy</ota:CardHolderName>
                              <ota:Address>
                                 <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                 <ota:AddressLine>Building 17</ota:AddressLine>
                                 <ota:CityName>Waltham</ota:CityName>
                                 <ota:PostalCode>02453</ota:PostalCode>
                                 <ota:StateProv>MA</ota:StateProv>
                                 <ota:CountryName Code="US">United States</ota:CountryName>
                              </ota:Address>
                           </ota:PaymentCard>
                        </ota:GuaranteeAccepted>
                     </ota:GuaranteesAccepted>
                  </ota:Guarantee>
                  <ota:HotelReservationIDs>
                     <ota:HotelReservationID/>
                  </ota:HotelReservationIDs>
               </ota:ResGlobalInfo>
               <ota:TPA_Extensions>
                  <ota:PK_Info>
                     <ota:EventID>151592</ota:EventID>
                     <ota:AttendeeCode>RTEATT0117FBV</ota:AttendeeCode>
                     <ota:SendAck>true</ota:SendAck>
                     <ota:ExtReferenceID>ABC-123</ota:ExtReferenceID>
                     <ota:ResSplitFolioTypeId>102</ota:ResSplitFolioTypeId>
                     <ota:HowBooked>101</ota:HowBooked>
                     <ota:ReceivedFrom>A Reg Company, Inc</ota:ReceivedFrom>
                     <ota:PaymentType>cc</ota:PaymentType>
                     <ota:BlockID>104636889</ota:BlockID>
                     <ota:BillPhone PhoneNumber="16173284800"/>
                     <ota:PrimaryGuestRPH>1</ota:PrimaryGuestRPH>
                     <ota:CustomFields>
                        <ota:CustomField1>This is a 4.00.04 test of CustomField1.</ota:CustomField1>
                        <ota:CustomField2>This is a 4.00.04 test of CustomField2.</ota:CustomField2>
                        <ota:CustomField3>This is a 4.00.04 test of CustomField3.</ota:CustomField3>
                        <ota:CustomField4>This is a 4.00.04 test of CustomField4.</ota:CustomField4>
                        <ota:CustomField5>This is a 4.00.04 test of CustomField5.</ota:CustomField5>
                     </ota:CustomFields>
                     <ota:Referrer>http://www.Cvent.com</ota:Referrer>
                  </ota:PK_Info>
               </ota:TPA_Extensions>
            </ota:HotelReservation>
         </ota:HotelReservations>
      </ota:OTA_HotelResRQ>
   </Data>
</CreateReservationRQ>

CreateReservationRQ - Multiguest - Otherpay

<?xml version="1.0" encoding="UTF-8"?>
<CreateReservationRQ xmlns="http://www.Cvent Passkey.com/apiSchema" xmlns:ota="http://www.opentravel.org/OTA/2002/11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Security>
      <Login>
         <UserName>reglinkapi</UserName>
         <Password>passkey1</Password>
      </Login>
      <PartnerID>136260</PartnerID>
      <Token> </Token>
   </Security>
   <Message>
      <Version>4.00.04</Version>
      <Mode>S</Mode>
      <OP>CreateReservation</OP>
      <Service>CreateReservation</Service>
      <Locale>EN_US</Locale>
   </Message>
   <Data>
      <ota:OTA_HotelResRQ>
         <ota:HotelReservations>
            <ota:HotelReservation RoomStayReservation="true">
               <ota:RoomStays>
                  <ota:RoomStay>
                     <ota:RoomTypes>
                        <ota:RoomType NumberOfUnits="1"/>
                     </ota:RoomTypes>
                     <ota:GuestCounts>
                        <ota:GuestCount AgeQualifyingCode="1" Count="2"/>
                     </ota:GuestCounts>
                  </ota:RoomStay>
               </ota:RoomStays>
               <ota:ResGuests>
                  <ota:ResGuest ResGuestRPH="1">
                     <ota:Profiles>
                        <ota:ProfileInfo>
                           <ota:Profile>
                              <ota:Customer>
                                 <ota:PersonName>
                                    <ota:NamePrefix>Mr.</ota:NamePrefix>
                                    <ota:GivenName>Jöhèn</ota:GivenName>
                                    <ota:MiddleName>Test</ota:MiddleName>
                                    <ota:Surname>Pãsskéy</ota:Surname>
                                 </ota:PersonName>
                                 <ota:Telephone PhoneNumber="6173284800" PhoneTechType="1"/>
                                 <ota:Telephone PhoneNumber="6173281461" PhoneTechType="3"/>
                                 <ota:Email>noreply@passkey.com</ota:Email>
                                 <ota:Address>
                                    <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                    <ota:AddressLine>Suite 201</ota:AddressLine>
                                    <ota:CityName>Boston</ota:CityName>
                                    <ota:PostalCode>02170</ota:PostalCode>
                                    <ota:StateProv>MA</ota:StateProv>
                                    <ota:CountryName Code="US">United States</ota:CountryName>
                                 </ota:Address>
                                 <ota:EmployeeInfo EmployeeTitle="Software Eng">Software Engineer</ota:EmployeeInfo>
                              </ota:Customer>
                              <ota:PrefCollections>
                                 <ota:PrefCollection>
                                    <ota:HotelPref SmokingAllowed="1">
                                       <ota:PhysChallFeaturePref PhysChallFeature="0">0</ota:PhysChallFeaturePref>
                                       <ota:SpecRequestPref>King Bed Requested</ota:SpecRequestPref>
                                    </ota:HotelPref>
                                 </ota:PrefCollection>
                              </ota:PrefCollections>
                              <ota:CompanyInfo>
                                 <ota:CompanyName>Cvent Soluctions Inc.</ota:CompanyName>
                              </ota:CompanyInfo>
                           </ota:Profile>
                        </ota:ProfileInfo>
                     </ota:Profiles>
                  </ota:ResGuest>
                  <ota:ResGuest ResGuestRPH="2">
                     <ota:Profiles>
                        <ota:ProfileInfo>
                           <ota:Profile>
                              <ota:Customer>
                                 <ota:PersonName>
                                    <ota:NamePrefix>Mr.</ota:NamePrefix>
                                    <ota:GivenName>James</ota:GivenName>
                                    <ota:MiddleName>Tiberius</ota:MiddleName>
                                    <ota:Surname>Passkey</ota:Surname>
                                 </ota:PersonName>
                                 <ota:Telephone PhoneNumber="6173284800" PhoneTechType="1"/>
                                 <ota:Telephone PhoneNumber="6173281461" PhoneTechType="3"/>
                                 <ota:Email>noreply@Cvent.com</ota:Email>
                                 <ota:Address>
                                    <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                                    <ota:AddressLine>Suite 201</ota:AddressLine>
                                    <ota:CityName>Boston</ota:CityName>
                                    <ota:PostalCode>02170</ota:PostalCode>
                                    <ota:StateProv>MA</ota:StateProv>
                                    <ota:CountryName Code="US">United States</ota:CountryName>
                                 </ota:Address>
                                 <ota:EmployeeInfo EmployeeTitle="Software Eng">Software Engineer</ota:EmployeeInfo>
                              </ota:Customer>
                              <ota:PrefCollections>
                                 <ota:PrefCollection>
                                    <ota:HotelPref SmokingAllowed="1">
                                       <ota:PhysChallFeaturePref PhysChallFeature="0">0</ota:PhysChallFeaturePref>
                                       <ota:SpecRequestPref>King Bed Requested</ota:SpecRequestPref>
                                    </ota:HotelPref>
                                 </ota:PrefCollection>
                              </ota:PrefCollections>
                              <ota:CompanyInfo>
                                 <ota:CompanyName>Cvent Soluctions Inc.</ota:CompanyName>
                              </ota:CompanyInfo>
                           </ota:Profile>
                        </ota:ProfileInfo>
                     </ota:Profiles>
                  </ota:ResGuest>
               </ota:ResGuests>
               <ota:ResGlobalInfo>
                  <ota:GuestCounts>
                     <ota:GuestCount AgeQualifyingCode="1" Count="2"/>
                  </ota:GuestCounts>
                  <ota:TimeSpan>
                     <ota:StartDateWindow EarliestDate="2022-12-20" LatestDate="2022-12-27"/>
                  </ota:TimeSpan>
                  <ota:ResGuestRPHs>
                     <ota:ResGuestRPH/>
                  </ota:ResGuestRPHs>
                  <ota:Memberships/>
                  <ota:SpecialRequests>
                     <ota:SpecialRequest>
                        <ota:Text>This is an API Comment testo</ota:Text>
                     </ota:SpecialRequest>
                  </ota:SpecialRequests>
                  <ota:HotelReservationIDs>
                     <ota:HotelReservationID/>
                  </ota:HotelReservationIDs>
               </ota:ResGlobalInfo>
               <ota:TPA_Extensions>
                  <ota:PK_Info>
                     <ota:EventID>151592</ota:EventID>
                     <ota:AttendeeCode>RTEATT0117FBV</ota:AttendeeCode>
                     <ota:SendAck>true</ota:SendAck>
                     <ota:ExtReferenceID>ABC-123</ota:ExtReferenceID>
                     <ota:HowBooked>100</ota:HowBooked>
                     <ota:ReceivedFrom>2200</ota:ReceivedFrom>
                     <ota:PaymentType>other</ota:PaymentType>
                     <ota:BlockID>104636889</ota:BlockID>
                     <ota:OtherPayment>
                        <ota:OPayAmt Amount="600"/>
                        <ota:OPayDate>2004-11-04</ota:OPayDate>
                        <ota:OPayReferenceNum>123456789</ota:OPayReferenceNum>
                        <ota:OPayCheckNum>1234</ota:OPayCheckNum>
                        <ota:OPayReceived>true</ota:OPayReceived>
                        <ota:OPayComments>Guest to provide a credit card at check in.</ota:OPayComments>
                        <ota:OPayName>Alexander Thomson</ota:OPayName>
                        <ota:OBillAddress>
                           <ota:AddressLine>221 Crescent Street</ota:AddressLine>
                           <ota:AddressLine>Suite 201</ota:AddressLine>
                           <ota:CityName>Boston</ota:CityName>
                           <ota:PostalCode>02062</ota:PostalCode>
                           <ota:StateProv>MA</ota:StateProv>
                           <ota:CountryName Code="US">United States</ota:CountryName>
                        </ota:OBillAddress>
                        <ota:OPhone PhoneNumber="16173284800"/>
                     </ota:OtherPayment>
                     <ota:BillPhone PhoneNumber="16173284800"/>
                     <ota:PrimaryGuestRPH>1</ota:PrimaryGuestRPH>
                     <ota:CustomFields>
                        <ota:CustomField1>This is a 4.00.04 test of CustomField1.</ota:CustomField1>
                        <ota:CustomField2>This is a 4.00.04 test of CustomField2.</ota:CustomField2>
                        <ota:CustomField3>This is a 4.00.04 test of CustomField3.</ota:CustomField3>
                        <ota:CustomField4>This is a 4.00.04 test of CustomField4.</ota:CustomField4>
                        <ota:CustomField5>This is a 4.00.04 test of CustomField5.</ota:CustomField5>
                     </ota:CustomFields>
                     <ota:Referrer>http://www.Cvent.com</ota:Referrer>
                  </ota:PK_Info>
               </ota:TPA_Extensions>
            </ota:HotelReservation>
         </ota:HotelReservations>
      </ota:OTA_HotelResRQ>
   </Data>
</CreateReservationRQ>

CreateReservationRS

<?xml version="1.0" encoding="ISO-8859-1"?>
<PasskeyRS xmlns="http://www.passkey.com/apiSchema" xmlns:ns1="http://www.passkey.com/apiSchema" xmlns:ota="http://www.opentravel.org/OTA/2002/11" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <Message GUID="1638e6bf162:-581f20">
      <Status ID="2">PROCESSED</Status>
   </Message>
   <Data>
      <ota:OTA_HotelResRS>
         <ota:Success/>
         <ota:HotelReservations>
            <ota:HotelReservation RoomStayReservation="1">
               <ota:UniqueId Id="328T78WS" Type="RES"/>
            </ota:HotelReservation>
         </ota:HotelReservations>
      </ota:OTA_HotelResRS>
   </Data>
</PasskeyRS>
Last updated on
Get ReservationModify Reservation