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

A typical retail integration uses only a few of the many transaction types available. Below is a list of the most common transactions used by retail POS applications.

- Auth
- Batch Close
- Cancel
- Incremental Auth
- Info Prompt
- Inquiry
- Locate Device
- Prior Auth Completion
- Refund
- Sale
- Void Refund
- Void Sale

## Retail-specific JSON fields

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

| Name | Type / Format / Length / Valid Values | Description | Request? | Response? |
|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------|
| HSA | Object | HSA object. | Yes | Yes |
| HSA.accountType | String (Number, 2) VALID VALUES: "00" = Not specified | API field(s): 1074 - 1083. | Yes | Yes |
| HSA.amountType | String (Enum) VALID VALUES: "4S" = Medical "4U" = RX "4V" = Vision/Optical "4W" = Clinic/Other Med "4X" = Dental "4T" = Transit | API field(s): 1074 - 1083. | Yes | Yes |
| HSA.currencyType | String (Number, 3) | Numeric string indicating alpha ISO currency code. e.g., "840" - US Dollars or 3-digit code defining the currency used in the amount. API field(s): 1074 - 1083. | Yes | Yes |
| HSA.expenseAmount | String (Currency, 4..12) | Amount with explicit decimal. API field(s): 1074 - 1083. | Yes | Yes |
| HSA.signAmount | String (Enum) VALID VALUES: "0" = Positive "C" = Positive "D" = Negative | API field(s): 1074 - 1083. | Yes | Yes |
| message .industry .data .hsaList | Array | \[Optional\] Array of HSA objects. For more information, see HSA/FSA Card Transactions. API field(s): 1074 - 1083. | | |
| invoiceNumber | String (Number, 1..15) | \[Required\] Invoice number / record of charge (ROC). API field(s): 0401. | Yes | Yes |
| Item | Object | Item object. | | |
| item .code | String (Number, 1..16) | SubField 1 describing type of product purchased. API field(s): 0412 - 0416. | Yes | Yes |
| item .description | String (1..40) | Item description. API field(s): 0406-0410. | Yes | Yes |
| item .quantity | Number (1..3) | SubField 2 indicating item quantity. API field(s): 0412 - 0416. | Yes | Yes |
| item .unitPrice | String (Currency, 4..13) | SubField 3 indicating item amount. See field description for item.code. API field(s): 0412 - 0416. | Yes | Yes |
| itemList | Array | Array of item objects. | | |
| productCode | String (Number, 2..4) | \[Required\] International code describing the type of purchase. A list of valid codes should be provided to the merchant by the acquiring bank or processor. Used in European countries. API field(s): 0400. | Yes | Yes |

## HSA/FSA card transactions

This section describes how to submit HSA/FSA transactions, which are specific to the Retail industry. Use the create transaction section above for your base financial transaction and use this section to add the HSAList Array to your base transaction.

### Medical expenses and examples

Medical expenses are handled as a combination with a rolled-up amount of general medical expenses. This is handled by a total for medical expenses in the first "hsaList" object in the array followed by objects with the subtotal amounts for the other items. The first "hsaList" object in the array should always have the "amountType" parameter set to "4S" for medical.

**Note:** If there is a medical expense that does not fit one of the categories identified, the amount in the first "hsaList" object may be greater than the total of all the defined entries. See
:magic-link[Purchase Prescription with Expense That Does Not Map Example]{id="#expense-does-not-map-to-valid-values"}.

#### Purchase prescription(s) from pharmacy

Cardholder visits pharmacy and is charged $49.95 for one or more prescriptions.

Total charges are $49.95. The transaction uses two "hsaList" objects.

```json
{
 "industry": {
 "data": {
 "productCode": "1234",
 "invoiceNumber": "987432",
 "itemList": [
 {
 "description": "Pharmacy",
 "code": "00001",
 "quantity": 1,
 "unitPrice": "49.95"
 }
 ],
 "hsaList": [
 {
 "accountType": "00",
 "amountType": "4S",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "49.95"
 },
 {
 "accountType": "00",
 "amountType": "4U",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "49.95"
 }
 ]
 }
 }
}
```

#### Purchase prescription(s) and visit clinic

Cardholder visits pharmacy and is charged $37.10 for prescription.

Cardholder also visits clinic and is charged $50.00 fee.

Total charges are $87.10. The transaction uses three "hsaList" objects.

```json
{
 "industry": {
 "data": {
 "productCode": "1234",
 "invoiceNumber": "987432",
 "itemList": [
 {
 "description": "Medical",
 "code": "00001",
 "quantity": 1,
 "unitPrice": "87.10"
 }
 ],
 "hsaList": [
 {
 "accountType": "00",
 "amountType": "4S",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "87.10"
 },
 {
 "accountType": "00",
 "amountType": "4U",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "37.10"
 },
 {
 "accountType": "00",
 "amountType": "4W",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "50.00"
 }
 ]
 }
 }
}
```

#### Expense does not map to valid values

Cardholder visits pharmacy/medical facility and is charged $35.25 for a generic expense that does not map to one of the valid values.

Total charges are $35.25. The transaction uses one "hsaList" object.

```json
{
 "industry": {
 "data": {
 "productCode": "1234",
 "invoiceNumber": "987432",
 "itemList": [
 {
 "description": "Medical",
 "code": "00001",
 "quantity": 1,
 "unitPrice": "35.25"
 }
 ],
 "hsaList": [
 {
 "accountType": "00",
 "amountType": "4S",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "35.25"
 }
 ]
 }
 }
}
```

#### Purchase prescription with expense that does not map

Cardholder visits pharmacy and is charged

- $20.00 for a medical expense not mapped to one of the valid values
- $37.10 prescription

Total charges are $57.10. The transaction uses two "hsaList" objects.

```json
{
 "industry": {
 "data": {
 "productCode": "1234",
 "invoiceNumber": "987432",
 "itemList": [
 {
 "description": "Medical",
 "code": "00001",
 "quantity": 1,
 "unitPrice": "57.10"
 }
 ],
 "hsaList": [
 {
 "accountType": "00",
 "amountType": "4S",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "57.10"
 },
 {
 "accountType": "00",
 "amountType": "4U",
 "currencyType": "840",
 "signAmount": "C",
 "expenseAmount": "37.10"
 }
 ]
 }
 }
}
```