lodgingInfo

The lodgingInfo element, through its child elements, defines a number of lodging or cruise line related data points that, when submitted, can result in a more favourable interchange rate (see TABLE 4-3 Lodging Element Requirements for Interchange Optimization for additional information).

Parent Elements:

authorization, capture, captureGivenAuth, credit, forceCapture, sale

Attributes:

None

 

Child Elements: (all Optional)

hotelFolioNumber, checkInDate, checkOutDate, duration, customerServicePhone, programCode, roomRate, roomTax, numAdults, propertyLocalPhone, fireSafetyIndicator, lodgingCharge, bookingID, passengerName, propertyAddress, travelPackageIndicator, smokingPreference, numberOfRooms, tollFreePhoneNumber

 

Example:  lodgingInfo Structure

<lodgingInfo>

  <hotelFolioNumber>Customer Folio Number</hotelFolioNumber>

  <checkInDate>YYYY-MM-DD</checkInDate>

  <checkOutDate>YYYY-MM-DD</checkOutDate>

  <duration>Length of Stay</duration>

  <customerServicePhone>CS Phone Number</customerServicePhone>

  <programCode>Program Code Enum</programCode>

  <roomRate>Daily Cost of Room</roomRate>

  <roomTax>Room Taxes</roomTax>

  <numAdults>Number of Adult Guests</numAdults>

  <propertyLocalPhone>Local Phone Number of Facility</propertyLocalPhone>

  <fireSafetyIndicator>true or false</fireSafetyIndicator>

  <lodgingCharge>

    <name>Lodging Charge Enum</name>

  </lodgingCharge>

  <bookingID>book9876543341</bookingID>

  <passengerName>John Doe</passengerName>

  <propertyAddress>

   <name>Best Downunder</name>

   <city>Brisbane</city>

   <region>QLD</region>

   <country>AUS</country>

  </propertyAddress>

  <travelPackageIndicator>Both</travelPackageIndicator>

  <smokingPreference>Y</smokingPreference>

  <numberOfRooms>3</numberOfRooms>

  <tollFreePhoneNumber>999123456789</tollFreePhoneNumber>

</lodgingInfo>

 

TABLE 4-3 Lodging Element Requirements for Interchange Optimization

cnpAPI Element

Card Brand Requirement for Better Interchange

hotelFolioNumber

  • Required for all card brands

checkInDate

  • Required for all card brands

checkOutDate

  • Required for all card brands

duration

  • Required for Visa and Mastercard (total number of nights)
  • Required for Discover (number of nights * number of rooms)
  • Not required for American Express

customerServicePhone

  • Required for Visa Mastercard, and Discover
  • Not required for American Express

programCode

  • Required for American Express
  • Recommended for Visa, but not required for Interchange

roomRate

  • Required for Mastercard and Discover
  • Not Required for Visa and American Express

roomTax

  • Required for Visa and Mastercard (total number of nights)
  • Required for Discover (number of nights * number of rooms)

numAdults

  • Required for Discover (total adults for all rooms booked)
  • Not required for other card brands

propertyLocalPhone

  • Required for Mastercard
  • Not required for other card brands

fireSafetyIndicator

  • Required for Mastercard
  • Not required for other card brands

lodgingCharge

  • Required for Visa
  • Not required for other card brands

bookingId

 

 

 

Not required for optimization

 

 

 

passengerName

propertyAddress

travelPackageIndicator

smokingPreference

numberOfRooms

tollFreePhoneNumber

 

TABLE 4-4 Cruise Element Requirements for Interchange Optimization.

cnpAPI Element

Card Brand Requirement for Better Interchange

No fields required by Mastercard and Discover for Interchange optimization. American Express requirements based upon merchant contract with American Express.

hotelFolioNumber

 

checkInDate

  • Required by Visa in settlement

checkOutDate

  • Required by Visa in settlement

duration

  • Required by Visa in authorization

customerServicePhone

 

 

 

 

 

 

programCode

roomRate

roomTax

numAdults

propertyLocalPhone

fireSafetyIndicator

lodgingCharge

bookingId

passengerName

propertyAddress

travelPackageIndicator

smokingPreference

numberOfRooms

tollFreePhoneNumber