A Lodging object represents lodging information to be sent in with a transaction.
Properties
| Property | Type | Description | Example |
|---|---|---|---|
charge_type | String | Identifies what part of the lodging merchant generated the charge. Options include: "hotel", "restaurant", and "gift shop" | "hotel" |
duration | Number(integer) | The number of days/nights associated with the lodging period. | 1 |
check_in_date | String(YYYY-MM-DD) | The actual or anticipated arrival/check-in date of the lodging period. | "2026-01-01" |
check_out_date | String(YYYY-MM-DD) | The actual or anticipated departure/check-out date of the lodging period. | "2026-01-02" |
room_rate | Number(float) | The daily rate of the room associated with the lodging period. | 12.34 |
folio_number | String | An identifier for the hotel's guest folio or internal account/ledger for the stay. | "FOL-12345" |
renter_name | String | The name of the guest/renter associated with the lodging period. | "Firstname Lastname" |
extra_charges | Boolean | Indicates whether additional/incedental charges are associated with the lodging bill beyond the room charge. | false |
is_advance_deposit | Boolean | Indicates that the transaction is a payment collected before the actual stay, securing or partially paying for the reservation. | false |
is_no_show | Boolean | Indicates that the guest had a guaranteed reservation but did not arrive/cancel according to the agreed policy, and the merchant is charging the permitted no-show amount. | false |
is_delayed_charge | Boolean | Indicates a charge processed after the original stay/checkout for something discovered or finalized later. | false |
Example
{
"duration": 1,
"check_in_date": "2024-01-01",
"check_out_date": "2024-01-02",
"room_rate": 12.34,
"folio_number": "FOL-12345",
"renter_name": "Firstname Lastname",
"extra_charges": false,
"is_advance_deposit": false,
"is_no_show": false,
"is_delayed_charge": false
}