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

## Transactions 

A Service/Restaurant integration uses only a few of the many transaction types available. Below is a list of the transaction types used by most integrations.

- Authorization Only
- Authorization Reversal (Full)
- Batch Close
- Incremental Authorization
- Prior-Authorized Sale (Completion)
- Return
- Sale
- Tip Adjustment
- DCC Eligibility
- Void Return
- Void Sale

## Service/Restaurant-specific JSON fields

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

| Name | Type / Format / Length / Valid Values | Description | Request? | Response? |
|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|--------------|---------------|
| message .industry .data .beverageAmount | String (Currency, 4..8) VALID VALUES: 0.00..99999.99 ($99,999.99 max) | \[Optional\] Dollar amount of the total ticket price used for beverage charges. API field(s): 0208. | Yes | Yes |
| message .industry .data .beverageDescription | String (Enum, 1..8) VALID VALUES: "BEVERAGE" "DRINKS" | \[Optional\] Description of beverage charge. API field(s): 0214. | Yes | Yes |
| message .industry .data .chargeDescription | String (Enum, 1..8) VALID VALUES: "FOOD" = food charges only "FOOD/BEV" = food and drinks "BEVERAGE" = drink total | \[Required\] Description of charge. API field(s): 0200. | Yes | Yes |
| message .industry .data .checkNumber | String (Integer, 1..6) VALID VALUES: 0..999999 | \[Required\] Ticket number for this transaction. API field(s): 0205, 7011. | Yes | Yes |
| message .industry .data .employeeNumber1 | String (Integer, 1..8) VALID VALUES: 0..99999999 | \[Required\] Employee ID of primary server on this ticket. API field(s): 0203. | Yes | Yes |
| message .industry .data .employeeNumber2 | String (Integer, 1..8) VALID VALUES: 0..99999999 | \[Optional\] Employee ID of secondary server on this ticket. API field(s): 0204. | | |
| message .industry .data .foodAmount | String (Currency, 4..8) VALID VALUES: 0.00 - 99999.99 ($99,999.99 max) | \[Optional\] Dollar amount of the total ticket price used for food charges. API field(s): 0207. | Yes | Yes |
| message .industry .data .foodDescription | String (Enum, 1..8) VALID VALUES: "FOOD" = food charges only "FOOD/BEV" = food and drinks "BEVERAGE" = drink total | \[Optional\] Description of food charges. API field(s): 0213. | Yes | Yes |
| message .industry .data .numberOfGuests | Double (Integer, 1..2) VALID VALUES: 0..99 | \[Optional\] Number of guests at the table. API field(s): 0216. | Yes | Yes |
| message .industry .data .tableNumber | String (Number, 1..3) VALID VALUES: 0..999 | \[Optional\] Identification number for the table where the customer(s) were seated. API field(s): 0209. | Yes | Yes |
| message .industry .data .tip1 | String (Currency, 4..7) VALID VALUES: 0.00 - 9999.99 ($9,999.99 max) | \[Optional\] Amount of tip for the primary server for this ticket. Variable length field with decimal point. API field(s): 0201. | Yes | Yes |
| message .industry .data .tipDescription1 | String (1..8) VALID VALUES: TIP | \[Optional\] Description of the tip field. This field should contain "TIP" even if no tip 1 is included. API field(s): 0210. | Yes | Yes |

## Sample transactions

### Request

#### Request URI

`https://{host}/devices/{deviceId}/message`

#### Request headers

Content-Type: application/vnd.elavon.transaction-b.v1+json 
Accept-Version: V2 
Authorization: {bearer token}

Correlation-Id: {Correlation-Id}

#### Request example

```json
{
 "messageId": "VMH1sJKCiEaRStqV",
 "responseChannelType": "SYNCHRONOUS",
 "responseChannel": {
 "responsePayloadFormat": "DEVICEMESSAGE"
 },
 "messageType": "application/vnd.elavon.transaction-b.v1+json",
 "message": {
 "referenceNumber": "886",
 "identifiers": {
 "chain": "TSTLA3",
 "location": "SIMTEST4",
 "terminal": "RETERM4"
 },
 "transType": "Sale",
 "transAmount": "12.50",
 "taxList": [
 {
 "taxIndicator": "A",
 "taxType": "TX",
 "taxAmount": "1.00"
 }
 ],
 "cashback": "0.00",
 "manuallyEntered": "false",
 "transactionDateTime": "2023-10-01T12:34:41Z",
 "businessDate": "100123",
 "cashierId": "ZZZZIE22",
 "offlineIndicator": "1",
 "compliance": {
 "uniqueLaneId": "09033243",
 "customerCode": "43253"
 },
 "industry": {
 "data": {
 "chargeDescription": "FOOD",
 "tip1": "5.00",
 "employeeNumber1": "12345",
 "checkNumber": "2565",
 "foodAmount": "25.00",
 "beverageAmount": "7.00",
 "tableNumber": "2",
 "tipDescription1": "TIP",
 "foodDescription": "Food",
 "beverageDescription": "Beverage",
 "numberOfGuests": 2
 }
 }
 }
}
```

### Response

200 OK
```json
{
 "messageId": "VMH1sJKCiEaRStqV",
 "responseChannelType": "SYNCHRONOUS",
 "responseChannel": {
 "responsePayloadFormat": "DEVICEMESSAGE"
 },
 "messageType": "application/vnd.elavon.transaction-b.v1+json",
 "message": {
 "referenceNumber": "227",
 "identifiers": {
 "merchantNumber": "ZZZZZZZZZZZZZZZZZZ3995",
 "chain": "TSTLA3",
 "location": "SIMTEST4",
 "terminal": "RETERM4",
 "transId": "KxqM3YDmhWTC2YPY",
 "hpiLoggingId": "kfrQJ2H7",
 "hpiTrackingNumber": "HPI-r4.3.3-API-V2;intId:FcVJVdVyYqxqDFDP;deviceId:fXhhxrM6gv6Rfdf9"
 },
 "transType": "SALE",
 "transAmount": "12.50",
 "taxList": [
 {
 "taxIndicator": "A",
 "taxType": "TX",
 "taxAmount": "1.00"
 }
 ],
 "cashback": "0.00",
 "manuallyEntered": "FALSE",
 "transactionDateTime": "2023-10-01T12:34:41Z",
 "businessDate": "100123",
 "cashierId": "ZZZZIE22",
 "partialAuthFlag": "1",
 "safetyFields": {
 "tokenization": {
 "token": "ZZZZZZZZZZZZZZZZZZZ",
 "typeRequested": "VN"
 }
 },
 "card": {
 "expirationMonth": "12",
 "expirationYear": "24",
 "maskedPAN": "******XXXXXX0011",
 "tenderType": "CREDIT",
 "cardType": "VI",
 "brand": "VISA",
 "cardholderPreferredLanguage": "en"
 },
 "compliance": {
 "posDataCode": {
 "posDeviceCapability": "M",
 "cardholderAuthenticationCapability": "1",
 "terminalCardCaptureCapability": "1",
 "terminalLocation": "1",
 "cardholderPresent": "0",
 "cardPresent": "X",
 "cardDataInputMode": "M",
 "cardDataAuthenticationMode": "5",
 "cardholderAuthenticationMode": "4",
 "cardDataOutputCapability": "1",
 "terminalDataOutputCapability": "3",
 "pinCaptureCapability": "C",
 "posAttendance": "0",
 "posDeviceTerminalType": "4"
 },
 "retrievalReferenceNumber": "1030211830",
 "entryMode": "07",
 "systemTraceAuditNumber": "122243",
 "cardProductResultCode": "A",
 "uniqueLaneId": "09033243",
 "uniqueDeviceId": "09033243",
 "customerCode": "43253",
 "totalAuthorizedAmount": "12.50"
 },
 "emv": {
 "applicationExpiryDate": "241231",
 "terminalApplicationLabel": "VISA CREDIT",
 "terminalApplicationIdentifier": "A0000000031010",
 "issuerApplicationData": "06010A03A00000",
 "applicationCryptogram": "A694B1ED03E01A82",
 "terminalVerificationResults": "0000000000",
 "deviceIFDSerialNumber": "07843720",
 "terminalCapabilities": "E0F8C8",
 "terminalCountryCode": "840",
 "applicationInterchangeProfile": "2000",
 "applicationPANSequenceNumber": "01",
 "dedicatedFileName": "A0000000031010",
 "transactionSequenceCounter": "00000439",
 "applicationTransactionCounter": "0160",
 "cryptogramInformationData": "80",
 "terminalType": "22",
 "unpredicatableNumber": "458393A5",
 "emvResponseCode": "00",
 "cryptogramTranType": "00",
 "cvmVerificationIndicator": "4",
 "terminalTransactionQualifiers": "36804000",
 "emvCryptogramAmount": "1250",
 "emvCryptogramOtherAmount": "000",
 "emvReceiptFieldList": "ApplicationLabel: VISA CREDIT,TC:
 A694B1ED03E01A82,TVR: 0000000000,AID: A0000000031010,IAD: 06010A03A00000","emvPOSEntryIndicator": "CONTACTLESS",
 "lastHostEMVKeyDownload": "10162023",
 "iccFormFactorIndicator": "20700000",
 "iccTransactionCurrency": "840"
 },
 "currency": {
 "merchantCurrencyCode": "USD"
 },
 "industry": {
 "data": {
 "chargeDescription": "FOOD",
 "tip1": "5.00",
 "employeeNumber1": "12345",
 "checkNumber": "2565",
 "foodAmount": "25.00",
 "beverageAmount": "7.00",
 "tableNumber": "2",
 "tipDescription1": "TIP",
 "foodDescription": "Food",
 "beverageDescription": "Beverage",
 "numberOfGuests": "2"
 }
 },
 "response": {
 "authorizationCode": "231526",
 "responseCode": "0000",
 "responseText": "COMPLETE",
 "hostResponseCode": "AA",
 "hostResponseText": "APPROVAL",
 "issuerResponseCode": "00",
 "authorizedDateTime": "2023-10-30T17:18:30Z",
 "transactionLinkIndicator": "1113303767100266",
 "rawData":
 "0001,02rn0002,12.50rn0003,ZZZZZZZZZZZZZZZ0011rn0004,1224rn0006,231526rn0007,227rn0009,001rn0011,035?V15N-OG-2.03B13021rn0013,100123rn0014,123441rn0017,0.00rn0025,100123rn0030,1rn0032,103023rn0033,171830rn0034,Arn0035,2232rn0036,753303767115056rn0037,Vrn0043,122243rn0047,M;1;1;1;0;X;M;5;4;1;3;C;0;4rn0049,Arn0052,2rn0054,07rn0055,1rn0057,0rn0060,09033243rn0062,ZZZrn0070,43253rn0071,Arn0072,1.00rn0079,TXrn0109,RETERM4rn0110,ZZZZIE22rn0112,400rn0115,010rn0125,1030211830rn0126,2rn0129,0rn0130,12.50rn0140,USDrn0163,enrn0200,1rn0201,5.00rn0203,12345rn0205,2565rn0207,25.00rn0208,7.00rn0209,2rn0210,TIPrn0213,Foodrn0214,Beveragern0216,2rn0647,1rn0651,ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZrn1000,VIrn1001,VISArn1003,0000rn1004,APPROVALrn1005,ZZZZZZZZZZZZZZZZZZ3995rn1008,******XXXXXX0011rn1009,AArn1010,COMPLETErn1012,0028rn1022,00rn1101,kfrQJ2H7rn1102,KxqM3YDmhWTC2YPYrn1200,0000AArn1300,A694B1ED03E01A82rn1302,241231rn1304,07843720rn1305,06010A03A00000rn1306,E0F8C8rn1307,0000000000rn1312,840rn1313,01rn1314,A0000000031010rn1318,00000439rn1319,2000rn1320,0160rn1321,80rn1322,22rn1323,458393A5rn1327,VISA
 CREDITrn1328,A0000000031010rn1333,
 10162023rn1339,
 00rn1345,
 20700000rn1357,
 840rn1358,
 00rn1359,
 4rn1360,
 36804000rn1362,
 1250rn1363,
 000rn1378,
 1327|Application
 Label: ;1300|TC: ;1307|TVR: ;1314|AID: ;1305|IAD:
 ;rn1379,
 1327|Application Label: ;1300|AAC: ;1307|TVR: ;1314|AID:
 ;1305|IAD:
 ;rn1380,CONTACTLESSrn4747,
 050611Nrn5001,
 30101147617300;1640000800057005rn5002,
 07843720rn5004,OGrn5006,ZZZZZZZZZZZZZZZZZZZZZZZZZZrn5007,Nrn5010,
 070803rn5013,fXhhxrM6gv6Rfdf9rn5027,VNrn5035,
 4854632318790011rn5060,
 00rn5070,Merchant:
 Demo;Simplify: N-OG-2.03.13021;PARM: 2.30.1;TENDERDEF: 2.30.1;EMVPARM:
 EMVPARM-E4-2-no-cert-- ;TMS: 88803584;Package: 2.30.1;Full SN: 190232203011023907843720;Injected SN: PLS-EI13111521;Build: 30121-SREV: 20rn6001,HPI-r4.3.3-API-V2;intId:FcVJVdVyYqxqDFDP;deviceId:fXhhxrM6gv6Rfdf9rn7007,
 1113303767100266rn7011,
 2565rn8002,SIMTEST4rn8006,TSTLA3rn8015,TZGV12RXrn8016,V23.01.25.1rn"
 },
 "batch": {}
 }
}
```

Restaurant and service