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.

Elements of the flow will vary based on the POS environment or requirements and on the connected terminal.

If the PIN entry device (PED) or card reader (example: Ingenico iCMP, iSC250) supports amount entry:

- The PED displays gratuity prompts.
- The final amount will be returned to the integrator.

If the PED or card reader (example: ROAM RP457c) does not support amount entry:

- The integrator can specify the `gratuityAmount` value (already pre-determined) when starting the transaction.
- Commerce SDK can request the value via callback, as needed.

## Code Samples

### CWS 

#### Request

| Property | Description |
| --- | --- |
| parameters JSONObject required | All relevant parameters for Gratuity processing. |
| gratuityFlowEnabled boolean required | Gratuity Support and Flow Indicator Indicates whether gratuity support and flow is part of the transaction. **Valid values:** - true - false (Default) |
| gratuityAmount JSONObject optional | Gratuity Amount Gratuity amount that has already entered into the POS prior to the start of the transaction or used as part of callback request. key: "currencyCode" ("USD") key: "value" ("2000" - in minor units) |
| gratuityQuickSelections JSONObject optional | Gratuity Quick Selections Enables the overriding of the quick selection option on the PED or callback. key: "curencyCode" ("USD") key: "value" ("125" - in minor units) key: "type" ("MONETARY_AMOUNT" or "PERCENTAGE") |
| gratuityCustomAmountEntryallowed boolean required | Allow Custom Gratuity Amount Indicator Indicates whether the user can enter a custom gratuity amount. **Valid values:** - true - false (Default) |


#### Response

| Property | Description |
| --- | --- |
| data JSONObject | Object holding various responses. |
| gratuityAmount JSONObject | Gratuity Amount Gratuity amount selected as part of gratuity flow or callback. This amount is typically returned at the time of the authorization request. key: "currencyCode" ("USD") key: "value" ("2000" - in minor units) |


#### Example

##### Request

```json
{
 "method" : "startPaymentTransaction",
 "requestId" : "1016061883",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "paymentGatewayId" : "6da0af71-2e4b-4609-ad18-6a06dbf070fb",
 "transactionType" : "SALE",
 "tenderType" : "CARD",
 .....
 "gratuityFlowEnabled" : true,
 "gratuityAmount" : null,
 "gratuityCustomAmountEntryAllowed" : true,
 "gratuityQuickSelections" : {
 "selection1" : {
 "type" : "PERCENTAGE",
 "currencyCode" : "USD",
 "value" : "15"
 },
 "selection2" : {
 "type" : "PERCENTAGE",
 "currencyCode" : "USD",
 "value" : "20"
 },
 "selection3" : {
 "type" : "MONETARY_AMOUNT",
 "currencyCode" : "USD",
 "value" : "300"
 }
 },
 .....
 }
}
```

##### Response

```json
"requestId" : "1016061925",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "paymentGatewayCommand" : {
 "completed" : true,
 "eventQueue" : [ ],
 "chanId" : "d220e0fc-dbe5-42d8-abd8-e476aa2a1c64",
 "paymentTransactionData" : {
 "result" : "APPROVED",
 "authCode" : "******",
 "date" : "Mon Mar 07 12:09:45 MST 2016",
 "cardEntryType" : "SWIPE",
 "resultMessage" : "APPROVED",
 "cardScheme" : "VISA",
 "amount" : {
 "currencyCode" : "USD",
 "value" : 1300
 },
 "id" : "070316A15-96503D56-5BF3-4944-8A5C-D7A819A44A05",
 "transactionType" : "SALE",
 "approved" : "yes",
 "errors" : [ ],
 "maskedPan" : "******",
 "gratuityAmount" : { 
 "currencyCode" : "USD",
 "value" : 300 
 },
 "signatureBitmap" : {
 "data" : "` *M _/_ X _/ _& _& _/___ _/ _& _%___ _% _&__^ _&__^ _'___ _'___ _&__^ _&___ _&p`#*K_ P_ Y !_ X \" ! ( ! ( ) ( ) ( 1 8 ) 8 8 8 8 _/ ( _' _' _/ _'___ _'__^___ _&__W__^__^_____^__W__^____________ _&_ X _/___ _/ _/ ( _/ ( ( ( ( ( _/ ( ( ( ( ( _' _'_ X____ X____ P____ X__W____ P__W____ P____ X__W____ X_ X _'_ Xp`(%\" !p`,(. _'____ X___ _'_______ X _'___ _'_____^ _'___ _' _&_ X _/ _' _/ _/ _/ 0 ( 0 0 1 ( 1 0 1 1 1 1 ) ) 1 \" 1 ! \" ! ! ! \"_ Y_ Y_ Y_ Y_ Y_ Q_ Y_ P_ P_ Y_ P_ P_ P____ P____ P____ Xp`2).____ X____ X_ X____ X_ X__W____ X_____W__W_____W_____^_________ _'___ _' _' ( _' _/ ( _7 ) 0 0 ) 0 9 1 1 ) 1 1 1 ) 2 ) * ! * \" ) ! \"_ Y !_ Y_ Z_ Y_ Q_ Q_ X_ I_ P_ P_ P_ Hp",
 "format" : "SIG_BIN_2"
 },
 "tenderType" : "CARD",
 "balanceDue" : {
 "currencyCode" : "UNKNOWN",
 "value" : 0
 }
 }
 }
 }
}
```

### Java 

#### ECLCurrencyTransactionInterface

| Property | Description |
| --- | --- |
| parameters | All relevant parameters for Gratuity processing. |
| setGratuityRequested boolean required | Set Gratuity Requested Enables the collection and tracking of a gratuity amount for the given transaction. **Valid values:** - true - false (Default) |
| setGratuityCustomAmountEntryAllowed boolean optional | Set Gratuity Custom Amount Entry Allowed Allows the cutomer to enter a custom gratuity amount on the card reader, overriding the default quick value options. **Valid values:** - true - false (Default) |
| setGratuityQuickValues long optional List<ECLGratuityQuickValue> | Set Gratuity Quick Values Overrides the default quick value options displayed for gratuity amount selection. |


##### Enable Gratuity

Using the same from the Sale transaction with a card tender, the only addition we need to do before processing the transaction is:

```java
((ECLCurrencyTransactionInterface) transaction).setGratuityRequested(true);
```

##### Quick Gratuity Selection

By default, there are 3 quick gratuity selections: 15%, 18%, and 20%. Optionally, you can specify up to 3 custom gratuity quick selection values. It can be either percentage or amount. Let's define a quick gratuity selections of 10%, $2.00, and $5.00

```java
List<ECLGratuityQuickValue> quickValues = new ArrayList<ECLGratuityQuickValue>();
BigDecimal percentage = new BigDecimal(10);
quickValues.add(new ECLGratuityQuickValue(percentage));
ECLMoney quickAmount1 = new ECLMoney(ECLCurrencyCode.USD, Long.valueOf(200));
quickValues.add(new ECLGratuityQuickValue(quickAmount1));
ECLMoney quickAmount2 = new ECLMoney(ECLCurrencyCode.USD, Long.valueOf(500));
quickValues.add(new ECLGratuityQuickValue(quickAmount2));
((ECLCurrencyTransactionInterface) transaction).setGratuityQuickValues(quickValues);
```

##### Enter Gratuity Amount Manually

Optionally, by setting the "custom amount entry" flag on, you can manually enter any gratuity amount on the device.

```java
((ECLCurrencyTransactionInterface) transaction).setGratuityCustomAmountEntryAllowed(true);
```

### Objective-C 

#### Enable Gratuity

Using the same code from the Sale transaction with a card tender, the only addition we need to do before processing the transaction is:

```objc
[saleTransaction setIsGratuityRequested:YES];
```

#### Quick Gratuity Selections

By default, there are 3 quick gratuity selections: 15%, 18%, and 20%. Optionally, you can specify up to 3 custom gratuity quick selection values. It can be either percentage or amount. Let's define a quick gratuity selections of 10%, $2.00, and $5.00

```objc
NSMutableArray * tipQuickSelections = [[NSMutableArray alloc] init];
int idx = 0;
ECLGratuityQuickValue *gratuity;
gratuity = [[ECLGratuityQuickValue alloc] initWithPercentage:10];
[tipQuickSelections insertObject:gratuity atIndex:idx++];
gratuity = [[ECLGratuityQuickValue alloc] initWithAmount:[[ECLMoney alloc] initWithMinorUnits:200 withCurrencyCode:_currency]];
[tipQuickSelections insertObject:gratuity atIndex:idx++];
gratuity = [[ECLGratuityQuickValue alloc] initWithAmount:[[ECLMoney alloc] initWithMinorUnits:500 withCurrencyCode:_currency]];
[tipQuickSelections insertObject:gratuity atIndex:idx++];
[saleTransaction setGratuityQuickValues:tipQuickSelections];

```

#### Enter Gratuity Amount manually

Optionally, by setting the "custom amount entry" flag on, you can manually enter any gratuity amount on the device.

```objc
[saleTransaction setIsCustomAmountEntryAllowed:YES];
```
 
#### Expected Results

The gratuity will be added to the base amount of the transaction and the final amount will be send for authorization.


### C\# 

#### Gratuity with Percentage

##### Request

```c#
PaymentArgs bea = new PaymentArgs();
...
bea.gratuityFlowEnabled = true;
bea.gratuityCustomAmountEntryAllowed = true; /* Or false */
 
QuickSelection qa = new QuickSelection();
qs.selection1 = new Dictionary<String, String>();
qs.selection1.Add("type", "PERCENTAGE");
qs.selection1.Add("currencyCode", "USD");
qs.selection1.Add("value", "15");
qs.selection2 = new Dictionary<String, String>();
qs.selection2.Add("type", "MONETARY_AMOUNT");
qs.selection2.Add("currencyCode", "USD");
qs.selection2.Add("value", "300");
 
...
 
bea.gratuityQuickSelections = qs; /* or null */
 
m_CWS.StartPaymentTransaction(bea, MyNotifyCWSEvent, MyPaymentComplete);
```

##### Response

```c#
public void MyBackEndComplete(BackEndResults ber)
{
 BackEndTransactionData betd = ber.BackEndTransactionData;
 if (null != betd)
 {
 if ((null != betd.approved)
 && (betd.approved.Equals("yes")))
 {
 Money tip = betd.gratuityAmount;
 if (null != tip)
 Log(String.Format("tip {0}", tip.getAmountInMinorUnits()));
```

Gratuity

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

Manual Card Data Entry

Merchant Transaction Reference

Partial Approval

Token Request

Pay with Token

Retrieve CVM Signature

Invoice Number

Lane Number

OAR-PS2000 Data

Healthcare

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