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.

This transaction integrates continuance of transaction processing into your application.

During transaction processing, Commerce SDK may need additional information from your application. The information needed will be based on the following **Tender** or **Transaction** requirements:

## Tender Requirements

- `requiresCardData`

 - If you have set card entry to token and have not set `tokenizedCardNumber` on the card tender, Commerce SDK will pause the transaction until you've provided the necessary information and continued the transaction.

- `requiresDigitalSignature`

 - If the card and transaction require a digital signature but the card reader failed to get it or does not support it or `digitalSignature` has not been set on card tender or canceled the signature, Commerce SDK will call back until the `digitalSignature` is set or you have called `cancelSignature` on the `cardTender`.
 - If you have set the `digitalSignature` but we are unable to use it, `lastSignatureError` will be set on the `tenderRequirements`. You can also get the minimize size required for the signature from the `tenderRequirements`.

- `requiresSignatureVerification`

 - If you have set signature verification required on the card tender, Commerce SDK will pause the transaction until you've called `setSignatureVerificationHandledAndVerified` and continued the transaction.

- `requiresVoiceReferral`

 - If you have set voice approval required on the card tender and have not called `setVoiceReferralHandledAndApproved` or `setVoiceReferralHandledAndDenied`, Commerce SDK will pause the transaction until you've called one of them and continued the transaction.

- `requiresSpecifyingCardPresence`

 - If you are doing a manual entry transaction whereby you want to key in the card information on the card reader, you will need to specify whether or not the card is physically present at the time of the transaction by calling `setCardPresent` on the card tender.

- `requiresEmvApplicationSelection`

 - If the chip requires an application selection, Commerce SDK will pause the transaction until you've called `setSelectedEmvApplication` on the tender and continued the transaction.

- `requiresAVS`

 - If some AVS data is required, Commerce SDK will pause the transaction until you've provided Commerce SDK with the required AVS field information via the `setAVSField` method.

## Transaction Requirements

- `requiresGratuity`

 - If you are doing a transaction that can have gratuity and have not turned on `isGratuityRequested` so it will be done on card reader or you have not set gratuity on the transaction, Commerce SDK will call back until it is set.
 - You can set gratuity to null (or nil depending on your platform) if you do not want gratuity to be involved.
 - You can set it when creating the transaction or wait until `shouldProvideInformation` is called.

- `requiresTax` and `requiresDiscount`

 - This will not be set as tax and discount default to null (or nil).

:::::notice{note}

 When `shouldProvideInformation` is called, there can be multiple requirements that need to be set but you should only call `contiuePaymentTransaction` once you have set as many requirements as you want.

 If there are multiple requirements that need to be set, you can set one and call `continuePaymentTransaction`. `shouldProvideInformation` will be called again and again until all requirements are set.

 If `shouldProvideInformation` is called and you want to stop the transaction, you should call `cancelPaymentTransaction`.
:::::


## Code Samples


::section-heading-list{max-level=3 }



### CWS 

During transaction processing, Commerce SDK will return the `requiredInformation` variable to indicate the information it needs from your application in order to continue processing the transaction. This variable will contain one of these values:

| Value | Description |
| ---- | ---- |
| `DigitalSignature` | Returned if digital signature has not been set on card tender Returned if the card and transaction require a digital signature but the card reader: - failed to retrieve the information - does not support digital signature capturing - canceled the signature |
| `VoiceReferral` | Returned if voice approval required is set on the card tender but one of these is not called: - `setVoiceReferralHandledAndApproved` - `setVoiceReferralHandeledAndDenied` |
| `SignatureVerification` | Returned if signature verification required is set on the card ternder but `setSignatureVerificationHandledAndVerified` is not called |
| `Tax` | Returned if tax is not enabled |
| `Discount` | Returned if discount defaults to null |
| `Tip` | Returned if `isGratuityRequested` is disabled or gratuity is not set on the transaction |
| `TokenizedCardNumber` | Tokenized credit card number |
| `CardPresent` | Returned if `setCardPresent` is not called from the card tender |
| `EmvApplicationSelectionRequired` | Returned if EMV application is required - The available applications will be returned in the `emvApplicationSelectionList` variable. - To select the application, send the **AID** in the `emvApplicationIdSelected` field of the `continuePaymentTransaction` request to CWS |
| `HandleBinLookupResult` | Returned if CSDK performed a bin lookup. Allows you to update the transaction based on the `binLookupResult` |

#### Request

| Property | Description |
| --- | --- |
| method string required | `continuePaymentTransaction` |
| requestId string required | Transaction Request ID |
| targetType string required | `paymentGatewayConverge` |
| parameters JSONObject required | All relevant parameters for continuing transaction processing. |
| paymentGatewayId string required | Payment Gateway ID Unique payment gateway identifier as returned in the `openPaymentGateway` transaction response. |
| chanId string required | Transaction ID **Important:** Returned in the `startPaymentTransaction` response. |
| DigitalSignature VoiceReferral SignatureVerification Tax Discount Tip TokenizedCardNumber CardPresent EmvApplicationIdSelected RequireAvsZipCode HandleBinLookupResult string required | Required Information **Important:** Returned in the `requiredInformation` variable. |

#### Example

##### Response

```json
{
 "requestId" : "2101936246",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "paymentGatewayCommand" : {
 "completed" : false,
 "eventQueue" : [ ],
 "chanId" : "eb5fcc9f-07db-40a6-9711-6c2bda9a26b9",
 "requiredInformation" : [ "VoiceReferral" ]
 }
 }
}
```

##### Request

```json
{
 "method" : "continuePaymentTransaction",
 "requestId" : "2101936247",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "VoiceReferral" : "321zxc",
 "paymentGatewayId" : "4c45c792-0513-4218-8b6d-c5ff7039a22e",
 "chanId" : "eb5fcc9f-07db-40a6-9711-6c2bda9a26b9"
 }
}
```

#### Response

```json
{
 "requestId" : "2101936248",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "paymentGatewayCommand" : {
 "completed" : false,
 "eventQueue" : [ ],
 "chanId" : "eb5fcc9f-07db-40a6-9711-6c2bda9a26b9",
 "requiredInformation" : [ "EmvApplicationSelectionRequired" ],
 "emvApplicationSelectionList" : [ {
 "name" : "Visa Debit ",
 "index" : 0,
 "aid" : "A0000000031010"
 }, {
 "name" : "US Debit ",
 "index" : 1,
 "aid" : "A0000000980840"
 } ]
 }
 }
}
```

#### Request

```json
{
 "method" : "continuePaymentTransaction",
 "requestId" : "2101936249",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "EmvApplicationIdSelected" : "A0000000980840",
 "paymentGatewayId" : "4c45c792-0513-4218-8b6d-c5ff7039a22e",
 "chanId" : "eb5fcc9f-07db-40a6-9711-6c2bda9a26b9"
 }
}
```

### Java 

If Commerce SDK need information in order to continue processing a transaction, the transaction listener `shouldProvideInformation` method will be called. You can check the parameters in that method to determine the specific information Commerce SDK needs.

After obtaining the required information, you can call the `continueTransaction` method on the transaction processor to tell Commerce SDK to continue.

:::::notice{note}

 You should call `continueTransaction` on a different thread than the current one in order to not block the current thread.

 Refer to the Windows sample app source code for more information.
:::::


In this example from `shouldProvideInformation`, we are checking the tenderRequirements interface to see if a voice referral was needed. In this case, it is needed so you need to get an approval code from the card issuer and then pass it back to Commerce SDK so the transaction can continue.

```java
boolean continueTransaction = false;
if (tenderRequirementsInterface.getRequiresVoiceReferral() != ECLVoiceReferralRequirement.NOT_REQUIRED)
{
 // you'd need to obtain an approval code at this point. In this example, the code is 321. Then you'd pass it back to CSDK like this:
 ((ECLCardTenderInterface) tender).setVoiceReferralHandledAndApproved("321");
 continueTransaction = true;
}

if (continueTransaction == true) 
{
 Thread thread = new Thread() {
 @Override
 public void run()
 account.getTransactionProcessor().continueProcessingTransaction(transaction, tender, transactionListener);
 }
 };
 thread.start();
 return;
}
```

### Objective-C 

If Commerce SDK needs information from you in order to continue processing a transaction, your transaction processing delegate's `shouldProvideInformation` method will be called. You can check the parameters in that method to determine what specific information Commerce SDK needs from you. After you've obtained the required information, you can call the `continueProcessingTransaction` method on the transaction processor to tell Commerce SDK to continue.

:::::notice{note}

 You should call `continueProcessingTransaction` from inside a `dispatch_async`.
:::::


See the sample app source code for more information.

In the example below, we are inside the `shouldProvideInformation` method. We are checking to see if voice referral is needed.

```objc
BOOL continueTransaction = NO;
if (tenderRequirementsInterface.requiresVoiceReferral != ECLVoiceReferral_NotRequired) {
 // you'd need to obtain an approval code at this point. In this example, the code is 321. You should show UI to get the actual code. Then you'd pass it back to CSDK like this:
 [((id<ECLCardTenderProtocol>) tender) setVoiceReferralHandledAndApproved:@"321"];
 continueTransaction = YES;
}

if (continueTransaction == YES) {
 dispatch_async(dispatch_get_main_queue(), ^() {
 [[_account transactionProcessor] continueProcessingTransaction:transaction using:tender delegate:delegate];
 });
 return;
}
```

### C\# 

If Commerce SDK needs information from you in order to continue processing a transaction, your payment complete callback will be called. You'll have access to a `paymentresults` parameter. Check to see if `paymentresults.completed` is false. If it is then you can call `getRequiredInformation` which will return an array of items that Commerce SDK needs from you. Typically there will only be one element in the array. If there are multiple elements, you need to handle them one by one.

During transaction processing, Commerce SDK will return the `requiredInformation` variable to indicate the information it needs from your application in order to continue processing the transaction. This variable will contain one of these values:

| Value | Description |
| ---- | ---- |
| `DigitalSignature` | Returned if digital signature has not been set on card tender Returned if the card and transaction require a digital signature but the card reader: - failed to retrieve the information - does not support digital signature capturing - canceled the signature |
| `VoiceReferral` | Returned if voice approval required is set on the card tender but one of these is not called: - `setVoiceReferralHandledAndApproved` - `setVoiceReferralHandeledAndDenied` |
| `SignatureVerification` | Returned if signature verification required is set on the card ternder but `setSignatureVerificationHandledAndVerified` is not called |
| `Tax` | Returned if tax is not enabled |
| `Discount` | Returned if discount defaults to null |
| `Tip` | Returned if `isGratuityRequested` is disabled or gratuity is not set on the transaction |
| `TokenizedCardNumber` | Tokenized credit card number. |
| `CardPresent` | Returned if `setCardPresent` is not called from the card tender |
| `EmvApplicationSelectionRequired` | Returned if `setSelectedEmvApplication` is not called from the card tender |
| `EmvApplicationIdSelected` | Identifier of the selected EMV application. |
| `RequireAvsZipCode` | Returned if cardholder zip code is required for the transaction |
| `HandleBinLookupResult` | If you need to update the transaction based on the `binLookupResult`, then you should use `CWS.HandleBinLookupResult` method to pass in a `HandleBinLookupResultInfo` object.

In the example below, we've called `getRequiredInformation` and there was a single element in there for `VoiceReferral`. Then the merchant obtains the voice referral code from the issuer and then gives it to your app. You pass the code into Commerce SDK by setting the `VoiceReferral` variable. Then you call `continuePaymentTransaction` to continue the transaction.

```c#
Dictionary<string, string> info = new Dictionary<string, string>();
info["VoiceReferral"] = "abc123";

PaymentTransactionResults tr = m_CWS.ContinuePaymentTransaction(m_PaymentGatewayId, chanId, info, MyNotifyCWSEvent);
```

Continue Transaction

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

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

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