Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

Elavon Cloud Payments Interface provides support for communicating with payment entry devices and processing retail card-present transactions and transactions needed for the lodging industry.

## Transactions

Typically, the lodging industry supports the following transaction messages:

- Auth
- Batch Close
- Cancel
- DCC Eligibility
- Full Auth Reversal
- Get Token
- Health Check
- Incremental Auth
- Info Prompt
- Inquiry
- Locate Device
- Partial Auth Reversal
- Prior Auth Completion
- Refund
- Sale
- Void Refund
- Void Sale

## Lodging-specific JSON parameters/fields

Elavon Cloud Payments Interface's lodging transactions use the following parameters/fields in a JSON payload for the industry transaction component:

| Name | Type / Format / Length / Valid Values | Description | Request? | Response? |
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---------------|
| arrivalDate | String (Date, MMDDYY, 6) | Date the guest checks into the property. MMDDYY format. API field(s): 0303. | Yes | Yes |
| chargeDescription | Number (Enum) VALID VALUES: 0 = Health Spa 1 = Lodging (default value) 2 = Food/Bev 3 = Gift Shop 4 = Beauty Salon 5 = Convention Fees 6 = Tennis/Pro Shop 7 = Golf/Pro Shop 8 = (Unassigned) 9 = (Unassigned) | \[Required\] API field(s): 0300. | Yes | Yes |
| departureDate | String (Date, MMDDYY, 6) | Date the guest checks out of the property. MMDDYY format. API field(s): 0304. | Yes | Yes |
| durationOfStay | String (Number, 2) | Indicates the number of days guest is staying. A leading zero must be included for numbers less than 10, e.g., "01". API field(s): 0307. | Yes | Yes |
| employeeNumber | String (Number, 1..6) | Identifies the employee that checked the guest in. API field(s): 0309. | Yes | Yes |
| extraChargeAmount | String (Currency, 4..7) | Extra charges amount. API field(s): 0311. | Yes | Yes |
| extraChargeReasons | String (Number, 1..6) VALID VALUES: "2" = Restaurant "3" = Gift Shop "4" = MiniBar "5" = Telephone "6" = Other "7" = Laundry | Identifies reason(s) for any extra charges. Should only be populated if field extraChargeAmount contains a valid amount. Multiple reasons may be entered back-to-back, e.g., "257" to indicate charges for restaurant (2), telephone (5) and laundry (7). API field(s): 0312. | Yes | Yes |
| folioNumber | String (Number, 1..8) | \[Required\] Links charges for a guest stay. API field(s): 0301. | Yes | Yes |
| guestName | String (1..26) | Name of the guest. API field(s): 0313. | Yes | Yes |
| programCode | String (Enum) VALID VALUES: "1" "2" "3" "4" "5" "6" | Program Code of charge. API field(s): 0305. | Yes | Yes |
| roomNumber | String (Number, 1..4) | Identifies room incurring primary charges. API field(s): 0310. | Yes | Yes |
| roomRate | String (Currency, 4..8) | Indicates room rate amount. API field(s): 0302. | Yes | Yes |
| ticketROC | String (Number, 1..8) | Receipt of Charge or Record of Charge (ROC), a reference number assigned to the charge. API field(s): 0308. | Yes | Yes |

## PMS transaction flows

In lodging scenarios, transactions are conducted by a Property Management Software (PMS). In terms of interactions with Elavon Cloud Payments Interface, the PMS plays the role of an Integrator.

- **Get Token** is called when an advance reservation is made. This provides the PMS with a token for the cardholder to be used either at time of check-in or for no-show charges.

- **Auth** is called when a cardholder checks in to open the transaction lifecycle.

- **Incremental Auth** is called by the PMS to increase the authorized amount if the customer has charged other expenses, such as incidentals or meals, to their room. This increases the open authorization amount.

- **Prior Auth Completion** is called either when a customer checks out, or after 14 days for extended stays (to avoid misuse of auth fees). This will close the open authorization.

- Extended Stay would repeat the steps 2-4 above, only using the token or credential-on-file in place of sending in a card-present **Auth**.

- If at any time, the PMS times out waiting for a response to a transaction message, the **Inquiry** message should be sent to determine whether the transaction was authorized and the result can be used to print the receipt or never reached Fusebox and can safely be resubmitted.

- If, at the time of checkout, the customer has been over-authorized (e.g., they check out a day early), a **Partial Reversal** should be sent before sending in the **Prior Auth Completion**.

- If the customer wishes to change cards at the time of check-out, a full **Reversal** should be sent before sending the **Prior Auth Completion**.

- If the manager agrees to return money to the customer, a **Refund** should be sent. A **Refund** is a stand-alone transaction lifecycle and can be sent after the customer has checked out and the **Prior Auth Completion** has been sent.

- If for some reason, the **Refund** needs to be rescinded, a **Void Refund** should be sent.

- Debit cards do not support the **Auth**, **Incremental Auth** and **Prior Auth Completion** messages. Some customers may put the lodging charges on a credit card, but at time of checkout wish to change payment to a debit card (such as Interac in Canada). The PMS can send a **Sale** transaction for the full amount of the charges at check-out time.

## Lodging best practices

The **final transaction date** must be the same as the checkout date (departureDate, API field 0304), except for the following transactions:

- No Show
- Advance Deposit
- Delayed Charge

### Settlement date

The number of days between the **final transaction date** and the **settlement date** cannot be more than **two** (2) processing days. *In the event that a transaction cannot be settled within this timeframe, the transaction is not in compliance with industry requirements.*

### Authorizations for extended stays

Each card issuer has a maximum number of days the amount authorized can be held.

:::::notice{note}
As a guideline, Elavon recommends using 14 days as the maximum time for all credit cards.
:::::