Developer Portal
Developer DocumentationLegacy APIRegLink APIsMessage Sample LibraryRegLink Basic and RegExpressCreate Bridge

Bridge Messages

Bridge calls allow a third party application to create, modify, or cancel a housing details which can then be used to create a reservation as part of a subsequent step or process. 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 Bridge call to modify an existing bridge. Many of the required elements for bridge messages can be received from the response from an availability call. Please refer to the field mappings for more details.

CreateBridgeRQ CC multiguest

<?xml version="1.0" encoding="UTF-8"?>
<CreateBridgeRQ 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.03</Version>
    <Mode>S</Mode>
    <OP>CreateBridge</OP>
    <Service>CreateBridge</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>John</ota:GivenName>
                        <ota:MiddleName>P</ota:MiddleName>
                        <ota:Surname>Smith</ota:Surname>
                      </ota:PersonName>
                      <ota:Telephone PhoneNumber="781-373-4100" PhoneTechType="1"/>
                      <ota:Telephone PhoneNumber="781-547-5414" 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-1234</ota:PostalCode>
                        <ota:StateProv>MA</ota:StateProv>
                        <ota:CountryName Code="US"/>
                      </ota:Address>
                      <ota:EmployeeInfo EmployeeTitle="Product Manager">Product Manager</ota:EmployeeInfo>
                    </ota:Customer>
                    <ota:PrefCollections>
                      <ota:PrefCollection>
                        <ota:HotelPref SmokingAllowed="0">
                          <ota:PhysChallFeaturePref PhysChallFeature="0">0</ota:PhysChallFeaturePref>
                          <ota:SpecRequestPref>Guest requests King Bed</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:ResGuest ResGuestRPH="2">
              <ota:Profiles>
                <ota:ProfileInfo>
                  <ota:Profile>
                    <ota:Customer>
                      <ota:PersonName>
                        <ota:NamePrefix>Ms.</ota:NamePrefix>
                        <ota:GivenName>Jenny</ota:GivenName>
                        <ota:MiddleName>G</ota:MiddleName>
                        <ota:Surname>Smith</ota:Surname>
                      </ota:PersonName>
                      <ota:Telephone PhoneNumber="603-555-1212" PhoneTechType="1"/>
                      <ota:Telephone PhoneNumber="603-555-1213" PhoneTechType="3"/>
                      <ota:Email>noreply@Cvent.com</ota:Email>
                      <ota:Address>
                        <ota:AddressLine>9 Jones Avenue</ota:AddressLine>
                        <ota:AddressLine>Suite 18</ota:AddressLine>
                        <ota:CityName>Waltham</ota:CityName>
                        <ota:PostalCode>02453</ota:PostalCode>
                        <ota:StateProv>MA</ota:StateProv>
                        <ota:CountryName Code="US"/>
                      </ota:Address>
                      <ota:EmployeeInfo EmployeeTitle="Business Analyst">Business Analyst</ota:EmployeeInfo>
                    </ota:Customer>
                    <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:Guarantee>
              <ota:GuaranteesAccepted>
                <ota:GuaranteeAccepted>
                  <ota:PaymentCard CardNumber="4444333322221111" ExpireDate="1123" CardCode="VI">
                    <ota:CardHolderName>John M Smith</ota:CardHolderName>
                    <ota:Address>
                      <ota:AddressLine>123 Main Street</ota:AddressLine>
                      <ota:AddressLine>Apt. 1</ota:AddressLine>
                      <ota:CityName>Portsmouth</ota:CityName>
                      <ota:PostalCode>03801</ota:PostalCode>
                      <ota:StateProv>NH</ota:StateProv>
                      <ota:CountryName Code="US">US</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: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.02 test of CustomField1.</ota:CustomField1>
                <ota:CustomField2>This is a 4.00.03 test of CustomField2.</ota:CustomField2>
                <ota:CustomField3>This is a 4.00.03 test of CustomField3.</ota:CustomField3>
                <ota:CustomField4>This is a 4.00.03 test of CustomField4.</ota:CustomField4>
                <ota:CustomField5>This is a 4.00.03 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>
</CreateBridgeRQ>

CreateBridgeRQ Otherpay

<?xml version="1.0" encoding="UTF-8"?>
<CreateBridgeRQ 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.03</Version>
    <Mode>S</Mode>
    <OP>CreateBridge</OP>
    <Service>CreateBridge</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>Suite 201</ota:AddressLine>
                        <ota:CityName>Boston</ota:CityName>
                        <ota:PostalCode>02170</ota:PostalCode>
                        <ota:StateProv>MA</ota:StateProv>
                        <ota:CountryName Code="US"/>
                      </ota:Address>
                      <ota:EmployeeInfo EmployeeTitle="Software Eng">Software Engineer</ota:EmployeeInfo>
                    </ota:Customer>
                    <ota:PrefCollections>
                      <ota:PrefCollection>
                        <ota:HotelPref SmokingAllowed="0">
                          <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 Solutions Inc.</ota:CompanyName>
                      <ota:AddressInfo>
                        <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:AddressInfo>
                      <ota:TelephoneInfo PhoneNumber="6173284800"/>
                    </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: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:HowBooked>100</ota:HowBooked>
              <ota:ReceivedFrom>Reg System Name</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 credit card upon 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">US</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.03 test of CustomField1.</ota:CustomField1>
                <ota:CustomField2>This is a 4.00.03 test of CustomField2.</ota:CustomField2>
                <ota:CustomField3>This is a 4.00.03 test of CustomField3.</ota:CustomField3>
                <ota:CustomField4>This is a 4.00.03 test of CustomField4.</ota:CustomField4>
                <ota:CustomField5>This is a 4.00.03 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>
</CreateBridgeRQ>

CreateBridgeRS

<?xml version="1.0" encoding="ISO-8859-1"?>
<PasskeyRS xmlns="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:-68e720">
    <Status ID="2">PROCESSED</Status>
  </Message>
  <Data>
    <ota:OTA_HotelResRS>
      <ota:HotelReservations>
        <ota:HotelReservation>
          <ota:UniqueId Id="32347XBH-G974" Type="BRD"/>
        </ota:HotelReservation>
      </ota:HotelReservations>
    </ota:OTA_HotelResRS>
  </Data>
</PasskeyRS>
Last updated on
OverviewModify Bridge