Getting Started

You can use one of three ways to submit transactions to the Converge application:

  1. Through the Virtual Terminal
  2. Through the Converge Mobile application
  3. Through an integrated application using Converge API

This Integration Guide  provides the information to submit transactions through an integrated application using Converge API.

Converge API

The Converge API enables you (the developer) to write a point-of-sale application (website, software application, shopping cart, etc.) that interfaces with the Converge payment gateway to process credit card, debit card, food stamp, cash benefit, electronic check, gift card, recurring, and installment transactions.

Before starting your Converge integration, you must request a Converge demo account from Elavon's Software Technical Support or Internet Product Support Group.

Converge Demo Account

The Converge demo account provides the environment for integration development, certification, and future user acceptance testing (UAT).

error_outline

note

Converge demo and production sites now use SHA-2 Certificates and will require TLS 1.2 connections.

To request for a Converge demo account or the Elavon Internet Product Support Group. If you lost your account credentials, contact Software Technical Support:

  • Email:   #SEDevPortalSupport@elavon.com
  • Phone:   1-800-377-3962 | Option 2 | Option 2

You must provide the following information to the product support group:

  • Company Name
  • Primary Contact Name
  • Primary Contact Number
  • Primary Email Address
  • Market Segment (Retail, Service/Restaurant, Mail/Telephone Order, eCommerce)

You must also request to switch on the Enabled HTTPS Transaction option to be able to submit transactions from an integrated application.

After the Elavon system administrator sets up your demo account to process transactions through an intgrated application using the Converge API, you will receive an email containing the following information:

  • Converge Demo URL
  • Converge Demo Login Credentials
    • Account ID (Merchant ID)
    • User ID (or Merchant Administrator ID)
    • Password
  • Converge API Authentication Credentials
    • ssl_merchant_id
    • ssl_user_id
    • ssl_pin
    • ssl_vendor_id
  • Converge Demo and Production Endpoints
  • Related Information

Once your Converge demo account is ready for use, you will need to determine the integration method that best suites the organization's business model and your programming capabilities.

Integration Methods

Converge API offers integration methods that feature HTTPS Authorization (SSL) Interfaces to process transactions for payment integration. These tables provide overviews of the Converge integration methods:

error_outline

important

  • Use the Demo endpoints when testing your Converge 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 Converge integrated page.
  • Refer to the Integration Methods section for more information.

Hosted Payments Page

Ease of Integration Market Segment Card Present/Card Not Present PCI SAQ Type Number of Questions (PCI-DSS v3.2) Customization
Easy eCommerce CNP SAQ A 22 Minimal

Demo Endpoints

  • Session Token Request:  https://api.demo.convergepay.com/hosted-payments/transaction_token
  • Redirect Transaction Request:  https://api.demo.convergepay.com/hosted-payments

Production Endpoints

  • Session Token Request:  https://api.convergepay.com/hosted-payments/transaction_token
  • Redirect Transaction Request:  https://api.convergepay.com/hosted-payments

Lightbox

Ease of Integration Market Segment Card Present/Card Not Present PCI SAQ Type Number of Questions (PCI-DSS v3.2) Customization
Easy eCommerce CNP SAQ A 22 Minimal

Demo Endpoints

  • Session Token Request:  https://api.demo.convergepay.com/hosted-payments/transaction_token
  • Redirect to Hosted Payment Form:  https://api.demo.convergepay.com/hosted-payments/PayWithConverge.js

Production Endpoints

  • Session Token Request:  https://api.convergepay.com/hosted-payments/transaction_token
  • Redirect to Hosted Payment Form:  https://api.convergepay.com/hosted-payments/PayWithConverge.js

Checkout.js

Ease of Integration Market Segment Card Present/Card Not Present PCI SAQ Type Number of Questions (PCI-DSS v3.2) Customization
Medium eCommerce CNP SAQ A - EP 191 Extensive

Demo Endpoints

  • Session Token Request:  https://api.demo.convergepay.com/hosted-payments/transaction_token
  • Checkout.js Library:  https://api.demo.convergepay.com/hosted-payments/Checkout.js

Production Endpoints

  • Session Token Request:  https://api.convergepay.com/hosted-payments/transaction_token
  • Checkout.js Library:  https://api.convergepay.com/hosted-payments/Checkout.js

XML API

Ease of Integration Market Segment Card Present/Card Not Present PCI SAQ Type Number of Questions (PCI-DSS v3.2) Customization
Hard Retail, Service, MOTO, eCommerce CP, CNP SAQ D 250 Extensive

Demo Endpoint:  https://api.demo.convergepay.com/VirtualMerchantDemo/processxml.do

Production Endpoint:  https://api.convergepay.com/VirtualMerchant/processxml.do