(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
Elavon Converge Payment Gateway
This page details the inputs, secure inputs and outputs available for the Verifone TokenGateway, how to complete each field, and an external link to the Verifone TokenGateway integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Input
Description
merchantId
Y
15 char
Merchant ID
Elavon-assigned Converge account ID
userId
Y
15 char
Converge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the
terminal.
pin
Y
64 char
Terminal ID
Unique identifier of the terminal that will process the transaction request and submit to the Converge
gateway
testMode
Y
true or false only
Indicates if the transaction is in test mode or not
entryMode
N
2 num
Transaction Entry Indicator
Indicates how the track data was captured.
Valid values:
01 - Key entered - Card not present
02 - Key entered - Card present
03 - Swiped (default)
04 -Proximity/Contactless (Always set to 01 for MOTO)
posMode
N
2 num
POS Device Data Entry Capability
Indicates how the POS device captures card data.
Valid values:
01 - Manual entry only
02 - Magnetic swipe-capable
03 - Proximity or contactless-capable
04 - EMV chip-capable (ICC) - Contact only with magnetic stripe
05 - EMV chip-capable (ICC) - Dual interface with magnetic stripe
cardPresent
N
Y or N only
Card Present Indicator
Indicates whether the card is physically present during the transaction.
Valid values:
Y - Card present
N - Card not present
Recommended for hand-keyed transactions. (Always set to “N” for MOTO).
transactionType
Y
20 char
The type of transaction being performed. Possible values are –
ccsale
ccauthonly
ccverify
ccaddrecurring
ccaddinstall
ccgettoken
description
N
255 char
Merchant-defined Transaction Description
Short and custom text to describe the transaction
cvv2cvc2Indicator
N
1 num
Card Verification Value / Card Validation Code Indicator
Indicates the status of the card security code or number during the transaction.
Valid values:
0 - Bypassed
1 - Present
2 - Illegible
9 - Not Present
getToken
N
Y or N only
Generate Token Indicator
Indicates whether to generate a token when submitting the card data.
Valid values:
Y - Generate token
N - Do not generate token (Default)
Only applicable to terminals that are set up with the Tokenization terminal option.
addToken
N
Y or N only
Add to Card Manager Indicator
Indicates whether to generate and store the token in Card Manager.
Valid values:
Y - Generate and store token
N - Do not store token (Default)
Important: Only applicable to terminals that are set up with the Tokenization terminal option.
amount
Y
11 num
Transaction Amount
The Sale amount that includes the Net and Sales Tax amounts.
For Tip Processing, the Sale amount must not include the Tip amount.
For terminals that are set up with the Multi Currency credit payment option, make sure that the number
of decimal places are correct as some currencies have 0 (like JPY) or 3 (like BHD) decimal places.
Format: Number with 2 decimals places
city
N
30 char
City
City name on the cardholder's / customer's account or billing address.
avsAddress
N
30 char
Address Line 1
Commonly the house number and street name on the cardholder's / customer's account or billing
address.
Address Verification Service (AVS) data compared with the address on the card issuer's file.
Recommended for hand-keyed transactions to qualify for better interchange rates.
avsZip
N
9 char
Postal or ZIP Code
ZIP code on the cardholder's account or billing address.
Address Verification Service (AVS) data compared with the postal or ZIP code on the card issuer's file.
Recommended for hand-keyed transactions to qualify for better interchange rates.
email
N
100 char
Email Address
The cardholder's or customer's email address.
firstName
Y
20 char
First Name
First name on the cardholder's / customer's account or billing address.
lastName
Y
30 char
Last Name
Last name on the cardholder's / customer's account or billing address.
state
N
2 char
State Code
State or province code on the cardholder's / customer's account or billing address
company
N
50 char
Company Name
Company name on the cardholder's / customer's account or billing address.
phone
N
10 num
Phone
Phone number on the cardholder's / customer's account or billing address.
Important: Must not include spaces or dashes.
country
N
3 char
Country ISO Code
Country ISO code on the cardholder's / customer's account or billing address.
Secure Inputs
Inputs Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 char
Secure input of the card number
expDate
Yes
4 char
Secure input of the card expiry - in the format MMYY
cvv2cvc2
Yes
3 or 4 char
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
errorCode
Error Code
Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
errorName
Error Name
Error name or reason for the error
errorMessage
Error Message
Detailed explanation of the error. This field may be changed based on merchant configuration in the user
interface.
emailOut
The customer’s email address as sent in the original transaction
phoneOut
The customer’s phone number as sent in the original transaction
token
Token
Generated from the credit card number.
amountOut
Transaction Amount
The total transaction amount that may include the Surcharge or Cashback amount.
result
Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
txnId
Transaction ID
Unique identifier of the transaction.
avsZip
The zip code as sent in the original transaction
companyOut
The company name as sent in the original transaction
expDateOut
The expiry date for the card as sent in the original transaction
txnTime
Processing Date and Time
Indicates when Converge processed the transaction.
Format: MM/DD/YYYY hh:mm:ss AM/PM
Example: 03/18/2010 10:34:10 AM
cardType
The type of card used in the transaction
lastNameOut
The customer’s last name, as sent in the original transaction
cardNumberOut
Masked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN.
descriptionOut
The description for the transaction, as provided in the original transaction
avsResponse
Address Verification Response Code
Refer to the AVS Response Codes section for a complete list of AVS response codes.
Important: Returned only if ssl_verify = Y
issuePoints
Accrue Points
Indicates whether points are accrued for the current transaction.
Valid values:
Y - Points accrued
N - Points not accrued
approvalCode
Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction
resultMessage
Transaction Result Message
Refer to the EMV Card Response Codes section for an extensive list of possible returned messages.
tokenResponse
Token Generation Outcome
A value of SUCCESS indicates Converge generted the token. Other values returned are FAILURE ,
Action Not Permitted , Invalid Token , Not Permitted , and Acct Verification Failed.
cardShortDescription
Short Card Brand Name
Please contact support@pcipal.com for a copy of the Elavon Converge API documentation.
