Lodging data

If your business operates under specific travel-related Merchant Category Codes (MCCs), you can provide enhanced scheme data (ESD) to optimize your interchange rates. Lodging data consists of industry-specific details such as check-in and check-out dates.

You get benefits for transactions, depending on the scheme:

• Visa: prevent downgrades to higher commercial standard rates.
• Mastercard: ensure that your transactions qualify for the interchange rates specific to your industry.

Requirements

In addition to the requirements that apply to sending ESD, take into account the following additional limitations for sending lodging data.

Eligible MCCs for lodging data

You can send lodging ESD if you have one of the following MCCs:

How it works

You include lodging data in the enhancedSchemeData.lodging object. The object has the same fields in each request that supports it.

1. Review the fields to send and the requirements that apply to your MCC.
2. Include the lodging data in one of the following requests. The request to use depends on your capture setting:
   • Automatic capture and Delayed automatic capture: the /payments request.
   • Manual capture (Single partial capture and Multiple partial capture): the /payments/{paymentPspReference}/captures request.
3. Check that you get a successful response.

Send lodging data

Include the following fields in the enhancedSchemeData.lodging object of your /payments or /payments/{paymentPspReference}/captures request.

Field	Required	Description	Value
lodging.checkInDate String		The check-in date.	Format: ISO 8601 date: yyyy-MM-dd
lodging.checkOutDate String		The check-out date.	Format: ISO 8601 date: yyyy-MM-dd
lodging.folio.number String		The internal invoice or billing ID reference number of the card acceptor.	Format: Alphanumeric Must not start with a space Must not contain special characters Must not contain only zeros
lodging.rooms.rate Integer		The room rate per night.	Format: Numeric, in minor units Maximum: 10000000000 Example: 2000 means USD 20.00.
lodging.rooms.numberOfNights Integer		The total number of nights that the room is booked for.	Format: Numeric A number between 1 and 99
lodging.customerServicePhoneNumber String		The toll-free phone number for the lodging customer service.	Format: Alphanumeric For the US and Canada, exactly 10 characters Must not start with a space Must not contain special characters such as + or - Must not contain only zeros
lodging.propertyPhoneNumber String		The phone number of the lodging property location.	Format: Alphanumeric Minimum 10 characters For the US and Canada, exactly 10 characters Must not start with a space Must not contain special characters such as + or - Must not contain only zeros
lodging.renterName String		The name of the person who rents the room.	Format: ASCII Must not start with a space, or contain only spaces or zeros
lodging.totalRoomTax Integer		The total room tax amount.	Format: Numeric, in minor units Maximum: 10000000000
lodging.totalTax Integer		The total tax amount.	Format: Numeric, in minor units Maximum: 10000000000
lodging.lodgingChargeType String		The category of lodging charges for the payment.	Possible values: advanceDeposit noShow stay
lodging.fireSafetyCompliance Boolean		Indicates whether the facility complies with the Hotel and Motel Fire Safety Act of 1990.	Possible values: true false
lodging.folio.cashAdvances Integer		The folio cash advances.	Format: Numeric, in minor units Maximum: 10000000000
lodging.foodBeverageCharges Integer		The charges for food and beverages for the booking.	Format: Numeric, in minor units Maximum: 10000000000
lodging.noShow Boolean		Indicates whether the customer did not check in for their booking.	Possible values: true false
lodging.prepaidExpenses Integer		The prepaid expenses for the booking.	Format: Numeric, in minor units Maximum: 10000000000

Select the endpoint for the corresponding request example:

Test sending lodging data

Use the following test card to test payments with lodging data:

See also

• Cards
• Enhanced scheme data
• Webhooks