Adapter - Elavon Hospitality
This page describes version 2.0.6 of the adapter.
Overview
This adapter is used to connect a hospitality kiosk solution to the Simplify payment application housed in Elavon provided payment devices, providing secure credit card payment transactions. The adapter is capable of performing credit card authorizations, reversals, and final sales transactions necessary for lodging related purchases.
TLS Configuration
The customer wishing to use TLS encrypted connection from the adapter to the payment device can use their own purchased certificate that can be provided to Elavon to install on the payment device the adapter is to connect to or they can use Elavon's self signed certificate.
With either selection, the certificate would also need to be installed as a trusted CA on the UIP that the adapter is managed on as well.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| serviceAddress |
Credit card pinpad ipaddress |
True |
The host address to connect to the credit card pinpad for this adapter instance. |
string |
127.0.0.1 |
|
|
1024 |
|
| servicePort |
Credit card pinpad port |
True |
The port to connect to the credit card pinpad for this adapter instance. |
integer |
6000 |
65535 |
1 |
|
|
| serviceSsl |
Use TLS (optional) |
False |
|
boolean |
false |
|
|
|
|
Commands
Authorize Credit Card (authorizecreditcard)
Used to request processor approval for credit card authorization.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| taxIndicator |
Tax Indicator |
Code to indicate whether tax is applied and if not why not. Acceptable values: 0=Non-Taxable, 1=Yes, 2=Exempt |
True |
string |
| taxAmount |
Tax Amount |
The amount of tax charged to the guest. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| authorizationCode |
Authorization code returned by Fusebox (Elavon). |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
One Time Sale (onetimesale)
Used to finalize a sale without prior authorization.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| taxIndicator |
Tax Indicator |
Code to indicate whether tax is applied and if not why not. Acceptable values: 0=Non-Taxable, 1=Yes, 2=Exempt |
True |
string |
| taxAmount |
Tax Amount |
The amount of tax charged to the guest. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chargeDescription |
Charge Description |
Generally set to 1. Code used to describe the charge being made. 0 = Health Spa, 1 = Lodging, 2 = Food/Beverage, 3 = Gift Shop, 4 = Beauty Salon, 5 = Convention Fees, 6 = Tennis/Pro Shop, 7 = Golf/Pro Shop. |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| extraChargeAmount |
Extra Charge Amount |
Amount of extra charges accrued during the guest stay. |
True |
string |
| extraChargeReason |
Extra Charge Reason |
Code for the extra charges entered back to back with no separator for multiple reasons 2=Restaurant, 3=Gift Shop, 4=Minibar, 5=Telephone, 6=Other, 7=Laundry. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| authorizationCode |
Authorization code returned by Fusebox (Elavon). |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Prior Authorized Credit Card Sale (priorauthsale)
Used as the follow up to Authorize Credit Card to finalize an authorized sale.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| accountToken |
Account Token |
Represents the credit card data used for the transaction. |
True |
string |
| expirationDate |
Expiration Date |
Expiration date for the card associated with the account token. |
True |
string |
| authorizationCode |
Authorization Code |
Authorization Code provided by the Auth Only response for corresponding Transaction Id. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| taxIndicator |
Tax Indicator |
Code to indicate whether tax is applied and if not why not. Acceptable values: 0=Non-Taxable, 1=Yes, 2=Exempt |
True |
string |
| taxAmount |
Tax Amount |
The amount of tax charged to the guest. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| extraChargeAmount |
Extra Charge Amount |
Amount of extra charges accrued during the guest stay. |
True |
string |
| extraChargeReason |
Extra Charge Reason |
Code for the extra charges entered back to back with no separator for multiple reasons 2=Restaurant, 3=Gift Shop, 4=Minibar, 5=Telephone, 6=Other, 7=Laundry. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Full Authorization Reversal (fullauthreversal)
Used to void and reverse a transaction.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| accountToken |
Account Token |
Represents the credit card data used for the transaction. |
True |
string |
| expirationDate |
Expiration Date |
Expiration date for the card associated with the account token. |
True |
string |
| authorizationCode |
Authorization Code |
Authorization Code provided by the Auth Only response for corresponding Transaction Id. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Incremental Authorization (incrementalauth)
Provides a means for achieving incremental authorization if the amount needed for authorization changes.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| accountToken |
Account Token |
Represents the credit card data used for the transaction. |
True |
string |
| expirationDate |
Expiration Date |
Expiration date for the card associated with the account token. |
True |
string |
| authorizationCode |
Authorization Code |
Authorization Code provided by the Auth Only response for corresponding Transaction Id. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| taxIndicator |
Tax Indicator |
Code to indicate whether tax is applied and if not why not. Acceptable values: 0=Non-Taxable, 1=Yes, 2=Exempt |
True |
string |
| taxAmount |
Tax Amount |
The amount of tax charged to the guest. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| extraChargeAmount |
Extra Charge Amount |
Amount of extra charges accrued during the guest stay. |
True |
string |
| extraChargeReason |
Extra Charge Reason |
Code for the extra charges entered back to back with no separator for multiple reasons 2=Restaurant, 3=Gift Shop, 4=Minibar, 5=Telephone, 6=Other, 7=Laundry. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Partial Authorization Reversal (partialauthreversal)
Used to void and reverse a Partially authorized transaction.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The dollar amount requested for Authorization. If not included the decimal point will be assumed. E.g. 200 will be read as 2.00. |
True |
string |
| accountToken |
Account Token |
Represents the credit card data used for the transaction. |
True |
string |
| expirationDate |
Expiration Date |
Expiration date for the card associated with the account token. |
True |
string |
| authorizationCode |
Authorization Code |
Authorization Code provided by the Auth Only response for corresponding Transaction Id. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| folioNumber |
Folio Number |
The Folio Number assigned by the PMS system. |
True |
string |
| roomRate |
Room Rate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
True |
string |
| arrivalDate |
Arrival Date |
MMDDYY. Date when guest checks in to the property. |
True |
string |
| departureDate |
Departure Date |
MMDDYY. Date when guest expects to check out. |
True |
string |
| lengthOfStay |
Expected Length of Stay |
The number of days the guest is expecting to stay. Numerical value only. |
True |
string |
| roomNumber |
Room Number |
The room number of the room incurring primary charges. |
True |
string |
| guestName |
Guest Name |
The name of the primary guest responsible for the charges accrued. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| emvReceiptInfo |
Information returned to be presented on a receipt when EMV chip is used to process a payment. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Transaction Inquiry (transactioninquiry)
Used to request information on a prior transaction.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionAmount |
Transaction Amount |
The amount requested for Authorization. |
True |
string |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| TransactionType |
The type of transaction on file for the inquiry. |
string |
| transactionAmount |
The amount requested for Authorization. |
string |
| accountToken |
The account token representing credit card data. |
string |
| expirationDate |
The expiration date of the card associated to the account token. |
string |
| authorizationCode |
Authorization code returned by Fusebox (Elavon). |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| folioNumber |
The Folio Number assigned by the PMS system. |
string |
| roomRate |
Per day charge for room. Include decimal. If room rate is more than 1000.00, enter 999.99 |
string |
| arrivalDate |
MMDDYY. Date when guest checks in to the property. |
string |
| departureDate |
MMDDYY. Date when guest expects to check out. |
string |
| lengthOfStay |
The number of days the guest is expecting to stay. Numerical value only. |
string |
| roomNumber |
The room number of the room incurring primary charges. |
string |
| guestName |
The name of the primary guest responsible for the charges accrued. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Token Request (tokenrequest)
Used to request a token for an account.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| transactionId |
Transaction Id |
Unique value used to identify a transaction. |
True |
string |
| terminalId |
Terminal Id |
Identifier for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| uniqueKioskId |
Unique Kiosk Id |
A unique numerical value 1-8 digits long to identify each kiosk at the location. |
True |
string |
| locationName |
Location Name |
Location name used for the provided credit card terminal. (Provided by Elavon) |
True |
string |
| chainCode |
Chain Code |
Chain code. (Provided by Elavon) |
True |
string |
Response Properties
| Name |
Description |
Type |
| transactionAmount |
The amount requested for Authorization. |
string |
| authorizationCode |
Authorization code returned by Fusebox (Elavon). |
string |
| transactionId |
Unique value used to identify a transaction. |
string |
| authorizedAmount |
The amount authorized by the API call to Fusebox (Elavon). |
string |
| hostResponse |
Host response message. |
string |
| gatewayResponse |
Gateway response message. |
string |
| maskedNumber |
The masked version of the credit card number authorized for the transaction amount. |
string |
| status |
Status of the command - success/failure |
string |
| errorMessage |
Error message originating from adapter. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.3 |
Initial |
First release in the Adapter Type store. |
|
|
| 2.0.5 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-11518 |
|
| 2.0.6 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-23945 |
2022-11-29 |
Categories