On this page:

Overview

This page describes how to send optional data with your settle request for lodging or a cruise. This data is supported for online payments.

To settle a transaction with Lodging or Cruise data after a successful Auth transaction, send a /settleTransaction request and include the addendums.lodging.reservationDetails class with the parameters described on this page.

General Notes

Lodging/Cruise data is supported only by REST API integration.
Lodging/Cruise data is supported only for the Auth-Settle flow.

Lodging Parameters

`reservationDetails`

This class contains the processing data of the reservation.

REST 1 Field Name	Description	Data Example
purchaseId string (25)	Folio number of the stay.	HR56K930911
customerServicePhone string (20)	Customer Service telephone number.	800-6548701
noShowIndicator string (1)	Indicates whether customer showed for the stay: 0 = Not Applicable 1 = No Show	0
extraCharges string (6)	Indicates additional charge applied to the stay: 0 or = Position Not Used 1 = Reserved 2 = Restaurant 3 = Gift Shop 4 = Mini-Bar 5 = Telephone 6 = Other 7 = Laundry	0
checkInDate string (8)	YYMMDD - Date of check-in or arrival.	231101
propertyPhone string (20)	Phone number of the property.	762-7569789
checkOutDate string (8)	YYMMDD - Date of check out or departure.	231103
lodgingName string (20)	Name of the lodging or cruise establishment.
totalAuthAmount string (12)	Final authorized amount for the stay.	100
lodgingType string (1)	Dentifies the stay as hotel or cruise line: 1 - Cruise 2 - Hotel	1 or 2

`reservationDetails.rooms`

This class contains room data.

REST 1 Field Name	Description	Data Example
rate string (12)	Room rate for the stay.	104.21
nights string (2)	Number of nights for the stay.	4

`reservationDetails.passengerDetails`

This is an array containing the passenger’s name.

REST 1 Field Name	Description	Data Example
fullName string (25)	Passenger name	John Smith

`reservationDetails.segments`

This is an array containing the dates of each segment.

REST 1 Field Name	Description	Data Example
departureDate string (8)	Segment in the reservation. You can have up to 4 segments in this array.	20231201

Example Lodging Request

{
    "merchantId": "<your merchantId>",
    "merchantSiteId": "<your merchantSiteId>",
    "timeStamp": "<YYYYMMDDHHmmss>",
    "checksum": "<calculated checksum>",
    "currency": "USD",
    "amount": "10",
    "clientUniqueId": "<unique transaction ID in merchant system>",
    "addendums": {
        "lodging": {
            "reservationDetails": {
                "purchaseId": "HR56K930911",
                "customerServicePhone": "800-654-8701",
                "noShowIndicator": "0",
                "extraCharges": "1",
                "checkInDate": "231101",
                "checkOutDate": "231103",
                "propertyPhone": "762-756-9789",
                "lodgingName": "Virgin",
                "lodgingType": "1",
                "totalAuthAmount": "1000",
                "rooms": {
                    "rate": "104.21",
                    "nights": "3"
                },
                "passengerDetails": [
                    {
                        "fullName": "John Smith"
                    }
                ],
                "segments": [
                    {
                        "departureDate": "20231201"
                    },
                    {
                        "departureDate": "20231203"
                    },
                    {
                        "departureDate": "20231206"
                    },
                    {
                        "departureDate": "20231209"
                    }
                ]
            }
        }
    },
    "relatedTransactionId": "<transactionId of the original Auth transaction>",
    "authCode": "<returned in the response from the original payment request>"
}