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.

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

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services 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.
Elavon Financial Services 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.

For terminals in the healthcare sector, you have the option to specify additional fields related to healthcare amounts.

There are 2 methods for providing the healthcare amounts:

1. Provide healthcare amounts when first initiating a transaction request to CommerceSDK.
2. If healthcare amounts are not provided, CommerceSDK will perform a bin lookup on the card and return the result via a callback method. You have the option to provide healthcare amounts at this point. Note that you must tell CommerceSDK to continue the transaction after receiving the callback, regardless if you actually set any healthcare amounts or not.

The following healthcare amounts can be set:

- Over The Counter Amount
- Prescription Amount
- Clinic/Other Amount
- Dental Amount
- Vision Amount
- Transit Amount


:::::notice{important}

If you need to set Transit Amount, it must be sent in a separate transaction request from any of the other healthcare amounts.
:::::


## Code Samples

### CWS

| Method | Description |
| ---- | ---- |
| parameters JSONObject required | All relevant parameters for a transaction. |
| healthcareAmount JSONObject optional | Healthcare amount. |
| overTheCounterAmount JSONObject optional | Amount of over the counter medical expenditures. |
| prescriptionAmount JSONObject optional | Amount of prescription drug expenditures. |
|clinicAmount JSONObject optional	| Amount of expenditures for clinic or other medical office services. |
| dentalAmount JSONObject optional | 	Amount of dental expenditures. |
| visionAmount JSONObject optional | Amount of vision expenditures. |
| transitAmount JSONObject optional | Amount of transit expenditures. *Note:* Transit Amount must be sent separately from healthcare transactions that include other healthcare amount fields above. |

Method 1 - set healthcare amounts during the initial `startPaymentTransaction` request.

#### Request

```json
{
 "method" : "startPaymentTransaction",
 "requestId" : "1828579547",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "transactionType" : "SALE",
 "paymentGatewayId" : "855cc46b-07fe-448e-ab39-f133c44988ae",
 "tenderType" : "CARD",
 "baseTransactionAmount" : {
 "value" : 500,
 "currencyCode" : "USD"
 },
 "healthcareAmount" : {
 "overTheCounterAmount" : {
 "value" : 200,
 "currencyCode" : "USD"
 },
 "prescriptionAmount" : {
 "value" : 300,
 "currencyCode" : "USD"
 }
 }
 }
}
```

Method 2 - wait for `HandleBinLookupResult` in `requiredInformation` of `getPaymentTransactionStatus` response.

#### Response

| Method | Description |
| ---- | ---- |
| paymentGatewayCommand JSONObject | Payment Gateway Command |
| requiredInformation Array | HandleBinLookupResult |
| binLookupResult JSONObject	| Result of the bin lookup |
| hsaCard boolean | Whether the card is an HSA card. |

```json
{
 "requestId" : "1785483547",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "paymentGatewayCommand" : {
 "completed" : false,
 "eventQueue" : [ ],
 "chanId" : "7386cfad-22a3-40fa-9fe2-d7a41ada9822",
 "requiredInformation" : [ "HandleBinLookupResult" ],
 "binLookupResult" : {
 "hsaCard" : true
 }
 }
 }
}
```

Continue the transaction, providing any necessary healthcare amounts.

#### Request

| Method | Description |
| ---- | ---- |
| parameters JSONObject required | All relevant parameters for a transaction. |
| chanId JSONObject required | Unique transaction identifier. |
| paymentGatewayId JSONObject required | Unique payment gateway identifier. |
| HandleBinLookupResult JSONObject required | Contains any new fields that need to be added to the transaction, e.g. healthcare amounts. |
| healthcareAmount JSONObject optional | Healthcare amount. See above for different amounts to include in this field. |

```json
{
 "method" : "continuePaymentTransaction",
 "requestId" : "1785483548",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "chanId" : "7386cfad-22a3-40fa-9fe2-d7a41ada9822",
 "paymentGatewayId" : "855cc46b-07fe-448e-ab39-f133c44988ae",
 "HandleBinLookupResult" : {
 "healthcareAmount" : {
 "overTheCounterAmount" : {
 "value" : 200,
 "currencyCode" : "USD"
 },
 "prescriptionAmount" : {
 "value" : 300,
 "currencyCode" : "USD"
 }
 }
 }
 }
}
```

### Java

```java
// Instantiate ECLHealthcareAmount and set any of the necessary healthcare amounts
ECLHealthcareAmount healthcareAmount = new ECLHealthcareAmount.Builder()
 .overTheCounterAmount(overTheCounterAmount)
 .prescriptionAmount(prescriptionAmount)
 .clinicAmount(clinicAmount)
 .dentalAmount(dentalAmount)
 .visionAmount(visionAmount)
 // don't set this if you have any of the other amounts set - must be sent in a separate transaction
 .transitAmount(transitAmount)
 .build();
 
 
// Method 1: set healthcare amounts when first starting the transaction
ECLCurrencyTransactionInterface transaction = account.getTransactionProcessor().createSaleTransactionWithSubtotal(amount);
transaction.setHealthcareAmount(healthcareAmount);
ECLCardTenderInterface tender = account.getTransactionProcessor().createCardTender();
account.getTransactionProcessor().processTransaction(transaction, tender, transactionListener);
 
 
// Method 2: handle bin lookup complete callback method of ECLTransactionProcessingListener
// if this method is called, you must tell CSDK to continue the transaction after setting any relevant fields
public void handleBinLookupComplete(ECLTransactionInterface transaction, ECLTenderInterface tender, ECLBinLookupResult binLookupResult)
{
 if (binLookupResult.isHsaCard())
 {
 if (transaction instanceof ECLCurrencyTransactionInterface)
 {
 // set healthcare amount on currencyTransaction
 ECLCurrencyTransactionInterface currencyTransaction = (ECLCurrencyTransactionInterface)transaction;
 currencyTransaction.setHealthcareAmount(healthcareAmount);
 }
 }
 
 handler.post(() -> account.getTransactionProcessor().continueProcessingTransaction(transaction, tender, transactionListener));
}
```

### Objective-C (iOS)

```objc
// Instantiate ECLHealthcareAmount and set any of the necessary healthcare amounts
ECLHealthcareAmount *healthcareAmount = [[ECLHealthcareAmount alloc] init];
healthcareAmount.overTheCounterAmount = ...
healthcareAmount.prescriptionAmount = ...
healthcareAmount.clinicAmount = ...
healthcareAmount.dentalAmount = ...
healthcareAmount.visionAmount = ...
 
// don't set this if you have any of the other amounts set - must be sent in a separate transaction
healthcareAmount.transitAmount = ...
 
 
// Method 1: set healthcare amounts when first starting the transaction
id<ECLCurrencyTransactionProtocol> transaction = [account.transactionProcessor createSaleTransactionWithSubtotal:amount];
transaction.healthcareAmount = healthcareAmount;
id<ECLCardTenderProtocol> tender = [account.transactionProcessor createCardTender];
[account.transactionProcessor processTransaction:transaction using:tender delegate:self];
 
 
// Method 2: handle bin lookup complete callback method of ECLTransactionProcessingDelegate
// if this method is called, you must tell CSDK to continue the transaction after setting any relevant fields
- (void)handleBinLookupComplete:(id<ECLTransactionProtocol>)transactionParam tender:(id<ECLTenderProtocol>)tenderParam binLookupResult:(ECLBinLookupResult *)binLookupResult {
 if (binLookupResult.hsaCard) {
 if ([transactionParam conformsToProtocol:@protocol(ECLCurrencyTransactionProtocol)]) {
 // set healthcare amount on currencyTransaction
 id<ECLCurrencyTransactionProtocol> currencyTransaction = (id<ECLCurrencyTransactionProtocol>)transactionParam;
 currencyTransaction.healthcareAmount = healthcareAmount;
 }
 }
 
 dispatch_async(dispatch_get_main_queue(), ^() {
 [[self->_account transactionProcessor] continueProcessingTransaction:transactionParam using:tenderParam delegate:self];
 });
}
```

### C\#

```c#
// Instantiate HealthcareAmount and set any of the necessary healthcare amounts
HealthcareAmount healthcareAmount = new HealthcareAmount();
healthcareAmount.overTheCounterAmount = ...
healthcareAmount.prescriptionAmount = ...
healthcareAmount.clinicAmount = ...
healthcareAmount.dentalAmount = ...
healthcareAmount.visionAmount = ...
 
// don't set this if you have any of the other amounts set - must be sent in a separate transaction
healthcareAmount.transitAmount = ...
 
 
// Method 1: set healthcare amounts when first starting the transaction
PaymentArgs bea = new PaymentArgs();
bea.baseTransactionAmount = ...
bea.tenderType = TenderType.CARD; 
bea.transactionType = TransactionType.SALE;
bea.paymentGatewayId = ...
bea.healthcareAmount = healthcareAmount;
m_CWS.StartPaymentTransaction(bea, MyNotifyCWSEvent, MyPaymentComplete);
 
 
// Method 2: check for HandleBinLookupResult in RequiredInformation
// You must call CWS.StartHandleBinLookupResult after setting any relevant fields
public void MyPaymentComplete(PaymentTransactionResults paymentResults)
{
 // get required information
 String[] req = paymentResults.GetRequiredInformation();
 if (null != req)
 {
 for (int i = 0; i < req.Length; i++)
 {
 if (String.Compare(req[i], "HandleBinLookupResult", true) == 0)
 {
 HandleBinLookupResultInfo binLookupResultInfo = null;
 BinLookupResult binLookupResult = paymentResults.GetBinLookupResult();
 if (binLookupResult.isHsaCard)
 {
 binLookupResultInfo = new HandleBinLookupResultInfo();
 binLookupResultInfo.healthcareAmount = healthcareAmount;
 }
 
 m_CWS.StartHandleBinLookupResult(m_PaymentGatewayId, chanId, binLookupResultInfo, MyNotifyCWSEvent, MyPaymentComplete);
 }
 }
 }
}
```

Healthcare

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Bank Holidays

Card Activation

Card Controls

Commercial Credit Cards

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Make a Payment - Coming Soon

Rewards Accelerator

Rewards Automatic Redemption

Rewards Balance Summary

Rewards Redemption Coming Soon

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

Avvance

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Card as a Service API

Check Payables

Core Banking API

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

Money Movement API

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

Reference API

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Elavon Commerce SDK Overview

Getting Started

Integration Methods

Commerce Web Services

Java (Windows)

Java (Android)

Objective-C (iOS)

System

Get Environment Information

Get Converge Account Information

Validate BMS Credentials

Payment Terminals

Payment Terminals Overview

Ingenico

iCMP

iPP320

iSC250

Lane 3000

Lane 5000

Link 2500

Moby 5500

RP457c

Self 4000

Card Reader Connection

Device Connection Criteria

Card Reader Configuration

Get Card Reader Information

24-Hour Reboot

On-Demand

Get Device Status

Reset Card Reader

Reboot Card Reader

Encrypted Card Read

Cancel Card Read

Prompt PIN Entry

Capture Card Data

Get Customer Input

Phone Number

Volume Control

Set Shutdown Timeout

Signature Capture

Set Time Zone on Card Reader

TMS Update Check Time Window

SSL Certificate Update Process for Card Reader

Printers

Printers Overview

Get Printer Information

Print Receipts

On Demand Print Receipt

Transaction Types

Transactions Overview

Sale

Auth Only

Auth Only Increment

Convert Auth Only to Sale

Auth Only Reversal

Void

Linked Refund

Stand Alone Refund

Debit Balance Inquiry

Post Auth Tip Adjust

Continue Transaction

Cancel Transaction

Transaction Lookup

Processing Options

Processing Options Overview

Address Verification Service

Force Sale

Gratuity

Manual Card Data Entry

Merchant Transaction Reference

Partial Approval

Token Request

Pay with Token

Retrieve CVM Signature

Invoice Number

Lane Number

OAR-PS2000 Data

Dynamic currency conversion

Credit Surcharge

Credit Surcharge Overview

Surcharge Property Retrieval

Token Transaction for Surcharge

Transaction Outcome Field for Surcharge

Transaction Search Result for Surcharge

Surcharge In-App

Service Fee

Service Fee Overview

Service Fee Property Retrieval

Token Transaction for Service Fee

Transaction Outcome Field for Service Fee

Transaction Search Result for Service Fee

Service Fee In-App