Getting Started

Commerce SDK® accelerates your business' ability to implement a secure EMV-compliant payment solution by combining Elavon's global payment processing, EMV certification, and hardware support.

Commerce SDK allows your mobile-based and/or desktop-based Point-of-Sale (POS) solution to communicate with payment terminals and printers, as well as process payments through Elavon's Converge payment gateway.

error_outline
important
  • Commerce SDK is not intended for use on unattended transactions in the US or Canada.
  • iOS 9.x will no longer be supported starting with version 4.3.
  • Windows 7 will no longer be supported starting with a future release in 2020 due to the end of extended support.

In this topic:

Commerce SDK Integration Process

The basic process to integrate your payment solution with Commerce SDK is as follows:

  1. Contact Elavon Sales (websales@elavon.com)

    At this step, Elavon will assist you with the completion of the license agreement and with the request for a solution engineer.

  2. Select an Integration Method

    At this step, you as the integrator will determine the appropriate integration method to implement for the merchant's payment solution.

  3. Receive the Software Developer Kit (SDK) from Your Solution Engineer
  4. Complete the Certification
  5. Go Live

Integration Methods

Commerce SDK supports the following integration methods, which you can use to develop your EMV-compliant payment solution:

error_outline
important
  • Use the Demo endpoints when testing your Commerce SDK integrated page.
  • Only use Elavon-approved card numbers to test your integration. Refer to the Test Cards section for more information.
  • Replace the Demo endpoints with the Production endpoints when you finish testing your Commerce SDK integrated page.
  • The CWS application or service must be run as an administrator on the local machine to which the pinpad is connected.

Supported Hardware

This section summarizes the payment terminals and printers that you can integrate with Commerce SDK.

Payment Terminals

This table describes the Ingenico payment terminals supported in Commerce SDK.

United States

Model Supported CSDK Version Software Encryption EMV Contactless Operating System (Connectivity)
iSC250 ALL RBA TDES Yes Yes Windows (USB, IP)
iOS (IP)
Android (IP)
iCMP ALL RBA TDES Yes Yes Windows (USB, BT)
iOS (BT)
Android (BT)
iPP320 V3 ALL RBA TDES Yes Yes Windows (USB, IP)
iOS (IP)
Android (IP)
iPP320 V4 4.0 (+) RBA TDES Yes Yes Windows (USB, IP)
iOS (IP)
Android (IP)
RP457c ALL RUA TDES Yes Yes iOS (BT, Audio)
Android (BT, USB OTG, Audio)
Link/2500 4.0 (+) UPP TDES Yes Yes Windows (USB, WiFi-based IP)
iOS (WiFi-based IP, BT)
Android (WiFi-based IP, BT)
Moby/5500 4.3 (+) RUA TDES Yes Yes Windows (USB)
iOS (BT)
Android (BT)

Canada

Model Supported CSDK Version Software Encryption EMV Contactless Operating System (Connectivity)
iCMP ALL RBA master/session Yes Yes Windows (USB, BT)
iOS (BT)
Android (BT)
iPP320 V3 ALL RBA master/session Yes Yes Windows (USB, IP)
iOS (IP)
Android (IP)
iPP320 V4 4.0 (+) RBA master/session Yes Yes Windows (USB, IP)
iOS (IP)
Android (IP)
Link/2500 4.2 (+) UPP TDES Yes Yes Windows (USB, WiFi-based IP)
iOS (WiFi-based IP, BT)
Android (WiFi-based IP, BT)

Printers

This table describes the STAR Micronics printers supported in Commerce SDK.

Model Operating System Region
S220 Android, iOS, Windows United States
T300i Android, iOS, Windows United States

Supported Transactions

This table summarizes the payment transactions that you can integrate into your application through Commerce SDK.

Transaction Description
Sale Obtains real-time authorization for an EMV, magnetic stripe, contactless or manual card entry transaction and enters the transaction into the Unsettled batch.
Pre-Auth Obtains real-time authorization for an EMV, magnetic stripe or contactless transaction, guarantees the availability of fund on the card, and reduces the cardholder's limit to buy for a pre-determined period (7 to 10 days depending on issuing bank). This transaction does not place the authorization in the Settlement batch.
Pre-Auth Complete Converts a previously approved pre-authorization to a Sale transaction and places the transaction into the Open batch for settlement.
Auth Only Reversal Deletes and attempts a reversal on a previous pre-authorization transaction.
Void Removes a Sale, Stand Alone Refund or Force Sale transaction from the Open batch.
Linked Refund Issues a partial or full refund to the cardholder's credit card or debit card.
Stand Alone Refund Issues a return to the cardholder's credit card using the full credit card number.
Continue Transaction Continues transaction processing once Commerce SDK receives needed information.
Cancel Transaction Cancels a transaction prior to authorization.
Transaction Lookup Searches for previous Sale, Pre-Auth, Refund or Void transactions.

This table summarizes the processing options that can be added to transactions.

Processing Option Applies To Description
Address Verification Service
 
Sale
Pre-Auth
Verifies the cardholder's address data with the issuing bank to minimize fraudulent transactions.
Force Sale Sale Processes a transaction using the voice authorization number provided by the creditor.
Gratuity
 
Sale
Pre-Auth
Adds a gratuity or tip amount to the transaction amount.
 
Manual Card Entry
 
Sale
Pre-Auth
Allows the terminal to encrypt the card data for manually entered card number and expiration date.
Merchant Transaction Reference Sale Associates a reference ID with a transaction.
Partial Approval
 
Sale
Pre-Auth
Partially authorizes a transaction when the funds on the payment card cannot cover the entire transaction amount.
Pay with Token
 
Sale
Pre-Auth
Processes a transaction using a token instead of card data.
 
Request Token
 
Sale
Pre-Auth
Request the tokenization of the card number as part of the transaction.
 
Invoice Number Sale Adds an invoice number to the transaction to track related transactions.

Contact Support

Email: techsupp@elavon.com

Phone: 1-800-377-3962 | Option 2 | Option 2